Struct lyon_core::fixed::Fp32

pub struct Fp32<F = _16> { /* fields omitted */ }

A 32 fixed point number. The size of the fractional is defined by the type parameter F.

Methods

impl<F: FractionalBits> Fp32<F>

fn raw(self) -> i32

Returns the internal representation.

This internal represenataion can be used for computations to avoid bit-shifting between each operation. The number of divisions should be equal to the number of multiplications performed in order to balance out the bit shifts that were skipped.

fn from_raw(bits: i32) -> Self

fn zero() -> Self

fn is_zero(self) -> bool

fn epsilon() -> Self

Smallest increment that can be reresented with this type.

fn from_f32(val: f32) -> Self

Converts from a 32 bits floating point value.

fn to_f32(self) -> f32

Converts to a 32 bits floating point value.

fn from_f64(val: f64) -> Self

Converts from a 64 bits floating point value.

fn to_f64(self) -> f64

Converts to a 64 bits floating point value.

fn sign(self) -> i32

Returns 1 if the number of positive, -1 if it is negative.

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

Returns the result of self % other.

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

Returns the lowest of the two values.

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

Returns the highest of the two values.

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

Returns the lowest and highest of the two values in order.

fn abs(self) -> Self

Returns the absolute value of this number.

fn to_fixed<NewF: FractionalBits>(self) -> Fp32<NewF>

Returns the same number with a different fractional precision.

impl<F: FractionalBits> Fp32<F>

fn one() -> Self

fn from_i32(val: i32) -> Self

fn truncate_to_i32(self) -> i32

Convert to an i32, truncating the fractional part

fn mul_div(self, m: Self, d: Self) -> Self

Computes the self * m / d in one go, avoid the precision loss from shifting bits back and forth.

fn min_val() -> Self

fn max_val() -> Self

fn to_fp64<NewF: FractionalBits>(self) -> Fp64<NewF>

Casts into a 64 bits fixed point number.

Trait Implementations

impl<F> Copy for Fp32<F>

impl<F> Clone for Fp32<F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> PartialEq for Fp32<F>

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

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

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

This method tests for !=.

impl<F> Eq for Fp32<F>

impl<F: FractionalBits> Debug for Fp32<F>

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

Formats the value using the given formatter.

impl<F: FractionalBits> Display for Fp32<F>

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

Formats the value using the given formatter.

impl<F> Hash for Fp32<F>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<F: FractionalBits> PartialOrd for Fp32<F>

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

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

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

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

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

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

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

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

impl<F: FractionalBits> Ord for Fp32<F>

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

This method returns an Ordering between self and other.

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

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

Compares and returns the maximum of two values.

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

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

Compares and returns the minimum of two values.

impl<F: FractionalBits> Add<Fp32<F>> for Fp32<F>

type Output = Self

The resulting type after applying the + operator

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

The method for the + operator

impl<F: FractionalBits> Sub<Fp32<F>> for Fp32<F>

type Output = Self

The resulting type after applying the - operator

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

The method for the - operator

impl<F: FractionalBits> Mul<Fp32<F>> for Fp32<F>

type Output = Self

The resulting type after applying the * operator

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

The method for the * operator

impl<F: FractionalBits> Neg for Fp32<F>

type Output = Self

The resulting type after applying the - operator

fn neg(self) -> Self

The method for the unary - operator

impl<F: FractionalBits> Mul<i32> for Fp32<F>

type Output = Fp32<F>

The resulting type after applying the * operator

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

The method for the * operator

impl<F: FractionalBits> Div<i32> for Fp32<F>

type Output = Fp32<F>

The resulting type after applying the / operator

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

The method for the / operator

impl<F: FractionalBits> AddAssign<Fp32<F>> for Fp32<F>

fn add_assign(&mut self, other: Self)

The method for the += operator

impl<F: FractionalBits> SubAssign<Fp32<F>> for Fp32<F>

fn sub_assign(&mut self, other: Self)

The method for the -= operator

impl<F: FractionalBits> Into<f32> for Fp32<F>

fn into(self) -> f32

Performs the conversion.

impl<F: FractionalBits> From<f32> for Fp32<F>

fn from(val: f32) -> Self

Performs the conversion.

impl<F: FractionalBits> Into<f64> for Fp32<F>

fn into(self) -> f64

Performs the conversion.

impl<F: FractionalBits> From<f64> for Fp32<F>

fn from(val: f64) -> Self

Performs the conversion.

impl<F: FractionalBits> Div<Fp32<F>> for Fp32<F>

type Output = Self

The resulting type after applying the / operator

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

The method for the / operator