Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

GraphicsStateCollection.RemoveVariant

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 Boolean RemoveVariant(Shader shader, UnityEngine.Rendering.PassIdentifier passId, UnityEngine.Rendering.LocalKeyword[] keywords);

Declaration

public Boolean RemoveVariant(Material mat, UnityEngine.Rendering.PassIdentifier passId);

Parameters

Parameter Description
shader Shader used in the variant.
passId PassIdentifier used in the variant.
keywords Array of keywords used in the variant.
material Material with the shader and enabled keywords used in the variant.

Returns

Boolean True if successfully removed, false otherwise.

Description

Remove ShaderVariant and associated graphics states from collection.

If only the material is provided, then this function will only remove a shader variant matching exactly the set of Material.enabledKeywords combined with the global shader keywords that are currently enabled in the active context. Additional resources: RemoveGraphicsStatesForVariant, ContainsVariant.