Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ComputeShader.DispatchIndirect

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

public function DispatchIndirect(kernelIndex: int, argsBuffer: ComputeBuffer, argsOffset: uint = 0): void;
public void DispatchIndirect(int kernelIndex, ComputeBuffer argsBuffer, uint argsOffset = 0);

Parameters

kernelIndex Which kernel to execute. A single compute shader asset can have multiple kernel entry points.
argsBuffer Buffer with dispatch arguments.
argsOffset Byte offset where in the buffer the dispatch arguments are.

Description

Execute a compute shader.

This function "runs" the compute shader, with the given work size read directly from the GPU. Typical use case is generating arbitrary amount of data from a ComputeShader and then dispatching that, without requiring a readback to the CPU.

Buffer with arguments, argsBuffer, has to have three integer numbers at given argsOffset offset: number of work groups in X dimension, number of work groups in Y dimension, number of work groups in Z dimension.

Within each work group, a number of shader invocations ("threads") are done. The work group size is specified in the compute shader itself (using "numthreads" HLSL attribute), and the total amount of compute shader invocations is thus group count multiplied by the thread group size. Work group size can be queried using GetKernelThreadGroupSizes function.

This very much maps to Direct3D11 DispatchIndirect / OpenGL ES 3.1 glDispatchComputeIndirect function

See Also: Dispatch, Graphics.DrawProceduralIndirect, ComputeBuffer.CopyCount, Compute Shaders.