Struct prisma::channel::angular_channel::AngularChannel

#[repr(transparent)]pub struct AngularChannel<T>(pub T);

A channel that is represented by an angle

Implementations

impl<T> AngularChannel<T> where
    T: Angle, 

pub fn new(val: T) -> Self

Construct a new AngularChannel

Trait Implementations

impl<T> AbsDiffEq<AngularChannel<T>> for AngularChannel<T> where
    T: Angle + AbsDiffEq,
    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: Self::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: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<T> Bounded for AngularChannel<T> where
    T: Angle, 

fn normalize(self) -> Self

Return a value clipped inside the normalized range

fn is_normalized(&self) -> bool

Return true if the value is normalized

impl<T> ChannelCast for AngularChannel<T> where
    T: Angle + Default + Sub<T, Output = T> + Add<T, Output = T>, 

fn channel_cast<To>(self) -> To where
    Self::Format: ChannelFormatCast<To::Format>,
    To: ColorChannel<Tag = Self::Tag>, 

Convert from one format to another

fn scalar_cast<To>(self) -> To where
    Self::Format: ChannelFormatCast<To>, 

Convert to a new scalar type

impl<T: Clone> Clone for AngularChannel<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ColorChannel for AngularChannel<T> where
    T: Angle + Default + Add<T, Output = T> + Sub<T, Output = T>, 

type Format = T

The contained type representing the channel. Format can be a wrapper around a scalar, such as an Angle<f32>, or a scalar itself.

type Scalar = T::Scalar

The scalar type used by the channel. This will be the scalar inside of a wrapper type.

type Tag = AngularChannelTag

A unique identifying tag type used in generic contexts

fn min_bound() -> T

The minimum valid value

fn max_bound() -> T

The maximum valid value

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

Return a new channel clamped between min and max

fn value(&self) -> T

Return the inner value of the channel

fn scalar(&self) -> T::Scalar

Return the scalar value of the channel

fn from_scalar(value: T::Scalar) -> Self

Construct the channel from a scalar value

fn new(value: T) -> Self

Construct the channel from the inner value

impl<T: Copy> Copy for AngularChannel<T>

impl<T: Debug> Debug for AngularChannel<T>

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

Formats the value using the given formatter.

impl<T> Default for AngularChannel<T> where
    T: Angle + Zero, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> Display for AngularChannel<T> where
    T: Angle + Display, 

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

Formats the value using the given formatter.

impl<T: Eq> Eq for AngularChannel<T>

impl<T: Hash> Hash for AngularChannel<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> Invert for AngularChannel<T> where
    T: Angle, 

fn invert(self) -> Self

Invert Self

impl<T> Lerp for AngularChannel<T> where
    T: Angle + Lerp, 

type Position = T::Position

The type of the pos argument

fn lerp(&self, right: &Self, pos: Self::Position) -> Self

Interpolate between self and right

impl<T: Ord> Ord for AngularChannel<T>

fn cmp(&self, other: &AngularChannel<T>) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<AngularChannel<T>> for AngularChannel<T>

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

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

fn ne(&self, other: &AngularChannel<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<AngularChannel<T>> for AngularChannel<T>

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

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

fn lt(&self, other: &AngularChannel<T>) -> bool

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

fn le(&self, other: &AngularChannel<T>) -> bool

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

fn gt(&self, other: &AngularChannel<T>) -> bool

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

fn ge(&self, other: &AngularChannel<T>) -> bool

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

impl<T> RelativeEq<AngularChannel<T>> for AngularChannel<T> where
    T: Angle + RelativeEq,
    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: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

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

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

The inverse of ApproxEq::relative_eq.

impl<T> StructuralEq for AngularChannel<T>

impl<T> StructuralPartialEq for AngularChannel<T>

impl<T> UlpsEq<AngularChannel<T>> for AngularChannel<T> where
    T: Angle + UlpsEq,
    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: Self::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: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.