Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine
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
A component for masking Sprites and Particles.
By default it will mask all Sorting Layers. A custom range of Sorting Layers can be set. If a SortingGroup is present, it will act local to the SortingGroup.
|The minimum alpha value used by the mask to select the area of influence defined over the mask's sprite.
|Unique ID of the sorting layer defining the end of the custom range.
|Order within the back sorting layer defining the end of the custom range.
|Unique ID of the sorting layer defining the start of the custom range.
|Order within the front sorting layer defining the start of the custom range.
|Mask sprites from front to back sorting values only.
|The Sprite used to define the mask.
|The game object this component is attached to. A component is always attached to a game object.
|The tag of this game object.
|The Transform attached to this GameObject.
|Should the object be hidden, saved with the scene or modifiable by the user?
|The name of the object.
|The bounding volume of the renderer (Read Only).
|Makes the rendered 3D object visible if enabled.
|Has this renderer been statically batched with any other renderers?
|Is this renderer visible in any camera? (Read Only)
|The index of the baked lightmap applied to this renderer.
|The UV scale & offset used for a lightmap.
|If set, the Renderer will use the Light Probe Proxy Volume component attached to the source GameObject.
|The light probe interpolation type.
|Matrix that transforms a point from local space into world space (Read Only).
|Returns the first instantiated Material assigned to the renderer.
|Returns all the instantiated materials of this object.
|Specifies the mode for motion vector rendering.
|If set, Renderer will use this Transform's position to find the light or reflection probe.
|The index of the realtime lightmap applied to this renderer.
|The UV scale & offset used for a realtime lightmap.
|Does this object receive shadows?
|Should reflection probes be used for this Renderer?
|Does this object cast shadows?
|The shared material of this object.
|All the shared materials of this object.
|Unique ID of the Renderer's sorting layer.
|Name of the Renderer's sorting layer.
|Renderer's order within a sorting layer.
|Matrix that transforms a point from world space into local space (Read Only).
|Calls the method named methodName on every MonoBehaviour in this game object or any of its children.
|Is this game object tagged with tag ?
|Returns the component of Type type if the game object has one attached, null if it doesn't.
|Returns the component of Type type in the GameObject or any of its children using depth first search.
|Returns the component of Type type in the GameObject or any of its parents.
|Returns all components of Type type in the GameObject.
|Returns all components of Type type in the GameObject or any of its children.
|Returns all components of Type type in the GameObject or any of its parents.
|Calls the method named methodName on every MonoBehaviour in this game object.
|Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
|Returns the instance id of the object.
|Returns the name of the game object.
|Returns an array of closest reflection probes with weights, weight shows how much influence the probe has on the renderer, this value is also used when blending between reflection probes occur.
|Get per-renderer material property block.
|Lets you add per-renderer material parameters without duplicating a material.
|Removes a gameobject, component or asset.
|Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
|Makes the object target not be destroyed automatically when loading a new scene.
|Returns the first active loaded object of Type type.
|Returns a list of all active loaded objects of Type type.
|Clones the object original and returns the clone.
|Does the object exist?
|Compares if two objects refer to a different object.
|Compares two object references to see if they refer to the same object.
Did you find this page useful? Please give it a rating: