Struct palette::Lch
[−]
[src]
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,
[src]
T: Float,
impl<Wp, T> Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
Trait Implementations
impl<Wp: Debug, T: Debug + Float> Debug for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp: PartialEq, T: PartialEq + Float> PartialEq for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn eq(&self, __arg_0: &Lch<Wp, T>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Lch<Wp, T>) -> bool
[src]
This method tests for !=
.
impl<Wp, T> Copy for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> Clone for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn clone(&self) -> Lch<Wp, T>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<Wp, T> FromColor<Wp, T> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn from_xyz(xyz: Xyz<Wp, T>) -> Self
[src]
Convert from XYZ color space
fn from_lab(lab: Lab<Wp, T>) -> Self
[src]
Convert from L*a*b* color space
fn from_lch(lch: Lch<Wp, T>) -> Self
[src]
Convert from L*C*h° color space
fn from_yxy(inp: Yxy<Wp, T>) -> Self
[src]
Convert from Yxy color space
fn from_rgb<S: RgbSpace<WhitePoint = Wp>>(inp: Rgb<Linear<S>, T>) -> Self
[src]
Convert from RGB color space
fn from_hsl<S: RgbSpace<WhitePoint = Wp>>(inp: Hsl<S, T>) -> Self
[src]
Convert from HSL color space
fn from_hsv<S: RgbSpace<WhitePoint = Wp>>(inp: Hsv<S, T>) -> Self
[src]
Convert from HSV color space
fn from_hwb<S: RgbSpace<WhitePoint = Wp>>(inp: Hwb<S, T>) -> Self
[src]
Convert from HWB color space
fn from_luma(inp: Luma<Wp, T>) -> Self
[src]
Convert from Luma
impl<Wp, T> Limited for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn is_valid(&self) -> bool
[src]
Check if the color's components are within the expected ranges.
fn clamp(&self) -> Lch<Wp, T>
[src]
Return a new color where the components has been clamped to the nearest valid values. Read more
fn clamp_self(&mut self)
[src]
Clamp the color's components to the nearest valid values.
impl<Wp, T> Mix for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
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>
[src]
Mix the color with an other color, by factor
. Read more
impl<Wp, T> Shade for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
type Scalar = T
The type of the lighten/darken amount.
fn lighten(&self, amount: T) -> Lch<Wp, T>
[src]
Lighten the color by amount
.
fn darken(&self, amount: Self::Scalar) -> Self
[src]
Darken the color by amount
.
impl<Wp, T> GetHue for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
type Hue = LabHue<T>
The kind of hue unit this color space uses. Read more
fn get_hue(&self) -> Option<LabHue<T>>
[src]
Calculate a hue if possible. Read more
impl<Wp, T> Hue for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn with_hue(&self, hue: LabHue<T>) -> Lch<Wp, T>
[src]
Return a new copy of self
, but with a specific hue.
fn shift_hue(&self, amount: LabHue<T>) -> Lch<Wp, T>
[src]
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,
[src]
T: Float,
Wp: WhitePoint,
type Scalar = T
The type of the (de)saturation factor.
fn saturate(&self, factor: T) -> Lch<Wp, T>
[src]
Increase the saturation by factor
.
fn desaturate(&self, factor: Self::Scalar) -> Self
[src]
Decrease the saturation by factor
.
impl<Wp, T> Default for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> Add<Lch<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
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>
[src]
Performs the +
operation.
impl<Wp, T> Add<T> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
type Output = Lch<Wp, T>
The resulting type after applying the +
operator.
fn add(self, c: T) -> Lch<Wp, T>
[src]
Performs the +
operation.
impl<Wp, T> Sub<Lch<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
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>
[src]
Performs the -
operation.
impl<Wp, T> Sub<T> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
type Output = Lch<Wp, T>
The resulting type after applying the -
operator.
fn sub(self, c: T) -> Lch<Wp, T>
[src]
Performs the -
operation.
impl<Wp, T> From<Alpha<Lch<Wp, T>, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> IntoColor<Wp, T> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
fn into_xyz(self) -> Xyz<Wp, T>
[src]
Convert into XYZ space
fn into_yxy(self) -> Yxy<Wp, T>
[src]
Convert into Yxy color space
fn into_lab(self) -> Lab<Wp, T>
[src]
Convert into L*a*b* color space
fn into_lch(self) -> Lch<Wp, T>
[src]
Convert into L*C*h° color space
fn into_rgb<S: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<S>, T>
[src]
Convert into RGB color space.
fn into_hsl<S: RgbSpace<WhitePoint = Wp>>(self) -> Hsl<S, T>
[src]
Convert into HSL color space
fn into_hsv<S: RgbSpace<WhitePoint = Wp>>(self) -> Hsv<S, T>
[src]
Convert into HSV color space
fn into_luma(self) -> Luma<Wp, T>
[src]
Convert into Luma
fn into_hwb<S: RgbSpace<WhitePoint = Wp>>(self) -> Hwb<S, T>
[src]
Convert into HWB color space
impl<S, T> From<Color<S, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
fn from(color: Color<S, T>) -> Lch<S::WhitePoint, T>
[src]
Performs the conversion.
impl<S, T> From<Alpha<Color<S, T>, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
impl<S, T> From<Hsl<S, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
fn from(other: Hsl<S, T>) -> Lch<S::WhitePoint, T>
[src]
Performs the conversion.
impl<S, T> From<Alpha<Hsl<S, T>, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
impl<S, T> From<Hsv<S, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
fn from(other: Hsv<S, T>) -> Lch<S::WhitePoint, T>
[src]
Performs the conversion.
impl<S, T> From<Alpha<Hsv<S, T>, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
impl<S, T> From<Hwb<S, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
fn from(other: Hwb<S, T>) -> Lch<S::WhitePoint, T>
[src]
Performs the conversion.
impl<S, T> From<Alpha<Hwb<S, T>, T>> for Lch<S::WhitePoint, T> where
T: Float,
S: RgbSpace,
[src]
T: Float,
S: RgbSpace,
impl<Wp, T> From<Xyz<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Alpha<Xyz<Wp, T>, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Yxy<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Alpha<Yxy<Wp, T>, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Lab<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Alpha<Lab<Wp, T>, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Luma<Wp, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<Wp, T> From<Alpha<Luma<Wp, T>, T>> for Lch<Wp, T> where
T: Float,
Wp: WhitePoint,
[src]
T: Float,
Wp: WhitePoint,
impl<S, T> From<Rgb<S, T>> for Lch<<S::Space as RgbSpace>::WhitePoint, T> where
T: Float,
S: RgbStandard,
[src]
T: Float,
S: RgbStandard,
fn from(other: Rgb<S, T>) -> Lch<<S::Space as RgbSpace>::WhitePoint, T>
[src]
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,
[src]
T: Float,
S: RgbStandard,
fn from(
other: Alpha<Rgb<S, T>, T>
) -> Lch<<S::Space as RgbSpace>::WhitePoint, T>
[src]
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,
[src]
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
[src]
The default tolerance to use when testing values that are close together. Read more
fn default_max_relative() -> Self::Epsilon
[src]
The default relative tolerance for testing values that are far-apart. Read more
fn default_max_ulps() -> u32
[src]
The default ULPs to tolerate when testing values that are far-apart. Read more
fn relative_eq(
&self,
other: &Self,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
[src]
&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
[src]
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
[src]
&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
[src]
The inverse of ApproxEq::ulps_eq
.