Class Mask
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
Namespace: UnityEngine.UI
Syntax
[AddComponentMenu("UI/Mask", 13)]
[ExecuteAlways]
[RequireComponent(typeof(RectTransform))]
[DisallowMultipleComponent]
public class Mask : UIBehaviour, ICanvasRaycastFilter, IMaterialModifierConstructors
Mask()
Declaration
protected Mask()Properties
graphic
The graphic associated with the Mask.
Declaration
public Graphic graphic { get; }Property Value
| Type | Description |
|---|---|
| Graphic |
rectTransform
Declaration
public RectTransform rectTransform { get; }Property Value
| Type | Description |
|---|---|
| RectTransform |
showMaskGraphic
Show the graphic that is associated with the Mask render area.
Declaration
public bool showMaskGraphic { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
GetModifiedMaterial(Material)
Declaration
public virtual Material GetModifiedMaterial(Material baseMaterial)Parameters
| Type | Name | Description |
|---|---|---|
| Material | baseMaterial |
Returns
| Type | Description |
|---|---|
| Material |
Implements
IsRaycastLocationValid(Vector2, Camera)
Declaration
public virtual bool IsRaycastLocationValid(Vector2 sp, Camera eventCamera)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2 | sp | |
| Camera | eventCamera |
Returns
| Type | Description |
|---|---|
| Boolean |
Implements
MaskEnabled()
Declaration
public virtual bool MaskEnabled()Returns
| Type | Description |
|---|---|
| Boolean |
OnDisable()
Declaration
protected override void OnDisable()Overrides
OnEnable()
Declaration
protected override void OnEnable()Overrides
OnSiblingGraphicEnabledDisabled()
Declaration
[Obsolete("Not used anymore.")]
public virtual void OnSiblingGraphicEnabledDisabled()