Struct Font 

pub struct Font { /* private fields */ }

One face of an OpenType/TrueType font file or collection. Cheap to clone (the bytes are shared); clones keep the same FontId, so they share cached glyphs.

Implementations

impl Font

pub fn new(data: impl Into<Arc<[u8]>>) -> Result<Self, FontError>

Loads a font from its file bytes (face 0 of a collection).

Errors

FontError::Parse if the bytes are not a readable font.

pub fn from_shared(data: FontBytes, index: u32) -> Result<Self, FontError>

Face index of the font file or collection in data, sharing the bytes.

Each call creates a new FontId: load a face once and clone the Font.

Errors

FontError::Parse if the bytes are not a readable font or have no face index.

pub fn bundled_mono() -> Result<Self, FontError>

The bundled JetBrains Mono (BUNDLED_MONO). Every call returns the same font (same FontId), so all users share its cached glyphs.

Errors

Only if the bundled file were corrupt; tests guard against that.

pub fn id(&self) -> FontId

This font’s identity, used to key cached glyphs.

pub fn index(&self) -> u32

The face’s index within its file (0 unless the file is a collection).

pub fn bytes(&self) -> &[u8]

The whole font file.

pub fn shared_bytes(&self) -> FontBytes

The shared file bytes, for handing to another library without copying.

pub fn glyph_id(&self, ch: char) -> Option<GlyphId>

The glyph the font draws for ch, or None if it has no glyph for it.

pub fn advance(&self, glyph: GlyphId, px: f32) -> f32

Horizontal advance of glyph at px pixels per em; 0 if unknown.

pub fn glyph_extent(&self, glyph: GlyphId, px: f32) -> Option<[f32; 2]>

Width and height in pixels of glyph’s outline bounding box at px pixels per em, without rasterizing it; None if the font cannot say (then the caller must assume the worst). Some([0.0, 0.0]) for glyphs without an outline.

pub fn line_metrics(&self, px: f32) -> LineMetrics

Ascent, descent and line gap at px pixels per em.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Self

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.