Version: 2022.3
LanguageEnglish
  • C#
Method group is Obsolete

TerrainData.UpdateDirtyRegion

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

Obsolete Please use DirtyHeightmapRegion instead.

Declaration

public void UpdateDirtyRegion(int x, int y, int width, int height, bool syncHeightmapTextureImmediately);

Parameters

x Start X position of the dirty heightmap region.
y Start Y position of the dirty heightmap region.
width Width of the dirty heightmap region.
height Width of the dirty heightmap region.
syncHeightmapTextureImmediately Update immediately, instead of deferring the update.

Description

Triggers an update to integrate modifications done to the heightmap outside of unity.

This function is obsolete. Use either CopyActiveRenderTextureToHeightmap or DirtyHeightmapRegion instead.

Invoke this function whenever custom Terrain heightmap paint tools modify the heightmap, to let Unity integrate the changes such as physics and collision updates.