Struct imgui::FontAtlas

#[repr(C)]
pub struct FontAtlas {
    pub flags: FontAtlasFlags,
    pub tex_id: TextureId,
    pub tex_desired_width: i32,
    pub tex_glyph_padding: i32,
    /* private fields */
}

A font atlas that builds a single texture

Fields

flags: FontAtlasFlags

Configuration flags

tex_id: TextureId

Texture identifier

tex_desired_width: i32

Texture width desired by user before building the atlas.

Must be a power-of-two. If you have many glyphs and your graphics API has texture size restrictions, you may want to increase texture width to decrease the height.

tex_glyph_padding: i32

Padding between glyphs within texture in pixels.

Defaults to 1. If your rendering method doesn’t rely on bilinear filtering, you may set this to 0.

Implementations

impl FontAtlas

pub fn add_font(&mut self, font_sources: &[FontSource<'_>]) -> FontId

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

pub fn get_font(&self, id: FontId) -> Option<&Font>

pub fn is_built(&self) -> bool

Returns true if the font atlas has been built

pub fn build_alpha8_texture(&mut self) -> FontAtlasTexture<'_>

Builds a 1 byte per-pixel font atlas texture

pub fn build_rgba32_texture(&mut self) -> FontAtlasTexture<'_>

Builds a 4 byte per-pixel font atlas texture

pub fn clear(&mut self)

Clears the font atlas completely (both input and output data)

pub fn clear_fonts(&mut self)

Clears output font data (glyph storage, UV coordinates)

pub fn clear_tex_data(&mut self)

Clears output texture data.

Can be used to save RAM once the texture has been transferred to the GPU.

pub fn clear_input_data(&mut self)

Clears all the data used to build the textures and fonts

Trait Implementations

impl RawCast<ImFontAtlas> for FontAtlas

unsafe fn from_raw(raw: &T) -> &Self

Casts an immutable reference from the raw type

unsafe fn from_raw_mut(raw: &mut T) -> &mut Self

Casts a mutable reference from the raw type

unsafe fn raw(&self) -> &T

Casts an immutable reference to the raw type

unsafe fn raw_mut(&mut self) -> &mut T

Casts a mutable reference to the raw type