Struct HSL

pub struct HSL {
    pub h: Angle,
    pub s: Ratio,
    pub l: Ratio,
}

A struct to represent how much hue, saturation, and luminosity should be added to create a color. The hue is a degree on the color wheel; 0 (or 360) is red, 120 is green, 240 is blue. A valid value for h must range between 0-360. The saturation ranges between 0-100, where 0 is completely desaturated, and 100 is full saturation. The luminosity ranges between 0-100, where 0 is no light (black), and 100 is full light (white).

For more, see the CSS Color Spec.

Fields

h: Angle

s: Ratio

l: Ratio

Trait Implementations

impl Clone for HSL

fn clone(&self) -> HSL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Color for HSL

type Alpha = HSLA

fn to_css(self) -> String

Converts self to its CSS string format.

fn to_rgb(self) -> RGB

Converts self into its RGB representation. When converting from a color model that supports an alpha channel (e.g. RGBA), the alpha value will not be preserved.

fn to_rgba(self) -> RGBA

Converts self into its RGBA representation. When converting from a color model that does not supports an alpha channel (e.g. RGB), it will be treated as fully opaque.

fn to_hsl(self) -> HSL

Converts self into its HSL representation. When converting from a color model that supports an alpha channel (e.g. RGBA), the alpha value will not be preserved.

fn to_hsla(self) -> HSLA

Converts self into its HSLA representation. When converting from a color model that does not supports an alpha channel (e.g. RGB), it will be treated as fully opaque.

fn saturate(self, amount: Ratio) -> Self

Increases the saturation of self by an absolute amount. Operates on the color within its HSL representation and preserves any existing alpha channel. For more, see Less’ Color Operations.

fn desaturate(self, amount: Ratio) -> Self

Decreases the saturation of self by an absolute amount. Operates on the color within its HSL representation and preserves any existing alpha channel. For more, see Less’ Color Operations.

fn lighten(self, amount: Ratio) -> Self

Increases the lightness of self by an absolute amount. Operates on the color within its HSL representation and preserves any existing alpha channel. For more, see Less’ Color Operations.

fn darken(self, amount: Ratio) -> Self

Decreases the lightness of self by an absolute amount. Operates on the color within its HSL representation and preserves any existing alpha channel. For more, see Less’ Color Operations.

fn fadein(self, amount: Ratio) -> Self::Alpha

Decreases the transparency (or increase the opacity) of self, making it more opaque. For opqaue colors, converts into the alpha equivalent of self, and then increases the opacity. For more, see Less’ Color Operations.

fn fadeout(self, amount: Ratio) -> Self::Alpha

Increases the transparency (or decrease the opacity) of self, making it less opaque. For opqaue colors, converts into the alpha equivalent of self, and then decreases the opacity. For more, see Less’ Color Operations.

fn fade(self, amount: Ratio) -> Self::Alpha

Sets the absolute opacity of self, and returns the alpha equivalent. Can be applied to colors whether they already have an opacity value or not. For more, see Less’ Color Operations.

fn spin(self, amount: Angle) -> Self

Rotate the hue angle of self in either direction. Returns the appropriate RGB representation of the color once it has been spun. For more, see Less’ Color Operations.

fn mix<T: Color>(self, other: T, weight: Ratio) -> Self::Alpha

Mixes two colors (self and any other Color) together in variable proportion. Takes opacity into account in the calculations. For more, see Less’ Color Operations.

fn tint(self, weight: Ratio) -> Self

Mixes self with white in variable proportion. Equivalent to calling mix() with white (rgb(255, 255, 255)). For more, see Less’ Color Operations.

fn shade(self, weight: Ratio) -> Self

Mixes self with white in variable proportion. Equivalent to calling mix() with black (rgb(0, 0, 0)). For more, see Less’ Color Operations.

fn greyscale(self) -> Self

Remove all saturation from self in the HSL color space. Equivalent to calling desaturate(0) on a color. For more, see Less’ Color Operations.

impl Debug for HSL

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

Formats the value using the given formatter.

impl Display for HSL

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

Formats the value using the given formatter.

impl PartialEq for HSL

fn eq(&self, other: &HSL) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for HSL

impl StructuralPartialEq for HSL