gsk4/auto/
mask_node.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, MaskMode, RenderNode};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A render node masking one child node with another.
    #[doc(alias = "GskMaskNode")]
    pub struct MaskNode(Shared<ffi::GskMaskNode>);

    match fn {
        ref => |ptr| ffi::gsk_render_node_ref(ptr as *mut ffi::GskRenderNode),
        unref => |ptr| ffi::gsk_render_node_unref(ptr as *mut ffi::GskRenderNode),
    }
}

impl StaticType for MaskNode {
    fn static_type() -> glib::Type {
        unsafe { from_glib(ffi::gsk_mask_node_get_type()) }
    }
}

impl MaskNode {
    /// Creates a [`RenderNode`][crate::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`][crate::RenderNode]
    #[doc(alias = "gsk_mask_node_new")]
    pub fn new(
        source: impl AsRef<RenderNode>,
        mask: impl AsRef<RenderNode>,
        mask_mode: MaskMode,
    ) -> MaskNode {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gsk_mask_node_new(
                source.as_ref().to_glib_none().0,
                mask.as_ref().to_glib_none().0,
                mask_mode.into_glib(),
            ))
        }
    }

    /// Retrieves the mask [`RenderNode`][crate::RenderNode] child of the @self.
    ///
    /// # Returns
    ///
    /// the mask child node
    #[doc(alias = "gsk_mask_node_get_mask")]
    #[doc(alias = "get_mask")]
    pub fn mask(&self) -> RenderNode {
        unsafe { from_glib_none(ffi::gsk_mask_node_get_mask(self.to_glib_none().0)) }
    }

    /// Retrieves the mask mode used by @self.
    ///
    /// # Returns
    ///
    /// the mask mode
    #[doc(alias = "gsk_mask_node_get_mask_mode")]
    #[doc(alias = "get_mask_mode")]
    pub fn mask_mode(&self) -> MaskMode {
        unsafe { from_glib(ffi::gsk_mask_node_get_mask_mode(self.to_glib_none().0)) }
    }

    /// Retrieves the source [`RenderNode`][crate::RenderNode] child of the @self.
    ///
    /// # Returns
    ///
    /// the source child node
    #[doc(alias = "gsk_mask_node_get_source")]
    #[doc(alias = "get_source")]
    pub fn source(&self) -> RenderNode {
        unsafe { from_glib_none(ffi::gsk_mask_node_get_source(self.to_glib_none().0)) }
    }
}