Struct cichlid::hsv::HSV

pub struct HSV {
    pub h: u8,
    pub s: u8,
    pub v: u8,
}

Represents a color encoded in (hue, saturation, value) format.

This structure is useful for a more human-centered approach to thinking about color.

Fields

h: u8

s: u8

v: u8

Methods

impl HSV

pub const BLANK: HSV

Blank HSV object where all values are initialized to zero.

pub const fn new(h: u8, s: u8, v: u8) -> Self

Create a new HSV object.

pub fn hue(self) -> u8

Grabs the hue component of the HSV.

pub fn saturation(self) -> u8

Grabs the saturation component of the HSV.

pub fn value(self) -> u8

Grabs the value component of the HSV.

pub fn to_rgb_rainbow(self) -> ColorRGB

Converts hue, saturation, and value to a ColorRGB using a visually balanced rainbow.

pub fn to_rgb_spectrum(self) -> ColorRGB

Converts a HSV to a ColorRGB using a traditional Mathematical rainbow.

pub unsafe fn to_rgb_raw(self) -> ColorRGB

Converts a HSV to a ColorRGB using a traditional Mathematical rainbow.

Safety

Value can only be up to 191, or else undefined behavior will follow.

pub fn maximize_brightness(&mut self)

Changes the brightness (the value component in HSV) to it's maximum, 255.

Trait Implementations

impl Copy for HSV

impl Clone for HSV

fn clone(&self) -> HSV

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<HSV> for HSV

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

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

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

This method tests for !=.

impl Eq for HSV

impl Default for HSV

fn default() -> HSV

Returns the "default value" for a type.

impl From<(u8, u8, u8)> for HSV

fn from(other: (u8, u8, u8)) -> Self

Performs the conversion.

impl From<[u8; 3]> for HSV

fn from(other: [u8; 3]) -> Self

Performs the conversion.

impl From<HSV> for ColorRGB

fn from(hsv: HSV) -> Self

Performs the conversion.

impl Display for HSV

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

Formats the value using the given formatter.

impl Hash for HSV

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for HSV

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

Formats the value using the given formatter.