Version: 2019.2
LanguageEnglish
  • C#

CommandBuffer.DispatchCompute

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 void DispatchCompute(ComputeShader computeShader, int kernelIndex, int threadGroupsX, int threadGroupsY, int threadGroupsZ);
public void DispatchCompute(ComputeShader computeShader, int kernelIndex, ComputeBuffer indirectBuffer, uint argsOffset);

Parameters

computeShader ComputeShader to execute.
kernelIndexKernel index to execute, see ComputeShader.FindKernel.
threadGroupsXNumber of work groups in the X dimension.
threadGroupsYNumber of work groups in the Y dimension.
threadGroupsZNumber of work groups in the Z dimension.
indirectBuffer ComputeBuffer with dispatch arguments.
argsOffsetByte offset indicating the location of the dispatch arguments in the buffer.

Description

Add a command to execute a ComputeShader.

When the command buffer executes, a compute shader kernel is dispatched, with work group size either specified directly (see ComputeShader.Dispatch) or read from the GPU buffer (see ComputeShader.DispatchIndirect).

Did you find this page useful? Please give it a rating: