Struct tetra::graphics::text::Font

pub struct Font { /* fields omitted */ }

A font with an associated size, cached on the GPU.

Performance

Creating a Font is a relatively expensive operation. If you can, store them in your State struct rather than recreating them each frame.

Cloning a Font is a very cheap operation, as the underlying data is shared between the original instance and the clone via reference-counting.

Examples

The text example demonstrates how to load a font and then draw some text.

Implementations

impl Font

pub fn vector<P>(ctx: &mut Context, path: P, size: f32) -> Result<Font> where
    P: AsRef<Path>, 

Creates a Font from a vector font file, with the given size.

TrueType and OpenType fonts are supported.

If you want to load multiple sizes of the same font, you can use a VectorFontBuilder to avoid loading/parsing the file multiple times.

Errors

• TetraError::FailedToLoadAsset will be returned if the file could not be loaded.
• TetraError::InvalidFont will be returned if the font data was invalid.
• TetraError::PlatformError will be returned if the GPU cache for the font could not be created.

Trait Implementations

impl Clone for Font

pub fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

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

Formats the value using the given formatter.