Struct roccat_vulcan_api_rs::Saturation

pub struct Saturation(_);

Color saturation, gauranties that the value is between 0 and 1.

Used by ColorRgb::new_hsv.

Examlpe

use roccat_vulcan_api_rs::Saturation;

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

Implementations

impl Saturation

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

Create a new value if s is between 0 and 1 both included. Otherwise return None

pub const fn value(self) -> f64

Get the value warpped

Trait Implementations

impl Clone for Saturation

fn clone(&self) -> Saturation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Saturation

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

Formats the value using the given formatter.

impl Default for Saturation

fn default() -> Self

Returns the “default value” for a type.

impl Display for Saturation

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

Formats the value using the given formatter.

impl Ord for Saturation

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<Saturation> for Saturation

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

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

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

This method tests for !=.

impl PartialOrd<Saturation> for Saturation

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 Saturation

impl Eq for Saturation

impl StructuralPartialEq for Saturation