Represents one or several GPU shader stages.
This enum is used in various APIs that allow specifying multiple GPU shader stages simultaneuously. APIs that need to specify individual shader stages use the ShaderStage enum instead.
The traditional graphics shader stages used in rasterization are represented by the following enum values:
The compute shader stage and the ray tracing shader stage are represented as ShaderStageFlags.Compute and ShaderStageFlags.RayTracing, respectively.
In addition to that, the following enum values can be used for convenient representation of common shader stage combinations:
Use Utility.IsShaderStageEnabled to check if the ShaderStageFlags value has the given stage enabled. Utility.ShaderStageToFlags can be used to convert an individual shader stage to ShaderStageFlags.
Additional resources: ShaderStage, Utility.
using UnityEngine;
using UnityEngine.Shaders;
/*
Attach this script to a GameObject and enter Play mode. "Shader stages: Basic, Tessellation" will be printed in the console.
*/
public class ShaderTypes : MonoBehaviour
{
void Start()
{
ShaderStageFlags stages = (ShaderStageFlags.Graphics & (~ShaderStageFlags.Geometry));
// Iterate over all possible shader stages and check if the only stages enabled are Vertex, Fragment, Hull, and Domain
// Log a message if a stage is enabled or disabled incorrectly.
for (ShaderStage stage = ShaderStage.FirstStage; stage < ShaderStage.Count; ++stage)
{
bool shouldBeEnabled = stage < ShaderStage.GraphicsStageCount && stage != ShaderStage.Geometry;
if (Utility.IsShaderStageEnabled(stages, stage) != shouldBeEnabled)
Debug.Log("Unexpected stage " + stage + (shouldBeEnabled ? " not enabled" : " enabled"));
}
Debug.Log("Shader stages: " + stages);
}
}
| Property | Description |
|---|---|
| None | Specifies that no shader stages are enabled. |
| Vertex | Specifies that vertex shader stage is enabled. |
| Fragment | Specifies that fragment shader stage is enabled. |
| Hull | Specifies that hull shader stage is enabled. |
| Domain | Specifies that domain shader stage is enabled. |
| Geometry | Specifies that geometry shader stage is enabled. |
| Compute | Specifies that compute shader stage is enabled. |
| RayTracing | Specifies that ray tracing shader stage is enabled. |
| Basic | Specifies that vertex and fragment shader stages are enabled. |
| Tessellation | Specifies that hull and domain shader stages are enabled. |
| Graphics | Specifies that vertex, fragment, geometry, hull, and domain shader stages are enabled. |
| Any | Specifies that all shader stages are enabled. |