Struct F2Dot14 

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

The OpenType F2Dot14 type, a 2.14-bit signed fixed-point type.

Implementations

impl F2Dot14

pub const STEP: Self

The difference between adjacent F2Dot14 values.

Examples

assert_eq!(F2Dot14::STEP, 0.000061035156);

pub const MIN: Self

The smallest value that can be represented by this type.

Examples

assert_eq!(F2Dot14::MIN, -2.0);

pub const MAX: Self

The largest value that can be represented by this type.

Examples

assert_eq!(F2Dot14::MAX, 1.999939);

pub const ZERO: Self

The value zero.

Examples

assert_eq!(F2Dot14::ZERO, 0.0);

pub const ONE: Self

The value one.

Examples

assert_eq!(F2Dot14::ONE, 1.0);

pub const DENOM: i16

This type’s integer fraction’s denominator.

Examples

assert_eq!(F2Dot14::DENOM, 16384);

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

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

Examples

use ttf_view::types::F2Dot14;

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

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

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

Creates a F2Dot14 from f32, saturating at the numeric bounds, and mapping NaN to 0.

Examples

use ttf_view::types::F2Dot14;

assert_eq!(F2Dot14::new_saturating(-0.125), -0.125);
assert_eq!(F2Dot14::new_saturating(1.99609375), 1.99609375);
assert_eq!(F2Dot14::new_saturating(-34000.0), -2.0);
assert_eq!(F2Dot14::new_saturating(34000.0), 1.999939);
assert_eq!(F2Dot14::new_saturating(f32::NAN), 0.0);

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

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

Creates a F2Dot14 from big-endian bytes.

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

Gets this F2Dot14’s big-endian bytes.

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

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

pub const fn frac_num(self) -> i16

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

pub const fn get(self) -> f32

Returns this F2Dot14’s value as f32.

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 F2Dot14

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

type Output = F2Dot14

The resulting type after applying the + operator.

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

Performs the + operation.

impl Binary for F2Dot14

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

Formats the value using the given formatter.

impl Clone for F2Dot14

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 F2Dot14

impl Debug for F2Dot14

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

Formats the value using the given formatter.

impl Default for F2Dot14

fn default() -> Self

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 Div for F2Dot14

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

Panics

This operation will panic if rhs == 0.

type Output = F2Dot14

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for F2Dot14

type Output = f32

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for F2Dot14

impl From<BigEndian<F2Dot14>> for F2Dot14

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

Converts to this type from the input type.

impl From<F2Dot14> for f32

fn from(value: F2Dot14) -> Self

Converts to this type from the input type.

impl FromStr for F2Dot14

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 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 LowerExp for F2Dot14

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

Formats the value using the given formatter.

impl LowerHex for F2Dot14

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

Formats the value using the given formatter.

impl Mul for F2Dot14

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

type Output = F2Dot14

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for F2Dot14

type Output = f32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for F2Dot14

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

type Output = F2Dot14

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for F2Dot14

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 F2Dot14

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<f32> for F2Dot14

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for F2Dot14

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<f32> for F2Dot14

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

type BigEndian = [u8; 2]

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

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

impl Rem for F2Dot14

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

Panics

This operation will panic if rhs == 0.

type Output = F2Dot14

The resulting type after applying the % operator.

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

Performs the % operation.

impl StructuralPartialEq for F2Dot14

impl Sub for F2Dot14

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

type Output = F2Dot14

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<f32> for F2Dot14

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperExp for F2Dot14

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

Formats the value using the given formatter.

impl UpperHex for F2Dot14

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

Formats the value using the given formatter.