RenderingLayerMask
The Render Pipeline allows you to use Rendering Layers, which are LayerMasks to make Lights or effects only affect specific Renderers.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
public struct RenderingLayerMask
Remarks
Rendering Layers are also supported on decal projectors, and can be sampled from the ShaderGraph to implement custom effects.
Rendering Layers are a Bitmask and it represents the 32 Layers and define them as or . Each bitmask describes whether the is used. As an example, bit 5 can be set to 1 ().
truefalseRenderingLayertrueEdit->Settings->Tags and LayersRenderingLayerLayer 0DefaultProperties
Property | Description |
|---|---|
| value | Converts a layer mask value to an integer value. |
Static Properties
Property | Description |
|---|---|
| defaultRenderingLayerMask | Returns an instance of Default Rendering Layer Mask. |
Static Methods
Method | Description |
|---|---|
| GetDefinedRenderingLayerCount | Returns a number of Rendering Layers defined in the Tags and Layers manager. |
| GetDefinedRenderingLayerNames | Returns a names of the defined Rendering Layers in the Tags and Layers manager. |
| GetDefinedRenderingLayersCombinedMaskValue | Returns value that represents all defined Rendering Layers in the Tags and Layers manager. |
| GetDefinedRenderingLayerValues | Returns a values of the defined Rendering Layers in the Tags and Layers manager. |
| GetLastDefinedRenderingLayerIndex | Returns an index of the last defined Rendering Layer in the Tags and Layers manager. |
| GetMask | Given a set of rendering layer names as defined in the Tags and Layers manager, returns the equivalent rendering layer mask for all of them. |
| GetRenderingLayerCount | Returns a number of Rendering Layers defined in the Tags and Layers manager including empty ones. |
| NameToRenderingLayer | Given a rendering layer name, returns the rendering layer index as defined in the Tags and Layers manager. |
| RenderingLayerToName | Given a rendering layer index, returns the name of the layer as defined in the Tags and Layers manager. |
Operators
Operator | Description |
|---|---|
| RenderingLayerMask | Implicitly converts |
| uint | Implicitly converts a RenderingLayerMask to an |