Struct Fixed 

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

The OpenType Fixed type, a 16.16-bit signed fixed-point type.

Implementations

impl Fixed

pub const STEP: Self

The difference between adjacent Fixed values.

Examples

assert_eq!(Fixed::STEP, 0.0000152587890625);

pub const MIN: Self

The smallest value that can be represented by this type.

Examples

assert_eq!(Fixed::MIN, -32768.0);

pub const MAX: Self

The largest value that can be represented by this type.

Examples

assert_eq!(Fixed::MAX, 32767.99998474121);

pub const ZERO: Self

The value zero.

Examples

assert_eq!(Fixed::ZERO, 0.0);

pub const ONE: Self

The value one.

Examples

assert_eq!(Fixed::ONE, 1.0);

pub const DENOM: i32

This type’s integer fraction’s denominator.

Examples

assert_eq!(Fixed::DENOM, 65536);

pub const fn new(num: f64) -> Option<Self>

Creates a Fixed from f64, returning None if the value is out of Fixed’s range.

Examples

use ttf_view::types::Fixed;

assert_eq!(Fixed::new(-0.125).unwrap(), -0.125);
assert_eq!(Fixed::new(1.99609375).unwrap(), 1.99609375);
assert_eq!(Fixed::new(-34000.0), None);
assert_eq!(Fixed::new(34000.0), None);
assert_eq!(Fixed::new(f64::NAN), None);

// numbers are rounded towards the closest value representable by Fixed
assert_eq!(Fixed::new(0.5156247).unwrap(), 0.515625);
assert_eq!(Fixed::new(0.5156250).unwrap(), 0.515625);
assert_eq!(Fixed::new(0.5156254).unwrap(), 0.515625);

pub const fn new_saturating(num: f64) -> Self

Creates a Fixed from f64, saturating at the numeric bounds, and mapping NaN to 0.

Examples

use ttf_view::types::Fixed;

assert_eq!(Fixed::new_saturating(-0.125), -0.125);
assert_eq!(Fixed::new_saturating(1.99609375), 1.99609375);
assert_eq!(Fixed::new_saturating(-34000.0), -32768.0);
assert_eq!(Fixed::new_saturating(34000.0), 32767.99998474121);
assert_eq!(Fixed::new_saturating(f64::NAN), 0.0);

// numbers are rounded towards the closest value representable by Fixed
assert_eq!(Fixed::new_saturating(0.5156247), 0.515625);
assert_eq!(Fixed::new_saturating(0.5156250), 0.515625);
assert_eq!(Fixed::new_saturating(0.5156254), 0.515625);

pub const fn from_be_bytes(bytes: [u8; 4]) -> Self

Creates a Fixed from big-endian bytes.

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

Gets this Fixed’s big-endian bytes.

pub const fn from_frac_num(numerator: i32) -> Self

Creates a Fixed from its integer fraction’s numerator (Fixed represented as numerator/65536$\frac{\mathrm{numerator}}{65536}$).

pub const fn frac_num(self) -> i32

Returns this Fixed’s integer fraction’s numerator (Fixed represented as numerator/65536$\frac{\mathrm{numerator}}{65536}$).

pub const fn get(self) -> f64

Returns this Fixed’s value as f64.

pub const fn wrapping_neg(self) -> Self

pub const fn wrapping_add(self, rhs: Self) -> Self

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

pub const fn wrapping_mul(self, rhs: Self) -> Self

pub const fn wrapping_div(self, rhs: Self) -> Self

Panics

This function panics if rhs == 0.

pub const fn wrapping_rem(self, rhs: Self) -> Self

Panics

This function panics if rhs == 0.

pub const fn saturating_neg(self) -> Self

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

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

pub const fn saturating_mul(self, rhs: Self) -> Self

pub const fn saturating_div(self, rhs: Self) -> Self

Panics

This function panics if rhs == 0.

pub const fn checked_neg(self) -> Option<Self>

pub const fn checked_add(self, rhs: Self) -> Option<Self>

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

pub const fn checked_mul(self, rhs: Self) -> Option<Self>

pub const fn checked_div(self, rhs: Self) -> Option<Self>

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

Trait Implementations

impl Add for Fixed

Performs addition + (panics on overflow in debug configuration).

type Output = Fixed

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Binary for Fixed

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

Formats the value using the given formatter.

impl Clone for Fixed

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Fixed

impl Debug for Fixed

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

Formats the value using the given formatter.

impl Default for Fixed

fn default() -> Self

Returns the “default value” for a type.

impl Display for Fixed

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

Formats the value using the given formatter.

impl Div for Fixed

Performs division / (panics on overflow in debug configuration).

Panics

This operation will panic if rhs == 0.

type Output = Fixed

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Fixed

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for Fixed

impl From<BigEndian<Fixed>> for Fixed

fn from(value: BigEndian<Fixed>) -> Self

Converts to this type from the input type.

impl From<Fixed> for f64

fn from(value: Fixed) -> Self

Converts to this type from the input type.

impl FromStr for Fixed

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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 LowerExp for Fixed

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

Formats the value using the given formatter.

impl LowerHex for Fixed

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

Formats the value using the given formatter.

impl Mul for Fixed

Performs multiplication * (panics on overflow in debug configuration).

type Output = Fixed

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Fixed

type Output = f64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Fixed

Performs negation - (panics on overflow in debug configuration).

type Output = Fixed

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Fixed

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Fixed

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<f64> for Fixed

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Fixed

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

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

type BigEndian = [u8; 4]

fn from_big_endian(x: Self::BigEndian) -> Self

fn to_big_endian(x: Self) -> Self::BigEndian

impl Rem for Fixed

Performs remainder operation % (panics on overflow in debug configuration).

Panics

This operation will panic if rhs == 0.

type Output = Fixed

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl StructuralPartialEq for Fixed

impl Sub for Fixed

Performs subtraction - (panics on overflow in debug configuration).

type Output = Fixed

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<f64> for Fixed

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperExp for Fixed

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

Formats the value using the given formatter.

impl UpperHex for Fixed

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

Formats the value using the given formatter.