Struct pdfium_render::points::PdfPoints

pub struct PdfPoints {
    pub value: f32,
}

The internal coordinate system inside a PdfDocument is measured in Points, a device-independent unit equal to 1/72 inches, roughly 0.358 mm. Points are converted to pixels when a PdfPage is rendered into a PdfBitmap.

Fields

value: f32

Implementations

impl PdfPoints

pub const ZERO: PdfPoints = _

A PdfPoints object with identity value 0.0.

pub const MAX: PdfPoints = _

A PdfPoints object with the largest addressable finite positive value.

pub const MIN: PdfPoints = _

A PdfPoints object with the smallest addressable finite negative value.

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

Creates a new PdfPoints object with the given value.

pub const fn zero() -> Self

Creates a new PdfPoints object with the value 0.0.

Consider using the compile-time constant value PdfPoints::ZERO rather than calling this function directly.

pub const fn max() -> Self

A PdfPoints object with the largest addressable finite positive value.

In theory, this should be f32::MAX; in practice, values approaching f32::MAX are handled inconsistently by Pdfium, so this value is set to an arbitrarily large positive value that does not approach f32::MAX but should more than suffice for every use case.

pub const fn min() -> Self

A PdfPoints object with the smallest addressable finite negative value.

In theory, this should be f32::MIN; in practice, values approaching f32::MIN are handled inconsistently by Pdfium, so this value is set to an arbitrarily large negative value that does not approach f32::MIN but should more than suffice for every use case.

pub fn from_inches(inches: f32) -> Self

Creates a new PdfPoints object from the given measurement in inches.

pub fn from_cm(cm: f32) -> Self

Creates a new PdfPoints object from the given measurement in centimeters.

pub fn from_mm(mm: f32) -> Self

Creates a new PdfPoints object from the given measurement in millimeters.

pub fn to_inches(&self) -> f32

Converts the value of this PdfPoints object to inches.

pub fn to_cm(&self) -> f32

Converts the value of this PdfPoints object to centimeters.

pub fn to_mm(&self) -> f32

Converts the value of this PdfPoints object to millimeters.

Trait Implementations

impl Add for PdfPoints

type Output = PdfPoints

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for PdfPoints

fn add_assign(&mut self, rhs: PdfPoints)

Performs the += operation.

impl Clone for PdfPoints

fn clone(&self) -> PdfPoints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PdfPoints

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

Formats the value using the given formatter.

impl Display for PdfPoints

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

Formats the value using the given formatter.

impl Div<f32> for PdfPoints

type Output = PdfPoints

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<f32> for PdfPoints

type Output = PdfPoints

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for PdfPoints

type Output = PdfPoints

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for PdfPoints

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

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

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

type Output = PdfPoints

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for PdfPoints

fn sub_assign(&mut self, rhs: PdfPoints)

Performs the -= operation.

impl Copy for PdfPoints

impl Eq for PdfPoints

impl StructuralPartialEq for PdfPoints