Struct bmfont_parser::BMFont

pub struct BMFont {
    pub font_name: String,
    pub size: u32,
    pub info_details: Option<InfoDetails>,
    pub line_height: u32,
    pub common_details: Option<CommonDetails>,
    pub pages: Vec<Page>,
    pub chars: HashMap<u32, BMCharacter>,
}

Loaded and parsed struct of an .sfl file (a bitmap font file).

Fields

font_name: String

The name of the font.

size: u32

Size of the font.

info_details: Option<InfoDetails>

Some details from the Info-block that are not available in all parsing methods

line_height: u32

Line height of the font.

common_details: Option<CommonDetails>

Some details from the Common-block that are not available in all parsing methods

pages: Vec<Page>

The pages of this font

chars: HashMap<u32, BMCharacter>

Hashmap of the characters in the font. <CharID, BMCharacter>

Methods

impl BMFont

pub fn from_path<T: Into<PathBuf>>(     format: &Format,     path: T ) -> Result<BMFont, Error>

Load and parse a BMFont from the given path, which should be an .sfl file.

Examples

use bmfont_parser::{BMFont, Format};

let bmfont = match BMFont::from_path(&Format::SFL, "examples/fonts/iosevka.sfl") {
    Ok(bmfont) => bmfont,
    Err(_) => panic!("Failed to load iosevka.sfl"),
};

println!("bmfont: {}", bmfont);

pub fn from_loaded<T: Into<String>>(     format: &Format,     contents: T,     image_path: &[&str] ) -> Result<BMFont, Error>

Load and parse a BMFont from the given String, which should be the contents of an .sfl file.

Examples

use bmfont_parser::{BMFont, Format};

let iosevka_sfl = include_str!("../examples/fonts/iosevka.sfl");

let bmfont = match BMFont::from_loaded(&Format::SFL, iosevka_sfl, &["examples/fonts/iosevka.png"]) {
    Ok(bmfont) => bmfont,
    Err(_) => panic!("Failed to load iosevka.sfl"),
};

println!("bmfont: {}", bmfont);

Trait Implementations

impl Clone for BMFont

fn clone(&self) -> BMFont

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BMFont

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

Formats the value using the given formatter.

impl Display for BMFont

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

Formats the value using the given formatter.