struct in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseThe 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.
defaultRenderingLayerMask | Returns an instance of Default Rendering Layer Mask. |
value | Converts a layer mask value to an integer value. |
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. |
RenderingLayerMask | Implicitly converts uint to a RenderingLayerMask. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.