Struct tetra::graphics::text::Font

pub struct Font { /* fields omitted */ }

A font that can be used to render text. TrueType fonts (.ttf) and a subset of OpenType fonts (.otf) are supported.

The actual data for fonts is cached in the Context, so there should be no overhead for copying this type - as such, it implements Copy and Clone.

Deja Vu Sans Mono is provided as a default font, and can be used by calling Font::default(). If you use it, you must distribute the license with your game - it can be found in src/resources.

Methods

impl Font

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

Loads a font from the given file.

Errors

If the file could not be read, a TetraError::Io will be returned.

pub fn from_file_data(ctx: &mut Context, data: &'static [u8]) -> Font

Loads a font from a slice of binary TTF data.

This is useful in combination with include_bytes, as it allows you to include your fonts directly in the binary.

Note that this function currently requires the slice to have the 'static lifetime due to the way that the font cache is implemented - this may change in the future.

pub fn from_data(ctx: &mut Context, data: &'static [u8]) -> Font

Deprecated since 0.2.14:

Renamed to from_file_data for consistency with Texture and Sound.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Font

impl PartialEq<Font> for Font

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for Font

fn default() -> Font

Returns the "default value" for a type.

impl Debug for Font

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

Formats the value using the given formatter.