Struct palette::Hwb

#[repr(C)]
pub struct Hwb<S = Srgb, T = f32> where
    T: FloatComponent,
    S: RgbStandard,  {
    pub hue: RgbHue<T>,
    pub whiteness: T,
    pub blackness: T,
    pub standard: PhantomData<S>,
}

HWB color space.

HWB is a cylindrical version of RGB and it’s very closely related to HSV. It describes colors with a starting hue, then a degree of whiteness and blackness to mix into that base hue.

It is very intuitive for humans to use and many color-pickers are based on the HWB color system

Fields

hue: RgbHue<T>

The hue of the color, in degrees. Decides if it’s red, blue, purple, etc. Same as the hue for HSL and HSV.

whiteness: T

The whiteness of the color. It specifies the amount white to mix into the hue. It varies from 0 to 1, with 1 being always full white and 0 always being the color shade (a mixture of a pure hue with black) chosen with the other two controls.

blackness: T

The blackness of the color. It specifies the amount black to mix into the hue. It varies from 0 to 1, with 1 being always full black and 0 always being the color tint (a mixture of a pure hue with white) chosen with the other two

standard: PhantomData<S>

The white point and RGB primaries this color is adapted to. The default is the sRGB standard.

Implementations

impl<T> Hwb<Srgb, T> where
    T: FloatComponent, 

pub fn new<H: Into<RgbHue<T>>>(
    hue: H,
    whiteness: T,
    blackness: T
) -> Hwb<Srgb, T>

HWB for linear sRGB.

impl<S, T> Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

pub fn with_wp<H: Into<RgbHue<T>>>(
    hue: H,
    whiteness: T,
    blackness: T
) -> Hwb<S, T>

Linear HWB.

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

Convert to a (hue, whiteness, blackness) tuple.

pub fn from_components<H: Into<RgbHue<T>>>(
    (hue, whiteness, blackness): (H, T, T)
) -> Self

Convert from a (hue, whiteness, blackness) tuple.

pub fn min_whiteness() -> T

Return the whiteness value minimum.

pub fn max_whiteness() -> T

Return the whiteness value maximum.

pub fn min_blackness() -> T

Return the blackness value minimum.

pub fn max_blackness() -> T

Return the blackness value maximum.

Trait Implementations

impl<S, T> AbsDiffEq<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + AbsDiffEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + 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: Self::Epsilon) -> bool

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

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

The inverse of AbsDiffEq::abs_diff_eq.

impl<S, T> Add<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hwb<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S, T> Add<T> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hwb<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S, T> AddAssign<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + AddAssign,
    S: RgbStandard, 

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

Performs the += operation.

impl<S, T> AddAssign<T> for Hwb<S, T> where
    T: FloatComponent + AddAssign,
    S: RgbStandard, 

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<S, T, P: ?Sized> AsMut<P> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    P: RawPixel<T>, 

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

Performs the conversion.

impl<S, T, P: ?Sized> AsRef<P> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

Performs the conversion.

impl<S, T> Clamp for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn is_within_bounds(&self) -> bool

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

fn clamp(&self) -> Hwb<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 Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, T: Debug> Debug for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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

Formats the value using the given formatter.

impl<S, T> Default for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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

Returns the “default value” for a type.

impl<S: RgbStandard, T: FloatComponent, H: Into<RgbHue<T>>> From<(H, T, T)> for Hwb<S, T>

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

Performs the conversion.

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    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> FromColorUnclamped<Hsl<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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 RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> FromColorUnclamped<Hsv<S, T>> for Hwb<S, T> where
    S: RgbStandard,
    T: FloatComponent, 

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> FromColorUnclamped<Hwb<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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<Hwb<S, T>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(hwb: Hwb<S, T>) -> Self

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

impl<S: RgbStandard, T: Component> FromColorUnclamped<Hwb<S, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S1, S2, T> FromColorUnclamped<Hwb<S1, T>> for Hwb<S2, T> where
    S1: RgbStandard,
    S2: RgbStandard,
    S1::Space: RgbSpace<WhitePoint = <S2::Space as RgbSpace>::WhitePoint>,
    T: FloatComponent, 

fn from_color_unclamped(hwb: Hwb<S1, T>) -> Self

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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, _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<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Xyz<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Yxy<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

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 RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> FromColorUnclamped<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> FromColorUnclamped<Lchuv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lchuv<<S::Space as RgbSpace>::WhitePoint, 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<S, T> FromColorUnclamped<Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> FromColorUnclamped<Rgb<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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 RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<S, T> GetHue for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

fn get_hue(&self) -> Option<RgbHue<T>>

Calculate a hue if possible.

impl<S, T> Hue for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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

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

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

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

impl<S: RgbStandard, T: FloatComponent> Into<(RgbHue<T>, T, T)> for Hwb<S, T>

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

Performs the conversion.

impl<S, T> Mix for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<S, T> PartialEq<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + PartialEq,
    S: RgbStandard, 

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

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

#[must_use]

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

This method tests for !=.

impl<S, T> Pixel<T> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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 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 Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + RelativeEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + 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.

pub 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 Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the lighten/darken modifier.

fn lighten(&self, factor: T) -> Hwb<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) -> Hwb<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<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hwb<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<S, T> Sub<T> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hwb<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<S, T> SubAssign<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + SubAssign,
    S: RgbStandard, 

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

Performs the -= operation.

impl<S, T> SubAssign<T> for Hwb<S, T> where
    T: FloatComponent + SubAssign,
    S: RgbStandard, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> UlpsEq<Hwb<S, T>> for Hwb<S, T> where
    T: FloatComponent + UlpsEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + 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.

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

The inverse of UlpsEq::ulps_eq.

impl<S, T, _A> WithAlpha<_A> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    _A: Component, 

type Color = Self

The opaque color type, without any transparency.

type WithAlpha = Alpha<Self, _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 Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

impl<S, T> Eq for Hwb<S, T> where
    T: FloatComponent + Eq,
    S: RgbStandard,