Struct Color 

pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

A color represented as RGB components. All values are compile-time constants with zero runtime cost.

Ordering is lexicographic by (r, g, b).

Fields

r: u8

Red component (0–255).

g: u8

Green component (0–255).

b: u8

Blue component (0–255).

Implementations

impl Color

pub const fn new(r: u8, g: u8, b: u8) -> Self

Construct a Color from RGB components.

Examples

use chromata::Color;

let red = Color::new(255, 0, 0);
assert_eq!(red.r, 255);
assert_eq!(red.g, 0);

pub const fn from_hex(hex: u32) -> Self

Construct a Color from a 24-bit hex value (0xRRGGBB).

Examples

use chromata::Color;

let c = Color::from_hex(0x1d2021);
assert_eq!(c.r, 0x1d);
assert_eq!(c.g, 0x20);
assert_eq!(c.b, 0x21);

pub const fn from_css_hex(s: &str) -> Option<Color>

Construct a Color by parsing a CSS hex string.

Accepts 6-digit ("#1d2021", "1d2021") and 3-digit shorthand ("#FFF", "FFF") formats. The 3-digit form expands each digit (e.g., #ABC becomes #AABBCC).

Returns None if the string is not a valid hex color.

Examples

use chromata::Color;

let c = Color::from_css_hex("#1d2021").unwrap();
assert_eq!(c, Color::from_hex(0x1d2021));

let c = Color::from_css_hex("1d2021").unwrap();
assert_eq!(c, Color::from_hex(0x1d2021));

let c = Color::from_css_hex("#FFF").unwrap();
assert_eq!(c, Color::new(255, 255, 255));

assert!(Color::from_css_hex("nope").is_none());

pub const fn to_hex(self) -> u32

Return the color as a 24-bit hex value.

Examples

use chromata::Color;

let c = Color::new(0x1d, 0x20, 0x21);
assert_eq!(c.to_hex(), 0x1d2021);

pub fn to_css_hex(self) -> String

Return the color as a CSS hex string like “#1d2021”.

Examples

use chromata::Color;

let c = Color::from_hex(0x1d2021);
assert_eq!(c.to_css_hex(), "#1d2021");

pub const fn to_f32(self) -> (f32, f32, f32)

Convert to an (f32, f32, f32) tuple in [0.0, 1.0] range.

Examples

use chromata::Color;

let white = Color::new(255, 255, 255);
let (r, g, b) = white.to_f32();
assert!((r - 1.0).abs() < f32::EPSILON);

pub fn from_f32(r: f32, g: f32, b: f32) -> Self

Construct a Color from normalized [0.0, 1.0] RGB components.

Values are clamped to [0.0, 1.0] and rounded to the nearest u8. NaN is treated as 0.0.

Examples

use chromata::Color;

let c = Color::from_f32(1.0, 0.5, 0.0);
assert_eq!(c, Color::new(255, 128, 0));

pub fn luminance(self) -> f64

Relative luminance per WCAG 2.0.

Returns a value between 0.0 (black) and 1.0 (white).

Examples

use chromata::Color;

let black = Color::new(0, 0, 0);
let white = Color::new(255, 255, 255);
assert!((black.luminance()).abs() < 0.001);
assert!((white.luminance() - 1.0).abs() < 0.001);

pub fn contrast_ratio(self, other: Color) -> f64

WCAG contrast ratio between two colors.

Returns a value between 1.0 (identical) and 21.0 (black vs white).

Examples

use chromata::Color;

let black = Color::new(0, 0, 0);
let white = Color::new(255, 255, 255);
let ratio = black.contrast_ratio(white);
assert!(ratio > 20.0); // ~21:1 for black/white

pub fn lerp(self, other: Color, t: f32) -> Color

Linear interpolation between two colors.

t is clamped to [0.0, 1.0]. Interpolation is performed in sRGB space.

Examples

use chromata::Color;

let black = Color::new(0, 0, 0);
let white = Color::new(255, 255, 255);
let mid = black.lerp(white, 0.5);
assert_eq!(mid, Color::new(127, 127, 127));

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Color

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Color

Default Color is black (0, 0, 0).

Examples

use chromata::Color;

assert_eq!(Color::default(), Color::new(0, 0, 0));

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Color

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<[u8; 3]> for Color

Construct a Color from an [r, g, b] array.

Examples

use chromata::Color;

let c: Color = [29, 32, 33].into();
assert_eq!(c, Color::new(29, 32, 33));

fn from([r, g, b]: [u8; 3]) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8)> for Color

Construct a Color from an (r, g, b) tuple.

Examples

use chromata::Color;

let c: Color = (29, 32, 33).into();
assert_eq!(c, Color::new(29, 32, 33));

fn from((r, g, b): (u8, u8, u8)) -> Self

Converts to this type from the input type.

impl From<Color> for [u8; 3]

Extract the [r, g, b] components from a Color.

Examples

use chromata::Color;

let arr: [u8; 3] = Color::new(29, 32, 33).into();
assert_eq!(arr, [29, 32, 33]);

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for (u8, u8, u8)

Extract the (r, g, b) components from a Color.

Examples

use chromata::Color;

let (r, g, b): (u8, u8, u8) = Color::new(29, 32, 33).into();
assert_eq!((r, g, b), (29, 32, 33));

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature colored-integration only.

Convert a chromata Color to a colored TrueColor.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature comfy-table-integration only.

Convert a chromata Color to a comfy-table RGB color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature crossterm-integration only.

Convert a chromata Color to a crossterm RGB color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature cursive-integration only.

Convert a chromata Color to a cursive RGB color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature iced-integration only.

Convert a chromata Color to an iced RGBA color (alpha = 1.0).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature macroquad-integration only.

Convert a chromata Color to a macroquad RGBA color (alpha = 1.0).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature ratatui-integration only.

Convert a chromata Color to a ratatui RGB color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature slint-integration only.

Convert a chromata Color to a Slint RGB color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature syntect-integration only.

Convert a chromata Color to a syntect RGBA color (alpha = 255).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature wgpu-integration only.

Convert a chromata Color to a wgpu RGBA color (alpha = 1.0).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color32

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature egui-integration only.

Convert a chromata Color to an egui Color32.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for PremultipliedColorU8

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature tiny-skia-integration only.

Convert a chromata Color to a tiny-skia premultiplied RGBA color (alpha = 255).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RGBColor

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature plotters-integration only.

Convert a chromata Color to a plotters RGBColor.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Rgb

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature owo-colors-integration only.

Convert a chromata Color to an owo-colors Rgb.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Srgb<u8>

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature palette-integration only.

Convert a chromata Color to a palette sRGB color with u8 components.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Rgb<u8>

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature image-integration only.

Convert a chromata Color to an image Rgb pixel.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Rgb

Available on Unix and crate feature termion-integration and (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) only.

Convert a chromata Color to a termion Rgb color.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Srgba

Available on (crate features bevy-color-integration or colored-integration or comfy-table-integration or crossterm-integration or cursive-integration or egui-integration or iced-integration or image-integration or macroquad-integration or owo-colors-integration or palette-integration or plotters-integration or ratatui-integration or slint-integration or syntect-integration or termion-integration or tiny-skia-integration or wgpu-integration) and crate feature bevy-color-integration only.

Convert a chromata Color to a Bevy sRGBA color (alpha = 1.0).

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for u32

Extract the 24-bit hex value from a Color.

Examples

use chromata::Color;

let v: u32 = Color::from_hex(0x1d2021).into();
assert_eq!(v, 0x1d2021);

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<u32> for Color

Construct a Color from a 24-bit hex value (0xRRGGBB).

Only the lower 24 bits are used; upper bits are silently ignored.

Examples

use chromata::Color;

let c: Color = 0x1d2021u32.into();
assert_eq!(c, Color::from_hex(0x1d2021));

fn from(hex: u32) -> Self

Converts to this type from the input type.

impl FromStr for Color

Parse a CSS hex color string like "#1d2021", "1d2021", "#FFF", or "FFF".

Examples

use chromata::Color;

let c: Color = "#1d2021".parse().unwrap();
assert_eq!(c, Color::from_hex(0x1d2021));

type Err = ParseColorError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Color

fn cmp(&self, other: &Color) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Color

fn eq(&self, other: &Color) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Color

fn partial_cmp(&self, other: &Color) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Color

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color