Struct HslColor 

pub struct HslColor {
    pub a: f64,
    pub h: f64,
    pub s: f64,
    pub l: f64,
}

Defines a color using the hue/saturation/lightness (HSL) model. This uses a cylindrical-coordinate representation of a color.

Fields

a: f64

The Alpha (transparency) component in the range from 0..1 (percentage). 0 is fully transparent, 1 is fully opaque.

h: f64

The Hue component in the range from 0..360 (degrees). This is the color’s location, in degrees, on a color wheel/circle from 0 to 360. Note that 360 is equivalent to 0 and will be adjusted automatically.

s: f64

The Saturation component in the range from 0..1 (percentage). HSL saturation is not the same as HSV saturation.

l: f64

The Lightness component in the range from 0..1 (percentage). 0 is fully black and 1 is fully white.

Implementations

impl HslColor

pub fn new(alpha: f64, hue: f64, saturation: f64, lightness: f64) -> Self

Initializes a new instance of the HslColor struct. Components are clamped to their ranges and a hue of 360 becomes 0.

pub fn new_with_clamp( alpha: f64, hue: f64, saturation: f64, lightness: f64, clamp_values: bool, ) -> Self

Initializes a new instance of the HslColor struct.

This constructor exists only for internal use where performance is critical. Whether or not the channel values are in the correct range must be known: when clamp_values is false the components are stored as given.

pub fn from_color(color: Color) -> Self

Initializes a new instance of the HslColor struct from an RGB color.

pub fn equals(&self, other: HslColor) -> bool

pub fn to_rgb(&self) -> Color

Returns the RGB color model equivalent of this HSL color.

pub fn to_hsv(&self) -> HsvColor

Returns the HSV color model equivalent of this HSL color.

pub fn to_string_format( &self, format: Option<&str>, format_provider: Option<&CultureInfo>, ) -> Result<String, FormatError>

Returns the string representation of the color using a format specifier.

Supported format specifiers:

• L / l: CSS hsla(h, s%, l%, a) / hsl(h, s%, l%)
• L% / l%: hsla(h%, s%, l%, a%) / hsl(h%, s%, l%)
• X, x, H, R, r, R%, r%: converted to RGB and formatted as such
• V, v, V%, v%: converted to HSV and formatted as such

A null or empty format is the same as to_string(). Any other format is an error. format_provider is ignored: color formatting is culture-invariant.

pub fn parse(s: &str) -> Result<HslColor, FormatError>

Parses an HSL color string (hsl(h, s, l) or hsla(h, s, l, a)).

pub fn try_parse(s: &str) -> Option<HslColor>

Parses an HSL color string (hsl(h, s, l) or hsla(h, s, l, a)), returning None when it is not valid. Saturation, lightness and alpha may be given as fractions or percentages.

pub fn from_ahsl(a: f64, h: f64, s: f64, l: f64) -> HslColor

Creates an HslColor from alpha, hue, saturation and lightness (clamped).

pub fn from_hsl(h: f64, s: f64, l: f64) -> HslColor

Creates an opaque HslColor from hue, saturation and lightness (clamped).

pub fn hsl_to_rgb( hue: f64, saturation: f64, lightness: f64, alpha: f64, ) -> Color

Converts the given HSLA color component values to their RGB color equivalent.

The hue is wrapped into [0, 360); the other components are clamped to 0..1.

pub fn hsl_to_hsv( hue: f64, saturation: f64, lightness: f64, alpha: f64, ) -> HsvColor

Converts the given HSLA color component values to their HSV color equivalent.

Trait Implementations

impl Clone for HslColor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HslColor

impl Debug for HslColor

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

Formats the value using the given formatter.

impl Default for HslColor

fn default() -> Self

Returns the “default value” for a type.

impl Display for HslColor

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

Formats the value using the given formatter.

impl From<HslColor> for Color

Converts the HSL color to RGB (an explicit conversion in the reference API).

fn from(hsl_color: HslColor) -> Color

Converts to this type from the input type.

impl FromStr for HslColor

type Err = FormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FormatError>

Parses a string s to return a value of this type.

impl MarkupTyped for HslColor

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for HslColor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HslColor