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

SortingLayer.GetLayerValueFromID

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

Declaration

public static int GetLayerValueFromID(int id);

Parameters

id The unique value of the sorting layer as returned by any renderer's sortingLayerID property.

Returns

int The final sorting value of the layer relative to other layers.

Description

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.

using UnityEngine;

public class ExampleClass : MonoBehaviour { int CompareLayer(GameObject rhs, GameObject lhs) { int rval = SortingLayer.GetLayerValueFromID(rhs.GetComponent<SpriteRenderer>().sortingLayerID); int lval = SortingLayer.GetLayerValueFromID(lhs.GetComponent<SpriteRenderer>().sortingLayerID); return rval.CompareTo(lval); } }

Additional resources: GetLayerValueFromName.