Version: 2018.3 (switch to 2019.1b or 2017.4)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

TerrainPaintUtility.EndPaintHeightmap

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

public static void EndPaintHeightmap(Experimental.TerrainAPI.PaintContext ctx, string editorUndoName);

Parameters

ctxThe heightmap paint context to complete.
editorUndoNameUnique name used for the undo stack.

Description

Helper function for completing a heightmap modification.

Once the modified data is written to PaintContext.destinationRenderTexture, call this function to copy the modifications back to the original Terrains. This function also signals Unity to update the dirty regions in each of the affected heightmaps, to update collision and physics. This function will also release all allocated resources in the PaintContext.

See TerrainPaintUtility.BeginPaintHeightmap, PaintContext, and PaintContext.ScatterHeightmap.

Did you find this page useful? Please give it a rating: