Skip to main content

GlyphMap

Struct GlyphMap 

Source
pub struct GlyphMap { /* private fields */ }
Expand description

Cached character-to-glyph mapping for one font at one size.

Font::glyph_id re-reads the font’s tables on every call; per-frame text needs the answer for thousands of characters, so this caches it: ASCII is resolved up front into a table, any other character on first use (that first use allocates, later ones don’t). Characters the font lacks map to its ? glyph.

Memory is bounded: after MAX_CACHED_CHARS distinct non-ASCII characters (streaming text, CJK), the non-ASCII memory is cleared, keeping its capacity, and refilled on use.

Implementations§

Source§

impl GlyphMap

Source

pub fn new(font: Font, px: f32) -> Self

A map for font at px pixels per em.

Source

pub fn font(&self) -> &Font

The font this map resolves against.

Source

pub fn px(&self) -> f32

The size in pixels per em.

Source

pub fn cached_chars(&self) -> usize

Non-ASCII characters currently remembered (at most MAX_CACHED_CHARS).

Source

pub fn line_metrics(&self) -> LineMetrics

The font’s line metrics at this size.

Source

pub fn get(&mut self, ch: char) -> Option<MappedGlyph>

The glyph for ch, or the ? glyph if the font has none; None only if the font lacks ? too.

Source

pub fn measure(&mut self, text: &str) -> f32

Total advance of text in pixels.

Trait Implementations§

Source§

impl Clone for GlyphMap

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GlyphMap

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.