The '''Mask''' component restricts the rendering of anything beneath it. It requires an [[Component:Image|Image]] component, [[Component:Text|text]], [[Component:OutlinedArc|arc]], [[Component:RectMesh|rectmesh]], or anything that displays a graphic on the same [[Slot|slot]]. Only opaque areas of the graphic on the same slot will render the [[UIX]] below. This is also utilized in [[Component:ScrollRect|ScrollRect]] since it can mask anything outside of the scrolling viewport when using the component.
The Mask component restricts the rendering of anything beneath it. It requires an [[Image (Component)|Image]] component, text, arc, rectmesh, or anything that displays a graphic on the same slot. Only opaque areas of the graphic on the same slot will render the UIX below. This is also utilized in [[Component:ScrollRect|ScrollRect]] since it can mask anything outside of the scrolling viewport when using the component.
{{Note|This can have issues with UIX's behind, since there are some rendering bugs with Unity.|warning}}
This can have issues with UIX's behind, since there are some rendering bugs with Unity.
There is a [[UIX Tutorial]] that use masking and [[Component:ScrollRect|ScrollRects]] to help you understand how masks work.
<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ShowMaskGraphic|Bool|Shows the graphic being used to do the masking for debug purposes
|ShowMaskGraphic|Bool|Shows the graphic being used to do the masking for debug purposes.
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
This can be used for fancy cutout effects.
<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
The [[Component:ScrollRect|ScrollRect]] section which is part of the UIX Canvas object created by the create new menu.
The [[Component:ScrollRect|ScrollRect]] section which is part of the [[UIX]] Canvas object created by the [[Create New Wizard|create new menu]].
The Mask component restricts the rendering of anything beneath it. It requires an Image component, text, arc, rectmesh, or anything that displays a graphic on the same slot. Only opaque areas of the graphic on the same slot will render the UIX below. This is also utilized in ScrollRect since it can mask anything outside of the scrolling viewport when using the component.
This can have issues with UIX's behind, since there are some rendering bugs with Unity.
There is a UIX Tutorial that use masking and ScrollRects to help you understand how masks work.
