Version: 2022.3
Language : English
Targeting shader models and GPU features in HLSL
Declaring and using shader keywords in HLSL

Targeting graphics APIs and platforms in HLSL

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.

Including or excluding graphics APIs

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

Generating shader variants for graphics tiers for a given graphics API

In the Built-in Render PipelineA series of operations that take the contents of a Scene, and displays them on a screen. Unity lets you choose from pre-built render pipelines, or write your own. More info
See in Glossary
, 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

List of valid parameter values

Supported values are:

Value Description
d3d11 DirectX 11 feature level 10 and above, DirectX 12
glcore OpenGL 3.x, OpenGL 4.x
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
metal Metal on iOS or Mac
ps4 PlayStation®4
ps5 PlayStation®5
switch Nintendo Switch™
vulkan Vulkan
xboxone Xbox One and GameCore, DirectX 11 and DirectX 12
xboxseries Xbox Series S|X
Targeting shader models and GPU features in HLSL
Declaring and using shader keywords in HLSL
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961