class in UnityEngine
/
Inherits from:Object
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseShader scripts used for all rendering.
Most of the advanced rendering is controlled via Material class. Shader class is mostly
used just to check whether a shader can run on the user's hardware (isSupported property), setting up
global shader properties and keywords, and finding shaders by name (Find method).
Additional resources: Material class, Materials, ShaderLab documentation.
enabledGlobalKeywords | An array containing the global shader keywords that are currently enabled. |
globalKeywords | An array containing the global shader keywords that currently exist. This includes enabled and disabled global shader keywords. |
globalMaximumLOD | Shader LOD level for all shaders. |
globalRenderPipeline | Render pipeline currently in use. |
maximumChunksOverride | Sets the limit on the number of shader variant chunks Unity loads and keeps in memory. |
isSupported | Can this shader run on the end-users graphics card? (Read Only) |
keywordSpace | The local keyword space of this shader. |
maximumLOD | Shader LOD level for this shader. |
passCount | Returns the number of shader passes on the active SubShader. |
renderQueue | Render queue of this shader. (Read Only) |
subshaderCount | Returns the number of SubShaders in this shader. |
FindPassTagValue | Searches for the tag specified by tagName on the shader's active SubShader and returns the value of the tag. |
FindPropertyIndex | Finds the index of a shader property by its name. |
FindSubshaderTagValue | Searches for the tag specified by tagName on the SubShader specified by subshaderIndex and returns the value of the tag. |
FindTextureStack | Find the name of a texture stack a texture belongs too. |
GetDependency | Returns the dependency shader. |
GetPassCountInSubshader | Returns the number of passes in the given SubShader. |
GetPropertyAttributes | Returns an array of strings containing attributes of the shader property at the specified index. |
GetPropertyCount | Returns the number of properties in this Shader. |
GetPropertyDefaultFloatValue | Returns the default float value of the shader property at the specified index. |
GetPropertyDefaultIntValue | Returns the default int value of the shader property at the specified index. |
GetPropertyDefaultVectorValue | Returns the default Vector4 value of the shader property at the specified index. |
GetPropertyDescription | Returns the description string of the shader property at the specified index. |
GetPropertyFlags | Returns the ShaderPropertyFlags of the shader property at the specified index. |
GetPropertyName | Returns the name of the shader property at the specified index. |
GetPropertyNameId | Returns the nameId of the shader property at the specified index. |
GetPropertyRangeLimits | Returns the min and max limits for a Range property at the specified index. |
GetPropertyTextureDefaultName | Returns the default Texture name of a Texture shader property at the specified index. |
GetPropertyTextureDimension | Returns the TextureDimension of a Texture shader property at the specified index. |
GetPropertyType | Returns the ShaderPropertyType of the property at the specified index. |
DisableKeyword | Disables a global shader keyword. |
EnableKeyword | Enables a global shader keyword. |
Find | Finds a shader with the given name. Returns null if the shader is not found. |
GetGlobalColor | Gets a global color property for all shaders previously set using SetGlobalColor. |
GetGlobalFloat | Gets a global float property for all shaders previously set using SetGlobalFloat. |
GetGlobalFloatArray | Gets a global float array for all shaders previously set using SetGlobalFloatArray. |
GetGlobalInt | This method is deprecated. Use GetGlobalFloat or GetGlobalInteger instead. |
GetGlobalInteger | Gets a global integer property for all shaders previously set using SetGlobalInteger. |
GetGlobalMatrix | Gets a global matrix property for all shaders previously set using SetGlobalMatrix. |
GetGlobalMatrixArray | Gets a global matrix array for all shaders previously set using SetGlobalMatrixArray. |
GetGlobalTexture | Gets a global texture property for all shaders previously set using SetGlobalTexture. |
GetGlobalVector | Gets a global vector property for all shaders previously set using SetGlobalVector. |
GetGlobalVectorArray | Gets a global vector array for all shaders previously set using SetGlobalVectorArray. |
IsKeywordEnabled | Checks whether a global shader keyword is enabled. |
PropertyToID | Gets unique identifier for a shader property name. |
SetGlobalBuffer | Sets a global buffer property for all shaders. |
SetGlobalColor | Sets a global color property for all shaders. |
SetGlobalConstantBuffer | Sets a ComputeBuffer or GraphicsBuffer as a named constant buffer for all shader types. |
SetGlobalFloat | Sets a global float property for all shaders. |
SetGlobalFloatArray | Sets a global float array property for all shaders. |
SetGlobalInt | This method is deprecated. Use SetGlobalFloat or SetGlobalInteger instead. |
SetGlobalInteger | Sets a global integer property for all shaders. |
SetGlobalMatrix | Sets a global matrix property for all shaders. |
SetGlobalMatrixArray | Sets a global matrix array property for all shaders. |
SetGlobalRayTracingAccelerationStructure | Sets a global RayTracingAccelerationStructure property for all shaders. |
SetGlobalTexture | Sets a global texture property for all shaders. |
SetGlobalVector | Sets a global vector property for all shaders. |
SetGlobalVectorArray | Sets a global vector array property for all shaders. |
SetKeyword | Sets the state of a global shader keyword. |
WarmupAllShaders | Prewarms all shader variants of all Shaders currently in memory. |
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. |
FindAnyObjectByType | Retrieves any active loaded object of Type type. |
FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
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.