optic-color 0.0.1

Zero-dependency color library for Optic engine — RGBA, HSV, HSL, gradients, named constants
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

use crate::{RGBA, ToRgba};

/// HSL color.
///
/// | Field | Range | Description |
/// |-------|-------|-------------|
/// | `h`   | 0..360 | Hue angle (wraps at 360) |
/// | `s`   | 0..1   | Saturation |
/// | `l`   | 0..1   | Lightness |
///
/// # Why no arithmetic?
///
/// Same reasoning as [`HSV`]: hue wraparound makes naive componentwise
/// operations incorrect. Convert to [`RGBA`], manipulate there, convert back.
///
/// See [`HSV`] for details and alternatives.
///
/// [`HSV`]: crate::HSV
#[derive(Copy, Clone, Debug)]
pub struct HSL {
    pub h: f32,
    pub s: f32,
    pub l: f32,
}

impl HSL {
    /// Construct an HSL color with clamping.
    ///
    /// Hue is clamped to 0..360, saturation and lightness to 0..1.
    pub fn new(h: f32, s: f32, l: f32) -> Self {
        HSL { h: h.clamp(0.0, 360.0), s: s.clamp(0.0, 1.0), l: l.clamp(0.0, 1.0) }
    }

    /// Convert to RGBA with a custom alpha.
    ///
    /// Equivalent to `self.to_rgba().with_alpha(alpha)`.
    pub fn to_rgba_alpha(self, alpha: f32) -> RGBA {
        self.to_rgba().with_alpha(alpha)
    }
}