Struct Font 

pub struct Font(/* private fields */);

Font: a glyph atlas texture plus per-glyph metrics.

raylib ships a built-in default font (used when None or no font is specified in draw-text calls). User-defined fonts are loaded via RaylibHandle methods:

• RaylibHandle::load_font — loads the default size and full glyph set from a TTF/BDF/FNT file.
• RaylibHandle::load_font_ex — loads with an explicit point size and optional Unicode codepoint list (pass None for the entire set).
• RaylibHandle::load_font_from_image — XNA-style bitmap font from an image.
• RaylibHandle::load_font_from_memory — loads from an in-memory file buffer.

Freed via UnloadFont on drop.

Examples

Load a font with explicit size and a Latin-1 subset, then draw text:

use raylib::prelude::*;
let (mut rl, thread) = raylib::init().size(640, 480).title("font demo").build();
// Load a TTF at 32 pt, restricting to printable ASCII (codepoints 32-126).
let ascii: String = (32u8..=126).map(|c| c as char).collect();
let font = rl
    .load_font_ex(&thread, "assets/Roboto.ttf", 32, Some(&ascii))
    .unwrap();
while !rl.window_should_close() {
    let mut d = rl.begin_drawing(&thread);
    d.clear_background(Color::RAYWHITE);
    d.draw_text_ex(&font, "Hello, raylib!", Vector2::new(10.0, 10.0), 32.0, 2.0, Color::BLACK);
}

Implementations

impl Font

pub unsafe fn unwrap(self) -> Font

Take the raw ffi type. Must manually free memory by calling the proper unload function

Safety

The caller is responsible for freeing the returned value by calling the appropriate raylib unload function. Failure to do so will leak resources.

impl Font

pub fn to_raw(self) -> Font

returns the unwrapped raylib-sys object

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

converts raylib-sys object to a “safe” version. Make sure to call this function from the thread the resource was created.

Safety

The caller must ensure raw is a valid, fully initialized raylib object obtained from a raylib load function. Ownership is transferred to the returned wrapper, which will call the appropriate unload function on drop.

impl Font

pub fn make_weak(self) -> WeakFont

Converts this Font into a WeakFont that does not run UnloadFont on drop.

Use this when you want to hand a font to code that holds it by WeakFont (e.g. a renderer that doesn’t own the resource) and you take responsibility for unloading the GPU atlas yourself. Forgets the owning Font so the Drop impl doesn’t run; the returned WeakFont keeps the same texture and glyph table but will not free them on drop.

Examples

use raylib::prelude::*;

let (mut rl, thread) = raylib::init().size(640, 480).title("font").build();
let font = rl
    .load_font(&thread, "assets/font.ttf")
    .expect("font load");
let weak = font.make_weak();
// `weak` is now an alias with no drop responsibility — the atlas leaks unless
// ownership is reclaimed before `weak` goes out of scope.

See also

• WeakFont — the returned no-drop alias type.
• Font — owning counterpart.

Trait Implementations

impl AsRawMut<Font> for Font

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

Mutable access to the wrapped raw FFI value.

impl AsRef<Font> for Font

fn as_ref(&self) -> &Font

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Texture> for Font

fn as_ref(&self) -> &Texture2D

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Font

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

Formats the value using the given formatter.

impl Deref for Font

type Target = Font

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for Font

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl RaylibFont for Font

fn base_size(&self) -> i32

Base size (default chars height)

fn texture(&self) -> &Texture2D

Texture atlas containing the glyphs

fn chars(&self) -> &[GlyphInfo]

Glyphs info data

fn chars_mut(&mut self) -> &mut [GlyphInfo]

Glyphs info data

fn is_font_valid(&self) -> bool

Check if a font is valid

fn export_font_as_code<A>(&self, filename: A) -> bool

where A: Into<OsString>,

Export font as code file, returns true on success

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

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

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

Gets index position for a unicode character on font.

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

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

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

Measures string width in pixels for font.