Version: 2019.4
  • C#
Experimental: this API is experimental and might be changed or removed in the future.


Suggest a change


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.


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.




public static Experimental.TerrainAPI.PaintContext BeginPaintHeightmap(Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels);


terrain Reference Terrain tile.
boundsInTerrainSpace The region in terrain space to edit.
extraBorderPixels Number of extra border pixels required.


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


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 Terrain tiles. 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 Terrain tiles. Alteratively, you may cancel the modification by calling TerrainPaintUtility.ReleaseContextResources to release the RenderTexture resources.

See Also: TerrainPaintUtility.EndPaintHeightmap and PaintContext.