Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine.Rendering
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
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
Adding a SortingGroup component to a GameObject will ensure that all Renderers within the GameObject's descendants will be sorted and rendered together.
A common use case for having a SortingGroup is to create complex 2D characters that are made up of multiple SpriteRenderers. When several clones of such a character overlap, their individual body parts might not be sorted properly resulting in a visual glitch where the the body parts interleave. For example, the hands of two characters might be sorted in front of their bodies, where you would expect one entire character to be drawn in front of the other character. The SortingGroup component solves this by ensuring the entire branch of the character are sorted and rendered together.
The descendants of the SortingGroup are sorted using the same SortingLayer and Renderer.sortingOrder. However, they are only sorted against other descendants of the SortingGroup and not with any renderers outside of it. This allows you to reuse the same SortingLayers (for example, "Hands", "Torso"...) to sort body parts while ensuring they never interleave with other clones of the character.
The SortingGroups, together with other renderers, are sorted using the SortingLayer and Renderer.sortingOrder. Additionally, they can be nested within other SortingGroups. This is useful if you have branches of descendants that should not be mixed up i.e. the "Left Hand" vs the "Right Hand" hierarchy branches.
|sortingLayerID||Unique ID of the Renderer's sorting layer.|
|sortingLayerName||Name of the Renderer's sorting layer.|
|sortingOrder||Renderer's order within a sorting layer.|
|enabled||Enabled Behaviours are Updated, disabled Behaviours are not.|
|isActiveAndEnabled||Has the Behaviour had enabled called.|
|gameObject||The game object this component is attached to. A component is always attached to a game object.|
|tag||The tag of this game object.|
|transform||The Transform attached to this GameObject.|
|hideFlags||Should the object be hidden, saved with the scene or modifiable by the user?|
|name||The name of the object.|
|BroadcastMessage||Calls the method named methodName on every MonoBehaviour in this game object or any of its children.|
|CompareTag||Is this game object tagged with tag ?|
|GetComponent||Returns the component of Type type if the game object has one attached, null if it doesn't.|
|GetComponentInChildren||Returns the component of Type type in the GameObject or any of its children using depth first search.|
|GetComponentInParent||Returns the component of Type type in the GameObject or any of its parents.|
|GetComponents||Returns all components of Type type in the GameObject.|
|GetComponentsInChildren||Returns all components of Type type in the GameObject or any of its children.|
|GetComponentsInParent||Returns all components of Type type in the GameObject or any of its parents.|
|SendMessage||Calls the method named methodName on every MonoBehaviour in this game object.|
|SendMessageUpwards||Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.|
|GetInstanceID||Returns the instance id of the object.|
|ToString||Returns the name of the GameObject.|
|Destroy||Removes a gameobject, component or asset.|
|DestroyImmediate||Destroys the object obj immediately. You are strongly recommended to use Destroy instead.|
|DontDestroyOnLoad||Makes the object target not be destroyed automatically when loading a new scene.|
|FindObjectOfType||Returns the first active loaded object of Type type.|
|FindObjectsOfType||Returns a list of all active loaded objects of Type type.|
|Instantiate||Clones the object original and returns the clone.|
Did you find this page useful? Please give it a rating: