gsk4/auto/
cross_fade_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
90
91
92
93
94
// 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, RenderNode};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A render node cross fading between two child nodes.
    #[doc(alias = "GskCrossFadeNode")]
    pub struct CrossFadeNode(Shared<ffi::GskCrossFadeNode>);

    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 CrossFadeNode {
    fn static_type() -> glib::Type {
        unsafe { from_glib(ffi::gsk_cross_fade_node_get_type()) }
    }
}

impl CrossFadeNode {
    /// Creates a [`RenderNode`][crate::RenderNode] that will do a cross-fade between @start and @end.
    /// ## `start`
    /// The start node to be drawn
    /// ## `end`
    /// The node to be cross_fadeed onto the @start node
    /// ## `progress`
    /// How far the fade has progressed from start to end. The value will
    ///     be clamped to the range [0 ... 1]
    ///
    /// # Returns
    ///
    /// A new [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_cross_fade_node_new")]
    pub fn new(
        start: impl AsRef<RenderNode>,
        end: impl AsRef<RenderNode>,
        progress: f32,
    ) -> CrossFadeNode {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gsk_cross_fade_node_new(
                start.as_ref().to_glib_none().0,
                end.as_ref().to_glib_none().0,
                progress,
            ))
        }
    }

    /// Retrieves the child [`RenderNode`][crate::RenderNode] at the end of the cross-fade.
    ///
    /// # Returns
    ///
    /// a [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_cross_fade_node_get_end_child")]
    #[doc(alias = "get_end_child")]
    pub fn end_child(&self) -> RenderNode {
        unsafe {
            from_glib_none(ffi::gsk_cross_fade_node_get_end_child(
                self.to_glib_none().0,
            ))
        }
    }

    /// Retrieves the progress value of the cross fade.
    ///
    /// # Returns
    ///
    /// the progress value, between 0 and 1
    #[doc(alias = "gsk_cross_fade_node_get_progress")]
    #[doc(alias = "get_progress")]
    pub fn progress(&self) -> f32 {
        unsafe { ffi::gsk_cross_fade_node_get_progress(self.to_glib_none().0) }
    }

    /// Retrieves the child [`RenderNode`][crate::RenderNode] at the beginning of the cross-fade.
    ///
    /// # Returns
    ///
    /// a [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_cross_fade_node_get_start_child")]
    #[doc(alias = "get_start_child")]
    pub fn start_child(&self) -> RenderNode {
        unsafe {
            from_glib_none(ffi::gsk_cross_fade_node_get_start_child(
                self.to_glib_none().0,
            ))
        }
    }
}