Struct palette::luma::Luma

#[repr(C)]
pub struct Luma<S = Srgb, T = f32> where
    T: Component,
    S: LumaStandard,  {
    pub luma: T,
    pub standard: PhantomData<S>,
}

Luminance.

Luma is a purely gray scale color space, which is included more for completeness than anything else, and represents how bright a color is perceived to be. It’s basically the Y component of CIE XYZ. The lack of any form of hue representation limits the set of operations that can be performed on it.

Fields

luma: T

The lightness of the color. 0.0 is black and 1.0 is white.

standard: PhantomData<S>

The kind of RGB standard. sRGB is the default.

Implementations

impl<S, T> Luma<S, T> where
    T: Component,
    S: LumaStandard, 

pub fn new(luma: T) -> Luma<S, T>

Create a luminance color.

pub fn into_format<U>(self) -> Luma<S, U> where
    U: Component + FromComponent<T>, 

Convert into another component type.

pub fn from_format<U>(color: Luma<S, U>) -> Self where
    U: Component,
    T: FromComponent<U>, 

Convert from another component type.

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

Convert to a (luma,) tuple.

pub fn from_components((luma): (T,)) -> Self

Convert from a (luma,) tuple.

pub fn min_luma() -> T

Return the luma value minimum.

pub fn max_luma() -> T

Return the luma value maximum.

impl<S, T> Luma<S, T> where
    T: FloatComponent,
    S: LumaStandard, 

pub fn into_linear(self) -> Luma<Linear<S::WhitePoint>, T>

Convert the color to linear luminance.

pub fn from_linear(color: Luma<Linear<S::WhitePoint>, T>) -> Luma<S, T>

Convert linear luminance to non-linear luminance.

pub fn into_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    self
) -> Luma<St, T>

Convert the color to a different encoding.

pub fn from_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    color: Luma<St, T>
) -> Luma<S, T>

Convert luminance from a different encoding.

Trait Implementations

impl<S, T> AbsDiffEq<Luma<S, T>> for Luma<S, T> where
    T: Component + AbsDiffEq,
    T::Epsilon: Copy,
    S: LumaStandard + PartialEq, 

type Epsilon = <T as AbsDiffEq<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: Self::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: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<S, T> Add<Luma<S, T>> for Luma<S, T> where
    T: Component + Add,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Add>::Output: Component, 

type Output = Luma<S, <T as Add<T>>::Output>

The resulting type after applying the + operator.

fn add(self, other: Luma<S, T>) -> Self::Output

Performs the + operation.

impl<S, T> Add<T> for Luma<S, T> where
    T: Component + Add,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Add>::Output: Component, 

type Output = Luma<S, <T as Add<T>>::Output>

The resulting type after applying the + operator.

fn add(self, c: T) -> Self::Output

Performs the + operation.

impl<S, T> AddAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + AddAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn add_assign(&mut self, other: Luma<S, T>)

Performs the += operation.

impl<S, T> AddAssign<T> for Luma<S, T> where
    T: Component + AddAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<S, T, P> AsMut<P> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    P: RawPixel<T> + ?Sized, 

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

Convert to a raw pixel format.

use palette::SrgbLuma;

let mut luma = SrgbLuma::new(100);
{
    let raw: &mut [u8] = luma.as_mut();
    raw[0] = 5;
}

assert_eq!(luma.luma, 5);

impl<S, T, P> AsRef<P> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    P: RawPixel<T> + ?Sized, 

fn as_ref(&self) -> &P

Convert to a raw pixel format.

use palette::SrgbLuma;

let luma = SrgbLuma::new(100);
let raw: &[u8] = luma.as_ref();

assert_eq!(raw[0], 100);

impl<S, T> Blend for Luma<S, T> where
    T: FloatComponent,
    S: LumaStandard<TransferFn = LinearFn>, 

type Color = Luma<S, T>

The core color type. Typically Self for color types without alpha.

fn into_premultiplied(self) -> PreAlpha<Luma<S, T>, T>

Convert the color to premultiplied alpha.

fn from_premultiplied(color: PreAlpha<Luma<S, T>, T>) -> Self

Convert the color from premultiplied alpha.

fn blend<F>(self, destination: Self, blend_function: F) -> Self where
    F: BlendFunction<Self::Color>, 

Blend self, as the source color, with destination, using blend_function. Anything that implements BlendFunction is acceptable, including functions and closures.

fn over(self, other: Self) -> Self

Place self over other. This is the good old common alpha composition equation.

fn inside(self, other: Self) -> Self

Results in the parts of self that overlaps the visible parts of other.

fn outside(self, other: Self) -> Self

Results in the parts of self that lies outside the visible parts of other.

fn atop(self, other: Self) -> Self

Place self over only the visible parts of other.

fn xor(self, other: Self) -> Self

Results in either self or other, where they do not overlap.

fn plus(self, other: Self) -> Self

Add self and other. This uses the alpha component to regulate the effect, so it’s not just plain component wise addition.

fn multiply(self, other: Self) -> Self

Multiply self with other. This uses the alpha component to regulate the effect, so it’s not just plain component wise multiplication.

fn screen(self, other: Self) -> Self

Make a color which is at least as light as self or other.

fn overlay(self, other: Self) -> Self

Multiply self or other if other is dark, or screen them if other is light. This results in an S curve.

fn darken(self, other: Self) -> Self

Return the darkest parts of self and other.

fn lighten(self, other: Self) -> Self

Return the lightest parts of self and other.

fn dodge(self, other: Self) -> Self

Lighten other to reflect self. Results in other if self is black.

fn burn(self, other: Self) -> Self

Darken other to reflect self. Results in other if self is white.

fn hard_light(self, other: Self) -> Self

Multiply self or other if other is dark, or screen them if self is light. This is similar to overlay, but depends on self instead of other.

fn soft_light(self, other: Self) -> Self

Lighten other if self is light, or darken other as if it’s burned if self is dark. The effect is increased if the components of self is further from 0.5.

fn difference(self, other: Self) -> Self

Return the absolute difference between self and other. It’s basically abs(self - other), but regulated by the alpha component.

fn exclusion(self, other: Self) -> Self

Similar to difference, but appears to result in a lower contrast. other is inverted if self is white, and preserved if self is black.

impl<S, T> Clamp for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

fn is_within_bounds(&self) -> bool

Check if the color’s components are within the expected clamped range bounds.

fn clamp(&self) -> Luma<S, T>

Return a new color where the components have been clamped to the nearest valid values.

fn clamp_self(&mut self)

Clamp the color’s components to the nearest valid values.

impl<S, T> Clone for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

fn clone(&self) -> Luma<S, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> ComponentWise for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

type Scalar = T

The scalar type for color components.

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

Perform a binary operation on this and an other color.

fn component_wise_self<F: FnMut(T) -> T>(&self, f: F) -> Luma<S, T>

Perform a unary operation on this color.

impl<S: Debug, T: Debug> Debug for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

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

Formats the value using the given formatter.

impl<S, T> Default for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

fn default() -> Luma<S, T>

Returns the “default value” for a type.

impl<S, T> Div<Luma<S, T>> for Luma<S, T> where
    T: Component + Div,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Div>::Output: Component, 

type Output = Luma<S, <T as Div<T>>::Output>

The resulting type after applying the / operator.

fn div(self, other: Luma<S, T>) -> Self::Output

Performs the / operation.

impl<S, T> Div<T> for Luma<S, T> where
    T: Component + Div,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Div>::Output: Component, 

type Output = Luma<S, <T as Div<T>>::Output>

The resulting type after applying the / operator.

fn div(self, c: T) -> Self::Output

Performs the / operation.

impl<S, T> DivAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + DivAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn div_assign(&mut self, other: Luma<S, T>)

Performs the /= operation.

impl<S, T> DivAssign<T> for Luma<S, T> where
    T: Component + DivAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn div_assign(&mut self, c: T)

Performs the /= operation.

impl<S: LumaStandard, T: Component> From<(T,)> for Luma<S, T>

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

Converts to this type from the input type.

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    _C: IntoColorUnclamped<Self>,
    _A: Component, 

fn from_color_unclamped(color: Alpha<_C, _A>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Hsl<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsluv<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Hsluv<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Hsv<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Hwb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lab<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Lab<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lch<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lchuv<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Lchuv<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, S> FromColorUnclamped<Luma<S, T>> for Xyz<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    S: LumaStandard<WhitePoint = Wp>, 

fn from_color_unclamped(color: Luma<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<T, S> FromColorUnclamped<Luma<S, T>> for Yxy<S::WhitePoint, T> where
    T: FloatComponent,
    S: LumaStandard, 

fn from_color_unclamped(luma: Luma<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S1, S2, T> FromColorUnclamped<Luma<S2, T>> for Luma<S1, T> where
    S1: LumaStandard,
    S2: LumaStandard<WhitePoint = S1::WhitePoint>,
    T: FloatComponent, 

fn from_color_unclamped(color: Luma<S2, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, St, T> FromColorUnclamped<Luma<St, T>> for Rgb<S, T> where
    S: RgbStandard,
    St: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>,
    T: FloatComponent, 

fn from_color_unclamped(color: Luma<St, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Oklab<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = D65>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = D65>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Luv<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Luv<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Oklab<T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    Xyz<S::WhitePoint, T>: FromColorUnclamped<Oklab<T>>, 

fn from_color_unclamped(color: Oklab<T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Oklch<T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    Xyz<S::WhitePoint, T>: FromColorUnclamped<Oklch<T>>, 

fn from_color_unclamped(color: Oklch<T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Rgb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Xyz<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    S: LumaStandard,
    T: FloatComponent, 

fn from_color_unclamped(color: Xyz<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Yxy<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    S: LumaStandard,
    T: FloatComponent, 

fn from_color_unclamped(color: Yxy<S::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: LumaStandard, T: Component> Into<(T,)> for Luma<S, T>

fn into(self) -> (T,)

Converts this type into the (usually inferred) input type.

impl<S, T> LowerHex for Luma<S, T> where
    T: Component + LowerHex,
    S: LumaStandard, 

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

Formats the value using the given formatter.

impl<S, T> Mix for Luma<S, T> where
    T: FloatComponent,
    S: LumaStandard<TransferFn = LinearFn>, 

type Scalar = T

The type of the mixing factor.

fn mix(&self, other: &Luma<S, T>, factor: T) -> Luma<S, T>

Mix the color with an other color, by factor.

impl<S, T> Mul<Luma<S, T>> for Luma<S, T> where
    T: Component + Mul,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Mul>::Output: Component, 

type Output = Luma<S, <T as Mul<T>>::Output>

The resulting type after applying the * operator.

fn mul(self, other: Luma<S, T>) -> Self::Output

Performs the * operation.

impl<S, T> Mul<T> for Luma<S, T> where
    T: Component + Mul,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Mul>::Output: Component, 

type Output = Luma<S, <T as Mul<T>>::Output>

The resulting type after applying the * operator.

fn mul(self, c: T) -> Self::Output

Performs the * operation.

impl<S, T> MulAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + MulAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn mul_assign(&mut self, other: Luma<S, T>)

Performs the *= operation.

impl<S, T> MulAssign<T> for Luma<S, T> where
    T: Component + MulAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn mul_assign(&mut self, c: T)

Performs the *= operation.

impl<S, T> PartialEq<Luma<S, T>> for Luma<S, T> where
    T: Component + PartialEq,
    S: LumaStandard, 

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<S, T> Pixel<T> for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

const CHANNELS: usize = 1usize

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 into 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<S, T> RelativeContrast for Luma<S, T> where
    T: FloatComponent,
    S: LumaStandard, 

type Scalar = T

The type of the contrast ratio.

fn get_contrast_ratio(&self, other: &Self) -> T

Calculate the contrast ratio between two colors.

fn has_min_contrast_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.3. Contrast is at least 4.5:1 (Level AA).

fn has_min_contrast_large_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.3 for large text. Contrast is at least 3:1 (Level AA).

fn has_enhanced_contrast_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.6. Contrast is at least 7:1 (Level AAA).

fn has_enhanced_contrast_large_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.6 for large text. Contrast is at least 4.5:1 (Level AAA).

fn has_min_contrast_graphics(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.11 for graphical objects. Contrast is at least 3:1 (Level AA).

impl<S, T> RelativeEq<Luma<S, T>> for Luma<S, T> where
    T: Component + RelativeEq,
    T::Epsilon: Copy,
    S: LumaStandard + PartialEq, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for 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 relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<S, T> Shade for Luma<S, T> where
    T: FloatComponent,
    S: LumaStandard<TransferFn = LinearFn>, 

type Scalar = T

The type of the lighten/darken modifier.

fn lighten(&self, factor: T) -> Luma<S, T>

Scale the color towards the maximum lightness by factor, a value ranging from 0.0 to 1.0.

fn lighten_fixed(&self, amount: T) -> Luma<S, T>

Lighten the color by amount, a value ranging from 0.0 to 1.0.

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

Scale the color towards the minimum lightness by factor, a value ranging from 0.0 to 1.0.

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

Darken the color by amount, a value ranging from 0.0 to 1.0.

impl<S, T> Sub<Luma<S, T>> for Luma<S, T> where
    T: Component + Sub,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Sub>::Output: Component, 

type Output = Luma<S, <T as Sub<T>>::Output>

The resulting type after applying the - operator.

fn sub(self, other: Luma<S, T>) -> Self::Output

Performs the - operation.

impl<S, T> Sub<T> for Luma<S, T> where
    T: Component + Sub,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Sub>::Output: Component, 

type Output = Luma<S, <T as Sub<T>>::Output>

The resulting type after applying the - operator.

fn sub(self, c: T) -> Self::Output

Performs the - operation.

impl<S, T> SubAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + SubAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn sub_assign(&mut self, other: Luma<S, T>)

Performs the -= operation.

impl<S, T> SubAssign<T> for Luma<S, T> where
    T: Component + SubAssign,
    S: LumaStandard<TransferFn = LinearFn>, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> UlpsEq<Luma<S, T>> for Luma<S, T> where
    T: Component + UlpsEq,
    T::Epsilon: Copy,
    S: LumaStandard + 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: 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 ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<S, T> UpperHex for Luma<S, T> where
    T: Component + UpperHex,
    S: LumaStandard, 

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

Formats the value using the given formatter.

impl<S, T, _A> WithAlpha<_A> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    _A: Component, 

type Color = Luma<S, T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Luma<S, T>, _A>

The color type with transparency applied.

fn with_alpha(self, alpha: _A) -> Self::WithAlpha

Transforms the color into a transparent color with the provided alpha value. If Self already has a transparency, it is overwritten.

fn without_alpha(self) -> Self::Color

Removes the transparency from the color. If Self::Color has an internal transparency field, that field will be set to A::max_intensity() to make it opaque.

fn split(self) -> (Self::Color, _A)

Splits the color into separate color and transparency values.

fn opaque(self) -> Self::WithAlpha

Transforms the color into a fully opaque color with a transparency field. If Self already has a transparency, it is overwritten.

fn transparent(self) -> Self::WithAlpha

Transforms the color into a fully transparent color. If Self already has a transparency, it is overwritten.

impl<S, T> Copy for Luma<S, T> where
    T: Component,
    S: LumaStandard, 

impl<S, T> Eq for Luma<S, T> where
    T: Component + Eq,
    S: LumaStandard,