gsk4/auto/
conic_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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
// 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 conic gradient.
    #[doc(alias = "GskConicGradientNode")]
    pub struct ConicGradientNode(Shared<ffi::GskConicGradientNode>);

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

impl ConicGradientNode {
    /// Creates a [`RenderNode`][crate::RenderNode] that draws a conic gradient.
    ///
    /// The conic gradient
    /// starts around @center in the direction of @rotation. A rotation of 0 means
    /// that the gradient points up. Color stops are then added clockwise.
    /// ## `bounds`
    /// the bounds of the node
    /// ## `center`
    /// the center of the gradient
    /// ## `rotation`
    /// the rotation of the gradient in degrees
    /// ## `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_conic_gradient_node_new")]
    pub fn new(
        bounds: &graphene::Rect,
        center: &graphene::Point,
        rotation: f32,
        color_stops: &[ColorStop],
    ) -> ConicGradientNode {
        assert_initialized_main_thread!();
        let n_color_stops = color_stops.len() as _;
        unsafe {
            from_glib_full(ffi::gsk_conic_gradient_node_new(
                bounds.to_glib_none().0,
                center.to_glib_none().0,
                rotation,
                color_stops.to_glib_none().0,
                n_color_stops,
            ))
        }
    }

    /// Retrieves the angle for the gradient in radians, normalized in [0, 2 * PI].
    ///
    /// The angle is starting at the top and going clockwise, as expressed
    /// in the css specification:
    ///
    ///     angle = 90 - gsk_conic_gradient_node_get_rotation()
    ///
    /// # Returns
    ///
    /// the angle for the gradient
    #[cfg(feature = "v4_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_2")))]
    #[doc(alias = "gsk_conic_gradient_node_get_angle")]
    #[doc(alias = "get_angle")]
    pub fn angle(&self) -> f32 {
        unsafe { ffi::gsk_conic_gradient_node_get_angle(self.to_glib_none().0) }
    }

    /// Retrieves the center pointer for the gradient.
    ///
    /// # Returns
    ///
    /// the center point for the gradient
    #[doc(alias = "gsk_conic_gradient_node_get_center")]
    #[doc(alias = "get_center")]
    pub fn center(&self) -> graphene::Point {
        unsafe {
            from_glib_none(ffi::gsk_conic_gradient_node_get_center(
                self.to_glib_none().0,
            ))
        }
    }

    /// Retrieves the color stops in the gradient.
    ///
    /// # Returns
    ///
    /// the color stops in the gradient
    #[doc(alias = "gsk_conic_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_conic_gradient_node_get_color_stops(
                    self.to_glib_none().0,
                    n_stops.as_mut_ptr(),
                ),
                n_stops.assume_init() as _,
            );
            ret
        }
    }

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

    /// Retrieves the rotation for the gradient in degrees.
    ///
    /// # Returns
    ///
    /// the rotation for the gradient
    #[doc(alias = "gsk_conic_gradient_node_get_rotation")]
    #[doc(alias = "get_rotation")]
    pub fn rotation(&self) -> f32 {
        unsafe { ffi::gsk_conic_gradient_node_get_rotation(self.to_glib_none().0) }
    }
}