Struct Font

pub struct Font {
    pub name: String,
    pub line_height: u32,
    pub size: u32,
    /* private fields */
}

The Font is used to load fonts that can be used in the TextBuffer

The Font can be loaded from an .sfl or .fnt file and then used in the TextBuffer, in example:

use glerminal::{TerminalBuilder, Font, FontFormat};

let mut terminal = TerminalBuilder::new()
    .with_title("Hello glerminal::font::Font!")
    .with_dimensions((1280, 720))
    .with_font(Font::load(&FontFormat::SFL, "fonts/source_code_pro.sfl"))
    .with_headless(true)
    .build();

Alternatively you can use load_raw to load the font straight with include_str! and include_bytes!, example:

use glerminal::{TerminalBuilder, Font, FontFormat};

static SCP_SFL: &'static str = include_str!("../fonts/source_code_pro.sfl");
static SCP_PNG: &'static [u8] = include_bytes!("../fonts/source_code_pro.png");

let mut terminal = TerminalBuilder::new()
    .with_title("Hello glerminal::font::Font!")
    .with_dimensions((1280, 720))
    .with_font(Font::load_raw(&FontFormat::SFL, SCP_SFL, SCP_PNG))
    .with_headless(true)
    .build();

Fields

name: String

The name of the font

line_height: u32

Line height of the font

size: u32

Size of the font (width)

Implementations

impl Font

pub fn load<T: Into<PathBuf>>(format: &FontFormat, fnt_path: T) -> Font

Loads the font fron the given font file, for example:

use glerminal::{Font, FontFormat};
let font = Font::load(&FontFormat::SFL, "fonts/source_code_pro.sfl");

pub fn load_raw<T: Into<String>, R: Read>( format: &FontFormat, content: T, image_read: R, ) -> Font

Loads the font from the given string (font file contents) and Read (image read)

use glerminal::{Font, FontFormat};
use std::fs::File;

let font = Font::load_raw(&FontFormat::SFL, include_str!("../fonts/source_code_pro.sfl"), File::open("fonts/source_code_pro.png").unwrap());

pub fn get_character(&self, character: u16) -> Result<CharacterData, String>

Gets the CharacterData from the Font with the given char, if the charcter exists, otherwise returns an error as a String. Example:

use glerminal::{Font, FontFormat};
let a_char_data = Font::load(&FontFormat::SFL, "fonts/source_code_pro.sfl").get_character('a' as u16);

Trait Implementations

impl Debug for Font

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

Formats the value using the given formatter.

impl PartialEq for Font

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Font