heightmapPC | PaintContext describing the heightmap from which to build the preview mesh. |
previewTexture | Specifies Whether to build the mesh using the source or destination render texture in heightmapPC. |
brushTexture | The brush texture to preview. |
brushXform | Describes the position and orientation of the brush. |
proceduralMaterial | Material used to render the preview. |
materialPassIndex | Material pass to render. |
Draws a Terrain brush preview mesh from a heightmap PaintContext using the provided procedural material.
The heightmapPC is used to build the mesh. To ensure that the preview is rendered on the mesh, the heightmapPC must contain an area around the brush.
To facilitate proper transformation of brush UV space, this method sets up the brush transforms in the material.
Important: The material provided must support procedural mesh generation in the vertex shader using the shader functions provided in TerrainPreview.cginc. A default implementation of the material is provided by GetDefaultBrushPreviewMaterial().
See Also: TerrainPaintUtilityEditor.GetDefaultBrushPreviewMaterial 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.