To mark parts of your shaderA program that runs on the GPU. More info
See in Glossary code conditional based on whether you enable or disable a shader keyword in a set, use an HLSL if statement.
For example:
#pragma multi_compile QUALITY_LOW QUALITY_MED QUALITY_HIGH if (QUALITY_LOW) { // code for low quality setting }
You can enable and disable keywords using the Inspector or C# scripting.
What Unity does with your shader code depends on which shader directive you use.
If you use dynamic_branch
, Unity creates a uniform integer variable for each keyword. When you enable a keyword, Unity sets the integer for that variable to 1
, and your GPU switches to using the code in the if
statement for that keyword. This is dynamic branching.
If you use shader_feature
or multi_compile
, Unity creates separate shader variantsA verion of a shader program that Unity generates according to a specific combination of shader keywords and their status. A Shader object can contain multiple shader variants. More info
See in Glossary for each keyword state. Each variant contains the code from an if
branch for that keyword. When you enable a keyword, Unity sends the matching variant to your GPU. This is static branching.
Refer to Conditionals in shaders for more information about when to use which shader directive.
For each keyword in a set, Unity automatically adds a _KEYWORD_DECLARED
keyword. For example, if you declare a QUALITY_LOW
keyword, Unity adds a QUALITY_LOW_KEYWORD_DECLARED
keyword.
You can use this to check if a keyword exists, regardless of whether it’s enabled or disabled.
For example:
#pragma multi_compile QUALITY_LOW QUALITY_MED QUALITY_HIGH #if defined(QUALITY_LOW_KEYWORD_DECLARED) { // The QUALITY_LOW keyword exists }
To execute code when all keywords in a set are disabled, Unity must create an additional shader variant or uniform integer for that state.
If you use shader_feature
or dynamic_branch
to create a single keyword, Unity automatically creates an additional variant or uniform integer. For example:
// Creates a variant for when FEATURE_1_ON is enabled, and another for when FEATURE_1_ON is disabled. #pragma shader_feature FEATURE_1_ON // Creates a uniform integer for when FEATURE_2_ON is enabled, and another for when FEATURE_2_ON is disabled. #pragma dynamic_branch FEATURE_2_ON
If you use shader_feature
or dynamic_branch
to create a set of two or more keywords, or you use multi_compile
, add _
when you declare a keyword set so that Unity creates an additional variant or uniform integer. For example:
// Creates 5 shader variants, including one for when RED, GREEN, BLUE, and WHITE are all disabled. #pragma shader_feature _ RED GREEN BLUE WHITE // Creates 2 shader variants, including one for when FEATURE_3_ON is disabled. #pragma multi_compile _ FEATURE_3_ON // Creates 4 uniform integers, including one for when QUALITY_LOW, QUALITY_MED, and QUALITY_HIGH are all disabled. #pragma dynamic_branch _ QUALITY_LOW QUALITY_MED QUALITY_HIGH
You can also use the following HLSL pre-processor directives to create conditional code:
Using these instead of if
makes it more difficult to change the #pragma
keyword directive later. For example, if you need to reduce the number of shader variants, it’s more difficult to change to dynamic_branch
.
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.