Struct palette::Hsl [−] [src]

pub struct Hsl<T: Float = f32> {
    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.

Methods

impl<T: Float> Hsl<T>
[src]

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

Linear HSL.

Trait Implementations

impl<T: PartialEq + Float> PartialEq for Hsl<T>
[src]

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

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

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

This method tests for !=.

impl<T: Debug + Float> Debug for Hsl<T>
[src]

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

Formats the value using the given formatter.

impl<T: Copy + Float> Copy for Hsl<T>
[src]

impl<T: Clone + Float> Clone for Hsl<T>
[src]

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

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl<T: Float> Limited for Hsl<T>
[src]

fn is_valid(&self) -> bool

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

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

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

fn clamp_self(&mut self)

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

impl<T: Float> Mix for Hsl<T>
[src]

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor. Read more

impl<T: Float> Shade for Hsl<T>
[src]

type Scalar = T

The type of the lighten/darken amount.

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: Float> GetHue for Hsl<T>
[src]

type Hue = RgbHue<T>

The kind of hue unit this color space uses. Read more

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

Calculate a hue if possible. Read more

impl<T: Float> Hue for Hsl<T>
[src]

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

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

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

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

impl<T: Float> Saturate for Hsl<T>
[src]

type Scalar = T

The type of the (de)saturation factor.

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: Float> Default for Hsl<T>
[src]

fn default() -> Hsl<T>

Returns the "default value" for a type. Read more

impl<T: Float> Add<Hsl<T>> for Hsl<T>
[src]

type Output = Hsl<T>

The resulting type after applying the + operator

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

The method for the + operator

impl<T: Float> Add<T> for Hsl<T>
[src]

type Output = Hsl<T>

The resulting type after applying the + operator

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

The method for the + operator

impl<T: Float> Sub<Hsl<T>> for Hsl<T>
[src]

type Output = Hsl<T>

The resulting type after applying the - operator

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

The method for the - operator

impl<T: Float> Sub<T> for Hsl<T>
[src]

type Output = Hsl<T>

The resulting type after applying the - operator

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

The method for the - operator

impl<T: Float> From<Color<T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Hsl<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Rgb<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Xyz<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Luma<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Lab<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Lch<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Hsv<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Alpha<Color<T>, T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Rgb<T>> for Hsl<T>
[src]

fn from(rgb: Rgb<T>) -> Hsl<T>

Performs the conversion.

impl<T: Float> From<Luma<T>> for Hsl<T>
[src]

fn from(luma: Luma<T>) -> Hsl<T>

Performs the conversion.

impl<T: Float> From<Xyz<T>> for Hsl<T>
[src]

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

Performs the conversion.

impl<T: Float> From<Lab<T>> for Hsl<T>
[src]

fn from(lab: Lab<T>) -> Hsl<T>

Performs the conversion.

impl<T: Float> From<Lch<T>> for Hsl<T>
[src]

fn from(lch: Lch<T>) -> Hsl<T>

Performs the conversion.

impl<T: Float> From<Hsv<T>> for Hsl<T>
[src]

fn from(hsv: Hsv<T>) -> Hsl<T>

Performs the conversion.