haussmann 0.0.3

Integrate highly customisable widgets and themes for any Rust application or GUI library
Documentation 
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

// This file is part of "haussmann"
// Under the MIT License
// Copyright (c) 2023 Antonin Hérault

//! Structures to store and convert hexadecimal to RGBA colour values, and
//! colour constants.

/// Blue colour constant (alpha = 255).
pub const BLUE: RGBA = RGBA {
    r: 0,
    g: 0,
    b: 255,
    a: 255,
};
/// Green colour constant (alpha = 255).
pub const GREEN: RGBA = RGBA {
    r: 0,
    g: 255,
    b: 0,
    a: 255,
};
/// Red colour constant (alpha = 255).
pub const RED: RGBA = RGBA {
    r: 255,
    g: 0,
    b: 0,
    a: 255,
};
/// Transparent colour constant (alpha = 0).
pub const TRANSPARENT: RGBA = RGBA {
    r: 0,
    g: 0,
    b: 0,
    a: 0,
};

/// Colour with red, green and blue values + an alpha channel.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub struct RGBA {
    /// Red part of the colour corresponding to the first two bytes of an
    /// hexadecimal colour value.
    ///
    /// Must be in range from 0 to 255.
    pub r: u32,
    /// Green part of the colour corresponding to the third and fourth bytes of
    /// an hexadecimal colour value.
    ///
    /// Must be in range from 0 to 255.
    pub g: u32,
    /// Blue part of the colour corresponding to the fifth and sixth bytes of an
    /// hexadecimal colour value.
    ///
    /// Must be in range from 0 to 255.
    pub b: u32,
    /// Alpha part of the colour corresponding to the seventh and eighth bytes
    /// of an hexadecimal colour value.
    ///
    /// Must be in range from 0 to 255.
    pub a: u32,
}

impl Default for RGBA {
    fn default() -> Self {
        RGBA {
            r: 0,
            g: 0,
            b: 0,
            a: 0,
        }
    }
}

impl RGBA {
    /// Creates a new `RGBA` object.
    ///
    /// `r`, `g`, `b` and `a` are in range 0 to 255, where 0 is the non-colour
    /// (black) and 255 the full colour (red, green or blue). For `a` being the
    /// alpha channel, 0 transparent and 255 is completely visible.
    pub fn new(r: u32, g: u32, b: u32, a: u32) -> Self {
        Self { r, g, b, a }
    }

    /// Creates a new `RGBA` object from an hexadecimal value having an alpha
    /// channel.
    ///
    /// Converts the hexadecimal `value` into a "RGBA" structure.
    pub fn from_hex(value: u32) -> Self {
        Self {
            r: ((value >> 24) & 0xFF) / 255, // RR byte
            g: ((value >> 16) & 0xFF) / 255, // GG byte
            b: ((value >> 8) & 0xFF) / 255,  // BB byte
            a: ((value) & 0xFF) / 255,       // AA byte
        }
    }

    /// Converts the `RGBA` values into an hexadecimal value.
    pub fn to_hex(&self) -> u32 {
        (self.a << 24) | (self.b << 16) | (self.g << 8) | self.r
    }
}