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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
use crate::prelude::{RGB, RGBA};
use std::convert::From;
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(PartialEq, Copy, Clone, Default, Debug)]
/// Represents an H/S/V triplet, in the range 0..1 (32-bit float)
/// This can provide for a more natural color progression, and provides
/// compatibility with HSV-based color systems.
pub struct HSV {
/// Hue (range 0..1)
pub h: f32,
/// Saturation (range 0..1)
pub s: f32,
/// Value (range 0..1)
pub v: f32,
}
/// Support conversion from RGB
impl From<RGB> for HSV {
fn from(rgb: RGB) -> Self {
rgb.to_hsv()
}
}
/// Support conversion from RGBA
impl From<RGBA> for HSV {
fn from(rgba: RGBA) -> Self {
rgba.to_rgb().to_hsv()
}
}
impl HSV {
/// Constructs a new, zeroed (black) HSV triplet.
#[must_use]
pub fn new() -> Self {
Self {
h: 0.0,
s: 0.0,
v: 0.0,
}
}
/// Constructs a new HSV color, from 3 32-bit floats
///
/// # Arguments
///
/// * `h` - The hue (0..1) to use.
/// * `s` - The saturation (0..1) to use.
/// * `v` - The value (0..1) to use.
#[inline]
#[must_use]
pub const fn from_f32(h: f32, s: f32, v: f32) -> Self {
Self { h, s, v }
}
/// Converts to an RGBA value with a specified alpha level
#[inline]
#[must_use]
pub fn to_rgba(&self, alpha: f32) -> RGBA {
self.to_rgb().to_rgba(alpha)
}
/// Converts an HSV triple to an RGB triple
#[allow(clippy::many_single_char_names)] // I like my short names for this one
#[allow(clippy::cast_precision_loss)]
#[allow(clippy::cast_possible_truncation)]
#[inline]
#[must_use]
pub fn to_rgb(&self) -> RGB {
let h = self.h;
let s = self.s;
let v = self.v;
let mut r: f32 = 0.0;
let mut g: f32 = 0.0;
let mut b: f32 = 0.0;
let i = f32::floor(h * 6.0) as i32;
let f = h * 6.0 - i as f32;
let p = v * (1.0 - s);
let q = v * (1.0 - f * s);
let t = v * (1.0 - (1.0 - f) * s);
match i % 6 {
0 => {
r = v;
g = t;
b = p;
}
1 => {
r = q;
g = v;
b = p;
}
2 => {
r = p;
g = v;
b = t;
}
3 => {
r = p;
g = q;
b = v;
}
4 => {
r = t;
g = p;
b = v;
}
5 => {
r = v;
g = p;
b = q;
}
// Catch-all; this shouldn't happen
_ => {}
}
RGB::from_f32(r, g, b)
}
/// Progress smoothly between two colors, in the HSV color space.
///
/// # Arguments
///
/// * `color` - the target color.
/// * `percent` - the percentage (0..1) of the starting (self) and target color to use.
///
/// # Example
///
/// ```rust
/// use bracket_color::prelude::*;
/// let red = RGB::named(RED);
/// let blue = RGB::named(YELLOW);
/// let color = red.lerp(blue, 0.5);
/// ```
#[inline]
#[must_use]
pub fn lerp(&self, color: Self, percent: f32) -> Self {
let range = (color.h - self.h, color.s - self.s, color.v - self.v);
Self {
h: self.h + range.0 * percent,
s: self.s + range.1 * percent,
v: self.v + range.2 * percent,
}
}
}
#[cfg(test)]
mod tests {
use crate::prelude::*;
#[test]
// Tests that we make an HSV triplet at defaults and it is black.
fn make_hsv_minimal() {
let black = HSV::new();
assert!(black.h < std::f32::EPSILON);
assert!(black.s < std::f32::EPSILON);
assert!(black.v < std::f32::EPSILON);
}
#[test]
// Tests that we make an HSV triplet at defaults and it is black.
fn convert_red_to_hsv() {
let red = RGB::from_f32(1.0, 0.0, 0.0);
let hsv = red.to_hsv();
assert!(hsv.h < std::f32::EPSILON);
assert!(f32::abs(hsv.s - 1.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.v - 1.0) < std::f32::EPSILON);
}
#[test]
// Tests that we make an HSV triplet at defaults and it is black.
fn convert_green_to_hsv() {
let green = RGB::from_f32(0.0, 1.0, 0.0);
let hsv = green.to_hsv();
assert!(f32::abs(hsv.h - 120.0 / 360.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.s - 1.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.v - 1.0) < std::f32::EPSILON);
}
#[test]
// Tests that we make an HSV triplet at defaults and it is black.
fn convert_blue_to_hsv() {
let blue = RGB::from_f32(0.0, 0.0, 1.0);
let hsv = blue.to_hsv();
assert!(f32::abs(hsv.h - 240.0 / 360.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.s - 1.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.v - 1.0) < std::f32::EPSILON);
}
#[test]
// Tests that we make an HSV triplet at defaults and it is black.
fn convert_olive_to_hsv() {
let grey = RGB::from_u8(128, 128, 0);
let hsv = grey.to_hsv();
assert!(f32::abs(hsv.h - 60.0 / 360.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.s - 1.0) < std::f32::EPSILON);
assert!(f32::abs(hsv.v - 0.5019_608) < std::f32::EPSILON);
}
#[test]
// Test the lerp function
fn test_lerp() {
let black = RGB::named(BLACK).to_hsv();
let white = RGB::named(WHITE).to_hsv();
assert!(black.lerp(white, 0.0) == black);
assert!(black.lerp(white, 1.0) == white);
}
}