Moved Permanently

The document has moved here .

  • Manual
  • Scripting API
  • unity3d.com
Version: 2018.2 (switch to 2018.3b or 2017.4 )
LanguageEnglish
  • English
  • C#

Scripting API

SortingLayer

struct in
UnityEngine

/

Implemented in: UnityEngine.CoreModule

Other Versions

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

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

layers Returns all the layers defined in this project.

Properties

id This 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.
name Returns the name of the layer as defined in the TagManager.
value This is the relative value that indicates the sort order of this layer relative to the other layers.

Static Methods

GetLayerValueFromID Returns 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.
GetLayerValueFromName Returns the final sorting layer value. See Also: GetLayerValueFromID.
IDToName Returns the unique id of the layer. Will return “<unknown layer>” if an invalid id is given.
IsValid Returns true if the id provided is a valid layer id.
NameToID Returns 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:

Thanks for rating this page!

Report a problem on this page

What kind of problem would you like to report?

  • This page needs code samples
  • Code samples do not work
  • Information is missing
  • Information is incorrect
  • Information is unclear or confusing
  • There is a spelling/grammar error on this page
  • Something else

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

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:

Thanks for helping to make the Unity documentation better!

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 © 2018 Unity Technologies. Publication: 2018.2-002M. Built: 2018-11-21.

Tutorials Community Answers Knowledge Base Forums Asset Store