Struct solstice::ClampedF32

pub struct ClampedF32(_);

An non-NAN f32 value clamped between 0.0 and 1.0, inclusive. This type can be constructed with an f32 which will be clamped into the appropriate range.

Trait Implementations

impl Clone for ClampedF32

fn clone(&self) -> ClampedF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ClampedF32

impl Debug for ClampedF32

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

Formats the value using the given formatter.

impl Default for ClampedF32

fn default() -> ClampedF32

Returns the "default value" for a type.

impl Deref for ClampedF32

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for ClampedF32

impl From<f32> for ClampedF32

fn from(v: f32) -> Self

Performs the conversion.

impl Ord for ClampedF32

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

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

Restrict a value to a certain interval.

impl PartialEq<ClampedF32> for ClampedF32

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

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

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

This method tests for !=.

impl PartialOrd<ClampedF32> for ClampedF32

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

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

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

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

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

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

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

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

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

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

impl StructuralPartialEq for ClampedF32