Class Mask
A visual element that can be used to mask color.
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public class Mask : Image, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyleConstructors
Mask()
Default constructor.
Declaration
public Mask()Fields
ussClassName
The Mask main styling class.
Declaration
public const string ussClassName = "appui-mask"Field Value
| Type | Description |
|---|---|
| string |
Properties
blur
The mask blur. Sets the blur of the mask (in pixels).
Declaration
public float blur { get; set; }Property Value
| Type | Description |
|---|---|
| float |
contentContainer
The content container of this element.
Declaration
public override VisualElement contentContainer { get; }Property Value
| Type | Description |
|---|---|
| VisualElement |
Overrides
innerMaskColor
The inner mask color. Sets the color of the inner mask.
Declaration
public Color innerMaskColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
maskRect
The mask rect. Sets the rect of the mask (in pixels or normalized if useNormalizedMaskRect is true).
Declaration
public Rect maskRect { get; set; }Property Value
| Type | Description |
|---|---|
| Rect |
outerMaskColor
The outer mask color. The color of the area outside the mask.
Declaration
public Color outerMaskColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
radius
The mask radius. Sets the radius of the rounded corners (in pixels).
Declaration
public float radius { get; set; }Property Value
| Type | Description |
|---|---|
| float |
useNormalizedMaskRect
If true, the mask rect you will provide through maskRect must be normalized (0-1) instead of using pixels coordinates.
Declaration
public bool useNormalizedMaskRect { get; set; }Property Value
| Type | Description |
|---|---|
| bool |