gsk4/auto/
cross_fade_node.rs

1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// DO NOT EDIT
4
5use crate::{ffi, RenderNode};
6use glib::{prelude::*, translate::*};
7
8glib::wrapper! {
9    /// A render node cross fading between two child nodes.
10    #[doc(alias = "GskCrossFadeNode")]
11    pub struct CrossFadeNode(Shared<ffi::GskCrossFadeNode>);
12
13    match fn {
14        ref => |ptr| ffi::gsk_render_node_ref(ptr as *mut ffi::GskRenderNode),
15        unref => |ptr| ffi::gsk_render_node_unref(ptr as *mut ffi::GskRenderNode),
16    }
17}
18
19impl StaticType for CrossFadeNode {
20    fn static_type() -> glib::Type {
21        unsafe { from_glib(ffi::gsk_cross_fade_node_get_type()) }
22    }
23}
24
25impl CrossFadeNode {
26    /// Creates a [`RenderNode`][crate::RenderNode] that will do a cross-fade between @start and @end.
27    /// ## `start`
28    /// The start node to be drawn
29    /// ## `end`
30    /// The node to be cross_fadeed onto the @start node
31    /// ## `progress`
32    /// How far the fade has progressed from start to end. The value will
33    ///     be clamped to the range [0 ... 1]
34    ///
35    /// # Returns
36    ///
37    /// A new [`RenderNode`][crate::RenderNode]
38    #[doc(alias = "gsk_cross_fade_node_new")]
39    pub fn new(
40        start: impl AsRef<RenderNode>,
41        end: impl AsRef<RenderNode>,
42        progress: f32,
43    ) -> CrossFadeNode {
44        skip_assert_initialized!();
45        unsafe {
46            from_glib_full(ffi::gsk_cross_fade_node_new(
47                start.as_ref().to_glib_none().0,
48                end.as_ref().to_glib_none().0,
49                progress,
50            ))
51        }
52    }
53
54    /// Retrieves the child [`RenderNode`][crate::RenderNode] at the end of the cross-fade.
55    ///
56    /// # Returns
57    ///
58    /// a [`RenderNode`][crate::RenderNode]
59    #[doc(alias = "gsk_cross_fade_node_get_end_child")]
60    #[doc(alias = "get_end_child")]
61    pub fn end_child(&self) -> RenderNode {
62        unsafe {
63            from_glib_none(ffi::gsk_cross_fade_node_get_end_child(
64                self.to_glib_none().0,
65            ))
66        }
67    }
68
69    /// Retrieves the progress value of the cross fade.
70    ///
71    /// # Returns
72    ///
73    /// the progress value, between 0 and 1
74    #[doc(alias = "gsk_cross_fade_node_get_progress")]
75    #[doc(alias = "get_progress")]
76    pub fn progress(&self) -> f32 {
77        unsafe { ffi::gsk_cross_fade_node_get_progress(self.to_glib_none().0) }
78    }
79
80    /// Retrieves the child [`RenderNode`][crate::RenderNode] at the beginning of the cross-fade.
81    ///
82    /// # Returns
83    ///
84    /// a [`RenderNode`][crate::RenderNode]
85    #[doc(alias = "gsk_cross_fade_node_get_start_child")]
86    #[doc(alias = "get_start_child")]
87    pub fn start_child(&self) -> RenderNode {
88        unsafe {
89            from_glib_none(ffi::gsk_cross_fade_node_get_start_child(
90                self.to_glib_none().0,
91            ))
92        }
93    }
94}