Struct roccat_vulcan_api_rs::Hue

pub struct Hue(_);

Color hue. Gauranties that the value is between 0 and 1.

Used by ColorRgb::new_hsv.

Examlpe

use roccat_vulcan_api_rs::Hue;

assert_eq!(Hue::new(0.5_f64).unwrap().value(), 0.5_f64);
assert_eq!(Hue::new(1.5_f64), None);
assert_eq!(Hue::new_from_degree(180_f64), Hue::new(0.5_f64))

Implementations

impl Hue

pub fn new(s: f64) -> Option<Self>

Create a new value between 0 and 1

Example

use roccat_vulcan_api_rs::Hue;

assert_eq!(Hue::new(0.5_f64).unwrap().value(), 0.5_f64);
assert_eq!(Hue::new(1.5_f64), None);

pub fn new_from_degree(f: f64) -> Option<Self>

Create a hue from an angle in degree

Examlpe

use roccat_vulcan_api_rs::Hue;

assert_eq!(Hue::new_from_degree(180_f64), Hue::new(0.5_f64))

pub fn new_from_radiant(f: f64) -> Option<Self>

Create a new hue from an angle in radiant

Example

use std::f64::consts::PI;

use roccat_vulcan_api_rs::Hue;

assert_eq!(Hue::new_from_radiant(PI), Hue::new(0.5_f64))

pub fn degree(self) -> f64

Get the hue in degree

Example

use roccat_vulcan_api_rs::Hue;

let hue = Hue::new(0.5_f64).unwrap();
assert_eq!(hue.degree(), 180_f64);
let hue = Hue::new(0_f64).unwrap();
assert_eq!(hue.degree(), 0_f64);
let hue = Hue::new(0.25_f64).unwrap();
assert_eq!(hue.degree(), 90_f64);

pub fn radiant(self) -> f64

Get the hue in radiant

pub const fn value(self) -> f64

Get the value warpped

Trait Implementations

impl Clone for Hue

fn clone(&self) -> Hue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hue

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

Formats the value using the given formatter.

impl Default for Hue

fn default() -> Self

Create a new Hue with value 0_f64

impl Display for Hue

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

Formats the value using the given formatter.

impl Ord for Hue

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Hue> for Hue

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

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

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

This method tests for !=.

impl PartialOrd<Hue> for Hue

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Copy for Hue

impl Eq for Hue

impl StructuralPartialEq for Hue