Class: Gsk::MaskNode

Inherits:

RenderNode

• Object
• RenderNode
• Gsk::MaskNode

Defined in:

(unknown)

Overview

A render node masking one child node with another.

Instance Method Summary

• #initialize(source, mask, mask_mode) ⇒ Gsk::MaskNode constructor

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

• #mask ⇒ Gsk::RenderNode

  Retrieves the mask GskRenderNode child of the node.

• #mask_mode ⇒ Gsk::MaskMode

  Retrieves the mask mode used by node.

• #source ⇒ Gsk::RenderNode

  Retrieves the source GskRenderNode child of the node.

Methods inherited from RenderNode

deserialize, #draw, #get_bounds, #node_type, #ref, #serialize, #unref, #write_to_file

Constructor Details

#initialize(source, mask, mask_mode) ⇒ 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.

Parameters:

• source (Gsk::RenderNode) —

  The source node to be drawn

• mask (Gsk::RenderNode) —

  The node to be used as mask

• mask_mode (Gsk::MaskMode) —

  The mask mode to use

Instance Method Details

#mask ⇒ Gsk::RenderNode

Retrieves the mask GskRenderNode child of the node.

Returns:

• (Gsk::RenderNode) —

  the mask child node

#mask_mode ⇒ Gsk::MaskMode

Retrieves the mask mode used by node.

Returns:

• (Gsk::MaskMode) —

  the mask mode

#source ⇒ Gsk::RenderNode

Retrieves the source GskRenderNode child of the node.

Returns:

• (Gsk::RenderNode) —

  the source child node