AddBatch
Create a draw command batch that shares a single set of metadata values and a single GraphicsBuffer.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
AddBatch(NativeArray<MetadataValue>, GraphicsBufferHandle)
Create a draw command batch that shares a single set of metadata values and a single .
GraphicsBufferpublic BatchID AddBatch(NativeArray<MetadataValue> batchMetadata, GraphicsBufferHandle buffer)
Parameters
The metadata properties for this batch.
The of the associated with this batch.
GraphicsBufferHandleGraphicsBufferReturns
Type | Description |
|---|---|
| BatchID | ID of the batch Unity has created. |
Remarks
Every buffer you pass in to this method must have the correct buffer target for the active graphics API. Use the 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.
AddBatch(NativeArray<MetadataValue>, GraphicsBufferHandle, uint, uint)
Create a draw command batch that shares a single set of metadata values and a single .
GraphicsBufferpublic BatchID AddBatch(NativeArray<MetadataValue> batchMetadata, GraphicsBufferHandle buffer, uint bufferOffset, uint windowSize)
Parameters
The metadata properties for this batch.
The of the associated with this batch.
GraphicsBufferHandleGraphicsBufferThe 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.
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
Type | Description |
|---|---|
| BatchID | ID of the batch Unity has created. |
Remarks
Every buffer you pass in to this method must have the correct buffer target for the active graphics API. Use the 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.