.. _stdlib_ui_mask_component:

======
UIMask
======


+++++++
Classes
+++++++

.. _struct-ui_mask_component-UIMask:

.. das:attribute:: UIMask : NativeComponent

.. note:: ``UIFrame``  component is automatically added to the node if it is not already present

Component that defines a mask for UI elements, controlling which parts of UI elements are visible.


:Properties:

.. _function-ui_mask_component__dot__rq_enabled_UIMask:

.. das:operator:: UIMask.enabled() : bool



.. _function-ui_mask_component__dot__rq_enabled_rq_clone_UIMask_bool:

.. das:operator:: UIMask.enabled =(value: bool)

Whether the mask is enabled and applied to UI elements.

:Arguments: * **value** : bool

.. _function-ui_mask_component__dot__rq_showMaskSource_UIMask:

.. das:operator:: UIMask.showMaskSource() : bool



.. _function-ui_mask_component__dot__rq_showMaskSource_rq_clone_UIMask_bool:

.. das:operator:: UIMask.showMaskSource =(value: bool)

If true, the mask is rendered as a source mask; if false, as a destination mask.

:Arguments: * **value** : bool