Class Mask
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.UI
Assembly: UnityEngine.UI.dll
Syntax
[AddComponentMenu("UI/Mask", 13)]
[ExecuteAlways]
[RequireComponent(typeof(RectTransform))]
[DisallowMultipleComponent]
public class Mask : UIBehaviour, ICanvasRaycastFilter, IMaterialModifier
Constructors
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 |
---|---|
bool |
Methods
GetModifiedMaterial(Material)
Declaration
public virtual Material GetModifiedMaterial(Material baseMaterial)
Parameters
Type | Name | Description |
---|---|---|
Material | baseMaterial |
Returns
Type | Description |
---|---|
Material |
IsRaycastLocationValid(Vector2, Camera)
Declaration
public virtual bool IsRaycastLocationValid(Vector2 sp, Camera eventCamera)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | sp | |
Camera | eventCamera |
Returns
Type | Description |
---|---|
bool |
MaskEnabled()
Declaration
public virtual bool MaskEnabled()
Returns
Type | Description |
---|---|
bool |
OnDisable()
Declaration
protected override void OnDisable()
Overrides
OnEnable()
Declaration
protected override void OnEnable()
Overrides
OnSiblingGraphicEnabledDisabled()
Declaration
[Obsolete("Not used anymore.")]
public virtual void OnSiblingGraphicEnabledDisabled()
OnValidate()
Declaration
protected override void OnValidate()