Struct amethyst_rendy::palette::RgbHue

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

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.

Methods

impl<T> RgbHue<T> where
    T: Float, 

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> Default for RgbHue<T> where
    T: Default + Float, 

fn default() -> RgbHue<T>

Returns the "default value" for a type.

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, T> Deserialize<'de> for RgbHue<T> where
    T: Float + Deserialize<'de>, 

fn deserialize<__D>(
    __deserializer: __D
) -> Result<RgbHue<T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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> PartialEq<RgbHue<T>> for RgbHue<T> where
    T: Float, 

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> Add<T> for RgbHue<T> where
    T: Float, 

type Output = RgbHue<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = RgbHue<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = RgbHue<T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = RgbHue<T>

The resulting type after applying the - operator.

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

Performs the - operation.

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 Into<f32> for RgbHue<f32>

fn into(self) -> f32

Performs the conversion.

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

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <RgbHue<T> as ApproxEq>::Epsilon

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

fn default_max_relative() -> <RgbHue<T> as ApproxEq>::Epsilon

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

fn default_max_ulps() -> u32

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

fn relative_eq(
    &self,
    other: &RgbHue<T>,
    epsilon: <RgbHue<T> as ApproxEq>::Epsilon,
    max_relative: <RgbHue<T> as ApproxEq>::Epsilon
) -> bool

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

fn ulps_eq(
    &self,
    other: &RgbHue<T>,
    epsilon: <RgbHue<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

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

fn relative_ne(
    &self,
    other: &RgbHue<T>,
    epsilon: <RgbHue<T> as ApproxEq>::Epsilon,
    max_relative: <RgbHue<T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

fn ulps_ne(
    &self,
    other: &RgbHue<T>,
    epsilon: <RgbHue<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

The inverse of ApproxEq::ulps_eq.

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

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<T> Serialize for RgbHue<T> where
    T: Float + Serialize, 

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.