Struct ColorHSLA

pub struct ColorHSLA { /* private fields */ }

A struct for defining a single color in HSLA space all values are between 0 and 1

Implementations

impl ColorHSLA

pub fn new(h: f32, s: f32, l: f32, a: f32) -> Self

Constructs a new hsla color, all values are clamped to between 0 and 1

Parameters

h: The hue component

s: The saturation component

l: The lightness component

a: The alpha component

pub fn new_hsl(h: f32, s: f32, l: f32) -> Self

Constructs a new hsla color with the alpha component equal to 1, all values are clamped to between 0 and 1

Parameters

h: The hue component

s: The saturation component

l: The ligness component

pub unsafe fn new_unsafe(h: f32, s: f32, l: f32, a: f32) -> Self

Constructs a new hsla color without validating the input

Parameters

h: The hue component

s: The saturation component

l: The lightness component

a: The alpha component

pub fn get_hue(&self) -> f32

Retrieves the hue component of the color

pub fn get_saturation(&self) -> f32

Retrieves the saturation component of the color

pub fn get_lightness(&self) -> f32

Retrieves the lightness component of the color

pub fn get_alpha(&self) -> f32

Retrieves the alpha component of the color

pub fn get(&self) -> [f32; 4]

Retrieves all the color components in an array in the order: hue, saturation, lightness, alpha

Trait Implementations

impl Clone for ColorHSLA

fn clone(&self) -> ColorHSLA

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Color for ColorHSLA

const TYPE: ColorType = ColorType::HSL

The base color type, the get_x method of this color must be implemented while the others will be implemented automatically

fn get_hsla(&self) -> ColorHSLA

Retrieves the HSLA color for this color

fn get_rgba(&self) -> ColorRGBA

Retrieves the RGBA color for this color

fn get_hsva(&self) -> ColorHSVA

Retrieves the HSVA color for this color

fn get_hsia(&self) -> ColorHSIA

Retrieves the HSIA color for this color

impl Debug for ColorHSLA

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

Formats the value using the given formatter.

impl PartialEq for ColorHSLA

fn eq(&self, other: &ColorHSLA) -> 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 PartialOrd for ColorHSLA

fn partial_cmp(&self, other: &ColorHSLA) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ColorHSLA

impl StructuralPartialEq for ColorHSLA