Struct Font

pub struct Font { /* private fields */ }

Font, font texture and GlyphInfo array data

Implementations

impl Font

pub fn base_size(&self) -> u32

Base size (default chars height)

pub fn glyph_count(&self) -> usize

Number of glyph characters

pub fn glyph_padding(&self) -> u32

Padding around the glyph characters

pub fn from_file(file_name: &str) -> Option<Self>

Load font from file into GPU memory (VRAM)

pub fn from_file_ex( file_name: &str, font_size: u32, chars: &[char], ) -> Option<Self>

Load font from file with extended parameters

pub fn from_image( image: &Image, key_color: Color, first_char: char, ) -> Option<Self>

Load font from Image (XNA style)

pub fn from_memory( file_type: &str, file_data: &[u8], font_size: u32, chars: &[char], ) -> Option<Self>

Load font from memory buffer, fileType refers to extension: i.e. ‘.ttf’

pub fn export_as_code(&self, file_name: &str) -> bool

Export font as code file, returns true on success

pub fn measure_text(text: &str, font_size: u32) -> u32

Measure string width for default font

pub fn measure_text_ex( &self, text: &str, font_size: f32, spacing: f32, ) -> Vector2

Measure string size for Font

pub fn get_glyph_index(&self, codepoint: char) -> usize

Get glyph index position in font for a codepoint (unicode character), fallback to ‘?’ if not found

pub fn get_glyph_atlas_rect(&self, codepoint: char) -> Rectangle

Get glyph rectangle in font atlas for a codepoint (unicode character), fallback to ‘?’ if not found

pub fn get_glyph_info(&self, codepoint: char) -> GlyphInfo

Get glyph font info data for a codepoint (unicode character), fallback to ‘?’ if not found

pub fn as_raw(&self) -> &Font

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut Font

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: Font) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Debug for Font

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

Formats the value using the given formatter.

impl Default for Font

fn default() -> Self

Get the default Font

impl Drop for Font

fn drop(&mut self)

Executes the destructor for this type.