In the Unity Editor, when you view a material in the material Inspector, you can enable and disable its local shader keywords. This is useful for two reasons:
[KeywordEnum]
MaterialPropertyDrawer, Unity automatically disables the other keywords in a set. This ensures that exactly one keyword from a set is enabled at any time.As with any shader settings or data, shader keywords are only available in the material Inspector when they are declared as material properties in the shader source file.
For shaders created in Shader Graph, keywords are material properties by default. This means that these settings are automatically available in the material Inspector. To change this, open the Blackboard, and change the Exposed property.
For hand-coded shaders, you must ensure that your ShaderLab code defines a material property that represents the keyword set. The material property must have a type of Float
, and must use the [Toggle]
, [ToggleOff]
, or [KeywordEnum]
MaterialPropertyDrawer attribute to expose it correctly to the Inspector.
Shader "Custom/ApplyEffectIfKeywordIsOn"
{
Properties
{
// Display a toggle in the Material's Inspector window
[Toggle] _Keyword ("Keyword", Float) = 0.0
}
SubShader
{
Pass
{
#pragma shader_feature _Keyword
fixed4 frag(v2f i) : SV_Target
{
#if _Keyword
// If _Keyword is on at build time, Unity creates a shader variant that uses the following code
ApplyEffect();
#endif
// rest of shader code...
}
}
}
}
For more information and examples, see the documentation for the MaterialPropertyDrawer API.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.