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.
CloseFor 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.
Closeevt | The point during the graphics processing at which this command buffer should commence on the GPU. |
buffer | The buffer to execute. |
queueType | The desired async compute queue type to execute the buffer on. |
shadowPassMask | A mask specifying which shadow passes to execute the buffer for. |
Adds a command buffer to the GPU's async compute queues and executes that command buffer when graphics processing reaches a given point.
Execute an async compute command buffer on the GPU when the graphics queues processing reaches a point described by the evt parameter.
Multiple command buffers can be set to execute at the same light event (or even the same buffer can be added multiple times). To remove a command buffer from execution, use RemoveCommandBuffer.
Passing a shadow pass mask allows detailed control over which shadow passes will execute the buffer.
The command buffer can only call the following commands for execution on the async compute queues, otherwise an error is logged and displayed in the Editor window:
CommandBuffer.BeginSample
CommandBuffer.CopyCounterValue
CommandBuffer.CopyTexture
CommandBuffer.CreateGPUFence
CommandBuffer.DispatchCompute
CommandBuffer.EndSample
CommandBuffer.IssuePluginEvent
CommandBuffer.SetComputeBufferParam
CommandBuffer.SetComputeFloatParam
CommandBuffer.SetComputeFloatParams
CommandBuffer.SetComputeTextureParam
CommandBuffer.SetComputeVectorParam
CommandBuffer.WaitOnGPUFence
All of the commands within the buffer are guaranteed to be executed on the same queue. If the target platform does not support async compute queues then the work is dispatched on the graphics queue.
See Also:GPUFence, SystemInfo.supportsAsyncCompute, CommandBuffer, RemoveCommandBuffer, GetCommandBuffers.
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:
Thanks for helping to make the Unity documentation better!