Some #pragma
directives take parameters that allow you to target specific graphics APIs and platforms. This page contains information on using those directives, and provides a list of valid parameter values.
By default, Unity compiles all shaderA program that runs on the GPU. More info
See in Glossary programs for each graphics API in the list for the current build target. Sometimes, you might want to compile certain shader programs only for certain graphics APIs; for example, if you use features that are not supported on all platforms.
To compile a shader program only for given APIs, use the #pragma only_renderers
directive. You can pass multiple values, space delimited.
This example demonstrates how to compile shaders only for Metal and Vulkan:
#pragma only_renderers metal vulkan
To exclude shader code from compilation by given compilers, use the #pragma exclude_renderers
directive. You can pass multiple values, space delimited.
This example demonstrates how to exclude a shader from compilation for Metal and Vulkan:
#pragma exclude_renderers metal vulkan
In the Built-in Render Pipeline, Unity automatically generates 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 that correspond to graphics tiers under certain conditions. You can also force Unity to generate these variants, if required.
To do this, use the #pragma hardware_tier_variants
preprocessor directive and specify the graphics APIs for which you want to generate tier shader variants.
For example, this instructs Unity to compile tier shader variants for Metal:
#pragma hardware_tier_variants metal
Supported values are:
Value | Description |
---|---|
d3d11 |
DirectX 11 feature level 10 and above, DirectX 12 |
gles |
OpenGL ES 2.0, WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity WebGL build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info See in Glossary 1.0 |
gles3 |
OpenGL ES 3.x, WebGL 2.0 |
ps4 |
PlayStation 4 |
xboxone |
Xbox One and GameCore, DirectX 11 and DirectX 12 |
metal |
iOSApple’s mobile operating system. More info See in Glossary/Mac Metal |
glcore |
OpenGL 3.x, OpenGL 4.x |
vulkan |
Vulkan |
switch |
Nintendo Switch |
ps5 |
PlayStation 5 |