Struct bracket_lib::prelude::Font

pub struct Font {
    pub bitmap_file: String,
    pub width: u32,
    pub height: u32,
    pub gl_id: Option<u32>,
    pub tile_size: (u32, u32),
    pub explicit_background: Option<RGB>,
    pub font_dimensions_glyphs: (u32, u32),
}

BTerm's representation of a font or tileset file.

Fields

bitmap_file: String

width: u32

height: u32

gl_id: Option<u32>

tile_size: (u32, u32)

explicit_background: Option<RGB>

font_dimensions_glyphs: (u32, u32)

Methods

impl Font

pub fn new<S>(
    filename: S,
    width: u32,
    height: u32,
    tile_size: (u32, u32)
) -> Font where
    S: ToString, 

Creates an unloaded texture with filename and size parameters provided.

pub fn load<S>(
    filename: S,
    tile_size: (u32, u32),
    explicit_background: Option<RGB>
) -> Font where
    S: ToString, 

Loads a font file (texture) to obtain the width and height for you

pub fn setup_gl_texture(
    &mut self,
    gl: &Context
) -> Result<u32, Box<dyn Error + 'static + Send + Sync>>

Load a font, and allocate it as an OpenGL resource. Returns the OpenGL binding number (which is also set in the structure).

pub fn bind_texture(&self, gl: &Context)

Sets this font file as the active texture

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

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 StructuralPartialEq for Font