Struct three_d_text_builder::GlyphCache

pub struct GlyphCache { /* private fields */ }

Rasterizes and caches glyphs for a specific font / size combination.

Implementation

Glyphs get rasterized on demand when first encountered and are packed into a CPU backed atlas texture, when the atlas can no longer fit any additional glyphs its size doubles until it reaches the maximum allowed size.

Once the maximum atlas size has been reached, no further glyphs will get rasterized any any characters that require them will be skipped when building the meshes.

When an atlas gets updated with new glyphs, its GPU texture is uploaded to the GPU as a new material for use with the text meshes.

Note: Font sizes are rounded to the first decimal place.

Note: Glyphs get only rasterized once, but may get copied multiple times into the backing CPU texture in case their position in the atlas changes.

Implementations

impl GlyphCache

pub fn is_empty(&self) -> bool

Returns true in case there are currently no glyphs in the cache

pub fn len(&self) -> usize

Returnss the number of rasterized glyphs in the cache

pub fn size(&self) -> (u32, u32)

Returns the size of the CPU texture in use by the cache

pub fn fill_ratio(&self) -> f32

Returns how much of the CPU texture’s area is currently used by glyphs

pub fn is_exhausted(&self) -> bool

Returns true when no further glyphs can be fit into the cache and the maximum texture size as allowed by TextBuilderSettings has already been reached

pub fn material(&self) -> Option<&TextMaterial>

Returns a reference to the cache’s currently uploaded GPU material