Struct arcdps_imgui::FontAtlas

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

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§

source§

impl FontAtlas

source

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

source

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

source

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

source

pub fn is_built(&self) -> bool

Returns true if the font atlas has been built

source

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

Builds a 1 byte per-pixel font atlas texture

source

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

Builds a 4 byte per-pixel font atlas texture

source

pub fn clear(&mut self)

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

source

pub fn clear_fonts(&mut self)

Clears output font data (glyph storage, UV coordinates)

source

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.

source

pub fn clear_input_data(&mut self)

Clears all the data used to build the textures and fonts

Trait Implementations§

source§

impl RawCast<ImFontAtlas> for FontAtlas

source§

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

Casts an immutable reference from the raw type Read more
source§

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

Casts a mutable reference from the raw type Read more
source§

unsafe fn raw(&self) -> &T

Casts an immutable reference to the raw type Read more
source§

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

Casts a mutable reference to the raw type Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.