Struct palette::Lab

pub struct Lab<Wp = D65, T = f32> where
    T: Float,
    Wp: WhitePoint,  {
    pub l: T,
    pub a: T,
    pub b: T,
    pub white_point: PhantomData<Wp>,
}

The CIE L*a*b* (CIELAB) color space.

CIE L*a*b* is a device independent color space which includes all perceivable colors. It's sometimes used to convert between other color spaces, because of its ability to represent all of their colors, and sometimes in color manipulation, because of its perceptual uniformity. This means that the perceptual difference between two colors is equal to their numerical difference.

The parameters of L*a*b* are quite different, compared to many other color spaces, so manipulating them manually may be unintuitive.

Fields

l: T

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

a: T

a* goes from red at -128 to green at 127.

b: T

b* goes from yellow at -128 to blue at 127.

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> Lab<D65, T> where
    T: Float, 

fn new(l: T, a: T, b: T) -> Lab<D65, T>

CIE L*a*b* with white point D65.

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

fn with_wp(l: T, a: T, b: T) -> Lab<Wp, T>

CIE L*a*b*.

Trait Implementations

impl<Wp: Debug, T: Debug> Debug for Lab<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> PartialEq for Lab<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

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

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

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

This method tests for !=.

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

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

fn clone(&self) -> Lab<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 Lab<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 Lab<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) -> Lab<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 Lab<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<Wp, T> GetHue for Lab<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> ComponentWise for Lab<Wp, T> where
    T: Float,
    Wp: WhitePoint, 

type Scalar = T

The scalar type for color components.

fn component_wise<F: FnMut(T, T) -> T>(
    &self,
    other: &Lab<Wp, T>,
    f: F
) -> Lab<Wp, T>

Perform a binary operation on this and an other color.

fn component_wise_self<F: FnMut(T) -> T>(&self, f: F) -> Lab<Wp, T>

Perform a unary operation on this color.

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

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

Returns the "default value" for a type.

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

type Output = Lab<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the * operator.

fn mul(self, other: Lab<Wp, T>) -> Lab<Wp, T>

Performs the * operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the * operator.

fn mul(self, c: T) -> Lab<Wp, T>

Performs the * operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the / operator.

fn div(self, other: Lab<Wp, T>) -> Lab<Wp, T>

Performs the / operation.

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

type Output = Lab<Wp, T>

The resulting type after applying the / operator.

fn div(self, c: T) -> Lab<Wp, T>

Performs the / operation.

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

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

Performs the conversion.

impl<Wp, T> IntoColor<Wp, T> for Lab<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 Lab<S::WhitePoint, T> where
    T: Float,
    S: RgbSpace, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp, T> ApproxEq for Lab<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.