Struct palette::Yxy

#[repr(C)]
pub struct Yxy<Wp = D65, T = f32> where
    T: Component + Float,
    Wp: WhitePoint,  {
    pub x: T,
    pub y: T,
    pub luma: T,
    pub white_point: PhantomData<Wp>,
}

The CIE 1931 Yxy (xyY) color space.

Yxy is a luminance-chromaticity color space derived from the CIE XYZ color space. It is widely used to define colors. The chromacity diagrams for the color spaces are a plot of this color space's x and y coordiantes.

Conversions and operations on this color space depend on the white point.

Fields

x: T

x chromacity co-ordinate derived from XYZ color space as X/(X+Y+Z). Typical range is between 0 and 1

y: T

y chromacity co-ordinate derived from XYZ color space as Y/(X+Y+Z). Typical range is between 0 and 1

luma: T

luma (Y) was a measure of the brightness or luminance of a color. It is the same as the Y from the XYZ color space. Its range is from 0 to 1, where 0 is black and 1 is white.

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> Yxy<D65, T> where     T: Component + Float,

pub fn new(x: T, y: T, luma: T) -> Yxy<D65, T>

CIE Yxy with white point D65.

impl<Wp, T> Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

pub fn with_wp(x: T, y: T, luma: T) -> Yxy<Wp, T>

CIE Yxy.

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

Convert to a (x, y, luma), a.k.a. (x, y, Y) tuple.

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

Convert from a (x, y, luma), a.k.a. (x, y, Y) tuple.

Trait Implementations

impl<S, T> From<Yxy<S::WhitePoint, T>> for Hsl<S, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Alpha<Hsl<S, T>, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Hsv<S, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Alpha<Hsv<S, T>, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Hwb<S, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Alpha<Hwb<S, T>, T> where     T: Component + Float,     S: RgbSpace,     T: Component + Float,

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

Performs the conversion.

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

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

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

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

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

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

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

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Alpha<Luma<S, T>, T> where     T: Component,     S: LumaStandard,     T: Component + Float,

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

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Luma<S, T> where     S: LumaStandard,     T: Component + Float,

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp, T> From<Yxy<Wp, T>> for Alpha<Xyz<Wp, T>, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

impl<Wp, T> From<Yxy<Wp, T>> for Xyz<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

fn from(color: Yxy<Wp, T>) -> Self

Performs the conversion.

impl<Wp, T> FromColor<Wp, T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     Wp: WhitePoint,

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

Convert from XYZ color space

fn from_yxy(color: Yxy<Wp, T>) -> Self

Convert from Yxy color space

fn from_luma(color: Luma<Linear<Wp>, T>) -> Self

Convert from Luma

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

Convert from Lab* color space

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

Convert from LCh° 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

impl<Wp, T, _S> From<Rgb<_S, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbStandard,     _S::Space: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Rgb<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbStandard,     _S::Space: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Luma<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: LumaStandard<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hsl<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Hsv<_S, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hsv<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Hwb<_S, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Hwb<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp, T> From<Alpha<Xyz<Wp, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp, T, _S> From<Color<_S, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

fn from(color: Color<_S, T>) -> Self

Performs the conversion.

impl<Wp, T, _S> From<Alpha<Color<_S, T>, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     T: Component + Float,     _S: RgbSpace<WhitePoint = Wp>,

fn from(color: Alpha<Color<_S, T>, T>) -> Self

Performs the conversion.

impl<Wp, T> Pixel<T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

const CHANNELS: usize

CHANNELS: usize = 3usize

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 from 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<Wp: Debug, T: Debug> Debug for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

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

Formats the value using the given formatter.

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

fn eq(&self, other: &Yxy<Wp, T>) -> bool

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

fn ne(&self, other: &Yxy<Wp, T>) -> bool

This method tests for !=.

impl<Wp, T> Copy for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

impl<Wp, T> Clone for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

fn clone(&self) -> Yxy<Wp, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Wp, T> From<Xyz<Wp, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

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

Performs the conversion.

impl<S, T> From<Luma<S, T>> for Yxy<S::WhitePoint, T> where     T: Component + Float,     S: LumaStandard,

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

Performs the conversion.

impl<Wp: WhitePoint, T: Component + Float> From<(T, T, T)> for Yxy<Wp, T>

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

Performs the conversion.

impl<Wp: WhitePoint, T: Component + Float> Into<(T, T, T)> for Yxy<Wp, T>

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

Performs the conversion.

impl<Wp, T> Limited for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

fn is_valid(&self) -> bool

Check if the color's components are within the expected ranges.

fn clamp(&self) -> Yxy<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 Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<Wp, T> Shade for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<Wp, T> ComponentWise for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Scalar = T

The scalar type for color components.

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

Perform a binary operation on this and an other color.

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

Perform a unary operation on this color.

impl<Wp, T> Default for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

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

Returns the "default value" for a type.

impl<Wp, T> Add<Yxy<Wp, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> Add<T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> Sub<Yxy<Wp, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> Sub<T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> Mul<Yxy<Wp, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Wp, T> Mul<T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Wp, T> Div<Yxy<Wp, T>> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Wp, T> Div<T> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,

type Output = Yxy<Wp, T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Wp, T, P: ?Sized> AsRef<P> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     P: RawPixel<T>,

fn as_ref(&self) -> &P

Performs the conversion.

impl<Wp, T, P: ?Sized> AsMut<P> for Yxy<Wp, T> where     T: Component + Float,     Wp: WhitePoint,     P: RawPixel<T>,

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

Performs the conversion.

impl<Wp, T> IntoColor<Wp, T> for Yxy<Wp, T> where     T: Component + 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 Lab* color space

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

Convert into LCh° 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<Linear<Wp>, T>

Convert into Luma

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

Convert into HWB color space

impl<Wp, T> ApproxEq for Yxy<Wp, T> where     T: Component + 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.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Color<S, T> where     T: Float + Component,     S: RgbSpace,

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

Performs the conversion.