The Mask component restricts the rendering of anything beneath it. It requires an [[Image (Component)|Image]] component, or something similar, on the same slot. Only opaque areas will be renderered.
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.
This can have issues with UIX's behind, since there are some rendering bugs with Unity.
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ShowMaskGraphic|Bool|Shows the graphic being used to do the masking
|ShowMaskGraphic|Bool|Shows the graphic being used to do the masking for debug purposes
}}
}}
Line 24:
Line 26:
<!--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 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.
