Struct Scheme

pub struct Scheme {

    pub white: [Color; 4],
    pub black: [Color; 4],
    pub gray: [Color; 4],
    pub red: [Color; 4],
    pub orange: [Color; 4],
    pub yellow: [Color; 4],
    pub limegreen: [Color; 4],
    pub green: [Color; 4],
    pub bluegreen: [Color; 4],
    pub cyan: [Color; 4],
    pub blue: [Color; 4],
    pub deepblue: [Color; 4],
    pub purple: [Color; 4],
    pub magenta: [Color; 4],
    pub redpink: [Color; 4],
    pub primary: [Color; 4],
    pub secondary: [Color; 4],
}

Color scheme.

This provides the palette used for a theme.

The ideas packed in here are

• provide two colors for highlighting and accents.
• I always want some white, black and gray.
• I don’t want to miss out anything, so go once round the hue in HSV. Take steps of 30° then we hit pretty much anything interesting.
• Just one variant of each color is not enough, make it 4.

Fields

white: [Color; 4]

black: [Color; 4]

gray: [Color; 4]

red: [Color; 4]

orange: [Color; 4]

yellow: [Color; 4]

limegreen: [Color; 4]

green: [Color; 4]

bluegreen: [Color; 4]

cyan: [Color; 4]

blue: [Color; 4]

deepblue: [Color; 4]

purple: [Color; 4]

magenta: [Color; 4]

redpink: [Color; 4]

primary: [Color; 4]

secondary: [Color; 4]

Implementations

impl Scheme

pub fn white(&self, n: usize) -> Style

Create a style from the given white shade. n is 0..=3

pub fn black(&self, n: usize) -> Style

Create a style from the given black shade. n is 0..=3

pub fn gray(&self, n: usize) -> Style

Create a style from the given gray shade. n is 0..=3

pub fn red(&self, n: usize) -> Style

Create a style from the given red shade. n is 0..=3

pub fn orange(&self, n: usize) -> Style

Create a style from the given orange shade. n is 0..=3

pub fn yellow(&self, n: usize) -> Style

Create a style from the given yellow shade. n is 0..=3

pub fn limegreen(&self, n: usize) -> Style

Create a style from the given limegreen shade. n is 0..=3

pub fn green(&self, n: usize) -> Style

Create a style from the given green shade. n is 0..=3

pub fn bluegreen(&self, n: usize) -> Style

Create a style from the given bluegreen shade. n is 0..=3

pub fn cyan(&self, n: usize) -> Style

Create a style from the given cyan shade. n is 0..=3

pub fn blue(&self, n: usize) -> Style

Create a style from the given blue shade. n is 0..=3

pub fn deepblue(&self, n: usize) -> Style

Create a style from the given deepblue shade. n is 0..=3

pub fn purple(&self, n: usize) -> Style

Create a style from the given purple shade. n is 0..=3

pub fn magenta(&self, n: usize) -> Style

Create a style from the given magenta shade. n is 0..=3

pub fn redpink(&self, n: usize) -> Style

Create a style from the given redpink shade. n is 0..=3

pub fn primary(&self, n: usize) -> Style

Create a style from the given primary shade. n is 0..=3

pub fn secondary(&self, n: usize) -> Style

Create a style from the given secondary shade. n is 0..=3

impl Scheme

pub fn true_dark_white(&self, n: usize) -> Style

Create a style from the given white shade. n is 0..=3

pub fn true_dark_black(&self, n: usize) -> Style

Create a style from the given black shade. n is 0..=3

pub fn true_dark_gray(&self, n: usize) -> Style

Create a style from the given gray shade. n is 0..=3

pub fn true_dark_red(&self, n: usize) -> Style

Create a style from the given red shade. n is 0..=3

pub fn true_dark_orange(&self, n: usize) -> Style

Create a style from the given orange shade. n is 0..=3

pub fn true_dark_yellow(&self, n: usize) -> Style

Create a style from the given yellow shade. n is 0..=3

pub fn true_dark_limegreen(&self, n: usize) -> Style

Create a style from the given limegreen shade. n is 0..=3

pub fn true_dark_green(&self, n: usize) -> Style

Create a style from the given green shade. n is 0..=3

pub fn true_dark_bluegreen(&self, n: usize) -> Style

Create a style from the given bluegreen shade. n is 0..=3

pub fn true_dark_cyan(&self, n: usize) -> Style

Create a style from the given cyan shade. n is 0..=3

pub fn true_dark_blue(&self, n: usize) -> Style

Create a style from the given blue shade. n is 0..=3

pub fn true_dark_deepblue(&self, n: usize) -> Style

Create a style from the given deepblue shade. n is 0..=3

pub fn true_dark_purple(&self, n: usize) -> Style

Create a style from the given purple shade. n is 0..=3

pub fn true_dark_magenta(&self, n: usize) -> Style

Create a style from the given magenta shade. n is 0..=3

pub fn true_dark_redpink(&self, n: usize) -> Style

Create a style from the given redpink shade. n is 0..=3

pub fn true_dark_primary(&self, n: usize) -> Style

Create a style from the given primary shade. n is 0..=3

pub fn true_dark_secondary(&self, n: usize) -> Style

Create a style from the given secondary shade. n is 0..=3

impl Scheme

pub fn reduced_white(&self, n: usize) -> Style

Create a style from the given white shade. n is 0..=3

pub fn reduced_black(&self, n: usize) -> Style

Create a style from the given black shade. n is 0..=3

pub fn reduced_gray(&self, n: usize) -> Style

Create a style from the given gray shade. n is 0..=3

pub fn reduced_red(&self, n: usize) -> Style

Create a style from the given red shade. n is 0..=3

pub fn reduced_orange(&self, n: usize) -> Style

Create a style from the given orange shade. n is 0..=3

pub fn reduced_yellow(&self, n: usize) -> Style

Create a style from the given yellow shade. n is 0..=3

pub fn reduced_limegreen(&self, n: usize) -> Style

Create a style from the given limegreen shade. n is 0..=3

pub fn reduced_green(&self, n: usize) -> Style

Create a style from the given green shade. n is 0..=3

pub fn reduced_bluegreen(&self, n: usize) -> Style

Create a style from the given bluegreen shade. n is 0..=3

pub fn reduced_cyan(&self, n: usize) -> Style

Create a style from the given cyan shade. n is 0..=3

pub fn reduced_blue(&self, n: usize) -> Style

Create a style from the given blue shade. n is 0..=3

pub fn reduced_deepblue(&self, n: usize) -> Style

Create a style from the given deepblue shade. n is 0..=3

pub fn reduced_purple(&self, n: usize) -> Style

Create a style from the given purple shade. n is 0..=3

pub fn reduced_magenta(&self, n: usize) -> Style

Create a style from the given magenta shade. n is 0..=3

pub fn reduced_redpink(&self, n: usize) -> Style

Create a style from the given redpink shade. n is 0..=3

pub fn reduced_primary(&self, n: usize) -> Style

Create a style from the given primary shade. n is 0..=3

pub fn reduced_secondary(&self, n: usize) -> Style

Create a style from the given secondary shade. n is 0..=3

impl Scheme

pub fn style(&self, color: Color) -> Style

Create a style with the given background color. Foreground is calculated with text_color.

pub fn reduced_style(&self, color: Color) -> Style

Create a style with the given background color. Foreground is calculated with reduced_text_color.

pub fn true_dark_style(&self, color: Color) -> Style

Create a style with the given background color converted with true_dark_color(). Foreground is calculated with text_color.

pub fn reduced_dark_style(&self, color: Color) -> Style

Create a style with the given background color. converted with true_dark_color(). Foreground is calculated with reduced_text_color.

pub const fn linear4(c0: u32, c1: u32) -> [Color; 4]

Linear interpolation between the two colors.

pub fn true_dark_color(&self, color: Color) -> Color

Reduces the range of the given color from 0..255 to 0..63.

This gives a true dark equivalent which can be used as a background for a dark theme.

pub fn grey_color(&self, color: Color) -> Color

Converts the given color to an equivalent grayscale.

pub fn text_color(&self, color: Color) -> Color

This gives back white[3] or black[0] for text foreground providing good contrast to the given background.

This converts RGB to grayscale and takes the grayscale value of VGA cyan as threshold, which is about 105 out of 255. This point is a bit arbitrary, just based on what I perceive as acceptable. But it produces a good reading contrast in my experience.

For the named colors it takes the VGA equivalent as a base. For indexed colors it splits the range in half as an estimate.

pub fn reduced_text_color(&self, color: Color) -> Color

This gives back white[3] or black[0] for text foreground providing good contrast to the given background.

This converts RGB to grayscale and takes the grayscale value of VGA cyan as threshold, which is about 105 out of 255. This point is a bit arbitrary, just based on what I perceive as acceptable. But it produces a good reading contrast in my experience.

For the named colors it takes the VGA equivalent as a base. For indexed colors it splits the range in half as an estimate.

pub fn rate_text_color(&self, color: Color) -> Option<bool>

This gives back true or false for text foreground where true means light and false means a dark text-color providing good contrast to the given background.

This converts RGB to grayscale and takes the grayscale value of VGA cyan as threshold, which is about 105 out of 255. This point is a bit arbitrary, just based on what I perceive as acceptable. But it produces a good reading contrast in my experience.

For the named colors it takes the VGA equivalent as a base. For indexed colors it splits the range in half as an estimate.

Trait Implementations

impl Clone for Scheme

fn clone(&self) -> Scheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scheme

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

Formats the value using the given formatter.

impl Default for Scheme

fn default() -> Scheme

Returns the “default value” for a type.