Struct picto::color::Hsl

pub struct Hsl<T = f32> where
    T: Float,  {
    pub hue: RgbHue<T>,
    pub saturation: T,
    pub lightness: T,
}

Linear HSL color space.

The HSL color space can be seen as a cylindrical version of RGB, where the hue is the angle around the color cylinder, the saturation is the distance from the center, and the lightness is the height from the bottom. Its composition makes it especially good for operations like changing green to red, making a color more gray, or making it darker.

See HSV for a very similar color space, with brightness instead of 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.

lightness: T

Decides how light the color will look. 0.0 will be black, 0.5 will give a clear color, and 1.0 will give white.

Implementations

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

pub fn new(hue: RgbHue<T>, saturation: T, lightness: T) -> Hsl<T>

Linear HSL.

Trait Implementations

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

type Output = Hsl<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Hsl<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

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

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

pub fn default_max_relative() -> <Hsl<T> as ApproxEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

pub fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

pub fn relative_eq(
    &self,
    other: &Hsl<T>,
    epsilon: <Hsl<T> as ApproxEq>::Epsilon,
    max_relative: <Hsl<T> as ApproxEq>::Epsilon
) -> bool

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

pub fn ulps_eq(
    &self,
    other: &Hsl<T>,
    epsilon: <Hsl<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.

pub fn relative_ne(
    &self,
    other: &Hsl<T>,
    epsilon: <Hsl<T> as ApproxEq>::Epsilon,
    max_relative: <Hsl<T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

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

The inverse of ApproxEq::ulps_eq.

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

pub fn clone(&self) -> Hsl<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for Hsl<T> where
    T: Float, 

pub fn default() -> Hsl<T>

Returns the “default value” for a type.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(color: Color<T>) -> Hsl<T>

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Lch<T>

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Yxy<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(color: Hsl<T>) -> Color<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Luma<T>

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Hwb<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Lab<T>

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Rgb<T>

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Hwb<T>) -> Hsl<T>

Performs the conversion.

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

pub fn from(other: Lab<T>) -> Hsl<T>

Performs the conversion.

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

pub fn from(other: Lch<T>) -> Hsl<T>

Performs the conversion.

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

pub fn from(other: Luma<T>) -> Hsl<T>

Performs the conversion.

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

pub fn from(other: Rgb<T>) -> Hsl<T>

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Yxy<T>) -> Hsl<T>

Performs the conversion.

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

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

Convert from XYZ color space

pub fn from_rgb(rgb: Rgb<T>) -> Hsl<T>

Convert from RGB color space

pub fn from_hsl(hsl: Hsl<T>) -> Hsl<T>

Convert from HSL color space

pub fn from_hsv(hsv: Hsv<T>) -> Hsl<T>

Convert from HSV color space

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

Convert from Yxy color space

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

Convert from Lab* color space

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

Convert from LCh° color space

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

Convert from HWB color space

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

Convert from Luma

impl<T> GetHue for Hsl<T> where
    T: Float, 

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

impl<T> Hue for Hsl<T> where
    T: Float, 

pub fn with_hue(&self, hue: RgbHue<T>) -> Hsl<T>

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

pub fn shift_hue(&self, amount: RgbHue<T>) -> Hsl<T>

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

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

pub fn into_xyz(self) -> Xyz<T>

Convert into XYZ space

pub fn into_yxy(self) -> Yxy<T>

Convert into Yxy color space

pub fn into_lab(self) -> Lab<T>

Convert into Lab* color space

pub fn into_lch(self) -> Lch<T>

Convert into LCh° color space

pub fn into_rgb(self) -> Rgb<T>

Convert into RGB color space.

pub fn into_hsl(self) -> Hsl<T>

Convert into HSL color space

pub fn into_hsv(self) -> Hsv<T>

Convert into HSV color space

pub fn into_luma(self) -> Luma<T>

Convert into Luma

fn into_hwb(self) -> Hwb<T>

Convert into HWB color space

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

pub fn is_valid(&self) -> bool

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

pub fn clamp(&self) -> Hsl<T>

Return a new color where the components has been clamped to the nearest valid values.

pub fn clamp_self(&mut self)

Clamp the color’s components to the nearest valid values.

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

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

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

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

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

This method tests for !=.

impl<C: Channel, T: Float + 'static> Pixel<C> for Hsl<T>

fn channels() -> usize

The number of channels in the Pixel.

impl<T: Float + 'static> Read<f32> for Hsl<T>

fn read(data: &[f32]) -> Self

Read a Pixel from the slice.

impl<T: Float + 'static> Read<f64> for Hsl<T>

fn read(data: &[f64]) -> Self

Read a Pixel from the slice.

impl<T> Saturate for Hsl<T> where
    T: Float, 

type Scalar = T

The type of the (de)saturation factor.

pub fn saturate(&self, factor: T) -> Hsl<T>

Increase the saturation by factor.

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

Decrease the saturation by factor.

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

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

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

type Output = Hsl<T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Hsl<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C: Channel, T: Float + 'static> Write<C> for Hsl<T>

fn write(&self, data: &mut [C])

Write the Pixel to the slice.

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

impl<T> StructuralPartialEq for Hsl<T> where
    T: Float,