Experimental: this API is experimental and might be changed or removed in the future.

TerrainPaintUtility.BeginPaintTexture

Switch to Manual
public static Experimental.TerrainAPI.PaintContext BeginPaintTexture (Terrain terrain, Rect boundsInTerrainSpace, TerrainLayer inputLayer, int extraBorderPixels);

Parameters

terrainReference Terrain tile.
inputLayerSelects the alphamap to paint.
boundsInTerrainSpaceThe region in terrain space to edit.
extraBorderPixelsNumber of extra border pixels required.

Returns

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

Description

Helper function to set up a PaintContext for modifying the alphamap of one or more Terrain tiles.

BeginPaintTexture identifies that alphamap 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.

After calling this function, you may modify the alphamap by writing the new values into PaintContext.destinationRenderTexture. Then, you may complete the modification by calling TerrainPaintUtility.EndPaintHeightmap to copy the modified data back to the Terrain tiles. Alteratively, you may cancel the modification by calling TerrainPaintUtility.ReleaseContextResources to release the RenderTexture resources.

See Also: TerrainPaintUtility.EndPaintTexture and PaintContext.