In HLSL, you can use the following types of preprocessor directive to provide information to the shaderA program that runs on the GPU. More info
See in Glossary compiler:
#pragma
#define_for_platform_compiler
#pragma
directives provide additional information to the shader compiler that isn’t covered by other types of preprocessor directive.
You can put #pragma
directives anywhere in your HLSL code, but it is a common convention to put them at the start, like this:
#pragma target 3.0
#pragma exclude_renderers vulkan
#pragma vertex vert
#pragma fragment frag
// The rest of your HLSL code goes here
There are some limitations around the use of #pragma
directives:
#pragma
directives inside conditional (#if
) directives if the expression depends only on:
#define
directives in your own codeSHADER_API_MOBILE
, SHADER_API_DESKTOP
, UNITY_NO_RGBM
, UNITY_USE_NATIVE_HDR
, UNITY_FRAMEBUFFER_FETCH_AVAILABLE
, UNITY_NO_CUBEMAP_ARRAY
UNITY_VERSION
macro#pragma
directives in .shader
files, and in files that you include with the #include_with_pragmas
directive. Unity does not support them in files that you include with the #include
directive; the compiler ignores them.#pragma
directives in files that you include with the #include
directive. Unity does not support them in .shader
files, or in files that you include with an #include_with_pragmas
directive; the compiler ignores them.
Note: If a shader file uses #include
to import a file that contains an #include_with_pragmas
directive, Unity ignores the #pragma
directives in the file the #include_with_pragmas
directive references.
Use a #define_for_platform_compiler
directive in your shader code to send a #define
directive to the shader compiler.
For example, #define_for_platform_compiler EXAMPLE_SYMBOL
sends a #define EXAMPLE_SYMBOL
directive to the shader compiler that defines a symbol called EXAMPLE_SYMBOL
. Refer to external shader compiler documentation, for example Microsoft’s documentation on the FXC compiler, for more information about symbols that shader compilers use.
The Unity preprocessor doesn’t use symbols you define with #define_for_platform_compiler
, so you can’t use the symbols in your own shader code. For example, in the above example, if you add shader code inside an #if (EXAMPLE_SYMBOL)
statement, the code won’t run.
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.