To improve performance when you tessellate a large mesh, use the job system. This prevents the main thread from being blocked for an extended period. When you create a tessellation job, use the MeshGenerationContext.AddMeshGenerationJob API to provide the job handle to UI Toolkit. This ensures that UI Toolkit will wait for the job to finish before accessing the mesh.
If you can quickly calculate the number of vertices or indices, use the main thread to allocate the mesh and add it to the draw sequence. You can do so with the following APIs:
Note: You can add the mesh to the draw sequence at any point during the call to generateVisualContent.
The following example demonstrates a jobified tessellation with allocation on the main thread, where the job performs the actual tessellation.
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/Examples/MeshGenerationContext_AddMeshGenerationJob.cs)]
If it’s computationally expensive to calculate the number of vertices or indices, insert a MeshGenerationNode into the draw sequence. Then provide the node to your job, along with a TempMeshAllocator. You can do so with the following APIs:
In this approach, perform the allocation from the job. Use the TempMeshAllocator.AllocateTempMesh to safely allocate a temporary mesh from a job. The MeshGenerationNode.DrawMesh acts like a container for a nested draw sequence that’s populated by the job.
Building on the prior example, the following demonstrates how to perform both the allocation and the tessellation from the job:
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/Examples/MeshGenerationContext_InsertMeshGenerationNode.cs)]
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.