Showing content from https://docs.unity3d.com/Manual/sprite/../../ScriptReference/Rendering.BatchRendererGroup.html below:
Unity - Scripting API: BatchRendererGroup
BatchRendererGroup
class in UnityEngine.Rendering
/
Implemented in:UnityEngine.CoreModule
Suggest a change Success!
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.
Close Submission failed
For 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.
Close Your name Your email Suggestion*
Cancel
Description
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.
Static Properties Property Description BufferTarget The buffer target BatchRendererGroup.AddBatch accepts for the active graphics API. Public Methods Method Description 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. SetEnabledViewTypes Set the combination of BatchCullingViewType for which this BatchRendererGroup should receive an OnPerformCulling callback. SetErrorMaterial Set the error material for the BatchRendererGroup. This material will be used internally by Unity to render the draw commands referring to erroneous shaders. You can also pass 'null' to this method to unset the material. 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. SetLoadingMaterial Set the loading material for the BatchRendererGroup. 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.
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4