ferriswheel 0.5.0

RGB LED ring effects and animations
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

//! A three-color palette for themed LED effects.

use rgb::RGB8;

/// A three-color theme palette.
///
/// Provides primary, secondary, and accent colors for effects that
/// need a coordinated color scheme (e.g., [`SectionEffect`](crate::SectionEffect)).
///
/// Currently [`SectionEffect`](crate::SectionEffect) uses only `primary` for rendering.
/// The `secondary` and `accent` fields are available for future rendering
/// modes such as gradients or alternating patterns within a section.
///
/// # Example
///
/// ```
/// use ferriswheel::ColorPalette;
/// use ferriswheel::RGB8;
///
/// let palette = ColorPalette::new(
///     RGB8::new(255, 0, 0),
///     RGB8::new(0, 255, 0),
///     RGB8::new(0, 0, 255),
/// );
/// assert_eq!(palette.primary, RGB8::new(255, 0, 0));
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ColorPalette {
    /// The dominant color.
    pub primary: RGB8,
    /// The supporting color.
    pub secondary: RGB8,
    /// The highlight color.
    pub accent: RGB8,
}

impl ColorPalette {
    /// Creates a new palette with the given colors.
    pub fn new(primary: RGB8, secondary: RGB8, accent: RGB8) -> Self {
        Self {
            primary,
            secondary,
            accent,
        }
    }

    /// Creates a monochromatic palette where all three colors are the same.
    pub fn mono(color: RGB8) -> Self {
        Self {
            primary: color,
            secondary: color,
            accent: color,
        }
    }
}

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

    #[test]
    fn test_new_stores_fields() {
        let p = RGB8::new(255, 0, 0);
        let s = RGB8::new(0, 255, 0);
        let a = RGB8::new(0, 0, 255);
        let palette = ColorPalette::new(p, s, a);
        assert_eq!(palette.primary, p);
        assert_eq!(palette.secondary, s);
        assert_eq!(palette.accent, a);
    }

    #[test]
    fn test_mono_sets_all_equal() {
        let color = RGB8::new(42, 100, 200);
        let palette = ColorPalette::mono(color);
        assert_eq!(palette.primary, color);
        assert_eq!(palette.secondary, color);
        assert_eq!(palette.accent, color);
    }

    #[test]
    fn test_copy_clone() {
        let palette = ColorPalette::mono(RGB8::new(10, 20, 30));
        let copied = palette;
        let cloned = palette.clone();
        assert_eq!(palette, copied);
        assert_eq!(palette, cloned);
    }

    #[test]
    fn test_partial_eq() {
        let a = ColorPalette::new(RGB8::new(1, 2, 3), RGB8::new(4, 5, 6), RGB8::new(7, 8, 9));
        let b = ColorPalette::new(RGB8::new(1, 2, 3), RGB8::new(4, 5, 6), RGB8::new(7, 8, 9));
        let c = ColorPalette::new(RGB8::new(9, 8, 7), RGB8::new(4, 5, 6), RGB8::new(7, 8, 9));
        assert_eq!(a, b);
        assert_ne!(a, c);
    }
}