Version: 2023.2
LanguageEnglish
  • C#

TerrainPaintUtility.CollectNormals

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static TerrainTools.PaintContext CollectNormals(Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0, bool fillOutsideTerrain = true);

Parameters

terrain Reference Terrain tile.
boundsInTerrainSpace The region in terrain space from which to collect normals.
extraBorderPixels Number of extra border pixels required.
fillOutsideTerrain Whether to fill empty space outside of Terrain tiles with data from the nearest tile.

Returns

PaintContext PaintContext containing the combined normalmap data for the specified region.

Description

Helper function to set up a PaintContext that collects mesh normal data from one or more Terrain tiles.

CollectNormals identifies all of the normalmap pixels that are within extraBorderPixels of the bounds rectangle. The search is performed across adjacent connected Terrain tiles. The pixels are collected into a temporary render texture and stored in PaintContext.sourceRenderTexture.

Important: there is no corresponding function to write modified normalmap data back to the Terrain tiles, because the normalmap is not stored; it is calculated from the heightmap.

Once you are done using the sourceRenderTexture, you must call TerrainPaintUtility.ReleaseContextResources to release the RenderTexture resources.

Additional resources: PaintContext.GatherNormals and PaintContext.