Struct Color

#[non_exhaustive]
pub struct Color {
    pub r: u16,
    pub g: u16,
    pub b: u16,
}

An RGB color with 16 bits per channel. You can use Color::scale_to_8bit to convert to an 8bit RGB color.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

r: u16

Red

g: u16

Green

b: u16

Blue

Implementations

impl Color

pub fn rgb(r: u16, g: u16, b: u16) -> Self

Creates a RGB color from its three channels: Red, Green and Blue.

pub fn perceived_lightness(&self) -> f32

Perceptual lightness (L*) as a value between 0.0 (black) and 1.0 (white) where 0.5 is the perceptual middle gray.

Note that the color’s alpha is ignored.

let is_dark = color.perceived_lightness() <= 0.5;

Examples found in repository

examples/theme.rs (line 16)

fn main() -> Result<(), display::DisplayAsDebug<Error>> {
    let colors = color_palette(QueryOptions::default())?;

    let theme = match colors.theme_mode() {
        ThemeMode::Dark => "dark",
        ThemeMode::Light => "light",
    };

    println!(
        "{theme}, fg: {}, bg: {}",
        colors.foreground.perceived_lightness(),
        colors.background.perceived_lightness()
    );

    Ok(())
}

pub fn scale_to_8bit(&self) -> (u8, u8, u8)

Converts the color to 8 bit precision per channel by scaling each channel.

let white = Color::rgb(u16::MAX, u16::MAX, u16::MAX);
assert_eq!((u8::MAX, u8::MAX, u8::MAX), white.scale_to_8bit());

let black = Color::rgb(0, 0, 0);
assert_eq!((0, 0, 0), black.scale_to_8bit());

Examples found in repository

examples/bg.rs (line 7)

fn main() -> Result<(), display::DisplayAsDebug<Error>> {
    let bg = background_color(QueryOptions::default())?;
    let bg_8bit = bg.scale_to_8bit();
    println!("rgb16({}, {}, {})", bg.r, bg.g, bg.b);
    println!("rgb8({}, {}, {})", bg_8bit.0, bg_8bit.1, bg_8bit.2);
    Ok(())
}

examples/fg.rs (line 7)

fn main() -> Result<(), display::DisplayAsDebug<Error>> {
    let fg = foreground_color(QueryOptions::default())?;
    let fg_8bit = fg.scale_to_8bit();
    println!("rgb16({}, {}, {})", fg.r, fg.g, fg.b);
    println!("rgb8({}, {}, {})", fg_8bit.0, fg_8bit.1, fg_8bit.2);
    Ok(())
}

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

fn default() -> Color

Returns the “default value” for a type.

impl From<Color> for RGB16

Available on crate feature rgb only.

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RGB8

Available on crate feature rgb only.

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RgbColor

Available on crate feature anstyle only.

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Rgb<u16>> for Color

Available on crate feature rgb only.

fn from(value: RGB16) -> Self

Converts to this type from the input 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 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 Eq for Color

impl StructuralPartialEq for Color