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
//! Color items, including everything from rgb, hsb/l/v, lap, alpha, luma and more, provided by the
//! [palette crate](https://docs.rs/palette).
//!
//! See the [**named**](./named/index.html) module for a set of provided color constants.
pub mod conv;
pub use self::conv::IntoLinSrgba;
pub use self::named::*;
#[doc(inline)]
pub use palette::*;
/// The default scalar value for working with color components, hues, etc.
pub type DefaultScalar = f32;
/// A color represented as red, green and blue intensities.
///
/// This type is an alias for the `Srgb` type, a type that represents the sRGB color space.
///
/// If you are looking for more advanced control over the RGB space and component type, please see
/// the `palette` crate's generic `Rgb` type.
pub type Rgb<S = DefaultScalar> = Srgb<S>;
/// The same as `Rgb`, but with `u8`'s.
pub type Rgb8 = Rgb<u8>;
/// The same as `Rgb`, but with an alpha value representing opacity.
///
/// This type is an alias for the `Srgba` type, a type that represents the sRGB color space
/// alongside an alpha value.
///
/// If you are looking for more advanced control over the RGB space and component type, please see
/// the `palette` crate's generic `Rgb` type.
pub type Rgba<S = DefaultScalar> = Srgba<S>;
/// The same as `Rgba`, but with `u8`'s.
pub type Rgba8 = Rgba<u8>;
/// A color represented as gray intensity.
///
/// This type is an alias for the `Srgb` type, a type that represents the sRGB color space.
///
/// If you are looking for more advanced control over the RGB space and component type, please see
/// the `palette` crate's generic `Rgb` type.
pub type Gray<S = DefaultScalar> = Srgb<S>;
/// A short-hand constructor for `Rgb::new`.
pub fn rgb<T>(r: T, g: T, b: T) -> Rgb<T>
where
T: Component,
{
srgb(r, g, b)
}
/// A short-hand constructor for `Rgb::<u8>::new` .
pub fn rgb8(r: u8, g: u8, b: u8) -> Rgb8 {
srgb(r, g, b)
}
/// A short-hand constructor for `Rgba::new`.
pub fn rgba<T>(r: T, g: T, b: T, a: T) -> Rgba<T>
where
T: Component,
{
srgba(r, g, b, a)
}
/// A short-hand constructor for `Rgba<u8>::new`.
pub fn rgba8(r: u8, g: u8, b: u8, a: u8) -> Rgba8 {
srgba8(r, g, b, a)
}
/// A short-hand constructor for `Srgb::new`.
pub fn srgb<T>(r: T, g: T, b: T) -> Srgb<T>
where
T: Component,
{
Srgb::new(r, g, b)
}
/// A short-hand constructor for `Srgb<u8>::new`.
pub fn srgb8(r: u8, g: u8, b: u8) -> Srgb<u8> {
Srgb::new(r, g, b)
}
/// A short-hand constructor for `Srgba::new`.
pub fn srgba<T>(r: T, g: T, b: T, a: T) -> Srgba<T>
where
T: Component,
{
Srgba::new(r, g, b, a)
}
/// A short-hand constructor for `Srgba<u8>::new`.
pub fn srgba8(r: u8, g: u8, b: u8, a: u8) -> Srgba<u8> {
Srgba::new(r, g, b, a)
}
/// A short-hand constructor for `LinSrgb::new`.
pub fn lin_srgb<T>(r: T, g: T, b: T) -> LinSrgb<T>
where
T: Component,
{
LinSrgb::new(r, g, b)
}
/// A short-hand constructor for `LinSrgba::new`.
pub fn lin_srgba<T>(r: T, g: T, b: T, a: T) -> LinSrgba<T>
where
T: Component,
{
LinSrgba::new(r, g, b, a)
}
/// Create a new color from a hexadecimal int literal
#[inline]
pub fn rgb_u32(c: u32) -> Rgb<u8> {
let blue: u8 = (c & 0xFF) as u8;
let green: u8 = ((c >> 8) & 0xFF) as u8;
let red: u8 = ((c >> 16) & 0xFF) as u8;
rgb8(red, green, blue)
}
/// A short-hand constructor for `Hsl::new(RgbHue::from_degrees(h * 360.0), s, l)`.
///
/// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
/// 360 degrees (or 2 PI radians).
pub fn hsl(h: f32, s: f32, l: f32) -> Hsl {
Hsl::new(RgbHue::from_degrees(h * 360.0), s, l)
}
/// A short-hand constructor for `Hsla::new(RgbHue::from_degrees(h * 360.0), s, l, a)`.
///
/// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
/// 360 degrees (or 2 PI radians).
pub fn hsla(h: f32, s: f32, l: f32, a: f32) -> Hsla {
Hsla::new(RgbHue::from_degrees(h * 360.0), s, l, a)
}
/// A short-hand constructor for `Hsv::new(RgbHue::from_degrees(h * 360.0), s, v)`.
///
/// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
/// 360 degrees (or 2 PI radians).
pub fn hsv(h: f32, s: f32, v: f32) -> Hsv {
Hsv::new(RgbHue::from_degrees(h * 360.0), s, v)
}
/// A short-hand constructor for `Hsva::new(RgbHue::from_degrees(h * 360.0), s, v, a)`.
///
/// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
/// 360 degrees (or 2 PI radians).
pub fn hsva(h: f32, s: f32, v: f32, a: f32) -> Hsva {
Hsva::new(RgbHue::from_degrees(h * 360.0), s, v, a)
}
/// A short-hand constructor for `Gray::new`.
pub fn gray<T>(g: T) -> Gray<T>
where
T: Component,
{
srgb(g, g, g)
}
#[test]
fn test_rgb_u32() {
assert_eq!(rgb_u32(0xFF8000), rgb8(255, 128, 0));
}