gdk4/auto/
rgba.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;
use glib::translate::*;

glib::wrapper! {
    /// A [`RGBA`][crate::RGBA] is used to represent a color, in a way that is compatible
    /// with cairo’s notion of color.
    ///
    /// [`RGBA`][crate::RGBA] is a convenient way to pass colors around. It’s based on
    /// cairo’s way to deal with colors and mirrors its behavior. All values
    /// are in the range from 0.0 to 1.0 inclusive. So the color
    /// (0.0, 0.0, 0.0, 0.0) represents transparent black and
    /// (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will
    /// be clamped to this range when drawing.
    pub struct RGBA(BoxedInline<ffi::GdkRGBA>);

    match fn {
        copy => |ptr| ffi::gdk_rgba_copy(ptr),
        free => |ptr| ffi::gdk_rgba_free(ptr),
        type_ => || ffi::gdk_rgba_get_type(),
    }
}

impl RGBA {
    #[doc(alias = "gdk_rgba_equal")]
    fn equal(&self, p2: &RGBA) -> bool {
        unsafe {
            from_glib(ffi::gdk_rgba_equal(
                ToGlibPtr::<*const ffi::GdkRGBA>::to_glib_none(self).0 as glib::ffi::gconstpointer,
                ToGlibPtr::<*const ffi::GdkRGBA>::to_glib_none(p2).0 as glib::ffi::gconstpointer,
            ))
        }
    }

    #[doc(alias = "gdk_rgba_hash")]
    fn hash(&self) -> u32 {
        unsafe {
            ffi::gdk_rgba_hash(
                ToGlibPtr::<*const ffi::GdkRGBA>::to_glib_none(self).0 as glib::ffi::gconstpointer,
            )
        }
    }

    /// Checks if an @self value is transparent.
    ///
    /// That is, drawing with the value would not produce any change.
    ///
    /// # Returns
    ///
    /// [`true`] if the @self is clear
    #[doc(alias = "gdk_rgba_is_clear")]
    pub fn is_clear(&self) -> bool {
        unsafe { from_glib(ffi::gdk_rgba_is_clear(self.to_glib_none().0)) }
    }

    /// Checks if an @self value is opaque.
    ///
    /// That is, drawing with the value will not retain any results
    /// from previous contents.
    ///
    /// # Returns
    ///
    /// [`true`] if the @self is opaque
    #[doc(alias = "gdk_rgba_is_opaque")]
    pub fn is_opaque(&self) -> bool {
        unsafe { from_glib(ffi::gdk_rgba_is_opaque(self.to_glib_none().0)) }
    }

    /// Returns a textual specification of @self in the form
    /// `rgb(r,g,b)` or `rgba(r,g,b,a)`, where “r”, “g”, “b” and
    /// “a” represent the red, green, blue and alpha values
    /// respectively. “r”, “g”, and “b” are represented as integers
    /// in the range 0 to 255, and “a” is represented as a floating
    /// point value in the range 0 to 1.
    ///
    /// These string forms are string forms that are supported by
    /// the CSS3 colors module, and can be parsed by [`parse()`][Self::parse()].
    ///
    /// Note that this string representation may lose some precision,
    /// since “r”, “g” and “b” are represented as 8-bit integers. If
    /// this is a concern, you should use a different representation.
    ///
    /// # Returns
    ///
    /// A newly allocated text string
    #[doc(alias = "gdk_rgba_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> glib::GString {
        unsafe { from_glib_full(ffi::gdk_rgba_to_string(self.to_glib_none().0)) }
    }
}

impl PartialEq for RGBA {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}

impl Eq for RGBA {}

impl std::fmt::Display for RGBA {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.to_str())
    }
}

impl std::hash::Hash for RGBA {
    #[inline]
    fn hash<H>(&self, state: &mut H)
    where
        H: std::hash::Hasher,
    {
        std::hash::Hash::hash(&self.hash(), state)
    }
}