Enum Color

Source

#[non_exhaustive]pub enum Color {
}

Expand description

A datatype representing color.

Currently this is only a 32 bit RGBA value, but it will likely extend to some form of wide-gamut colorspace, and in the meantime is useful for giving programs proper type.

Implementations§

Source §

impl Color

Source

pub const AQUA: Color

Opaque aqua (or cyan).

Source

pub const BLACK: Color

Opaque black.

Source

pub const BLUE: Color

Opaque blue.

Source

pub const GRAY: Color

Opaque gray.

Source

pub const GREEN: Color

Opaque green.

Source

pub const LIME: Color

Opaque lime.

Source

pub const MAROON: Color

Opaque maroon.

Source

pub const NAVY: Color

Opaque navy.

Source

pub const OLIVE: Color

Opaque olive.

Source

pub const PURPLE: Color

Opaque purple.

Source

pub const RED: Color

Opaque red.

Source

pub const SILVER: Color

Opaque silver.

Source

pub const TEAL: Color

Opaque teal.

Source

pub const WHITE: Color

Opaque white.

Source

pub const YELLOW: Color

Opaque yellow.

Source

pub const fn rgb8(r: u8, g: u8, b: u8) -> Color

Create a color from 8 bit per sample RGB values.

Source

pub const fn rgba8(r: u8, g: u8, b: u8, a: u8) -> Color

Create a color from 8 bit per sample RGBA values.

Source

pub const fn from_rgba32_u32(rgba: u32) -> Color

Create a color from a 32-bit rgba value (alpha as least significant byte).

Source

pub const fn from_hex_str(hex: &str) -> Result<Color, ColorParseError>

Attempt to create a color from a CSS-style hex string.

This will accept strings in the following formats, with or without the leading #:

rrggbb
rrggbbaa
rbg
rbga

This method returns a ColorParseError if the color cannot be parsed.

Source

pub const fn grey8(grey: u8) -> Color

Create a color from a grey value.

use piet::Color;

let grey_val = 0x55;

let one = Color::grey8(grey_val);
// is shorthand for
let two = Color::rgb8(grey_val, grey_val, grey_val);

assert_eq!(one.as_rgba_u32(), two.as_rgba_u32());

Source

pub fn grey(grey: f64) -> Color

Create a color with a grey value in the range 0.0..=1.0.

Source

pub fn rgba(r: f64, g: f64, b: f64, a: f64) -> Color

Create a color from four floating point values, each in the range 0.0 to 1.0.

The interpretation is the same as rgba32, and no greater precision is (currently) assumed.

Source

pub fn rgb(r: f64, g: f64, b: f64) -> Color

Create a color from three floating point values, each in the range 0.0 to 1.0.

The interpretation is the same as rgb8, and no greater precision is (currently) assumed.

Source

pub fn hlc(h: f64, L: f64, c: f64) -> Color

Create a color from a CIEL*a*b* polar (also known as CIE HCL) specification.

The h parameter is an angle in degrees, with 0 roughly magenta, 90 roughly yellow, 180 roughly cyan, and 270 roughly blue. The l parameter is perceptual luminance, with 0 black and 100 white. The c parameter is a chrominance concentration, with 0 grayscale and a nominal maximum of 127 (in the future, higher values might be useful, for high gamut contexts).

Currently this is just converted into sRGB, but in the future as we support high-gamut colorspaces, it can be used to specify more colors or existing colors with a higher accuracy.

Currently out-of-gamut values are clipped to the nearest sRGB color, which is perhaps not ideal (the clipping might change the hue). See https://github.com/d3/d3-color/issues/33 for discussion.

Source