Version: 2023.2
LanguageEnglish
  • C#

PaintContext.GetClippedPixelRectInTerrainPixels

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 RectInt GetClippedPixelRectInTerrainPixels(int terrainIndex);

Parameters

terrainIndex Index of the Terrain.

Returns

RectInt Returns the clipped pixel rectangle.

Description

Retrieves the clipped pixel rectangle for a Terrain.

When painting across a border, the PaintContext can refer to several Terrain tiles. GetClippedPixelRectInTerrainPixels returns the PaintContext.pixelRect clipped to the specified Terrain, in the pixel coordinates of the target texture on that Terrain. terrainIndex must be between 0 and PaintContext.terrainCount - 1. Additional resources: PaintContext.GetTerrain, PaintContext.targetTextureWidth, and PaintContext.targetTextureHeight.