Struct nannou::color::Lch

pub struct Lch<T = f32> where
    T: Float,  {
    pub l: T,
    pub chroma: T,
    pub hue: LabHue<T>,
}

CIE LCh°, a polar version of CIE Lab*.

LCh° shares its range and perceptual uniformity with Lab*, but it's a cylindrical color space, like HSL and HSV. This gives it the same ability to directly change the hue and colorfulness of a color, while preserving other visual aspects.

Fields

l: T

L* is the lightness of the color. 0.0 gives absolute black and 1.0 give the brightest white.

chroma: T

C* is the colorfulness of the color. It's similar to saturation. 0.0 gives gray scale colors, and numbers around 1.0-1.41421356 gives fully saturated colors. The upper limit of 1.41421356 (or sqrt(2.0)) should include the whole Lab* space and some more.

hue: LabHue<T>

The hue of the color, in degrees. Decides if it's red, blue, purple, etc.

Methods

impl<T> Lch<T> where
    T: Float, 

pub fn new(l: T, chroma: T, hue: LabHue<T>) -> Lch<T>

CIE LCh°.

Trait Implementations

impl<T> IntoColor<T> for Lch<T> where
    T: Float, 

fn into_xyz(self) -> Xyz<T>

Convert into XYZ space

fn into_yxy(self) -> Yxy<T>

Convert into Yxy color space

fn into_lab(self) -> Lab<T>

Convert into Lab* color space

fn into_lch(self) -> Lch<T>

Convert into LCh° color space

fn into_rgb(self) -> Rgb<T>

Convert into RGB color space.

fn into_hsl(self) -> Hsl<T>

Convert into HSL color space

fn into_hsv(self) -> Hsv<T>

Convert into HSV color space

fn into_luma(self) -> Luma<T>

Convert into Luma

fn into_hwb(self) -> Hwb<T>

Convert into HWB color space

impl<T> ApproxEq for Lch<T> where
    T: ApproxEq + Float,
    <T as ApproxEq>::Epsilon: Copy,
    <T as ApproxEq>::Epsilon: Float, 

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Lch<T> as ApproxEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn default_max_relative() -> <Lch<T> as ApproxEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Lch<T>,
    epsilon: <Lch<T> as ApproxEq>::Epsilon,
    max_relative: <Lch<T> as ApproxEq>::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn ulps_eq(
    &self,
    other: &Lch<T>,
    epsilon: <Lch<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn relative_ne(
    &self,
    other: &Lch<T>,
    epsilon: <Lch<T> as ApproxEq>::Epsilon,
    max_relative: <Lch<T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

fn ulps_ne(
    &self,
    other: &Lch<T>,
    epsilon: <Lch<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

The inverse of ApproxEq::ulps_eq.

impl<T> From<Lch<T>> for Hwb<T> where
    T: Float, 

fn from(other: Lch<T>) -> Hwb<T>

Performs the conversion.

impl<T> From<Alpha<Hsv<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Hsv<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Yxy<T>> for Lch<T> where
    T: Float, 

fn from(other: Yxy<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Hsl<T>> for Lch<T> where
    T: Float, 

fn from(other: Hsl<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Lch<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Hsv<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Hsv<T>, T>

Performs the conversion.

impl<T> From<Lch<T>> for Rgb<T> where
    T: Float, 

fn from(other: Lch<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Lch<T>> for Color<T> where
    T: Float, 

fn from(color: Lch<T>) -> Color<T>

Performs the conversion.

impl<T> From<Lab<T>> for Lch<T> where
    T: Float, 

fn from(other: Lab<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Hwb<T>> for Lch<T> where
    T: Float, 

fn from(other: Hwb<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Luma<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Luma<T>, T>

Performs the conversion.

impl<T> From<Alpha<Hsl<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Hsl<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Lab<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Lab<T>, T>

Performs the conversion.

impl<T> From<Lch<T>> for Yxy<T> where
    T: Float, 

fn from(other: Lch<T>) -> Yxy<T>

Performs the conversion.

impl<T> From<Luma<T>> for Lch<T> where
    T: Float, 

fn from(other: Luma<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Yxy<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Yxy<T>, T>

Performs the conversion.

impl<T> From<Lch<T>> for Xyz<T> where
    T: Float, 

fn from(other: Lch<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Rgb<T>> for Lch<T> where
    T: Float, 

fn from(other: Rgb<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Hsv<T> where
    T: Float, 

fn from(other: Lch<T>) -> Hsv<T>

Performs the conversion.

impl<T> From<Hsv<T>> for Lch<T> where
    T: Float, 

fn from(other: Hsv<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Xyz<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Xyz<T>, T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Hwb<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Hwb<T>, T>

Performs the conversion.

impl<T> From<Color<T>> for Lch<T> where
    T: Float, 

fn from(color: Color<T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Luma<T> where
    T: Float, 

fn from(other: Lch<T>) -> Luma<T>

Performs the conversion.

impl<T> From<Alpha<Lch<T>, T>> for Lch<T> where
    T: Float, 

fn from(color: Alpha<Lch<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Alpha<Lab<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Lab<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Alpha<Hwb<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Hwb<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Alpha<Luma<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Luma<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Hsl<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Hsl<T>, T>

Performs the conversion.

impl<T> From<Lch<T>> for Lab<T> where
    T: Float, 

fn from(other: Lch<T>) -> Lab<T>

Performs the conversion.

impl<T> From<Lch<T>> for Hsl<T> where
    T: Float, 

fn from(other: Lch<T>) -> Hsl<T>

Performs the conversion.

impl<T> From<Alpha<Xyz<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Xyz<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Alpha<Rgb<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Rgb<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> From<Lch<T>> for Alpha<Rgb<T>, T> where
    T: Float, 

fn from(color: Lch<T>) -> Alpha<Rgb<T>, T>

Performs the conversion.

impl<T> From<Alpha<Yxy<T>, T>> for Lch<T> where
    T: Float, 

fn from(other: Alpha<Yxy<T>, T>) -> Lch<T>

Performs the conversion.

impl<T> Limited for Lch<T> where
    T: Float, 

fn is_valid(&self) -> bool

Check if the color's components are within the expected ranges.

fn clamp(&self) -> Lch<T>

Return a new color where the components has been clamped to the nearest valid values.

fn clamp_self(&mut self)

Clamp the color's components to the nearest valid values.

impl<T> Default for Lch<T> where
    T: Float, 

fn default() -> Lch<T>

Returns the "default value" for a type.

impl<T> FromColor<T> for Lch<T> where
    T: Float, 

fn from_xyz(xyz: Xyz<T>) -> Lch<T>

Convert from XYZ color space

fn from_lab(lab: Lab<T>) -> Lch<T>

Convert from Lab* color space

fn from_lch(lch: Lch<T>) -> Lch<T>

Convert from LCh° color space

fn from_yxy(inp: Yxy<T>) -> Self

Convert from Yxy color space

fn from_rgb(inp: Rgb<T>) -> Self

Convert from RGB color space

fn from_hsl(inp: Hsl<T>) -> Self

Convert from HSL color space

fn from_hsv(inp: Hsv<T>) -> Self

Convert from HSV color space

fn from_hwb(inp: Hwb<T>) -> Self

Convert from HWB color space

fn from_luma(inp: Luma<T>) -> Self

Convert from Luma

impl<T> Shade for Lch<T> where
    T: Float, 

type Scalar = T

The type of the lighten/darken amount.

fn lighten(&self, amount: T) -> Lch<T>

Lighten the color by amount.

fn darken(&self, amount: Self::Scalar) -> Self

Darken the color by amount.

impl<T> Debug for Lch<T> where
    T: Debug + Float, 

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

Formats the value using the given formatter.

impl<T> Copy for Lch<T> where
    T: Copy + Float, 

impl<T> Mix for Lch<T> where
    T: Float, 

type Scalar = T

The type of the mixing factor.

fn mix(&self, other: &Lch<T>, factor: T) -> Lch<T>

Mix the color with an other color, by factor.

impl<T> PartialEq<Lch<T>> for Lch<T> where
    T: PartialEq<T> + Float, 

fn eq(&self, other: &Lch<T>) -> bool

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

fn ne(&self, other: &Lch<T>) -> bool

This method tests for !=.

impl<T> Add<Lch<T>> for Lch<T> where
    T: Float, 

type Output = Lch<T>

The resulting type after applying the + operator.

fn add(self, other: Lch<T>) -> Lch<T>

Performs the + operation.

impl<T> Add<T> for Lch<T> where
    T: Float, 

type Output = Lch<T>

The resulting type after applying the + operator.

fn add(self, c: T) -> Lch<T>

Performs the + operation.

impl<T> Hue for Lch<T> where
    T: Float, 

fn with_hue(&self, hue: LabHue<T>) -> Lch<T>

Return a new copy of self, but with a specific hue.

fn shift_hue(&self, amount: LabHue<T>) -> Lch<T>

Return a new copy of self, but with the hue shifted by amount.

impl<T> Sub<T> for Lch<T> where
    T: Float, 

type Output = Lch<T>

The resulting type after applying the - operator.

fn sub(self, c: T) -> Lch<T>

Performs the - operation.

impl<T> Sub<Lch<T>> for Lch<T> where
    T: Float, 

type Output = Lch<T>

The resulting type after applying the - operator.

fn sub(self, other: Lch<T>) -> Lch<T>

Performs the - operation.

impl<T> Saturate for Lch<T> where
    T: Float, 

type Scalar = T

The type of the (de)saturation factor.

fn saturate(&self, factor: T) -> Lch<T>

Increase the saturation by factor.

fn desaturate(&self, factor: Self::Scalar) -> Self

Decrease the saturation by factor.

impl<T> GetHue for Lch<T> where
    T: Float, 

type Hue = LabHue<T>

The kind of hue unit this color space uses.

fn get_hue(&self) -> Option<LabHue<T>>

Calculate a hue if possible.

impl<T> Clone for Lch<T> where
    T: Clone + Float, 

fn clone(&self) -> Lch<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> IntoRgba<S> for Lch<S> where
    S: Float + One, 

fn into_rgba(self) -> Rgba<S>

Convert self into RGBA.