Enum druid::Color

pub enum Color {
    Rgba32(u32),
}

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.

Variants

Rgba32(u32)

Implementations

impl Color

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

Create a color from 8 bit per sample RGB values.

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

Create a color from 8 bit per sample RGBA values.

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

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

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());

pub fn grey(grey: impl Into<f64>) -> Color

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

pub fn rgba<F>(r: F, g: F, b: F, a: F) -> Color where
    F: Into<f64>, 

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.

pub fn rgb<F>(r: F, g: F, b: F) -> Color where
    F: Into<f64>, 

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.

pub fn hlc<F>(h: F, l: F, c: F) -> Color where
    F: Into<f64>, 

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.

pub fn hlca<F>(h: F, l: F, c: F, a: impl Into<f64>) -> Color where
    F: Into<f64>, 

Create a color from a CIEL*a*b* polar specification and alpha.

The a value represents alpha in the range 0.0 to 1.0.

pub fn with_alpha(self, a: impl Into<f64>) -> Color

Change just the alpha value of a color.

The a value represents alpha in the range 0.0 to 1.0.

pub fn as_rgba_u32(&self) -> u32

Convert a color value to a 32-bit rgba value.

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

Convert a color value to four 8-bit rgba values.

pub fn as_rgba(&self) -> (f64, f64, f64, f64)

Convert a color value to four f64 values, each in the range 0.0 to 1.0.

pub const WHITE: Color

Opaque white.

pub const BLACK: Color

Opaque black.

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 Data for Color

fn same(&self, other: &Self) -> bool

Determine whether two values are the same.

impl Debug for Color

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

Formats the value using the given formatter.

impl From<Color> for PaintBrush

fn from(src: Color) -> PaintBrush

Performs the conversion.

impl<T> From<Color> for BackgroundBrush<T>

fn from(src: Color) -> BackgroundBrush<T>

Performs the conversion.

impl Into<Value> for Color

fn into(self) -> Value

Performs the conversion.

impl<P> IntoBrush<P> for Color where
    P: RenderContext, 

fn make_brush(
    &'a self,
    piet: &mut P,
    _bbox: impl FnOnce() -> Rect
) -> Cow<'a, <P as RenderContext>::Brush>

impl<'a> ValueType<'a> for Color

type Owned = Color

The corresponding owned type.

fn try_from_value(value: &Value) -> Result<Self, ValueTypeError>

Attempt to convert the generic Value into this type.