Struct Font 

pub struct Font {
    idx: usize,
    is_builtin: bool,
    scale: Scale,
    line_height: Mm,
    glyph_height: Mm,
    ascent: Mm,
    descent: Mm,
}

A reference to a font cached by a FontCache.

See the module documentation for details on the internals.

Fields

idx: usize

is_builtin: bool

scale: Scale

line_height: Mm

glyph_height: Mm

ascent: Mm

descent: Mm

Implementations

impl Font

fn new(idx: usize, is_builtin: bool, rt_font: &Font<'static>) -> 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.

Examples

use genpdfi_extended::fonts::{FontData, FontFamily, FontCache};
let data = include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/fonts/NotoSans-Regular.ttf")).to_vec();
let fd = FontData::new(data, None).expect("font data");
let family = FontFamily { regular: fd.clone(), bold: fd.clone(), italic: fd.clone(), bold_italic: fd.clone() };
let cache = FontCache::new(family);
let f = cache.default_font_family().regular;
assert!(f.ascent(12) > genpdfi_extended::Mm::from(0.0));

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

Returns the descent 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.

fn char_h_metrics(&self, font_cache: &FontCache, c: char) -> HMetrics

fn builtin_char_h_metrics(&self, c: char) -> HMetrics

Returns standardized character metrics for built-in PDF fonts. These values are based on the Adobe Font Metrics (AFM) for standard PDF fonts.

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 duplicate 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 for Font

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

Tests for self and other values to be equal, and is used by ==.

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

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