Version: 2021.3
LanguageEnglish
  • C#

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

Cancel

Description

A group of batches.

Represents a container for multiple batches that share the same culling method. See Also: OnPerformCulling

BatchRendererGroup is an experimental API originally designed for DOTS Hybrid Renderer use only. This API is under construction and several public methods will be deprecated. The goal is to improve the API to make it usable for more than just the DOTS Hybrid Renderer. The current API is going be replaced with a new API in 2022.1.

Constructors

BatchRendererGroupCreates a new BatchRendererGroup.

Public Methods

AddBatchAdds a new batch to the group.
DisposeDeletes a group.
EnableVisibleIndicesYArrayEnables or disables BatchCullingContext.visibleIndicesY.
GetBatchMatricesRetrieves the matrices associated with one batch.
GetBatchMatrixArrayRetrieves an array of instanced vector properties for a given batch.
GetBatchScalarArrayRetrieves an array of instanced float properties for a given batch.
GetBatchScalarArrayIntRetrieves an array of instanced int properties for a given batch.
GetBatchVectorArrayRetrieves an array of instanced vector properties for a given batch.
GetBatchVectorArrayIntRetrieves an array of instanced int vector properties for a given batch.
GetNumBatchesRetrieves the number of batches added to the group.
RemoveBatchRemoves a batch from the group. Note: For performance reasons, the removal is done via emplace_back() which will simply replace the removed batch index with the last index in the array and will decrement the size. If you're holding your own array of batch indices, you'll have to either regenerate it or apply the same emplace_back() mechanism as RemoveBatch does.
SetBatchBoundsSets the bounding box of the batch.
SetBatchFlagsSets flag bits that enable special behavior for this Hybrid Renderer V2 batch.
SetBatchPropertyMetadataSets all Hybrid Renderer DOTS instancing metadata for this batch, and marks it as a Hybrid Renderer V2 batch.
SetInstancingDataUpdates a batch.

Delegates

OnPerformCullingCulling callback function.