Struct nannou::color::Lch

#[repr(C)]
pub struct Lch<Wp = D65, T = f32> where
    T: Component + Float,
    Wp: WhitePoint,  {
    pub l: T,
    pub chroma: T,
    pub hue: LabHue<T>,
    pub white_point: PhantomData<Wp>,
}

CIE L*C*h°, a polar version of CIE L*a*b*.

L*C*h° shares its range and perceptual uniformity with L*a*b*, 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 100.0 gives 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 128-181 gives fully saturated colors. The upper limit of 128 should include the whole L*a*b* space and some more.

hue: LabHue<T>

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

white_point: PhantomData<Wp>

The white point associated with the color's illuminant and observer. D65 for 2 degree observer is used by default.

Methods

impl<T> Lch<D65, T> where
    T: Component + Float, 

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

CIE L*C*h° with white point D65.

impl<Wp, T> Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

pub fn with_wp<H>(l: T, chroma: T, hue: H) -> Lch<Wp, T> where
    H: Into<LabHue<T>>, 

CIE L*C*h°.

pub fn into_components(self) -> (T, T, LabHue<T>)

Convert to a (L\*, C\*, h°) tuple.

pub fn from_components<H>((T, T, H)) -> Lch<Wp, T> where
    H: Into<LabHue<T>>, 

Convert from a (L\*, C\*, h°) tuple.

Trait Implementations

impl<Wp, T, P> AsRef<P> for Lch<Wp, T> where
    P: RawPixel<T> + ?Sized,
    T: Component + Float,
    Wp: WhitePoint, 

fn as_ref(&self) -> &P

Performs the conversion.

impl<Wp, T> Limited for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn is_valid(&self) -> bool

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

fn clamp(&self) -> Lch<Wp, 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<Wp, T> FromColor<Wp, T> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn from_xyz(color: Xyz<Wp, T>) -> Lch<Wp, T>

Convert from XYZ color space

fn from_lab(color: Lab<Wp, T>) -> Lch<Wp, T>

Convert from Lab* color space

fn from_lch(color: Lch<Wp, T>) -> Lch<Wp, T>

Convert from LCh° color space

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

Convert from Yxy color space

fn from_rgb<S>(inp: Rgb<Linear<S>, T>) -> Self where
    S: RgbSpace<WhitePoint = Wp>, 

Convert from RGB color space

fn from_hsl<S>(inp: Hsl<S, T>) -> Self where
    S: RgbSpace<WhitePoint = Wp>, 

Convert from HSL color space

fn from_hsv<S>(inp: Hsv<S, T>) -> Self where
    S: RgbSpace<WhitePoint = Wp>, 

Convert from HSV color space

fn from_hwb<S>(inp: Hwb<S, T>) -> Self where
    S: RgbSpace<WhitePoint = Wp>, 

Convert from HWB color space

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

Convert from Luma

impl<Wp, T> Saturate for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Scalar = T

The type of the (de)saturation factor.

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

Increase the saturation by factor.

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

Decrease the saturation by factor.

impl<Wp, T> IntoColor<Wp, T> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn into_xyz(self) -> Xyz<Wp, T>

Convert into XYZ space

fn into_yxy(self) -> Yxy<Wp, T>

Convert into Yxy color space

fn into_lab(self) -> Lab<Wp, T>

Convert into Lab* color space

fn into_lch(self) -> Lch<Wp, T>

Convert into LCh° color space

fn into_rgb<S>(self) -> Rgb<Linear<S>, T> where
    S: RgbSpace<WhitePoint = Wp>, 

Convert into RGB color space.

fn into_hsl<S>(self) -> Hsl<S, T> where
    S: RgbSpace<WhitePoint = Wp>, 

Convert into HSL color space

fn into_hsv<S>(self) -> Hsv<S, T> where
    S: RgbSpace<WhitePoint = Wp>, 

Convert into HSV color space

fn into_luma(self) -> Luma<Linear<Wp>, T>

Convert into Luma

fn into_hwb<S>(self) -> Hwb<S, T> where
    S: RgbSpace<WhitePoint = Wp>, 

Convert into HWB color space

impl<Wp, T> Mix for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

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

Formats the value using the given formatter.

impl<Wp, T> Shade for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<Wp, T> Add<T> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Output = Lch<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> Add<Lch<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Output = Lch<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

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

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

This method tests for !=.

impl<Wp, T> Sub<T> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Output = Lch<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> Sub<Lch<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

type Output = Lch<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> Into<(T, T, LabHue<T>)> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn into(self) -> (T, T, LabHue<T>)

Performs the conversion.

impl<Wp, T> Hue for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn with_hue<H>(&self, hue: H) -> Lch<Wp, T> where
    H: Into<<Lch<Wp, T> as GetHue>::Hue>, 

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

fn shift_hue<H>(&self, amount: H) -> Lch<Wp, T> where
    H: Into<<Lch<Wp, T> as GetHue>::Hue>, 

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

impl<Wp, T> GetHue for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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<Wp, T> ApproxEq for Lch<Wp, T> where
    T: Component + Float + ApproxEq,
    Wp: WhitePoint,
    <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<Wp, T> as ApproxEq>::Epsilon

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

fn default_max_relative() -> <Lch<Wp, 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<Wp, T>,
    epsilon: <Lch<Wp, T> as ApproxEq>::Epsilon,
    max_relative: <Lch<Wp, 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<Wp, T>,
    epsilon: <Lch<Wp, 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<Wp, T>,
    epsilon: <Lch<Wp, T> as ApproxEq>::Epsilon,
    max_relative: <Lch<Wp, T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

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

The inverse of ApproxEq::ulps_eq.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Wp, T> Default for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

fn default() -> Lch<Wp, T>

Returns the "default value" for a type.

impl<Wp, T> Pixel<T> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

const CHANNELS: usize

The number of color channels.

fn as_raw<P>(&self) -> &P where
    P: RawPixel<T> + ?Sized, 

Cast as a reference to raw color components.

fn as_raw_mut<P>(&mut self) -> &mut P where
    P: RawPixel<T> + ?Sized, 

Cast as a mutable reference to raw color components.

fn into_raw<P>(self) -> P where
    P: RawPixelSized<T>, 

Convert from raw color components.

fn from_raw<P>(pixel: &P) -> &Self where
    P: RawPixel<T> + ?Sized, 

Cast from a reference to raw color components.

fn from_raw_mut<P>(pixel: &mut P) -> &mut Self where
    P: RawPixel<T> + ?Sized, 

Cast from a mutable reference to raw color components.

Important traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

fn from_raw_slice(slice: &[T]) -> &[Self]

Cast a slice of raw color components to a slice of colors.

Important traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

fn from_raw_slice_mut(slice: &mut [T]) -> &mut [Self]

Cast a mutable slice of raw color components to a mutable slice of colors.

Important traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

fn into_raw_slice(slice: &[Self]) -> &[T]

Cast a slice of colors to a slice of raw color components.

Important traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

fn into_raw_slice_mut(slice: &mut [Self]) -> &mut [T]

Cast a mutable slice of colors to a mutable slice of raw color components.

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

impl<Wp, T, _S> From<Alpha<Luma<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Alpha<Yxy<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Alpha<Hsv<S, T>, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Alpha<Hsv<S, T>, T>

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Hsl<S, T>

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Alpha<Hsl<S, T>, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Alpha<Hsl<S, T>, T>

Performs the conversion.

impl<Wp, T, _S> From<Hwb<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, H> From<(T, T, H)> for Lch<Wp, T> where
    H: Into<LabHue<T>>,
    T: Component + Float,
    Wp: WhitePoint, 

fn from(components: (T, T, H)) -> Lch<Wp, T>

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Hwb<S, T>

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Rgb<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbStandard,
    <_S as RgbStandard>::Space: RgbSpace,
    <<_S as RgbStandard>::Space as RgbSpace>::WhitePoint == Wp, 

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

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbStandard,
    <_S as RgbStandard>::Space: RgbSpace,
    <<_S as RgbStandard>::Space as RgbSpace>::WhitePoint == Wp, 

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

Performs the conversion.

impl<Wp, T> From<Alpha<Xyz<Wp, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: Component + Float, 

fn from(
    color: Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>
) -> Rgb<S, T>

Performs the conversion.

impl<Wp, T> From<Yxy<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Alpha<Hwb<S, T>, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Alpha<Hwb<S, T>, T>

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Yxy<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Xyz<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsv<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hsv<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<S, T> From<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Alpha<Rgb<S, T>, T> where
    S: RgbStandard,
    T: Component + Float, 

fn from(
    color: Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>
) -> Alpha<Rgb<S, T>, T>

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Alpha<Lab<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T> From<Alpha<Yxy<Wp, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hwb<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T> From<Lab<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T> From<Alpha<Lab<Wp, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Alpha<Xyz<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Color<S, T> where
    S: RgbSpace,
    T: Float + Component, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Color<S, T>

Performs the conversion.

impl<Wp, T> From<Xyz<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    S: LumaStandard,
    T: Component + Float, 

fn from(color: Lch<<S as LumaStandard>::WhitePoint, T>) -> Luma<S, T>

Performs the conversion.

impl<Wp, T> From<Lch<Wp, T>> for Lab<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Hsv<S, T>

Performs the conversion.

impl<S, T> From<Lch<<S as LumaStandard>::WhitePoint, T>> for Alpha<Luma<S, T>, T> where
    S: LumaStandard,
    T: Component + Float, 

fn from(color: Lch<<S as LumaStandard>::WhitePoint, T>) -> Alpha<Luma<S, T>, T>

Performs the conversion.

impl<Wp, T, _S> From<Luma<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Color<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Color<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hsl<_S, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T> From<Alpha<Lch<Wp, T>, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T, P> AsMut<P> for Lch<Wp, T> where
    P: RawPixel<T> + ?Sized,
    T: Component + Float,
    Wp: WhitePoint, 

fn as_mut(&mut self) -> &mut P

Performs the conversion.

impl<S> IntoLinSrgba<S> for Lch<D65, S> where
    S: Component + Float, 

fn into_lin_srgba(self) -> LinSrgba<S>

Convert self into RGBA.