Struct rckive_genpdf::fonts::Font

pub struct Font { /* private fields */ }

A reference to a font cached by a FontCache.

See the module documentation for details on the internals.

Implementations

impl Font

pub fn is_builtin(&self) -> bool

Returns whether this font is a built-in PDF font.

pub fn get_line_height(&self, font_size: u8) -> Mm

Returns the line height for text with this font and the given font size.

pub fn glyph_height(&self, font_size: u8) -> Mm

Returns the glyph height for text with this font and the given font size.

pub fn ascent(&self, font_size: u8) -> Mm

Returns the ascent for text with this font and the given font size.

pub fn char_width(&self, font_cache: &FontCache, c: char, font_size: u8) -> Mm

Returns the width of a character with this font and the given font size.

The given FontCache must be the font cache that loaded this font.

pub fn char_left_side_bearing(
    &self,
    font_cache: &FontCache,
    c: char,
    font_size: u8
) -> Mm

Returns the width of the empty space between the origin of the glyph bounding box and the leftmost edge of the character, for a given font and font size.

The given FontCache must be the font cache that loaded this font.

pub fn str_width(&self, font_cache: &FontCache, s: &str, font_size: u8) -> Mm

Returns the width of a string with this font and the given font size.

The given FontCache must be the font cache that loaded this font.

pub fn kerning<I>(&self, font_cache: &FontCache, iter: I) -> Vec<f32>where
    I: IntoIterator<Item = char>,

Returns the kerning data for the given sequence of characters.

The i-th value of the returned data is the amount of kerning to insert before the i-th character of the sequence.

The given FontCache must be the font cache that loaded this font.

pub fn glyph_ids<I>(&self, font_cache: &FontCache, iter: I) -> Vec<u16>where
    I: IntoIterator<Item = char>,

Returns the glyphs IDs for the given sequence of characters.

The given FontCache must be the font cache that loaded this font.

pub fn metrics(&self, font_size: u8) -> Metrics

Calculate the metrics of a given font size for this font.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

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

Formats the value using the given formatter.

impl PartialEq<Font> for Font

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

impl StructuralPartialEq for Font