Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

TerrainData.CopyActiveRenderTextureToHeightmap

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 void CopyActiveRenderTextureToHeightmap(RectInt sourceRect, Vector2Int dest, TerrainHeightmapSyncControl syncControl);

Parameters

sourceRect The part of the active Render Texture to copy.
dest The X and Y coordinates of the heightmap texture to copy into.
syncControl Controls how CPU synchronization is performed.

Description

Copies the specified part of the active RenderTexture to the Terrain heightmap texture.

This functions calls DirtyHeightmapRegion internally and sends out the OnTerrainChanged message accordingly.

Additional resources: TerrainHeightmapSyncControl, DirtyHeightmapRegion, SyncHeightmap.