A BatchRendererGroup
is an object that lets you perform customizable high performance rendering.
You can set up batches in advance to set up groups of instances with shared metadata values that describe how to load Material properties. Whenever Unity renders a BatchRendererGroup
, it invokes the OnPerformCulling
callback to perform visibility culling and to generate a variable sized list of draw commands that describe how to render the visible parts of the BatchRendererGroup
. Each draw command instructs Unity to render a group of instances from a given batch with a specific Mesh and Material.
BatchRendererGroup | Constructor for a BatchRendererGroup object. |
AddBatch | Create a draw command batch that shares a single set of metadata values and a single GraphicsBuffer. |
Dispose | Deletes a group. |
GetRegisteredMaterial | Returns the previously registered Material associated with this MaterialID. |
GetRegisteredMesh | Returns the previously registered Mesh associated with this MeshID. |
GetThreadedBatchContext | Get the thread-safe API for interacting with a BatchRendererGroup from Burst jobs. |
RegisterMaterial | Registers a Material in BatchRendererGroup and returns its BatchMaterialID. Each registration of a specific Material increases its number of owners by 1. |
RegisterMesh | Registers a mesh in BatchRendererGroup and returns its BatchMeshID. Each registration of a specific mesh increases its number of owners by 1. |
RemoveBatch | Delete a batch that was previously created with AddBatch. |
SetBatchBuffer | Change the GraphicsBuffer associated with the given batch. |
SetGlobalBounds | Set the bounds of the BatchRendererGroup. The bounds should encapsulate the render bounds of every object rendered with this BatchRendererGroup. Unity uses these bounds internally for culling. |
SetPickingMaterial | Set the material that Unity uses to render object picking data using the draw commands in the Scene view. |
UnregisterMaterial | Unregister the Material ID associated with BatchRendererGroup. Each deregistration of a specific Material reduces its number of owners by 1. |
UnregisterMesh | Unregister the mesh ID associated with BatchRendererGroup. Each deregistration of a specific mesh reduces its number of owners by 1. |
OnPerformCulling | Culling callback function. |
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.