Struct palette::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: Into<LabHue<T>>>(l: T, chroma: T, hue: H) -> Lch<D65, 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: Into<LabHue<T>>>(l: T, chroma: T, hue: H) -> Lch<Wp, 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: Into<LabHue<T>>>((l, chroma, hue): (T, T, H)) -> Self

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

Trait Implementations

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

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

Convert from XYZ color space

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

Convert from Lab* color space

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

Convert from LCh° color space

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

Convert from Yxy color space

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

Convert from RGB color space

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

Convert from HSL color space

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

Convert from HSV color space

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

Convert from HWB color space

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

Convert from Luma

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: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<S>, T>

Convert into RGB color space.

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

Convert into HSL color space

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

Convert into HSV color space

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

Convert into Luma

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

Convert into HWB color space

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: RawPixel<T> + ?Sized>(&self) -> &P

Cast as a reference to raw color components.

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

Cast as a mutable reference to raw color components.

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

Convert from raw color components.

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

Cast from a reference to raw color components.

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

Cast from a mutable reference to raw color components.

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

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

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

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

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

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

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

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

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

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

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

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, P: ?Sized> AsRef<P> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

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

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>) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

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>) -> Self

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>) -> Self

Performs the conversion.

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

fn from(components: (T, T, H)) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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: PartialEq, T: PartialEq> PartialEq<Lch<Wp, T>> for Lch<Wp, T> where
    T: Component + Float,
    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: Debug, T: Debug> Debug for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint, 

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

Formats the value using the given formatter.

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>) -> Self::Output

Performs the - operation.

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) -> Self::Output

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>) -> Self::Output

Performs the + operation.

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) -> Self::Output

Performs the + operation.

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

fn add_assign(&mut self, other: Lch<Wp, T>)

Performs the += operation.

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

fn add_assign(&mut self, c: T)

Performs the += operation.

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

fn sub_assign(&mut self, other: Lch<Wp, T>)

Performs the -= operation.

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

fn sub_assign(&mut self, c: T)

Performs the -= operation.

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

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

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

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

fn abs_diff_eq(&self, other: &Self, epsilon: T::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: T::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

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

fn default_max_relative() -> T::Epsilon

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

fn relative_eq(
    &self,
    other: &Self,
    epsilon: T::Epsilon,
    max_relative: T::Epsilon
) -> bool

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

fn relative_ne(
    &self,
    other: &Self,
    epsilon: T::Epsilon,
    max_relative: T::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

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

fn default_max_ulps() -> u32

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

fn ulps_eq(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool

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

fn ulps_ne(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.