Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CollectNormals(Terrain, Rect, int, bool)

Helper function to set up a PaintContext that collects mesh normal data from one or more Terrain tiles.
Read time 1 minuteLast updated 12 days ago

Definition

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

Parameters

terrain

Terrain
Reference Terrain tile.

boundsInTerrainSpace

Rect
The region in terrain space from which to collect normals.

extraBorderPixels

int
Number of extra border pixels required.

fillOutsideTerrain

bool
Whether to fill empty space outside of Terrain tiles with data from the nearest tile.

Returns

Type

Description

PaintContextPaintContext containing the combined normalmap data for the specified region.

Remarks

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.