Version: 2021.3
LanguageEnglish
  • C#

TerrainPaintUtility.BeginPaintTexture

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 BeginPaintTexture(Terrain terrain, Rect boundsInTerrainSpace, TerrainLayer inputLayer, int extraBorderPixels = 0, bool fillOutsideTerrain = true);

Parameters

terrain Reference Terrain tile.
inputLayer Selects the alphamap to paint.
boundsInTerrainSpace The region in terrain space to edit.
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 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 all of the 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.EndPaintTexture 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.

Additional resources: TerrainPaintUtility.EndPaintTexture and PaintContext.