Struct MaskNode

pub struct MaskNode { /* private fields */ }

Available on crate feature v4_10 only.

A render node masking one child node with another.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl MaskNode

pub fn as_ptr(&self) -> *mut GskMaskNode

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GskMaskNode) -> &Self

Borrows the underlying C value.

impl MaskNode

pub fn new( source: impl AsRef<RenderNode>, mask: impl AsRef<RenderNode>, mask_mode: MaskMode, ) -> MaskNode

Creates a RenderNode 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.

source

The source node to be drawn

mask

The node to be used as mask

mask_mode

The mask mode to use

Returns

A new RenderNode

pub fn mask(&self) -> RenderNode

Retrieves the mask RenderNode child of the @self.

Returns

the mask child node

pub fn mask_mode(&self) -> MaskMode

Retrieves the mask mode used by @self.

Returns

the mask mode

pub fn source(&self) -> RenderNode

Retrieves the source RenderNode child of the @self.

Returns

the source child node

Methods from Deref<Target = RenderNode>

pub fn as_ptr(&self) -> *mut GskRenderNode

Return the inner pointer to the underlying C value.

pub const NONE: Option<&'static RenderNode> = None

pub fn draw(&self, cr: &Context)

Draw the contents of @self to the given cairo context.

Typically, you’ll use this function to implement fallback rendering of RenderNodes on an intermediate Cairo context, instead of using the drawing context associated to a gdk::Surface’s rendering buffer.

For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.

cr

cairo context to draw to

pub fn bounds(&self) -> Rect

Retrieves the boundaries of the @self.

The node will not draw outside of its boundaries.

Returns

bounds

return location for the boundaries

pub fn node_type(&self) -> RenderNodeType

Returns the type of the @self.

Returns

the type of the RenderNode

pub fn opaque_rect(&self) -> Option<Rect>

Available on crate feature v4_16 only.

Gets an opaque rectangle inside the node that GTK can determine to be fully opaque.

There is no guarantee that this is indeed the largest opaque rectangle or that regions outside the rectangle are not opaque. This function is a best effort with that goal.

The rectangle will be fully contained in the bounds of the node.

Returns

true if part or all of the rendernode is opaque, false if no opaque region could be found.

out_opaque

return location for the opaque rect

pub fn serialize(&self) -> Bytes

Serializes the @self for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and gsk_render_node_deserialize() will correctly reject files it cannot open that were created with previous versions of GTK.

The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

Returns

a GBytes representing the node.

pub fn write_to_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>

This function is equivalent to calling serialize() followed by file_set_contents().

See those two functions for details on the arguments.

It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.

filename

the file to save it to.

Returns

true if saving was successful

pub fn is<T: IsRenderNode>(&self) -> bool

pub fn type_(&self) -> Type

pub fn downcast_ref<T: IsRenderNode>(&self) -> Option<&T>

Trait Implementations

impl AsRef<RenderNode> for MaskNode

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MaskNode

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MaskNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for MaskNode

type Target = RenderNode

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> FromValue<'a> for MaskNode

Available on crate feature v4_6 only.

type Checker = GenericValueTypeOrNoneChecker<MaskNode>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl IsRenderNode for MaskNode

const NODE_TYPE: RenderNodeType = RenderNodeType::MaskNode

fn upcast(self) -> RenderNode

fn upcast_ref(&self) -> &RenderNode

impl StaticType for MaskNode

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for MaskNode

Available on crate feature v4_6 only.

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ToValueOptional for MaskNode

Available on crate feature v4_6 only.

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl ValueType for MaskNode

Available on crate feature v4_6 only.

type Type = MaskNode

Type to get the Type from.