:right-sidebar: True

MaskNode
===================================================================

.. currentmodule:: gi.repository.Gsk


.. versionadded:: 4.10




.. class:: MaskNode(*args, **kwargs)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gsk.RenderNode`





A render node masking one child node with another.


Constructors
------------

.. rst-class:: interim-class

.. class:: MaskNode
   :no-index:


   .. classmethod:: new(source: ~gi.repository.Gsk.RenderNode, mask: ~gi.repository.Gsk.RenderNode, mask_mode: ~gi.repository.Gsk.MaskMode) -> ~gi.repository.Gsk.MaskNode

      Creates a ``GskRenderNode`` that will mask a given node by another.

      The ``mask_mode`` determines how the 'mask values' are derived from
      the colors of the ``mask``\. Applying the mask consists of multiplying
      the 'mask value' with the alpha of the source.


      .. versionadded:: 4.10





      :param source: The source node to be drawn

      :param mask: The node to be used as mask

      :param mask_mode: The mask mode to use








Methods
-------

.. rst-class:: interim-class

.. class:: MaskNode
   :no-index:


   .. method:: get_mask() -> ~gi.repository.Gsk.RenderNode

      Retrieves the mask ``GskRenderNode`` child of the ``node``\.


      .. versionadded:: 4.10








   .. method:: get_mask_mode() -> ~gi.repository.Gsk.MaskMode

      Retrieves the mask mode used by ``node``\.


      .. versionadded:: 4.10








   .. method:: get_source() -> ~gi.repository.Gsk.RenderNode

      Retrieves the source ``GskRenderNode`` child of the ``node``\.


      .. versionadded:: 4.10