Struct figures::units::Lp

#[repr(C)]
pub struct Lp(/* private fields */);

Logical pixels, a device-independent measurement

A logical pixel is equivalent to a single pixel on a 96-DPI display. However, this unit is scaled when converiting to Px to honor the target display’s actual DPI.

For example, consider these assertions:

use figures::units::{Lp, Px};
use figures::{Fraction, ScreenScale};

// Scaling factor of 1.0
assert_eq!(Lp::new(1).into_px(Fraction::new_whole(1)), Px::new(1));

// Scaling factor of 2.0
assert_eq!(Lp::new(1).into_px(Fraction::new_whole(2)), Px::new(2));

// Scaling factor of 0.5
assert_eq!(Lp::new(1).into_px(Fraction::new(1, 2)), Px::from(0.5));

Logical pixels are designed around several use cases. Internally, this type uses integers to represent logical pixels, which ensures that math is always predictable, and any precision loss is controllable by the developer.

To ensure that the Lp type has as little precision loss as possible, it uses a scale of 1,905 subpixels . This number may seem arbitrary, but it is a multiple of the prime numbers 3, 5, and 127. These numbers are important because:

• 72: Typographic points are defined as 72 points per inch, and the prime factorization is 2^3 * 3^2.
• 96: A scaling factor of 1 is defined as 96 pixels per inchm, and the prime factorization is 2^5 * 3.
• 254: Allows using metric units lossleslly because 2.54cm = 1in, and it’s prime factorization is 2 * 127
• 5: Five is a low common prime, and everyone likes round numbers.

Because the Lp scale is arbitrary and hard to reason about, this type has many constructors to allow specifying measurements in various units developers will be more comfortable with:

use figures::units::Lp;

// Centimeters
assert_eq!(Lp::cm_f(1.), Lp::cm(1));
// Millimeters
assert_eq!(Lp::mm_f(1.), Lp::mm(1));
assert_eq!(Lp::mm(10), Lp::cm(1));

// Inches
assert_eq!(Lp::inches_f(1.), Lp::inches(1));
assert_eq!(Lp::inches(1), Lp::cm_f(2.54));

// Points
assert_eq!(Lp::points_f(36.), Lp::points(36));
assert_eq!(Lp::points(36), Lp::inches_f(0.5));

Implementations

impl Lp

pub const MAX: Self = _

The maximum value for this type.

pub const MIN: Self = _

The minimum value for this type.

pub const fn new(value: i32) -> Self

Returns a new wrapped value for this unit.

pub const fn get(self) -> i32

Returns the contained value, rounded if applicable.

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

Returns the result of subtracting other from self. If the calculation overflows, the value will be limited to Self::MIN/Self::MAX.

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

Returns the result of adding self and other. If the calculation overflows, the value will be limited to Self::MIN/Self::MAX.

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

Returns the result of multiplying self and other. If the calculation overflows, the value will be limited to Self::MIN/Self::MAX.

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

Returns the result of dividing self by other. If the calculation overflows, the value will be limited to Self::MIN/Self::MAX.

impl Lp

pub const fn points(points: i32) -> Self

Returns a value equivalent to the number of points provided. One point is 1/72 of an inch.

pub fn points_f(points: f32) -> Self

Returns a value equivalent to the number of points provided. One point is 1/72 of an inch.

pub const fn cm(centimeters: i32) -> Self

Returns a value equivalent to the number of centimeters provided.

pub fn cm_f(centimeters: f32) -> Self

Returns a value equivalent to the number of centimeters provided.

pub const fn mm(millimeters: i32) -> Self

Returns a value equivalent to the number of millimeters provided.

pub fn mm_f(millimeters: f32) -> Self

Returns a value equivalent to the number of millimeters provided.

pub const fn inches(inches: i32) -> Self

Returns a value equivalent to the number of inches provided.

pub fn inches_f(inches: f32) -> Self

Returns a value equivalent to the number of inches provided.

Trait Implementations

impl Abs for Lp

fn abs(&self) -> Self

Returns the positive difference between this value and 0.

impl<Unit> Add<Lp> for Point<Unit>where Unit: Add<Lp, Output = Unit>,

type Output = Point<Unit>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Unit> Add<Lp> for Size<Unit>where Unit: Add<Lp, Output = Unit>,

type Output = Size<Unit>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for Lp

type Output = Lp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Lp

type Output = Lp

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<i32> for Lp

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl AddAssign for Lp

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Lp

fn clone(&self) -> Lp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lp

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

Formats the value using the given formatter.

impl Default for Lp

fn default() -> Lp

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Lp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Lp

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

Formats the value using the given formatter.

impl Div<Fraction> for Lp

type Output = Lp

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Unit> Div<Lp> for Point<Unit>where Unit: Div<Lp, Output = Unit>,

type Output = Point<Unit>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Unit> Div<Lp> for Size<Unit>where Unit: Div<Lp, Output = Unit>,

type Output = Size<Unit>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Lp

type Output = Lp

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for Lp

type Output = Lp

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Lp

type Output = Lp

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i32> for Lp

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl DivAssign for Lp

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl FloatConversion for Lp

type Float = f32

The type that represents this type in floating point form.

fn into_float(self) -> Self::Float

Returns this value in floating point form.

fn from_float(float: Self::Float) -> Self

Converts from floating point to this form.

impl From<Lp> for f32

fn from(value: Lp) -> Self

Converts to this type from the input type.

impl From<Lp> for i32

fn from(value: Lp) -> Self

Converts to this type from the input type.

impl From<f32> for Lp

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<i32> for Lp

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Hash for Lp

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 IntoComponents<Lp> for f32

fn into_components(self) -> (Lp, Lp)

Extracts this type’s 2d vector components.

fn to_vec<Type>(self) -> Typewhere Type: FromComponents<Unit>,

Converts this type to another type using FromComponents and IntoComponents.

impl IntoComponents<Lp> for i32

fn into_components(self) -> (Lp, Lp)

Extracts this type’s 2d vector components.

fn to_vec<Type>(self) -> Typewhere Type: FromComponents<Unit>,

Converts this type to another type using FromComponents and IntoComponents.

impl IntoSigned for Lp

type Signed = Lp

The signed representation of this type.

fn into_signed(self) -> Self::Signed

Returns this value as an unsigned value. Values that are larger than can fit in an i32 are converted to i32::MAX.

impl Mul<Fraction> for Lp

type Output = Lp

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Unit> Mul<Lp> for Point<Unit>where Unit: Mul<Lp, Output = Unit>,

type Output = Point<Unit>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Unit> Mul<Lp> for Size<Unit>where Unit: Mul<Lp, Output = Unit>,

type Output = Size<Unit>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Lp

type Output = Lp

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for Lp

type Output = Lp

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Lp

type Output = Lp

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for Lp

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl MulAssign for Lp

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Lp

type Output = Lp

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Lp

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<i32> for Lp

fn eq(&self, other: &i32) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Lp

fn eq(&self, other: &Lp) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<i32> for Lp

fn partial_cmp(&self, other: &i32) -> 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 PartialOrd for Lp

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

const PX_SCALING_FACTOR: u16 = 1_905u16

The scaling factor to apply when converting to pixels, in addition to any spatial scaling already being applied.

impl Pow for Lp

fn pow(&self, exp: u32) -> Self

Returns the saturating result of raising self to the exp power.

impl Ranged for Lp

const MAX: Self = Lp::MAX

The maximum value for this type.

const MIN: Self = Lp::MIN

The minimum value for this type.

impl<Unit> Rem<Lp> for Point<Unit>where Unit: Rem<Lp, Output = Unit>,

type Output = Point<Unit>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<Unit> Rem<Lp> for Size<Unit>where Unit: Rem<Lp, Output = Unit>,

type Output = Size<Unit>

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Lp

type Output = Lp

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<i32> for Lp

type Output = Lp

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for Lp

type Output = Lp

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<i32> for Lp

fn rem_assign(&mut self, rhs: i32)

Performs the %= operation.

impl RemAssign for Lp

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Roots for Lp

fn sqrt(self) -> Self

Returns the square root of self.

fn cbrt(self) -> Self

Returns the cube root of self.

impl Round for Lp

fn round(self) -> Self

Returns self rounded to the nearest whole number.

fn ceil(self) -> Self

Returns self raised to the next whole number further away from 0.

fn floor(self) -> Self

Returns self lowered to the next whole number closer to 0.

impl ScreenScale for Lp

type Lp = Lp

This type when measuring with Lp.

type Px = Px

This type when measuring with Px.

type UPx = UPx

This type when measuring with UPx.

fn into_px(self, scale: Fraction) -> Self::Px

Converts this value from its current unit into device pixels (Px) using the provided scale factor.

fn from_px(px: Self::Px, scale: Fraction) -> Self

Converts from pixels into this type, using the provided scale factor.

fn into_lp(self, _scale: Fraction) -> Self::Lp

Converts this value from its current unit into device independent pixels (Lp) using the provided scale factor.

fn from_lp(lp: Self::Lp, _scale: Fraction) -> Self

Converts from Lp into this type, using the provided scale factor.

fn into_upx(self, scale: Fraction) -> Self::UPx

Converts this value from its current unit into device pixels (UPx) using the provided scale factor.

fn from_upx(px: Self::UPx, scale: Fraction) -> Self

Converts from unsigned pixels into this type, using the provided scale factor.

impl Serialize for Lp

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

Serialize this value into the given Serde serializer.

impl<Unit> Sub<Lp> for Point<Unit>where Unit: Sub<Lp, Output = Unit>,

type Output = Point<Unit>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Unit> Sub<Lp> for Size<Unit>where Unit: Sub<Lp, Output = Unit>,

type Output = Size<Unit>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for Lp

type Output = Lp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Lp

type Output = Lp

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<i32> for Lp

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

impl SubAssign for Lp

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<u32> for Lp

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UnscaledUnit for Lp

type Representation = i32

The internal reprsentation used by this type.

fn from_unscaled(unscaled: Self::Representation) -> Self

Returns a new instance using the unscaled representation.

fn into_unscaled(self) -> Self::Representation

Returns the inner, unscaled representation of this value.

impl Zero for Lp

const ZERO: Self = _

The zero value for this type.

fn is_zero(&self) -> bool

Returns true if self represents 0.

impl Zeroable for Lp

fn zeroed() -> Self

Calls zeroed.

impl Copy for Lp

impl Eq for Lp

impl Pod for Lp

impl StructuralEq for Lp

impl StructuralPartialEq for Lp