Struct Fonts

pub struct Fonts<'a> { /* private fields */ }

A collection of fonts to use for rendering. Supports font fallback.

It is recommended, but not required, that all fonts have the same/very similar aspect ratio, or you may get unexpected results during rendering due to fallback.

Implementations

impl<'a> Fonts<'a>

pub fn new(font: Font<'a>, size_px: u32) -> Self

Create a new, empty set of fonts. The provided font will be used as a last-resort fallback if no other fonts can render a particular character. Rendering will attempt to fake bold/italic styles using this font where appropriate.

The provided size_px will be the rendered height in pixels of all fonts in this collection.

pub fn height_px(&self) -> u32

The height (in pixels) of all fonts.

pub fn set_size_px(&mut self, height_px: u32)

Change the height of all fonts in this collection to the specified height in pixels.

pub fn add_fonts(&mut self, fonts: impl IntoIterator<Item = Font<'a>>)

Add a collection of fonts for various styles. They will automatically be added to the appropriate fallback font list based on the font’s bold/italic properties. Note that this will automatically organize fonts by relative width in order to optimize fallback rendering quality. The ordering of already provided fonts will remain unchanged.

pub fn add_regular_fonts(&mut self, fonts: impl IntoIterator<Item = Font<'a>>)

Add a new collection of fonts for regular styled text. These fonts will come after previously provided fonts in the fallback order.

pub fn add_bold_fonts(&mut self, fonts: impl IntoIterator<Item = Font<'a>>)

Add a new collection of fonts for bold styled text. These fonts will come after previously provided fonts in the fallback order.

You do not have to provide these for bold text to be supported. If no bold fonts are supplied, rendering will fallback to the regular fonts with fake bolding.

pub fn add_italic_fonts(&mut self, fonts: impl IntoIterator<Item = Font<'a>>)

Add a new collection of fonts for italic styled text. These fonts will come after previously provided fonts in the fallback order.

It is recommended, but not required, that you provide italic fonts if your application intends to make use of italics. If no italic fonts are supplied, rendering will fallback to the regular fonts with fake italics.

pub fn add_bold_italic_fonts( &mut self, fonts: impl IntoIterator<Item = Font<'a>>, )

Add a new collection of fonts for bold italic styled text. These fonts will come after previously provided fonts in the fallback order.

You do not have to provide these for bold text to be supported. If no bold fonts are supplied, rendering will fallback to the italic fonts with fake bolding.