Struct nannou::color::Xyz

pub struct Xyz<T = f32> where
    T: Float,  {
    pub x: T,
    pub y: T,
    pub z: T,
}

The CIE 1931 XYZ color space.

XYZ links the perceived colors to their wavelengths and simply makes it possible to describe the way we see colors as numbers. It's often used when converting from one color space to an other, and requires a standard illuminant and a standard observer to be defined.

Conversions and operations on this color space assumes the CIE Standard Illuminant D65 as the white point, and the 2° standard colorimetric observer.

Fields

x: T

X is the scale of what can be seen as a response curve for the cone cells in the human eye. It goes from 0.0 to 0.95047.

y: T

Y is the luminance of the color, where 0.0 is black and 1.0 is white.

z: T

Z is the scale of what can be seen as the blue stimulation. It goes from 0.0 to 1.08883.

Methods

impl<T> Xyz<T> where
    T: Float, 

pub fn new(x: T, y: T, z: T) -> Xyz<T>

CIE XYZ.

Trait Implementations

impl<T> IntoColor<T> for Xyz<T> where
    T: Float, 

fn into_xyz(self) -> Xyz<T>

Convert into XYZ space

fn into_yxy(self) -> Yxy<T>

Convert into Yxy color space

fn into_lab(self) -> Lab<T>

Convert into Lab* color space

fn into_lch(self) -> Lch<T>

Convert into LCh° color space

fn into_rgb(self) -> Rgb<T>

Convert into RGB color space.

fn into_hsl(self) -> Hsl<T>

Convert into HSL color space

fn into_hsv(self) -> Hsv<T>

Convert into HSV color space

fn into_luma(self) -> Luma<T>

Convert into Luma

fn into_hwb(self) -> Hwb<T>

Convert into HWB color space

impl<T> ComponentWise for Xyz<T> where
    T: Float, 

type Scalar = T

The scalar type for color components.

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

Perform a binary operation on this and an other color.

fn component_wise_self<F>(&self, f: F) -> Xyz<T> where
    F: FnMut(T) -> T, 

Perform a unary operation on this color.

impl<T> ApproxEq for Xyz<T> where
    T: ApproxEq + Float,
    <T as ApproxEq>::Epsilon: Copy,
    <T as ApproxEq>::Epsilon: Float, 

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Xyz<T> as ApproxEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn default_max_relative() -> <Xyz<T> as ApproxEq>::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: &Xyz<T>,
    epsilon: <Xyz<T> as ApproxEq>::Epsilon,
    max_relative: <Xyz<T> as ApproxEq>::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn ulps_eq(
    &self,
    other: &Xyz<T>,
    epsilon: <Xyz<T> as ApproxEq>::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: &Xyz<T>,
    epsilon: <Xyz<T> as ApproxEq>::Epsilon,
    max_relative: <Xyz<T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

fn ulps_ne(
    &self,
    other: &Xyz<T>,
    epsilon: <Xyz<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

The inverse of ApproxEq::ulps_eq.

impl<T> From<Xyz<T>> for Alpha<Lch<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Hwb<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Luma<T>> for Xyz<T> where
    T: Float, 

fn from(other: Luma<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Alpha<Rgb<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Luma<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Lch<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Lch<T>

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Alpha<Luma<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Alpha<Hwb<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Xyz<T>> for Color<T> where
    T: Float, 

fn from(color: Xyz<T>) -> Color<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Luma<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Luma<T>

Performs the conversion.

impl<T> From<Alpha<Lch<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Hsl<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Hwb<T>> for Xyz<T> where
    T: Float, 

fn from(other: Hwb<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Lch<T>> for Xyz<T> where
    T: Float, 

fn from(other: Lch<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Hsl<T>> for Xyz<T> where
    T: Float, 

fn from(other: Hsl<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Rgb<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Alpha<Yxy<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Alpha<Hsl<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Yxy<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Yxy<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Yxy<T>, T> where
    T: Float, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Rgb<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Hsv<T>> for Xyz<T> where
    T: Float, 

fn from(other: Hsv<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Hwb<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Hwb<T>

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Alpha<Hsv<T>, T>> for Xyz<T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Alpha<Hsv<T>, T> where
    T: Float, 

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

Performs the conversion.

impl<T> From<Xyz<T>> for Hsl<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Hsl<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Hsv<T> where
    T: Float, 

fn from(other: Xyz<T>) -> Hsv<T>

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Yxy<T>> for Xyz<T> where
    T: Float, 

fn from(other: Yxy<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Color<T>> for Xyz<T> where
    T: Float, 

fn from(color: Color<T>) -> Xyz<T>

Performs the conversion.

impl<T> From<Rgb<T>> for Xyz<T> where
    T: Float, 

fn from(other: Rgb<T>) -> Xyz<T>

Performs the conversion.

impl<T> Div<Xyz<T>> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Div<T> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Limited for Xyz<T> where
    T: Float, 

fn is_valid(&self) -> bool

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

fn clamp(&self) -> Xyz<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<T> Default for Xyz<T> where
    T: Float, 

fn default() -> Xyz<T>

Returns the "default value" for a type.

impl<T> Mul<Xyz<T>> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<T> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> FromColor<T> for Xyz<T> where
    T: Float, 

fn from_xyz(xyz: Xyz<T>) -> Xyz<T>

Convert from XYZ color space

fn from_rgb(rgb: Rgb<T>) -> Xyz<T>

Convert from RGB color space

fn from_yxy(yxy: Yxy<T>) -> Xyz<T>

Convert from Yxy color space

fn from_lab(input_lab: Lab<T>) -> Xyz<T>

Convert from Lab* color space

fn from_luma(luma: Luma<T>) -> Xyz<T>

Convert from Luma

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

Convert from LCh° color space

fn from_hsl(inp: Hsl<T>) -> Self

Convert from HSL color space

fn from_hsv(inp: Hsv<T>) -> Self

Convert from HSV color space

fn from_hwb(inp: Hwb<T>) -> Self

Convert from HWB color space

impl<T> Shade for Xyz<T> where
    T: Float, 

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<T> Debug for Xyz<T> where
    T: Debug + Float, 

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

Formats the value using the given formatter.

impl<T> Copy for Xyz<T> where
    T: Copy + Float, 

impl<T> Mix for Xyz<T> where
    T: Float, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<T> PartialEq<Xyz<T>> for Xyz<T> where
    T: PartialEq<T> + Float, 

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

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

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

This method tests for !=.

impl<T> Add<T> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<Xyz<T>> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Sub<Xyz<T>> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for Xyz<T> where
    T: Float, 

type Output = Xyz<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Clone for Xyz<T> where
    T: Clone + Float, 

fn clone(&self) -> Xyz<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> IntoRgba<S> for Xyz<S> where
    S: Float + One, 

fn into_rgba(self) -> Rgba<S>

Convert self into RGBA.