Version: 2021.3
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

ShaderWarmup.WarmupShader

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

Declaration

public static void WarmupShader(Shader shader, Experimental.Rendering.ShaderWarmupSetup setup);

Description

Prewarms all shader variants for a given Shader, using a given rendering configuration.

For information on shader loading and prewarming, including a list of different prewarming techniques, see Shader loading.

On modern graphics APIs, such as DX12, Metal, and Vulkan, the graphics driver uses the vertex data layout when it creates shader progams. This method allows you to specify the vertex data layout, and therefore correctly prewarm shader variants for these graphics APIs.

Additional resources: ShaderWarmup.WarmupShaderFromCollection, Shader.WarmupAllShaders, ShaderVariantCollection.WarmUp