Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

DirtyHeightmapRegion(RectInt, TerrainHeightmapSyncControl)

Marks the specified part of the heightmap as dirty.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.TerrainModule
public void DirtyHeightmapRegion(RectInt region, TerrainHeightmapSyncControl syncControl)

Parameters

region

RectInt
The rectangular region to mark as dirty.

syncControl

TerrainHeightmapSyncControl
Controls how CPU synchronization is performed.

Remarks

Use this function only after you manually change the GPU part of the heightmap texture by rendering into it, or by using Graphics.CopyTexture. Use the 
syncControl
parameter to control how you want Unity to perform CPU synchronization. Unity queues the reading back of unsynchronized data (height data, LOD data, or both) until the next call to TerrainData.SyncHeightmap.
If the current active RenderTexture contains your changes, and you want to copy a part of it into the heightmap texture, use TerrainData.CopyActiveRenderTextureToHeightmap instead.
This function sends out the OnTerrainChanged message with TerrainChangedFlags.Heightmap if you pass TerrainHeightmapSyncControl.HeightAndLod to the 
syncControl
parameter. If you pass Height to the 
syncControl
parameter, it sends out the OnTerrainChanged message with TerrainChangedFlags.DelayedHeightmapUpdate.