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

TerrainPaintUtility.BeginPaintHeightmap

Switch to Manual
public static Experimental.TerrainAPI.TerrainPaintUtility.PaintContext BeginPaintHeightmap (Terrain terrain, Rect bounds);

Parameters

terrainReference Terrain tile. Defines terrain space and heightmap resolution.
boundsInTerrainSpaceThe region in terrain space to edit.
extraBorderPixelsNumber of extra border pixels required.

Returns

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

Description

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

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

After calling this function, you may modify the heightmap 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 Terrains. Alteratively, you may cancel the modification by calling TerrainPaintUtility.ReleaseContextResources to release the RenderTexture resources.

See Also: TerrainPaintUtility.EndPaintHeightmap and PaintContext.