Struct palette::RgbHue

#[repr(C)]pub struct RgbHue<T: Float = f32>(_);

A hue type for the RGB family of color spaces.

It's measured in degrees and uses the three additive primaries red, green and blue.

The hue is a circular type, where 0 and 360 is the same, and it's normalized to (-180, 180] when it's converted to a linear number (like f32). This makes many calculations easier, but may also have some surprising effects if it's expected to act as a linear number.

Implementations

impl<T: Float> RgbHue<T>

pub fn from_degrees(degrees: T) -> RgbHue<T>

Create a new hue from degrees.

pub fn from_radians(radians: T) -> RgbHue<T>

Create a new hue from radians, instead of degrees.

pub fn to_degrees(self) -> T

Get the hue as degrees, in the range (-180, 180].

pub fn to_radians(self) -> T

Convert the hue to radians, in the range (-π, π].

pub fn to_positive_degrees(self) -> T

Convert the hue to positive degrees, in the range [0, 360).

pub fn to_positive_radians(self) -> T

Convert the hue to positive radians, in the range [0, 2π).

pub fn to_raw_degrees(self) -> T

Get the internal representation, without normalizing it.

pub fn to_raw_radians(self) -> T

Get the internal representation as radians, without normalizing it.

Trait Implementations

impl<T: Float + AbsDiffEq> AbsDiffEq<RgbHue<T>> for RgbHue<T> where
    T::Epsilon: Float, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: T::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: T::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<T: Float> Add<RgbHue<T>> for RgbHue<T>

type Output = RgbHue<T>

The resulting type after applying the + operator.

fn add(self, other: RgbHue<T>) -> RgbHue<T>

Performs the + operation.

impl Add<RgbHue<f32>> for f32

type Output = RgbHue<f32>

The resulting type after applying the + operator.

fn add(self, other: RgbHue<f32>) -> RgbHue<f32>

Performs the + operation.

impl Add<RgbHue<f64>> for f64

type Output = RgbHue<f64>

The resulting type after applying the + operator.

fn add(self, other: RgbHue<f64>) -> RgbHue<f64>

Performs the + operation.

impl<T: Float> Add<T> for RgbHue<T>

type Output = RgbHue<T>

The resulting type after applying the + operator.

fn add(self, other: T) -> RgbHue<T>

Performs the + operation.

impl<T: Float + AddAssign> AddAssign<RgbHue<T>> for RgbHue<T>

fn add_assign(&mut self, other: RgbHue<T>)

Performs the += operation.

impl AddAssign<RgbHue<f32>> for f32

fn add_assign(&mut self, other: RgbHue<f32>)

Performs the += operation.

impl AddAssign<RgbHue<f64>> for f64

fn add_assign(&mut self, other: RgbHue<f64>)

Performs the += operation.

impl<T: Float + AddAssign> AddAssign<T> for RgbHue<T>

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T: Clone + Float> Clone for RgbHue<T>

fn clone(&self) -> RgbHue<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Float> Copy for RgbHue<T>

impl<T: Debug + Float> Debug for RgbHue<T>

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

Formats the value using the given formatter.

impl<T: Default + Float> Default for RgbHue<T>

fn default() -> RgbHue<T>

Returns the "default value" for a type.

impl<T: Float> From<T> for RgbHue<T>

fn from(degrees: T) -> RgbHue<T>

Performs the conversion.

impl Into<f32> for RgbHue<f32>

fn into(self) -> f32

Performs the conversion.

impl Into<f32> for RgbHue<f64>

fn into(self) -> f32

Performs the conversion.

impl Into<f64> for RgbHue<f64>

fn into(self) -> f64

Performs the conversion.

impl<T: Float> PartialEq<RgbHue<T>> for RgbHue<T>

fn eq(&self, other: &RgbHue<T>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Float> PartialEq<T> for RgbHue<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Float + RelativeEq> RelativeEq<RgbHue<T>> for RgbHue<T> where
    T::Epsilon: Float, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: T::Epsilon,
    max_relative: T::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

impl<T: Float> Sub<RgbHue<T>> for RgbHue<T>

type Output = RgbHue<T>

The resulting type after applying the - operator.

fn sub(self, other: RgbHue<T>) -> RgbHue<T>

Performs the - operation.

impl Sub<RgbHue<f32>> for f32

type Output = RgbHue<f32>

The resulting type after applying the - operator.

fn sub(self, other: RgbHue<f32>) -> RgbHue<f32>

Performs the - operation.

impl Sub<RgbHue<f64>> for f64

type Output = RgbHue<f64>

The resulting type after applying the - operator.

fn sub(self, other: RgbHue<f64>) -> RgbHue<f64>

Performs the - operation.

impl<T: Float> Sub<T> for RgbHue<T>

type Output = RgbHue<T>

The resulting type after applying the - operator.

fn sub(self, other: T) -> RgbHue<T>

Performs the - operation.

impl<T: Float + SubAssign> SubAssign<RgbHue<T>> for RgbHue<T>

fn sub_assign(&mut self, other: RgbHue<T>)

Performs the -= operation.

impl SubAssign<RgbHue<f32>> for f32

fn sub_assign(&mut self, other: RgbHue<f32>)

Performs the -= operation.

impl SubAssign<RgbHue<f64>> for f64

fn sub_assign(&mut self, other: RgbHue<f64>)

Performs the -= operation.

impl<T: Float + SubAssign> SubAssign<T> for RgbHue<T>

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T: Float + UlpsEq> UlpsEq<RgbHue<T>> for RgbHue<T> where
    T::Epsilon: Float, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.