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.
See Also: ComputeBuffer class, Compute Shaders overview.
enabledKeywords | An array containing the local shader keywords that are currently enabled for this compute shader. |
keywordSpace | The local keyword space of this compute shader. |
shaderKeywords | An array containing names of the local shader keywords that are currently enabled for this compute shader. |
DisableKeyword | Disables a local shader keyword for this compute shader. |
Dispatch | Execute a compute shader. |
DispatchIndirect | Execute a compute shader. |
EnableKeyword | Enables a local shader keyword for this compute shader. |
FindKernel | Find ComputeShader kernel index. |
GetKernelThreadGroupSizes | Get kernel thread group sizes. |
HasKernel | Checks whether a shader contains a given kernel. |
IsKeywordEnabled | Checks whether a local shader keyword is enabled for this compute shader. |
IsSupported | Allows you to check whether the current end user device supports the features required to run the specified compute shader kernel. |
SetBool | Set a bool parameter. |
SetBuffer | Sets an input or output compute buffer. |
SetConstantBuffer | Sets a ComputeBuffer or a GraphicsBuffer as a named constant buffer for the ComputeShader. |
SetFloat | Set a float parameter. |
SetFloats | Set multiple consecutive float parameters at once. |
SetInt | Set an integer parameter. |
SetInts | Set multiple consecutive integer parameters at once. |
SetKeyword | Sets the state of a local shader keyword for this compute shader. |
SetMatrix | Set a Matrix parameter. |
SetMatrixArray | Set a Matrix array parameter. |
SetTexture | Set a texture parameter. |
SetTextureFromGlobal | Set a texture parameter from a global texture property. |
SetVector | Set a vector parameter. |
SetVectorArray | Set a vector array parameter. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsOfType | Gets a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
bool | Does 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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.