Version: 2018.1 (switch to 2018.2b or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SortingLayer

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

SortingLayer allows you to set the render order of multiple sprites easily. There is always a default SortingLayer named "Default" which all sprites are added to initially. Added more SortingLayers to easily control the order of rendering of groups of sprites. Layers can be ordered before or after the default layer.

See Also: Tags and Layers.

Static Properties

layersReturns all the layers defined in this project.

Properties

idThis is the unique id assigned to the layer. It is not an ordered running value and it should not be used to compare with other layers to determine the sorting order.
nameReturns the name of the layer as defined in the TagManager.
valueThis is the relative value that indicates the sort order of this layer relative to the other layers.

Static Methods

GetLayerValueFromIDReturns the final sorting layer value. To determine the sorting order between the various sorting layers, use this method to retrieve the final sorting value and use CompareTo to determine the order.
GetLayerValueFromNameReturns the final sorting layer value. See Also: GetLayerValueFromID.
IDToNameReturns the unique id of the layer. Will return "<unknown layer>" if an invalid id is given.
IsValidReturns true if the id provided is a valid layer id.
NameToIDReturns the id given the name. Will return 0 if an invalid name was given.

Did you find this page useful? Please give it a rating: