Struct terminal_colorsaurus::Color

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

r: u16

Red

g: u16

Green

b: u16

Blue

Implementations

impl Color

pub fn perceived_lightness(&self) -> u8

The perceived lightness of the color as a value between 0 (black) and 100 (white) where 50 is the perceptual “middle grey”.

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

Examples found in repository

examples/theme.rs (line 18)

fn main() -> Result<(), Box<dyn Error>> {
    let colors = color_scheme(QueryOptions::default())?;

    let theme = if colors.is_light_on_dark() {
        "light on dark"
    } else {
        "dark on 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 { r: u16::MAX, g: u16::MAX, b: u16::MAX };
assert_eq!((u8::MAX, u8::MAX, u8::MAX), white.scale_to_8bit());

let black = Color { r: 0, g: 0, b: 0 };
assert_eq!((0, 0, 0), black.scale_to_8bit());

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy 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<RGB<u16>> for Color

Available on crate feature rgb only.

fn from(value: RGB16) -> Self

Converts to this type from the input type.

impl PartialEq for Color

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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