Version: 2019.2
LanguageEnglish
  • C#

ShaderUtil

class in UnityEditor

/

Implemented in:UnityEditor

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

Description

Utility functions to assist with working with shaders from the editor.

Static Properties

allowAsyncCompilationWhen true, asynchronous Shader compilation is allowed at the current call site.
anythingCompilingWhen true, the Editor is compiling some Shaders asynchronously at the point of query.
hardwareSupportsRectRenderTextureDoes the current hardware support render textues.

Static Methods

ClearCachedDataClears all internally-cached data that was generated for the given shader, such as errors and compilation info.
ClearShaderErrorsClears compile time messages for the given shader.
ClearShaderMessagesClear compile time messages for the given shader.
CompilePassRequest the Editor to compile the Shader Variant needed for the specific pass of the given Material.
GetAllShaderInfoReturns an array of ShaderInfo of all available shaders. That includes built-in shaders.
GetComputeShaderMessageCountReturns the number of errors and warnings generated by the Unity Shader Compiler for the given ComputeShader.
GetComputeShaderMessagesReturns each error and warning generated by the Unity Shader Compiler for the given ComputeShader.
GetPropertyCountGet the number of properties in Shader s.
GetPropertyDescriptionGet the description of the shader propery at index propertyIdx of Shader s.
GetPropertyNameGet the name of the shader propery at index propertyIdx of Shader s.
GetPropertyTypeGet the ShaderProperyType of the shader propery at index propertyIdx of Shader s.
GetRangeLimitsGet Limits for a range property at index propertyIdx of Shader s.
GetShaderDataGet the shader data for a specific shader.
GetShaderMessageCountReturns the number of errors and warnings generated by the Unity Shader Compiler for the given Shader.
GetShaderMessagesReturns each error and warning generated by the Unity Shader Compiler for the given Shader.
GetTexDimGets texture dimension of a shader property.
IsPassCompiledChecks if the Shader variant for the given pass in the Material has already been compiled.
IsShaderPropertyHiddenIs the shader propery at index propertyIdx of Shader s hidden?
IsShaderPropertyNonModifiableTexurePropertyIs the shader propery at index propertyIdx of Shader s a NonModifiableTextureProperty?
RegisterShaderRegister a user created shader.
RestoreAsyncCompilationRestores the previous Shader compilation mode in this CommandBuffer scope.
SetAsyncCompilationAdds shader compilation mode command in the CommandBuffer.
ShaderHasErrorReturns true if the given Shader generated any errors. Ignores warnings.
UpdateShaderAssetReplaces the existing source code in the specified shader with the source code in the supplied string. The override provides a boolean that specifies whether the shader should be recompiled.

Did you find this page useful? Please give it a rating: