Struct macroquad_text::Fonts

pub struct Fonts { /* fields omitted */ }

Implementations

impl Fonts

pub fn new(mode: ScalingMode) -> Self

Creates a new Fonts instance to handle all your fonts with a given ScalingMode

You can also call Fonts::default which defaults to [ScalingMode::Linear]

Examples

With nearest mode

let mut fonts = Fonts::new(ScalingMode::Nearest);

With linear mode

let mut fonts = Fonts::new(ScalingMode::Linear);

pub fn fonts(&self) -> &Vec<Font>

Returns an immutable reference to the list of fonts that are currently loaded

pub fn cache_glyph(&self, c: char, size: u16)

Caches a glyph for a given character with a given font size

You don’t really need to call this function since caching happens automatically

pub fn load_font_from_bytes_with_scale(
    &mut self,
    bytes: &[u8],
    scale: f32
) -> FontResult<()>

Loads font from bytes with a given scale

What Scale does

(copied from FontSettings::scale)

The scale in px the font geometry is optimized for. Fonts rendered at the scale defined here will be the most optimal in terms of looks and performance. Glyphs rendered smaller than this scale will look the same but perform slightly worse, while glyphs rendered larger than this will looks worse but perform slightly better. The units of the scale are pixels per Em unit.

pub fn load_font_from_bytes(&mut self, bytes: &[u8]) -> FontResult<()>

Loads font from bytes with a scale of 100.0

pub fn contains(&self, c: char) -> bool

Checks if any fonts supports this character

pub fn lookup_glyph_index(&self, c: char) -> (usize, u16)

Looks up glyph index in all fonts until it finds one

pub fn rasterize(&self, c: char, px: f32) -> (Metrics, Vec<u8>)

Rasterize a character using which ever font that contains that character first

See Font::rasterize or Font::rasterize_indexed

pub fn measure_text(&self, text: &str, size: u16) -> TextDimensions

Measures text with a given font size

Example

let dimensions = fonts.measure_text("Some Text", 22);

println!("width: {}, height: {}, offset_y: {}",
  dimensions.width,
  dimensions.height,
  dimensions.offset_y
)

See TextDimensions

pub fn draw_text(&self, text: &str, x: f32, y: f32, size: u16, color: Color)

Draws text with a given font size, draws from TopLeft

Examples

fonts.draw_text("Some Text", 20.0, 20.0, 22, Color::from_rgba(255, 255, 255, 255));

See Self::draw_text_ex

pub fn draw_text_ex(&self, params: &TextParams<'_>)

Draws text with given TextParams

Example

fonts.draw_text_ex(&TextParams {
  text: "Some Text",
  x: 20.0,
  y: 20.0,
  // Default Size
  size: 22,
  // Default Color
  color: Color::from_rgba(255, 255, 255, 255),
  // Default Draw method
  draw: DrawFrom::TopLeft
});

// Does the same as above
fonts.draw_text_ex(&TextParams {
  text: "Some Text",
  x: 20.0,
  y: 20.0,
  ..Default::default()
});

See Self::draw_text

Trait Implementations

impl Default for Fonts

fn default() -> Self

Creates a new Fonts instance to handle all your font

Same as calling [Fonts::new(ScalingMode::Linear)]