Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Dispatch(int, int, int, int)

Execute a compute shader.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public void Dispatch(int kernelIndex, int threadGroupsX, int threadGroupsY, int threadGroupsZ)

Parameters

kernelIndex

int
Which kernel to execute. A single compute shader asset can have multiple kernel entry points.

threadGroupsX

int
Number of work groups in the X dimension.

threadGroupsY

int
Number of work groups in the Y dimension.

threadGroupsZ

int
Number of work groups in the Z dimension.

Remarks

This functions "runs" the compute shader, launching the indicated number of compute shader thread groups in the X, Y and Z dimensions. Within each work group, a number of shader invocations ("threads") are made. 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 ComputeShader.GetKernelThreadGroupSizes function.
Additional Resources: ComputeShader.FindKernel, ComputeShader.GetKernelThreadGroupSizes, ComputeShader.DispatchIndirect, Compute Shaders.