Version: 2022.3
LanguageEnglish
  • C#

Shader

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

Shader 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.

Static Properties

enabledGlobalKeywordsAn array containing the global shader keywords that are currently enabled.
globalKeywordsAn array containing the global shader keywords that currently exist. This includes enabled and disabled global shader keywords.
globalMaximumLODShader LOD level for all shaders.
globalRenderPipelineRender pipeline currently in use.
maximumChunksOverrideSets the limit on the number of shader variant chunks Unity loads and keeps in memory.

Properties

isSupportedCan this shader run on the end-users graphics card? (Read Only)
keywordSpaceThe local keyword space of this shader.
maximumLODShader LOD level for this shader.
passCountReturns the number of shader passes on the active SubShader.
renderQueueRender queue of this shader. (Read Only)
subshaderCountReturns the number of SubShaders in this shader.

Public Methods

FindPassTagValueSearches for the tag specified by tagName on the shader's active SubShader and returns the value of the tag.
FindPropertyIndexFinds the index of a shader property by its name.
FindSubshaderTagValueSearches for the tag specified by tagName on the SubShader specified by subshaderIndex and returns the value of the tag.
FindTextureStackFind the name of a texture stack a texture belongs too.
GetDependencyReturns the dependency shader.
GetPassCountInSubshaderReturns the number of passes in the given SubShader.
GetPropertyAttributesReturns an array of strings containing attributes of the shader property at the specified index.
GetPropertyCountReturns the number of properties in this Shader.
GetPropertyDefaultFloatValueReturns the default float value of the shader property at the specified index.
GetPropertyDefaultIntValueReturns the default int value of the shader property at the specified index.
GetPropertyDefaultVectorValueReturns the default Vector4 value of the shader property at the specified index.
GetPropertyDescriptionReturns the description string of the shader property at the specified index.
GetPropertyFlagsReturns the ShaderPropertyFlags of the shader property at the specified index.
GetPropertyNameReturns the name of the shader property at the specified index.
GetPropertyNameIdReturns the nameId of the shader property at the specified index.
GetPropertyRangeLimitsReturns the min and max limits for a Range property at the specified index.
GetPropertyTextureDefaultNameReturns the default Texture name of a Texture shader property at the specified index.
GetPropertyTextureDimensionReturns the TextureDimension of a Texture shader property at the specified index.
GetPropertyTypeReturns the ShaderPropertyType of the property at the specified index.

Static Methods

DisableKeywordDisables a global shader keyword.
EnableKeywordEnables a global shader keyword.
FindFinds a shader with the given name. Returns null if the shader is not found.
GetGlobalColorGets a global color property for all shaders previously set using SetGlobalColor.
GetGlobalFloatGets a global float property for all shaders previously set using SetGlobalFloat.
GetGlobalFloatArrayGets a global float array for all shaders previously set using SetGlobalFloatArray.
GetGlobalIntThis method is deprecated. Use GetGlobalFloat or GetGlobalInteger instead.
GetGlobalIntegerGets a global integer property for all shaders previously set using SetGlobalInteger.
GetGlobalMatrixGets a global matrix property for all shaders previously set using SetGlobalMatrix.
GetGlobalMatrixArrayGets a global matrix array for all shaders previously set using SetGlobalMatrixArray.
GetGlobalTextureGets a global texture property for all shaders previously set using SetGlobalTexture.
GetGlobalVectorGets a global vector property for all shaders previously set using SetGlobalVector.
GetGlobalVectorArrayGets a global vector array for all shaders previously set using SetGlobalVectorArray.
IsKeywordEnabledChecks whether a global shader keyword is enabled.
PropertyToIDGets unique identifier for a shader property name.
SetGlobalBufferSets a global buffer property for all shaders.
SetGlobalColorSets a global color property for all shaders.
SetGlobalConstantBufferSets a ComputeBuffer or GraphicsBuffer as a named constant buffer for all shader types.
SetGlobalFloatSets a global float property for all shaders.
SetGlobalFloatArraySets a global float array property for all shaders.
SetGlobalIntThis method is deprecated. Use SetGlobalFloat or SetGlobalInteger instead.
SetGlobalIntegerSets a global integer property for all shaders.
SetGlobalMatrixSets a global matrix property for all shaders.
SetGlobalMatrixArraySets a global matrix array property for all shaders.
SetGlobalTextureSets a global texture property for all shaders.
SetGlobalVectorSets a global vector property for all shaders.
SetGlobalVectorArraySets a global vector array property for all shaders.
SetKeywordSets the state of a global shader keyword.
WarmupAllShadersPrewarms all shader variants of all Shaders currently in memory.

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.