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.
CloseFor 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.
ClosetextureName | The name of the Terrain texture to copy into. |
textureIndex | The index of the Terrain texture to copy into. |
sourceRect | The part of the active Render Texture to copy. |
dest | The X and Y coordinates of the Terrain texture to copy into. |
allowDelayedCPUSync | Specifies whether to allow delayed CPU synchronization of the texture. |
Copies the specified part of the active RenderTexture to the Terrain texture.
If the allowDelayedCPUSync
parameter is set to true
, and the platform supports copying between a RenderTexture and a Texture2D, Unity performs a GPU copy from the active RenderTexture to the Terrain texture. This is sufficient for Terrain rendering, but you will need to call SyncTexture afterward to synchronize the CPU part of the texture.
If the allowDelayedCPUSync
parameter is set to false
, or the platform doesn't support copying between textures, Unity immediately reads back the content of the active RenderTexture, and updates both the CPU and GPU parts of the Terrain texture.
Unity recommends you create the source Render Texture to copy in the format that Terrain.heightmapRenderTextureFormat specifies, and call the HLSL function PackHeightmap
before you write to the source render texture. To use PackHeightmap
, make sure you have the include directive #include "UnityCG.cginc"
in your shader.
Additional resources: DirtyTextureRegion, SyncTexture.
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.