Struct palette::Lch

pub struct Lch<Wp = D65, T: Float = f32> where
    T: 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: Float, 

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

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

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

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

CIE L*C*h°.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

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

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

This method tests for !=.

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

impl<Wp, T> Clone for Lch<Wp, T> where
    T: 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> FromColor<Wp, T> for Lch<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

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

Convert from XYZ color space

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

Convert from L*a*b* color space

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

Convert from L*C*h° 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<Wp, T>) -> Self

Convert from Luma

impl<Wp, T> Limited for Lch<Wp, T> where
    T: 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: 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: 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: 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: Float,
    Wp: WhitePoint, 

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

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

fn shift_hue(&self, amount: LabHue<T>) -> 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: 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> Default for Lch<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

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

Returns the "default value" for a type.

impl<Wp, T> Add<Lch<Wp, T>> for Lch<Wp, T> where
    T: 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> Add<T> for Lch<Wp, T> where
    T: 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> Sub<Lch<Wp, T>> for Lch<Wp, T> where
    T: 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> Sub<T> for Lch<Wp, T> where
    T: 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> From<Alpha<Lch<Wp, T>, T>> for Lch<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

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

Performs the conversion.

impl<Wp, T> IntoColor<Wp, T> for Lch<Wp, T> where
    T: 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 L*a*b* color space

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

Convert into L*C*h° 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<Wp, T>

Convert into Luma

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

Convert into HWB color space

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

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

Performs the conversion.

impl<S, T> From<Alpha<Color<S, T>, T>> for Lch<S::WhitePoint, T> where
    T: Float,
    S: RgbSpace, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

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

fn default_max_relative() -> Self::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: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

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

fn ulps_eq(&self, other: &Self, epsilon: Self::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: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

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

The inverse of ApproxEq::ulps_eq.