# SpriteMask

> A component for masking Sprites and Particles.

## Definition

* **Type:** Class
* **Namespace:** [UnityEngine](/engine/6000.0/script-reference/unityengine.md)
* **Assembly:** UnityEngine.SpriteMaskModule
* **Inherits from:** [Renderer](/engine/6000.0/script-reference/unityengine/renderer.md)

```csharp
public sealed class SpriteMask : Renderer
```

## Remarks

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.

## Properties

| Property                                                                                             | Description                                                                                                                                                                                  |
| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [alphaCutoff](/engine/6000.0/script-reference/unityengine/spritemask/alphacutoff.md)                 | The minimum alpha value used by the mask to select the area of influence defined over the mask's sprite.                                                                                     |
| [backSortingLayerID](/engine/6000.0/script-reference/unityengine/spritemask/backsortinglayerid.md)   | Unique ID of the sorting layer defining the end of the custom range.                                                                                                                         |
| [backSortingOrder](/engine/6000.0/script-reference/unityengine/spritemask/backsortingorder.md)       | Order within the back sorting layer defining the end of the custom range.                                                                                                                    |
| [frontSortingLayerID](/engine/6000.0/script-reference/unityengine/spritemask/frontsortinglayerid.md) | Unique ID of the sorting layer defining the start of the custom range.                                                                                                                       |
| [frontSortingOrder](/engine/6000.0/script-reference/unityengine/spritemask/frontsortingorder.md)     | Order within the front sorting layer defining the start of the custom range.                                                                                                                 |
| [isCustomRangeActive](/engine/6000.0/script-reference/unityengine/spritemask/iscustomrangeactive.md) | Mask sprites from front to back sorting values only.                                                                                                                                         |
| [maskSource](/engine/6000.0/script-reference/unityengine/spritemask/masksource-1.md)                 | The source used for generating the mask for this [SpriteMask](/engine/6000.0/script-reference/unityengine/spritemask.md).                                                                    |
| [sprite](/engine/6000.0/script-reference/unityengine/spritemask/sprite.md)                           | The Sprite used to define the mask.                                                                                                                                                          |
| [spriteSortPoint](/engine/6000.0/script-reference/unityengine/spritemask/spritesortpoint.md)         | Determines the position of the [Sprite](/engine/6000.0/script-reference/unityengine/sprite.md) used for sorting the [SpriteMask](/engine/6000.0/script-reference/unityengine/spritemask.md). |

## Enums

| Enum                                                                                          | Description                                        |
| --------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| [SpriteMask.MaskSource](/engine/6000.0/script-reference/unityengine/spritemask/masksource.md) | Sets which source to use when generating the mask. |

## Inheritance

**Inherited Members:**

* [Renderer.ResetBounds()](/engine/6000.0/script-reference/unityengine/renderer/resetbounds.md)
* [Renderer.ResetLocalBounds()](/engine/6000.0/script-reference/unityengine/renderer/resetlocalbounds.md)
* [Renderer.HasPropertyBlock()](/engine/6000.0/script-reference/unityengine/renderer/haspropertyblock.md)
* [Renderer.SetPropertyBlock(MaterialPropertyBlock)](/engine/6000.0/script-reference/unityengine/renderer/setpropertyblock.md#setpropertyblock\(materialpropertyblock\))
* [Renderer.SetPropertyBlock(MaterialPropertyBlock, int)](/engine/6000.0/script-reference/unityengine/renderer/setpropertyblock.md#setpropertyblock\(materialpropertyblock-int\))
* [Renderer.GetPropertyBlock(MaterialPropertyBlock)](/engine/6000.0/script-reference/unityengine/renderer/getpropertyblock.md#getpropertyblock\(materialpropertyblock\))
* [Renderer.GetPropertyBlock(MaterialPropertyBlock, int)](/engine/6000.0/script-reference/unityengine/renderer/getpropertyblock.md#getpropertyblock\(materialpropertyblock-int\))
* [Renderer.GetMaterials(List\<Material>)](/engine/6000.0/script-reference/unityengine/renderer/getmaterials.md)
* [Renderer.SetSharedMaterials(List\<Material>)](/engine/6000.0/script-reference/unityengine/renderer/setsharedmaterials.md)
* [Renderer.SetMaterials(List\<Material>)](/engine/6000.0/script-reference/unityengine/renderer/setmaterials.md)
* [Renderer.GetSharedMaterials(List\<Material>)](/engine/6000.0/script-reference/unityengine/renderer/getsharedmaterials.md)
* [Renderer.GetClosestReflectionProbes(List\<ReflectionProbeBlendInfo>)](/engine/6000.0/script-reference/unityengine/renderer/getclosestreflectionprobes.md)
* [Renderer.bounds](/engine/6000.0/script-reference/unityengine/renderer/bounds.md)
* [Renderer.localBounds](/engine/6000.0/script-reference/unityengine/renderer/localbounds.md)
* [Renderer.enabled](/engine/6000.0/script-reference/unityengine/renderer/enabled.md)
* [Renderer.isVisible](/engine/6000.0/script-reference/unityengine/renderer/isvisible.md)
* [Renderer.shadowCastingMode](/engine/6000.0/script-reference/unityengine/renderer/shadowcastingmode.md)
* [Renderer.receiveShadows](/engine/6000.0/script-reference/unityengine/renderer/receiveshadows.md)
* [Renderer.forceRenderingOff](/engine/6000.0/script-reference/unityengine/renderer/forcerenderingoff.md)
* [Renderer.staticShadowCaster](/engine/6000.0/script-reference/unityengine/renderer/staticshadowcaster.md)
* [Renderer.motionVectorGenerationMode](/engine/6000.0/script-reference/unityengine/renderer/motionvectorgenerationmode.md)
* [Renderer.lightProbeUsage](/engine/6000.0/script-reference/unityengine/renderer/lightprobeusage.md)
* [Renderer.reflectionProbeUsage](/engine/6000.0/script-reference/unityengine/renderer/reflectionprobeusage.md)
* [Renderer.renderingLayerMask](/engine/6000.0/script-reference/unityengine/renderer/renderinglayermask.md)
* [Renderer.rendererPriority](/engine/6000.0/script-reference/unityengine/renderer/rendererpriority.md)
* [Renderer.rayTracingMode](/engine/6000.0/script-reference/unityengine/renderer/raytracingmode.md)
* [Renderer.rayTracingAccelerationStructureBuildFlags](/engine/6000.0/script-reference/unityengine/renderer/raytracingaccelerationstructurebuildflags.md)
* [Renderer.rayTracingAccelerationStructureBuildFlagsOverride](/engine/6000.0/script-reference/unityengine/renderer/raytracingaccelerationstructurebuildflagsoverride.md)
* [Renderer.sortingLayerName](/engine/6000.0/script-reference/unityengine/renderer/sortinglayername.md)
* [Renderer.sortingLayerID](/engine/6000.0/script-reference/unityengine/renderer/sortinglayerid.md)
* [Renderer.sortingOrder](/engine/6000.0/script-reference/unityengine/renderer/sortingorder.md)
* [Renderer.isLOD0](/engine/6000.0/script-reference/unityengine/renderer/islod0.md)
* [Renderer.allowOcclusionWhenDynamic](/engine/6000.0/script-reference/unityengine/renderer/allowocclusionwhendynamic.md)
* [Renderer.isPartOfStaticBatch](/engine/6000.0/script-reference/unityengine/renderer/ispartofstaticbatch.md)
* [Renderer.worldToLocalMatrix](/engine/6000.0/script-reference/unityengine/renderer/worldtolocalmatrix.md)
* [Renderer.localToWorldMatrix](/engine/6000.0/script-reference/unityengine/renderer/localtoworldmatrix.md)
* [Renderer.lightProbeProxyVolumeOverride](/engine/6000.0/script-reference/unityengine/renderer/lightprobeproxyvolumeoverride.md)
* [Renderer.probeAnchor](/engine/6000.0/script-reference/unityengine/renderer/probeanchor.md)
* [Renderer.lightmapIndex](/engine/6000.0/script-reference/unityengine/renderer/lightmapindex.md)
* [Renderer.realtimeLightmapIndex](/engine/6000.0/script-reference/unityengine/renderer/realtimelightmapindex.md)
* [Renderer.lightmapScaleOffset](/engine/6000.0/script-reference/unityengine/renderer/lightmapscaleoffset.md)
* [Renderer.realtimeLightmapScaleOffset](/engine/6000.0/script-reference/unityengine/renderer/realtimelightmapscaleoffset.md)
* [Renderer.materials](/engine/6000.0/script-reference/unityengine/renderer/materials.md)
* [Renderer.material](/engine/6000.0/script-reference/unityengine/renderer/material.md)
* [Renderer.sharedMaterial](/engine/6000.0/script-reference/unityengine/renderer/sharedmaterial.md)
* [Renderer.sharedMaterials](/engine/6000.0/script-reference/unityengine/renderer/sharedmaterials.md)
* [Renderer.LODGroup()](/engine/6000.0/script-reference/unityengine/renderer/lodgroup.md)
* [Component.GetComponent(Type)](/engine/6000.0/script-reference/unityengine/component/getcomponent.md#getcomponent\(type\))
* [Component.GetComponent\<T>()](/engine/6000.0/script-reference/unityengine/component/getcomponent.md)
* [Component.TryGetComponent(Type, Component)](/engine/6000.0/script-reference/unityengine/component/trygetcomponent.md)
* [Component.TryGetComponent\<T>(T)](/engine/6000.0/script-reference/unityengine/component/trygetcomponent.md)
* [Component.GetComponent(string)](/engine/6000.0/script-reference/unityengine/component/getcomponent.md#getcomponent\(string\))
* [Component.GetComponentInChildren(Type, bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentinchildren.md#getcomponentinchildren\(type-bool\))
* [Component.GetComponentInChildren(Type)](/engine/6000.0/script-reference/unityengine/component/getcomponentinchildren.md#getcomponentinchildren\(type\))
* [Component.GetComponentInChildren\<T>(bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentinchildren.md)
* [Component.GetComponentsInChildren(Type, bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinchildren.md)
* [Component.GetComponentsInChildren\<T>(bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinchildren.md#getcomponentsinchildrent\(bool\))
* [Component.GetComponentsInChildren\<T>(bool, List\<T>)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinchildren.md)
* [Component.GetComponentsInChildren\<T>()](/engine/6000.0/script-reference/unityengine/component/getcomponentsinchildren.md#getcomponentsinchildrent\(\))
* [Component.GetComponentsInChildren\<T>(List\<T>)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinchildren.md)
* [Component.GetComponentInParent(Type, bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentinparent.md#getcomponentinparent\(type-bool\))
* [Component.GetComponentInParent(Type)](/engine/6000.0/script-reference/unityengine/component/getcomponentinparent.md#getcomponentinparent\(type\))
* [Component.GetComponentInParent\<T>(bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentinparent.md#getcomponentinparentt\(bool\))
* [Component.GetComponentInParent\<T>()](/engine/6000.0/script-reference/unityengine/component/getcomponentinparent.md#getcomponentinparentt\(\))
* [Component.GetComponentsInParent(Type, bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinparent.md)
* [Component.GetComponentsInParent\<T>(bool)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinparent.md#getcomponentsinparentt\(bool\))
* [Component.GetComponentsInParent\<T>(bool, List\<T>)](/engine/6000.0/script-reference/unityengine/component/getcomponentsinparent.md)
* [Component.GetComponentsInParent\<T>()](/engine/6000.0/script-reference/unityengine/component/getcomponentsinparent.md#getcomponentsinparentt\(\))
* [Component.GetComponents(Type)](/engine/6000.0/script-reference/unityengine/component/getcomponents.md#getcomponents\(type\))
* [Component.GetComponents(Type, List\<Component>)](/engine/6000.0/script-reference/unityengine/component/getcomponents.md#getcomponents\(type-listcomponent\))
* [Component.GetComponents\<T>(List\<T>)](/engine/6000.0/script-reference/unityengine/component/getcomponents.md)
* [Component.GetComponents\<T>()](/engine/6000.0/script-reference/unityengine/component/getcomponents.md#getcomponentst\(\))
* [Component.GetComponentIndex()](/engine/6000.0/script-reference/unityengine/component/getcomponentindex.md)
* [Component.CompareTag(string)](/engine/6000.0/script-reference/unityengine/component/comparetag.md#comparetag\(string\))
* [Component.CompareTag(TagHandle)](/engine/6000.0/script-reference/unityengine/component/comparetag.md#comparetag\(taghandle\))
* [Component.SendMessageUpwards(string, Object, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/sendmessageupwards.md#sendmessageupwards\(string-object-sendmessageoptions\))
* [Component.SendMessageUpwards(string, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/sendmessageupwards.md#sendmessageupwards\(string-sendmessageoptions\))
* [Component.SendMessage(string, Object)](/engine/6000.0/script-reference/unityengine/component/sendmessage.md#sendmessage\(string-object\))
* [Component.SendMessage(string)](/engine/6000.0/script-reference/unityengine/component/sendmessage.md#sendmessage\(string\))
* [Component.SendMessage(string, Object, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/sendmessage.md#sendmessage\(string-object-sendmessageoptions\))
* [Component.SendMessage(string, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/sendmessage.md#sendmessage\(string-sendmessageoptions\))
* [Component.BroadcastMessage(string, Object, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/broadcastmessage.md#broadcastmessage\(string-object-sendmessageoptions\))
* [Component.BroadcastMessage(string, SendMessageOptions)](/engine/6000.0/script-reference/unityengine/component/broadcastmessage.md#broadcastmessage\(string-sendmessageoptions\))
* [Component.transform](/engine/6000.0/script-reference/unityengine/component/transform.md)
* [Component.gameObject](/engine/6000.0/script-reference/unityengine/component/gameobject.md)
* [Component.tag](/engine/6000.0/script-reference/unityengine/component/tag.md)
* [Object.GetInstanceID()](/engine/6000.0/script-reference/unityengine/object/getinstanceid.md)
* [Object.GetHashCode()](/engine/6000.0/script-reference/unityengine/object/gethashcode.md)
* [Object.InstantiateAsync\<T>(T)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Transform, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, InstantiateParameters, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, InstantiateParameters, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>, InstantiateParameters, CancellationToken)](/engine/6000.0/script-reference/unityengine/object/instantiateasync.md)
* [Object.Instantiate(Object, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object-vector3-quaternion\))
* [Object.Instantiate(Object, Vector3, Quaternion, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object-vector3-quaternion-transform\))
* [Object.Instantiate(Object)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object\))
* [Object.Instantiate(Object, Scene)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object-scene\))
* [Object.Instantiate\<T>(T, InstantiateParameters)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion, InstantiateParameters)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate(Object, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object-transform\))
* [Object.Instantiate(Object, Transform, bool)](/engine/6000.0/script-reference/unityengine/object/instantiate.md#instantiate\(object-transform-bool\))
* [Object.Instantiate\<T>(T)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Transform)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Transform, bool)](/engine/6000.0/script-reference/unityengine/object/instantiate.md)
* [Object.Destroy(Object, float)](/engine/6000.0/script-reference/unityengine/object/destroy.md)
* [Object.DestroyImmediate(Object, bool)](/engine/6000.0/script-reference/unityengine/object/destroyimmediate.md)
* [Object.FindObjectsByType(Type, FindObjectsSortMode)](/engine/6000.0/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytype\(type-findobjectssortmode\))
* [Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)](/engine/6000.0/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytype\(type-findobjectsinactive-findobjectssortmode\))
* [Object.DontDestroyOnLoad(Object)](/engine/6000.0/script-reference/unityengine/object/dontdestroyonload.md)
* [Object.FindObjectsByType\<T>(FindObjectsSortMode)](/engine/6000.0/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytypet\(findobjectssortmode\))
* [Object.FindObjectsByType\<T>(FindObjectsInactive, FindObjectsSortMode)](/engine/6000.0/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytypet\(findobjectsinactive-findobjectssortmode\))
* [Object.FindFirstObjectByType\<T>()](/engine/6000.0/script-reference/unityengine/object/findfirstobjectbytype.md#findfirstobjectbytypet\(\))
* [Object.FindAnyObjectByType\<T>()](/engine/6000.0/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytypet\(\))
* [Object.FindFirstObjectByType\<T>(FindObjectsInactive)](/engine/6000.0/script-reference/unityengine/object/findfirstobjectbytype.md#findfirstobjectbytypet\(findobjectsinactive\))
* [Object.FindAnyObjectByType\<T>(FindObjectsInactive)](/engine/6000.0/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytypet\(findobjectsinactive\))
* [Object.FindFirstObjectByType(Type)](/engine/6000.0/script-reference/unityengine/object/findfirstobjectbytype.md#findfirstobjectbytype\(type\))
* [Object.FindAnyObjectByType(Type)](/engine/6000.0/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytype\(type\))
* [Object.FindFirstObjectByType(Type, FindObjectsInactive)](/engine/6000.0/script-reference/unityengine/object/findfirstobjectbytype.md#findfirstobjectbytype\(type-findobjectsinactive\))
* [Object.FindAnyObjectByType(Type, FindObjectsInactive)](/engine/6000.0/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytype\(type-findobjectsinactive\))
* [Object.ToString()](/engine/6000.0/script-reference/unityengine/object/tostring.md)
* [Object.name](/engine/6000.0/script-reference/unityengine/object/name.md)
* [Object.hideFlags](/engine/6000.0/script-reference/unityengine/object/hideflags.md)

### Operators

| Operator                                                                           | Description                                                             |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [operator ==](/engine/6000.0/script-reference/unityengine/object/op-equality.md)   | Compares two object references to see if they refer to the same object. |
| [bool](/engine/6000.0/script-reference/unityengine/object/op-implicit.md)          | Determines whether the object exists.                                   |
| [operator !=](/engine/6000.0/script-reference/unityengine/object/op-inequality.md) | Compares if two objects refer to a different object.                    |