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

TerrainPaintUtility.BeginPaintHeightmap

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

Parameters

terrainReference Terrain tile.
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 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.

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961