Struct palette::Hsv

pub struct Hsv<S = Srgb, T = f32> where
    T: Float,
    S: RgbSpace,  {
    pub hue: RgbHue<T>,
    pub saturation: T,
    pub value: T,
    pub space: PhantomData<S>,
}

Linear HSV color space.

HSV is a cylindrical version of RGB and it's very similar to HSL. The difference is that the value component in HSV determines the brightness of the color, and not the lightness. The difference is that, for example, red (100% R, 0% G, 0% B) and white (100% R, 100% G, 100% B) has the same brightness (or value), but not the same lightness.

Fields

hue: RgbHue<T>

The hue of the color, in degrees. Decides if it's red, blue, purple, etc.

saturation: T

The colorfulness of the color. 0.0 gives gray scale colors and 1.0 will give absolutely clear colors.

value: T

Decides how bright the color will look. 0.0 will be black, and 1.0 will give a bright an clear color that goes towards white when saturation goes towards 0.0.

space: PhantomData<S>

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

Methods

impl<T> Hsv<Srgb, T> where
    T: Float, 

fn new(hue: RgbHue<T>, saturation: T, value: T) -> Hsv<Srgb, T>

HSV for linear sRGB.

impl<S, T> Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

fn with_wp(hue: RgbHue<T>, saturation: T, value: T) -> Hsv<S, T>

Linear HSV.

Trait Implementations

impl<S: Debug, T: Debug> Debug for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

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

Formats the value using the given formatter.

impl<S: PartialEq, T: PartialEq> PartialEq for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

fn eq(&self, __arg_0: &Hsv<S, T>) -> bool

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

fn ne(&self, __arg_0: &Hsv<S, T>) -> bool

This method tests for !=.

impl<S, T> Copy for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

impl<S, T> Clone for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, Wp, T> FromColor<Wp, T> for Hsv<S, T> where
    T: Float,
    S: RgbSpace<WhitePoint = Wp>,
    Wp: WhitePoint, 

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

Convert from XYZ color space

fn from_rgb<Sp: RgbSpace<WhitePoint = Wp>>(rgb: Rgb<Linear<Sp>, T>) -> Self

Convert from RGB color space

fn from_hsl<Sp: RgbSpace<WhitePoint = Wp>>(hsl: Hsl<Sp, T>) -> Self

Convert from HSL color space

fn from_hsv<Sp: RgbSpace<WhitePoint = Wp>>(hsv: Hsv<Sp, T>) -> Self

Convert from HSV color space

fn from_hwb<Sp: RgbSpace<WhitePoint = Wp>>(hwb: Hwb<Sp, T>) -> Self

Convert from HWB color space

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

Convert from Yxy color space

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

Convert from L*a*b* color space

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

Convert from L*C*h° color space

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

Convert from Luma

impl<S, T> Limited for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

fn is_valid(&self) -> bool

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

fn clamp(&self) -> Hsv<S, 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<S, T> Mix for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<S, T> Shade for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<S, T> GetHue for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

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 Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

fn with_hue(&self, hue: RgbHue<T>) -> Hsv<S, T>

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

fn shift_hue(&self, amount: RgbHue<T>) -> Hsv<S, T>

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

impl<S, T> Saturate for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Scalar = T

The type of the (de)saturation factor.

fn saturate(&self, factor: T) -> Hsv<S, T>

Increase the saturation by factor.

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

Decrease the saturation by factor.

impl<S, T> Default for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

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

Returns the "default value" for a type.

impl<S, T> Add<Hsv<S, T>> for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Output = Hsv<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S, T> Add<T> for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Output = Hsv<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S, T> Sub<Hsv<S, T>> for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Output = Hsv<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<S, T> Sub<T> for Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

type Output = Hsv<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the conversion.

impl<S, T> ApproxEq for Hsv<S, T> where
    T: Float + ApproxEq,
    T::Epsilon: Copy + Float,
    S: RgbSpace, 

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

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<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<Sp>, T>

Convert into RGB color space.

fn into_hsl<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsl<Sp, T>

Convert into HSL color space

fn into_hsv<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsv<Sp, 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 Hsv<S, T> where
    T: Float,
    S: RgbSpace, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, T> From<Rgb<S, T>> for Hsv<S::Space, T> where
    T: Float,
    S: RgbStandard, 

fn from(other: Rgb<S, T>) -> Hsv<S::Space, T>

Performs the conversion.

impl<S, T> From<Alpha<Rgb<S, T>, T>> for Hsv<S::Space, T> where
    T: Float,
    S: RgbStandard, 

fn from(other: Alpha<Rgb<S, T>, T>) -> Hsv<S::Space, T>

Performs the conversion.