Version: 2022.3
LanguageEnglish
  • C#

ComputeShader

class in UnityEngine

/

Inherits from:Object

/

Implemented in:UnityEngine.CoreModule

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

Description

Compute Shader asset.

Compute shaders are programs that run on the GPU outside of the normal rendering pipeline. They correspond to compute shader assets in the project (.compute files).

Compute shader support can be queried runtime using SystemInfo.supportsComputeShaders. See Compute Shaders overview for more info about platforms supporting compute shaders.

Additional resources: ComputeBuffer class, Compute Shaders overview.

Properties

enabledKeywordsAn array containing the local shader keywords that are currently enabled for this compute shader.
keywordSpaceThe local keyword space of this compute shader.
shaderKeywordsAn array containing names of the local shader keywords that are currently enabled for this compute shader.

Public Methods

DisableKeywordDisables a local shader keyword for this compute shader.
DispatchExecute a compute shader.
DispatchIndirectExecute a compute shader.
EnableKeywordEnables a local shader keyword for this compute shader.
FindKernelFind ComputeShader kernel index.
GetKernelThreadGroupSizesGet kernel thread group sizes.
HasKernelChecks whether a shader contains a given kernel.
IsKeywordEnabledChecks whether a local shader keyword is enabled for this compute shader.
IsSupportedAllows you to check whether the current end user device supports the features required to run the specified compute shader kernel.
SetBoolSet a bool parameter.
SetBufferSets an input or output compute buffer.
SetConstantBufferSets a ComputeBuffer or GraphicsBuffer as a named constant buffer for the ComputeShader.
SetFloatSet a float parameter.
SetFloatsSet multiple consecutive float parameters at once.
SetIntSet an integer parameter.
SetIntsSet multiple consecutive integer parameters at once.
SetKeywordSets the state of a local shader keyword for this compute shader.
SetMatrixSet a Matrix parameter.
SetMatrixArraySet a Matrix array parameter.
SetTextureSet a texture parameter.
SetTextureFromGlobalSet a texture parameter from a global texture property.
SetVectorSet a vector parameter.
SetVectorArraySet a vector array parameter.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.