Enum ProcessColor 

pub enum ProcessColor {
    Luma(Alpha<Luma, f32>),
    Oklab(Alpha<Oklab, f32>),
    Oklch(Alpha<Oklch, f32>),
    Rgb(Alpha<Rgb, f32>),
    LinearRgb(Alpha<Rgb<Linear<Srgb>>, f32>),
    Cmyk(Cmyk),
    Hsl(Alpha<Hsl, f32>),
    Hsv(Alpha<Hsv, f32>),
}

Colors with a well-defined color space.

Variants

Luma(Alpha<Luma, f32>)

A 32-bit luma color.

Oklab(Alpha<Oklab, f32>)

A 32-bit L*a*b* color in the Oklab color space.

Oklch(Alpha<Oklch, f32>)

A 32-bit LCh color in the Oklab color space.

Rgb(Alpha<Rgb, f32>)

A 32-bit RGB color.

LinearRgb(Alpha<Rgb<Linear<Srgb>>, f32>)

A 32-bit linear RGB color.

Cmyk(Cmyk)

A 32-bit CMYK color.

Hsl(Alpha<Hsl, f32>)

A 32-bit HSL color.

Hsv(Alpha<Hsv, f32>)

A 32-bit HSV color.

Implementations

impl ProcessColor

pub fn components(self, alpha: bool) -> Array

Extracts the components of this color.

pub fn to_hex(&self) -> EcoString

Returns the color’s RGB(A) hex representation.

pub fn space(self) -> ProcessColorSpace

Returns the constructor function for this color’s space.

pub fn lighten(self, factor: Ratio) -> ProcessColor

Lightens a color by a given factor.

pub fn darken(self, factor: Ratio) -> ProcessColor

Darkens a color by a given factor.

pub fn saturate( self, span: Span, factor: Ratio, ) -> Result<ProcessColor, EcoVec<SourceDiagnostic>>

Increases the saturation of a color by a given factor.

pub fn desaturate( self, span: Span, factor: Ratio, ) -> Result<ProcessColor, EcoVec<SourceDiagnostic>>

Decreases the saturation of a color by a given factor.

pub fn negate(self, space: ProcessColorSpace) -> ProcessColor

Produces the complementary color using a provided color space.

pub fn from_u8(r: u8, g: u8, b: u8, a: u8) -> ProcessColor

Construct a new RGBA color from 8-bit values.

pub fn from_u32(color: u32) -> ProcessColor

Converts a 32-bit integer to an RGBA color.

pub fn alpha(self) -> Option<f32>

Returns the alpha channel of the color, if it has one.

pub fn with_alpha(self, alpha: f32) -> ProcessColor

Sets the alpha channel of the color, if it has one.

pub fn to_vec4(self) -> [f32; 4]

Converts the color to a vec of four floats.

pub fn to_vec4_u8(&self) -> [u8; 4]

Converts the color to a vec of four u8s.

pub fn to_space(&self, space: ProcessColorSpace) -> ProcessColor

pub fn to_luma(self) -> Alpha<Luma, f32>

pub fn to_oklab(self) -> Alpha<Oklab, f32>

pub fn to_oklch(self) -> Alpha<Oklch, f32>

pub fn to_rgb(self) -> Alpha<Rgb, f32>

pub fn to_linear_rgb(self) -> Alpha<Rgb<Linear<Srgb>>, f32>

pub fn to_cmyk(self) -> Cmyk

pub fn to_hsl(self) -> Alpha<Hsl, f32>

pub fn to_hsv(self) -> Alpha<Hsv, f32>

Trait Implementations

impl Clone for ProcessColor

fn clone(&self) -> ProcessColor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProcessColor

impl Debug for ProcessColor

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

Formats the value using the given formatter.

impl Eq for ProcessColor

impl From<Alpha<Hsl, f32>> for ProcessColor

fn from(c: Alpha<Hsl, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Hsv, f32>> for ProcessColor

fn from(c: Alpha<Hsv, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Luma, f32>> for ProcessColor

fn from(c: Alpha<Luma, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Oklab, f32>> for ProcessColor

fn from(c: Alpha<Oklab, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Oklch, f32>> for ProcessColor

fn from(c: Alpha<Oklch, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Rgb, f32>> for ProcessColor

fn from(c: Alpha<Rgb, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Alpha<Rgb<Linear<Srgb>>, f32>> for ProcessColor

fn from(c: Alpha<Rgb<Linear<Srgb>>, f32>) -> ProcessColor

Converts to this type from the input type.

impl From<Cmyk> for ProcessColor

fn from(c: Cmyk) -> ProcessColor

Converts to this type from the input type.

impl FromStr for ProcessColor

fn from_str( hex_str: &str, ) -> Result<ProcessColor, <ProcessColor as FromStr>::Err>

Constructs a new color from hex strings like the following:

• #aef (shorthand, with leading hash),
• 7a03c2 (without alpha),
• abcdefff (with alpha).

The hash is optional and both lower and upper case are fine.

type Err = &'static str

The associated error which can be returned from parsing.

impl FromValue for ProcessColor

fn from_value(value: Value) -> Result<ProcessColor, HintedString>

Try to cast the value into an instance of Self.

impl Hash for ProcessColor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 IntoValue for ProcessColor

fn into_value(self) -> Value

Cast this type into a value.

impl PartialEq for ProcessColor

fn eq(&self, other: &ProcessColor) -> 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 Reflect for ProcessColor

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for ProcessColor

fn repr(&self) -> EcoString

Return the debug representation of the value.