Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

RenderingLayerMask

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The Render Pipeline allows you to use Rendering Layers, which are LayerMasks to make Lights or effects only affect specific Renderers.

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 true or false. Each bitmask describes whether the RenderingLayer is used. As an example, bit 5 can be set to 1 (true).

Edit->Settings->Tags and Layers option shows the use of the 32 bitmasks. Each RenderingLayer is shown with a string setting. As an example Layer 0 is set as Default. There is always at least one defined RenderingLayer.

Static Properties

defaultRenderingLayerMaskReturns an instance of Default Rendering Layer Mask.

Properties

valueConverts a layer mask value to an integer value.

Static Methods

GetDefinedRenderingLayerCountReturns a number of Rendering Layers defined in the Tags and Layers manager.
GetDefinedRenderingLayerNamesReturns a names of the defined Rendering Layers in the Tags and Layers manager.
GetDefinedRenderingLayersCombinedMaskValueReturns value that represents all defined Rendering Layers in the Tags and Layers manager.
GetDefinedRenderingLayerValuesReturns a values of the defined Rendering Layers in the Tags and Layers manager.
GetLastDefinedRenderingLayerIndexReturns an index of the last defined Rendering Layer in the Tags and Layers manager.
GetMaskGiven a set of rendering layer names as defined in the Tags and Layers manager, returns the equivalent rendering layer mask for all of them.
GetRenderingLayerCountReturns a number of Rendering Layers defined in the Tags and Layers manager including empty ones.
NameToRenderingLayerGiven a rendering layer name, returns the rendering layer index as defined in the Tags and Layers manager.
RenderingLayerToNameGiven a rendering layer index, returns the name of the layer as defined in the Tags and Layers manager.

Operators

RenderingLayerMaskImplicitly converts uint to a RenderingLayerMask.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2005-2024 Unity Technologies. All rights reserved. Built from: 6000.0.2f1 (4402c6d9551f). Built on: 2024-05-04.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information