Struct tetra::graphics::text::VectorFontBuilder

pub struct VectorFontBuilder { /* fields omitted */ }

A builder for vector-based fonts.

TrueType and OpenType fonts are supported. The font data will only be loaded into memory once, and it will be shared between all Fonts that are subsequently created by the builder instance.

Font::vector provides a simpler API for loading vector fonts, if you don't need all of the functionality of this struct.

Performance

Creating a VectorFontBuilder is a relatively expensive operation. If you need to create extra sizes of the font later on, store the VectorFontBuilder rather than building a new one.

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

Implementations

impl VectorFontBuilder

pub fn new<P>(path: P) -> Result<VectorFontBuilder> where
    P: AsRef<Path>, 

Loads a vector font from the given file.

Errors

• TetraError::FailedToLoadAsset will be returned if the file could not be loaded.
• TetraError::InvalidFont will be returned if the font data was invalid.

pub fn from_file_data(data: &'static [u8]) -> Result<VectorFontBuilder>

Loads a vector font from a slice of binary data.

Errors

• TetraError::InvalidFont will be returned if the font data was invalid.

pub fn with_size(&self, ctx: &mut Context, size: f32) -> Result<Font>

Creates a Font with the given size.

Errors

• TetraError::PlatformError will be returned if the GPU cache for the font could not be created.

Trait Implementations

impl Clone for VectorFontBuilder

pub fn clone(&self) -> VectorFontBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VectorFontBuilder

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

Formats the value using the given formatter.