Version: 2021.3
LanguageEnglish
  • C#

ComputeShader.GetKernelThreadGroupSizes

Leave feedback
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

Switch to Manual

Declaration

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.

Additional resources: Dispatch, FindKernel, Compute Shaders.

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 ©2024 Unity Technologies. Publication Date: 2024-11-13.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information