gem 0.1.1

Color representations and conversions
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

use crate::{alpha::AlphaLast, rgb::RgbF32};

/// Floating-point RGBA color representation.
///
/// Each component is represented by 32 bits (f32).
///
/// ## Layout
///
/// ```c
/// struct RgbaF32 {
///   float r;
///   float g;
///   float b;
///   float a;
/// }
/// ```
///
/// ## Examples
///
/// To create an `RgbaF32` color from individual components:
///
/// ```rust
/// use gem::rgb::RgbaF32;
///
/// let color = RgbaF32::from_rgba(1.0, 0.0, 0.0, 1.0);
/// ```
pub type RgbaF32 = AlphaLast<f32, RgbF32>;

impl RgbaF32 {
    /// Creates a new RGBA color from the individual components.
    ///
    /// ## Examples
    ///
    /// ```rust
    /// use gem::{alpha::HasAlpha, rgb::{HasRed, HasGreen, HasBlue, RgbaF32}};
    ///
    /// let color = RgbaF32::from_rgba(1.0, 0.0, 0.0, 1.0);
    /// assert_eq!(color.red(), 1.0);
    /// assert_eq!(color.green(), 0.0);
    /// assert_eq!(color.blue(), 0.0);
    /// assert_eq!(color.alpha(), 1.0);
    /// ```
    #[must_use]
    pub const fn from_rgba(r: f32, g: f32, b: f32, a: f32) -> Self {
        Self::with_color(a, RgbF32::from_rgb(r, g, b))
    }
}

#[cfg(test)]
#[allow(clippy::float_cmp)]
mod tests {
    use super::*;

    use crate::{rgb::HasBlue, rgb::HasGreen, rgb::HasRed};

    #[test]
    fn test_new() {
        let color = RgbaF32::from_rgba(1.0, 0.0, 0.0, 1.0);
        assert_eq!(color.red(), 1.0);
        assert_eq!(color.green(), 0.0);
        assert_eq!(color.blue(), 0.0);
        assert_eq!(color.alpha(), 1.0);
    }
}