terrain | Reference Terrain tile. |
boundsInTerrainSpace | The region in terrain space to edit. |
extraBorderPixels | Number of extra border pixels required. |
fillOutsideTerrain | Whether to fill empty space outside of Terrain tiles with data from the nearest tile. |
PaintContext PaintContext containing the combined heightmap data for the specified region.
Helper function to set up a PaintContext for modifying the heightmap of one or more Terrain tiles.
BeginPaintHeightmap identifies all of the heightmap pixels that are within extraBorderPixels of the bounds rectangle.
The search is performed across adjacent connected Terrain tiles.
The pixels are collected into a temporary render texture and stored in PaintContext.sourceRenderTexture.
After calling this function, you may modify the heightmap by writing the new values into PaintContext.destinationRenderTexture.
Then, you may complete the modification by calling TerrainPaintUtility.EndPaintHeightmap to copy the modified data back to the Terrain tiles.
Alteratively, you may cancel the modification by calling TerrainPaintUtility.ReleaseContextResources to release the RenderTexture resources.
See Also: TerrainPaintUtility.EndPaintHeightmap and PaintContext.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.