Struct image2::colorspace::Hsv

#[repr(C)]
pub struct Hsv<S = Srgb, T = f32> where
    S: RgbSpace,
    T: Component + Float,  {
    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: Component + Float, 

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

HSV for linear sRGB.

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

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

Linear HSV.

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

Convert to a (hue, saturation, value) tuple.

pub fn from_components<H>((H, T, T)) -> Hsv<S, T> where
    H: Into<RgbHue<T>>, 

Convert from a (hue, saturation, value) tuple.

Trait Implementations

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

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

Returns the "default value" for a type.

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

impl<S, T> Pixel<T> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

const CHANNELS: usize

The number of color channels.

fn as_raw<P>(&self) -> &P where
    P: RawPixel<T> + ?Sized, 

Cast as a reference to raw color components.

fn as_raw_mut<P>(&mut self) -> &mut P where
    P: RawPixel<T> + ?Sized, 

Cast as a mutable reference to raw color components.

fn into_raw<P>(self) -> P where
    P: RawPixelSized<T>, 

Convert from raw color components.

fn from_raw<P>(pixel: &P) -> &Self where
    P: RawPixel<T> + ?Sized, 

Cast from a reference to raw color components.

fn from_raw_mut<P>(pixel: &mut P) -> &mut Self where
    P: RawPixel<T> + ?Sized, 

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

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

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

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

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

This method tests for !=.

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

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

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

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, P> AsMut<P> for Hsv<S, T> where
    P: RawPixel<T> + ?Sized,
    S: RgbSpace,
    T: Component + Float, 

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

Performs the conversion.

impl<S, T> FromColor<<S as RgbSpace>::WhitePoint, T> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

fn from_xyz(color: Xyz<<S as RgbSpace>::WhitePoint, T>) -> Hsv<S, T>

Convert from XYZ color space

fn from_rgb<_S>(color: Rgb<Linear<_S>, T>) -> Hsv<S, T> where
    _S: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>, 

Convert from RGB color space

fn from_hsl<_S>(color: Hsl<_S, T>) -> Hsv<S, T> where
    _S: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>, 

Convert from HSL color space

fn from_hwb<_S>(color: Hwb<_S, T>) -> Hsv<S, T> where
    _S: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>, 

Convert from HWB color space

fn from_hsv<_S>(color: Hsv<_S, T>) -> Hsv<S, T> where
    _S: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>, 

Convert from HSV 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 Lab* color space

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

Convert from LCh° color space

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

Convert from Luma

impl<'de, S, T> Deserialize<'de> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float + Deserialize<'de>, 

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Hsv<S, T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S, T> Serialize for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float + Serialize, 

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

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

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

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

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

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

Convert into RGB color space.

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

Convert into HSL color space

fn into_hsv<Sp>(self) -> Hsv<Sp, T> where
    Sp: RgbSpace<WhitePoint = Wp>, 

Convert into HSV color space

fn into_luma(self) -> Luma<Linear<Wp>, T>

Convert into Luma

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

Convert into HWB color space

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

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

Formats the value using the given formatter.

impl<S, T> Into<(RgbHue<T>, T, T)> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

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

Performs the conversion.

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

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Hsv<S, T> as ApproxEq>::Epsilon

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

fn default_max_relative() -> <Hsv<S, 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: &Hsv<S, T>,
    epsilon: <Hsv<S, T> as ApproxEq>::Epsilon,
    max_relative: <Hsv<S, 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: &Hsv<S, T>,
    epsilon: <Hsv<S, 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: &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, P> AsRef<P> for Hsv<S, T> where
    P: RawPixel<T> + ?Sized,
    S: RgbSpace,
    T: Component + Float, 

fn as_ref(&self) -> &P

Performs the conversion.

impl<S, T> Mix for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

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<Wp, T, _S> From<Hsv<_S, T>> for Lab<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, Sp, T> From<Hwb<Sp, T>> for Hsv<S, T> where
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>,
    T: Component + Float, 

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

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Alpha<Lab<<S as RgbSpace>::WhitePoint, T>, T>) -> Hsv<S, T>

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 

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

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Lch<<S as RgbSpace>::WhitePoint, T>) -> Hsv<S, T>

Performs the conversion.

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

fn from(color: Alpha<Lch<<S as RgbSpace>::WhitePoint, T>, T>) -> Hsv<S, T>

Performs the conversion.

impl<S, Sp, T> From<Hsl<Sp, T>> for Hsv<S, T> where
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>,
    T: Component + Float, 

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

Performs the conversion.

impl<S, T, _S> From<Alpha<Luma<_S, T>, T>> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float,
    _S: LumaStandard<WhitePoint = <S as RgbSpace>::WhitePoint>, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, T, Sp> From<Hsv<Sp, T>> for Hwb<S, T> where
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>,
    T: Component + Float, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, T, _S> From<Alpha<Rgb<_S, T>, T>> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 

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

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Alpha<Xyz<<S as RgbSpace>::WhitePoint, T>, T>) -> Hsv<S, T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, T, _S> From<Luma<_S, T>> for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float,
    _S: LumaStandard<WhitePoint = <S as RgbSpace>::WhitePoint>, 

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

Performs the conversion.

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

fn from(color: Lab<<S as RgbSpace>::WhitePoint, T>) -> Hsv<S, T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, T, H> From<(H, T, T)> for Hsv<S, T> where
    H: Into<RgbHue<T>>,
    S: RgbSpace,
    T: Component + Float, 

fn from(components: (H, T, T)) -> Hsv<S, T>

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Xyz<<S as RgbSpace>::WhitePoint, T>) -> Hsv<S, T>

Performs the conversion.

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

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

Performs the conversion.

impl<S, T, Sp, Wp> From<Hsv<Sp, T>> for Rgb<S, T> where
    S: RgbStandard,
    Sp: RgbSpace<WhitePoint = Wp>,
    T: Component + Float,
    Wp: WhitePoint,
    <S as RgbStandard>::Space: RgbSpace,
    <<S as RgbStandard>::Space as RgbSpace>::WhitePoint == Wp, 

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

Performs the conversion.

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

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

Performs the conversion.

impl<S, Sp, T> From<Hsv<Sp, T>> for Hsl<S, T> where
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = <S as RgbSpace>::WhitePoint>,
    T: Component + Float, 

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

Performs the conversion.

impl<S, T, _S> From<Hsv<_S, T>> for Luma<S, T> where
    S: LumaStandard,
    T: Component + Float,
    _S: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, 

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

Performs the conversion.

impl<S, T, _S> From<Hsv<_S, T>> for Alpha<Luma<S, T>, T> where
    S: LumaStandard,
    T: Component + Float,
    _S: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, 

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

Performs the conversion.

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

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

Performs the conversion.

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

fn from(color: Hsv<<S as RgbStandard>::Space, T>) -> Alpha<Rgb<S, T>, T>

Performs the conversion.

impl<S, T> Hue for Hsv<S, T> where
    S: RgbSpace,
    T: Component + Float, 

fn with_hue<H>(&self, hue: H) -> Hsv<S, T> where
    H: Into<<Hsv<S, T> as GetHue>::Hue>, 

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

fn shift_hue<H>(&self, amount: H) -> Hsv<S, T> where
    H: Into<<Hsv<S, T> as GetHue>::Hue>, 

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

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

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.