Version: 2022.3
LanguageEnglish
  • C#

ShaderVariantCollection.WarmUpProgressively

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 bool WarmUpProgressively(int variantCount);

Parameters

variantCount The maximum number of variants to warm up.

Returns

bool True if all variants in this shader variant collection have been warmed up, false otherwise.

Description

Prewarms the given number of shader variants in this shader variant collection.

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

Warning: This method is fully supported on DX11 and OpenGL. On DX12, Vulkan, and Metal, the graphics driver might still perform work if the vertex layout or the render target setup is different from the data used to prewarm it. This can result in wasted work and GPU memory, and leave visible stalls in your application. ShaderWarmup is supported on all graphics APIs.

Additional resources: ShaderWarmup, Shader.WarmupAllShaders, Shader loading