Struct FontAtlasSet

pub struct FontAtlasSet { /* private fields */ }

A map of font sizes to their corresponding FontAtlases, for a given font face.

Provides the interface for adding and retrieving rasterized glyphs, and manages the FontAtlases.

A FontAtlasSet is an Asset.

There is one FontAtlasSet for each font:

• When a Font is loaded as an asset and then used in TextFont, a FontAtlasSet asset is created from a weak handle to the Font.
• When a font is loaded as a system font, and then used in TextFont, a FontAtlasSet asset is created and stored with a strong handle to the FontAtlasSet. (Note that system fonts are not currently supported by the TextPipeline.)

A FontAtlasSet contains one or more FontAtlases for each font size.

It is used by TextPipeline::queue_text.

Implementations

impl FontAtlasSet

pub fn iter(&self) -> impl Iterator<Item = (&FontAtlasKey, &Vec<FontAtlas>)>

Returns an iterator over the FontAtlases in this set

Examples found in repository

examples/stress_tests/many_text2d.rs (line 181)

fn print_counts(
    time: Res<Time>,
    mut timer: Local<PrintingTimer>,
    texts: Query<&ViewVisibility, With<Text2d>>,
    atlases: Res<FontAtlasSets>,
    font: Res<FontHandle>,
) {
    timer.tick(time.delta());
    if !timer.just_finished() {
        return;
    }

    let num_atlases = atlases
        .get(font.0.id())
        .map(|set| set.iter().map(|atlas| atlas.1.len()).sum())
        .unwrap_or(0);

    let visible_texts = texts.iter().filter(|visibility| visibility.get()).count();

    info!(
        "Texts: {} Visible: {} Atlases: {}",
        texts.iter().count(),
        visible_texts,
        num_atlases
    );
}

examples/ui/font_atlas_debug.rs (line 45)

fn atlas_render_system(
    mut commands: Commands,
    mut state: ResMut<State>,
    font_atlas_sets: Res<FontAtlasSets>,
    images: Res<Assets<Image>>,
) {
    if let Some(set) = font_atlas_sets.get(&state.handle) {
        if let Some((_size, font_atlases)) = set.iter().next() {
            let x_offset = state.atlas_count as f32;
            if state.atlas_count == font_atlases.len() as u32 {
                return;
            }
            let font_atlas = &font_atlases[state.atlas_count as usize];
            let image = images.get(&font_atlas.texture).unwrap();
            state.atlas_count += 1;
            commands.spawn((
                ImageNode::new(font_atlas.texture.clone()),
                Node {
                    position_type: PositionType::Absolute,
                    top: Val::ZERO,
                    left: Val::Px(image.width() as f32 * x_offset),
                    ..default()
                },
            ));
        }
    }
}

pub fn has_glyph(&self, cache_key: CacheKey, font_size: &FontAtlasKey) -> bool

Checks if the given subpixel-offset glyph is contained in any of the FontAtlases in this set

pub fn add_glyph_to_atlas( &mut self, texture_atlases: &mut Assets<TextureAtlasLayout>, textures: &mut Assets<Image>, font_system: &mut FontSystem, swash_cache: &mut SwashCache, layout_glyph: &LayoutGlyph, font_smoothing: FontSmoothing, ) -> Result<GlyphAtlasInfo, TextError>

Adds the given subpixel-offset glyph to the FontAtlases in this set

pub fn get_glyph_atlas_info( &mut self, cache_key: CacheKey, font_smoothing: FontSmoothing, ) -> Option<GlyphAtlasInfo>

Generates the GlyphAtlasInfo for the given subpixel-offset glyph.

pub fn len(&self) -> usize

Returns the number of font atlases in this set.

pub fn is_empty(&self) -> bool

Returns true if the set has no font atlases.

pub fn get_outlined_glyph_texture( font_system: &mut FontSystem, swash_cache: &mut SwashCache, physical_glyph: &PhysicalGlyph, font_smoothing: FontSmoothing, ) -> Result<(Image, IVec2), TextError>

Get the texture of the glyph as a rendered image, and its offset

Trait Implementations

impl Debug for FontAtlasSet

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

Formats the value using the given formatter.

impl Default for FontAtlasSet

fn default() -> FontAtlasSet

Returns the “default value” for a type.

impl TypePath for FontAtlasSet

where FontAtlasSet: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl VisitAssetDependencies for FontAtlasSet

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for FontAtlasSet