Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

BatchRendererGroup.AddBatch

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

Declaration

public Rendering.BatchID AddBatch(NativeArray<MetadataValue> batchMetadata, GraphicsBufferHandle buffer);

Declaration

public Rendering.BatchID AddBatch(NativeArray<MetadataValue> batchMetadata, GraphicsBufferHandle buffer, uint bufferOffset, uint windowSize);

Parameters

batchMetadata The metadata properties for this batch.
buffer The GraphicsBufferHandle of the GraphicsBuffer associated with this batch.
bufferOffset The offset amount of the data to bound within the Uniform Buffer Object (UBO). This value defaults to zero, which is the start of the buffer. If this is a constant buffer, this value must be an integer multiple of BatchRendererGroup.GetConstantBufferOffsetAlignment.
windowSize Amount of data in the buffer to be bound, starting from the bufferOffset value. Defaults to zero. If this is a constant buffer, this value must be less or equal to BatchRendererGroup.GetConstantBufferMaxWindowSize.

Returns

BatchID ID of the batch Unity has created.

Description

Create a draw command batch that shares a single set of metadata values and a single GraphicsBuffer.

Every buffer you pass in to this method must have the correct buffer target for the active graphics API. Use the BatchRendererGroup.BatchBufferTarget query to find out which buffer target you should use. If the target is BatchBufferTarget.RawBuffer then both bufferOffset and windowSize must be zero If the target is BatchBufferTarget.ConstantBuffer, then bufferOffset must be an integer multiple of the BatchRendererGroup.GetConstantBufferOffsetAlignment value (zero allowed), and windowSize must be less than or equal to the BatchRendererGroup.GetConstantBufferMaxWindowSize value. The combined value of bufferOffset and windowSize must be less than or equal to the size of the ConstantBuffer.