gsk4/auto/
linear_gradient_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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// 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, ColorStop};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A render node for a linear gradient.
    #[doc(alias = "GskLinearGradientNode")]
    pub struct LinearGradientNode(Shared<ffi::GskLinearGradientNode>);

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

impl LinearGradientNode {
    /// Creates a [`RenderNode`][crate::RenderNode] that will create a linear gradient from the given
    /// points and color stops, and render that into the area given by @bounds.
    /// ## `bounds`
    /// the rectangle to render the linear gradient into
    /// ## `start`
    /// the point at which the linear gradient will begin
    /// ## `end`
    /// the point at which the linear gradient will finish
    /// ## `color_stops`
    /// a pointer to an array of
    ///   [`ColorStop`][crate::ColorStop] defining the gradient. The offsets of all color stops
    ///   must be increasing. The first stop's offset must be >= 0 and the last
    ///   stop's offset must be <= 1.
    ///
    /// # Returns
    ///
    /// A new [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_linear_gradient_node_new")]
    pub fn new(
        bounds: &graphene::Rect,
        start: &graphene::Point,
        end: &graphene::Point,
        color_stops: &[ColorStop],
    ) -> LinearGradientNode {
        assert_initialized_main_thread!();
        let n_color_stops = color_stops.len() as _;
        unsafe {
            from_glib_full(ffi::gsk_linear_gradient_node_new(
                bounds.to_glib_none().0,
                start.to_glib_none().0,
                end.to_glib_none().0,
                color_stops.to_glib_none().0,
                n_color_stops,
            ))
        }
    }

    /// Retrieves the color stops in the gradient.
    ///
    /// # Returns
    ///
    /// the color stops in the gradient
    #[doc(alias = "gsk_linear_gradient_node_get_color_stops")]
    #[doc(alias = "get_color_stops")]
    pub fn color_stops(&self) -> Vec<ColorStop> {
        unsafe {
            let mut n_stops = std::mem::MaybeUninit::uninit();
            let ret = FromGlibContainer::from_glib_none_num(
                ffi::gsk_linear_gradient_node_get_color_stops(
                    self.to_glib_none().0,
                    n_stops.as_mut_ptr(),
                ),
                n_stops.assume_init() as _,
            );
            ret
        }
    }

    /// Retrieves the final point of the linear gradient.
    ///
    /// # Returns
    ///
    /// the final point
    #[doc(alias = "gsk_linear_gradient_node_get_end")]
    #[doc(alias = "get_end")]
    pub fn end(&self) -> graphene::Point {
        unsafe { from_glib_none(ffi::gsk_linear_gradient_node_get_end(self.to_glib_none().0)) }
    }

    /// Retrieves the number of color stops in the gradient.
    ///
    /// # Returns
    ///
    /// the number of color stops
    #[doc(alias = "gsk_linear_gradient_node_get_n_color_stops")]
    #[doc(alias = "get_n_color_stops")]
    pub fn n_color_stops(&self) -> usize {
        unsafe { ffi::gsk_linear_gradient_node_get_n_color_stops(self.to_glib_none().0) }
    }

    /// Retrieves the initial point of the linear gradient.
    ///
    /// # Returns
    ///
    /// the initial point
    #[doc(alias = "gsk_linear_gradient_node_get_start")]
    #[doc(alias = "get_start")]
    pub fn start(&self) -> graphene::Point {
        unsafe {
            from_glib_none(ffi::gsk_linear_gradient_node_get_start(
                self.to_glib_none().0,
            ))
        }
    }
}