Version: 2023.1
LanguageEnglish
  • C#

PaintContext.GetTerrain

Leave feedback
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 Terrain GetTerrain(int terrainIndex);

Parameters

terrainIndex Index of the terrain.

Returns

Terrain Returns the Terrain object.

Description

Retrieves a Terrain from the PaintContext.

When painting across a border, the PaintContext can refer to several Terrain tiles. GetTerrain is used to access those Terrain tiles. terrainIndex must be between 0 and PaintContext.terrainCount - 1. See Also: PaintContext.GetClippedPixelRectInTerrainPixels and PaintContext.GetClippedPixelRectInRenderTexturePixels.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2023 Unity Technologies. Publication Date: 2023-11-02.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information