Struct duku::Hsb

pub struct Hsb {
    pub h: u16,
    pub s: u8,
    pub b: u8,
    pub a: u8,
}

Color bytes in HSB with alpha.

Makes it easier to handle/convert colors.

HSB is the same as HSV.

Examples

let red = Hsb::new(0, 100, 100);

Fields

h: u16

the hue component in range 0 to 360

s: u8

the saturation component in range 0 to 100

b: u8

the brightness component in range 0 to 100

a: u8

the alpha component

Implementations

impl Hsb

pub fn new(h: u16, s: u8, b: u8) -> Self

Create color

Converts components to correct ranges

pub const fn alpha(self, a: u8) -> Self

Create color, modifying the color's alpha

Examples

let color = Hsb::new(0, 100, 100).alpha(50);

pub const fn shift(self, h: u16) -> Self

Create color, shifting the hue by value

Examples

let red = Hsb::new(360, 100, 100);
let yellow = red.shift(60);

pub fn darken(self, v: u8) -> Self

Create color, darkening by some value

Examples

let red = Hsb::new(0, 100, 100);
let dark_red = red.darken(5);

pub fn brighten(self, v: u8) -> Self

Create color, brightening by some value

Examples

let red = Hsb::new(0, 100, 50);
let bright_red = red.brighten(5);

pub fn saturate(self, v: u8) -> Self

Create color, saturating by some value

Examples

let red = Hsb::new(0, 50, 100);
let saturated_red = red.saturate(5);

pub fn desaturate(self, v: u8) -> Self

Create color, desaturating by some value

Examples

let red = Hsb::new(0, 100, 100);
let desaturated_red = red.desaturate(5);

Trait Implementations

impl Clone for Hsb

pub fn clone(&self) -> Hsb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Hsb

impl Debug for Hsb

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

Formats the value using the given formatter.

impl Default for Hsb

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for Hsb

impl<'_> From<&'_ str> for Hsb

pub fn from(s: &str) -> Self

Performs the conversion.

impl From<Hsb> for Rgb

pub fn from(c: Hsb) -> Self

Performs the conversion.

impl From<Hsb> for Rgbf

pub fn from(hsb: Hsb) -> Self

Performs the conversion.

impl From<Rgb> for Hsb

pub fn from(rgb: Rgb) -> Self

Performs the conversion.

impl From<Rgbf> for Hsb

pub fn from(rgbf: Rgbf) -> Self

Performs the conversion.

impl Hash for Hsb

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Mix for Hsb

pub fn mix(from: Self, to: Self, p: f32) -> Self

Calculate color between from and to at point p in range 0 to 1

impl PartialEq<Hsb> for Hsb

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

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

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

This method tests for !=.

impl StructuralEq for Hsb

impl StructuralPartialEq for Hsb