Struct F2Dot14

pub struct F2Dot14(/* private fields */);

16-bit signed fixed point number with 14 bits of fraction.

Implementations

impl F2Dot14

pub const MIN: Self = _

Minimum value.

pub const MAX: Self = _

Maximum value.

pub const EPSILON: Self = _

This type’s smallest representable value

pub const ZERO: Self = _

Representation of 0.0.

pub const ONE: Self = _

Representation of 1.0.

pub const fn from_bits(bits: i16) -> Self

Creates a new fixed point value from the underlying bit representation.

pub const fn to_bits(self) -> i16

Returns the underlying bit representation of the value.

pub const fn round(self) -> Self

Returns the nearest integer value.

pub const fn abs(self) -> Self

Returns the absolute value of the number.

pub const fn floor(self) -> Self

Returns the largest integer less than or equal to the number.

pub const fn fract(self) -> Self

Returns the fractional part of the number.

pub fn wrapping_add(self, other: Self) -> Self

Wrapping addition.

pub const fn saturating_add(self, other: Self) -> Self

Saturating addition.

pub const fn wrapping_sub(self, other: Self) -> Self

Wrapping substitution.

pub const fn saturating_sub(self, other: Self) -> Self

Saturating substitution.

pub const fn to_be_bytes(self) -> [u8; 2]

The representation of this number as a big-endian byte array.

impl F2Dot14

pub fn from_f32(x: f32) -> Self

Creates a fixed point value from af32.

This operation is lossy; the float will be rounded to the nearest representable value.

pub fn to_f32(self) -> f32

Returns the value as an f32.

This operation is lossless: all representable values can be round-tripped.

impl F2Dot14

pub const fn to_fixed(self) -> Fixed

Converts a 2.14 to 16.16 fixed point value.

Trait Implementations

impl Add for F2Dot14

type Output = F2Dot14

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for F2Dot14

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for F2Dot14

fn clone(&self) -> F2Dot14

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for F2Dot14

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

Formats the value using the given formatter.

impl Default for F2Dot14

fn default() -> F2Dot14

Returns the “default value” for a type.

impl Display for F2Dot14

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

Formats the value using the given formatter.

impl Hash for F2Dot14

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for F2Dot14

fn cmp(&self, other: &F2Dot14) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for F2Dot14

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for F2Dot14

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Scalar for F2Dot14

type Raw = [u8; 2]

The raw byte representation of this type.

fn to_raw(self) -> [u8; 2]

Encode this type as raw big-endian bytes

fn from_raw(raw: [u8; 2]) -> Self

Create an instance of this type from raw big-endian bytes

fn read(slice: &[u8]) -> Option<Self>

Attempt to read a scalar from a slice.

impl Sub for F2Dot14

type Output = F2Dot14

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign for F2Dot14

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Zeroable for F2Dot14

fn zeroed() -> Self

Calls zeroed.

impl AnyBitPattern for F2Dot14

impl Copy for F2Dot14

impl Eq for F2Dot14

impl NoUninit for F2Dot14

impl StructuralPartialEq for F2Dot14