Struct FontDefinitions

pub struct FontDefinitions {
    pub font_data: BTreeMap<String, Arc<FontData>>,
    pub families: BTreeMap<FontFamily, Vec<String>>,
}

Describes the font data and the sizes to use.

Often you would start with FontDefinitions::default() and then add/change the contents.

This is how you install your own custom fonts:

let mut fonts = FontDefinitions::default();

// Install my own font (maybe supporting non-latin characters):
fonts.font_data.insert("my_font".to_owned(),
   std::sync::Arc::new(
       // .ttf and .otf supported
       FontData::from_static(include_bytes!("../../../epaint_default_fonts/fonts/Ubuntu-Light.ttf"))
   )
);

// Put my font first (highest priority):
fonts.families.get_mut(&FontFamily::Proportional).unwrap()
    .insert(0, "my_font".to_owned());

// Put my font as last fallback for monospace:
fonts.families.get_mut(&FontFamily::Monospace).unwrap()
    .push("my_font".to_owned());

egui_ctx.set_fonts(fonts);

Fields

font_data: BTreeMap<String, Arc<FontData>>

List of font names and their definitions.

epaint has built-in-default for these, but you can override them if you like.

families: BTreeMap<FontFamily, Vec<String>>

Which fonts (names) to use for each FontFamily.

The list should be a list of keys into Self::font_data. When looking for a character glyph epaint will start with the first font and then move to the second, and so on. So the first font is the primary, and then comes a list of fallbacks in order of priority.

Implementations

impl FontDefinitions

pub fn empty() -> FontDefinitions

No fonts.

pub fn builtin_font_names() -> &'static [&'static str]

List of all the builtin font names used by epaint.

Trait Implementations

impl Clone for FontDefinitions

fn clone(&self) -> FontDefinitions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FontDefinitions

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

Formats the value using the given formatter.

impl Default for FontDefinitions

fn default() -> FontDefinitions

Specifies the default fonts if the feature default_fonts is enabled, otherwise this is the same as Self::empty.

impl<'de> Deserialize<'de> for FontDefinitions

where FontDefinitions: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<FontDefinitions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FontDefinitions

fn eq(&self, other: &FontDefinitions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FontDefinitions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FontDefinitions