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

Script language

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

ComputeShader.GetKernelThreadGroupSizes

Other Versions
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 GetKernelThreadGroupSizes(kernelIndex: int, out x: uint, out y: uint, out z: uint): void;
public void GetKernelThreadGroupSizes(int kernelIndex, out uint x, out uint y, out uint z);

Parameters

kernelIndex Which kernel to query. A single compute shader asset can have multiple kernel entry points.
x Thread group size in the X dimension.
y Thread group size in the Y dimension.
z Thread group size in the Z dimension.

Description

Get kernel thread group sizes.

Work group size for each compute shader kernel is specified in the shader code itself (using "numthreads" HLSL attribute). Use this function to query it.

See Also: Dispatch, FindKernel, Compute Shaders.

Leave Feedback

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store