Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

PaintContext.CreateFromBounds

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

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

Parameters

terrainTerrain that defines terrain space for this PaintContext.
boundsInTerrainSpaceTerrain space bounds to edit in the target terrain texture.
targetTextureWidthWidth of the target terrain texture (per Terrain).
targetTextureHeightHeight of the target terrain texture (per Terrain).
extraBorderPixelsNumber of extra border pixels required.

Description

Constructs a PaintContext that you can use to edit a texture on a Terrain, in the region defined by boundsInTerrainSpace and extraBorderPixels.

This function calculates a pixelRect from boundsInTerrainSpace and extraBorderPixels, and then constructs a PaintContext from the pixelRect.

This function is called internally by TerrainPaintUtility.BeginPaintHeightmap, TerrainPaintUtility.BeginPaintTexture and TerrainPaintUtility.CollectNormals.

See Also: PaintContext

Did you find this page useful? Please give it a rating: