Struct Fixed

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

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

Implementations

impl Fixed

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: i32) -> Self

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

pub const fn to_bits(self) -> i32

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; 4]

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

impl Fixed

pub const fn mul_div(&self, a: Self, b: Self) -> Self

Multiplies self by a and divides the product by b.

impl Fixed

pub fn from_f64(x: f64) -> Self

Creates a fixed point value from af64.

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

pub fn to_f64(self) -> f64

Returns the value as an f64.

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

impl Fixed

pub const fn from_i32(i: i32) -> Self

Creates a 16.16 fixed point value from a 32 bit integer.

pub const fn to_i32(self) -> i32

Converts a 16.16 fixed point value to a 32 bit integer, rounding off the fractional bits.

pub const fn to_f26dot6(self) -> F26Dot6

Converts a 16.16 to 26.6 fixed point value.

pub const fn to_f2dot14(self) -> F2Dot14

Converts a 16.16 to 2.14 fixed point value.

This specific conversion is defined by the spec: https://learn.microsoft.com/en-us/typography/opentype/spec/otvaroverview#coordinate-scales-and-normalization

“5. Convert the final, normalized 16.16 coordinate value to 2.14 by this method: add 0x00000002, and sign-extend shift to the right by 2.”

pub fn to_f32(self) -> f32

Converts a 16.16 fixed point value to a single precision floating point value.

This operation is lossy. Use to_f64() for a lossless conversion.

Trait Implementations

impl Add for Fixed

type Output = Fixed

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Fixed

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Fixed

fn clone(&self) -> Fixed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fixed

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

Formats the value using the given formatter.

impl Default for Fixed

fn default() -> Fixed

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fixed

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fixed

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

Formats the value using the given formatter.

impl Div for Fixed

type Output = Fixed

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl DivAssign for Fixed

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<i32> for Fixed

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Hash for Fixed

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 Mul for Fixed

type Output = Fixed

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl MulAssign for Fixed

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Fixed

type Output = Fixed

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Fixed

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

fn eq(&self, other: &Fixed) -> 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 Fixed

fn partial_cmp(&self, other: &Fixed) -> 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 Fixed

type Raw = [u8; 4]

The raw byte representation of this type.

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

Encode this type as raw big-endian bytes

fn from_raw(raw: [u8; 4]) -> 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 Serialize for Fixed

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Fixed

type Output = Fixed

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Fixed

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Zeroable for Fixed

fn zeroed() -> Self

Calls zeroed.

impl AnyBitPattern for Fixed

impl Copy for Fixed

impl Eq for Fixed

impl NoUninit for Fixed

impl StructuralPartialEq for Fixed