Struct FontRenderer 

pub struct FontRenderer { /* private fields */ }

Font renderer for rendering text with WGPU.

This is the hybrid renderer that combines both bitmap and SDF backends, automatically selecting the best mode based on text size and effects.

• Small text (< 24px) without effects: uses bitmap for sharpness
• Large text (>= 24px) or text with effects: uses SDF for quality

This is the backwards-compatible default renderer.

Implementations

impl FontRenderer

pub fn new(context: Arc<GraphicsContext>, font_system: FontSystem) -> Self

Create a new font renderer.

pub fn new_with_atlas_size( context: Arc<GraphicsContext>, font_system: FontSystem, atlas_size: u32, ) -> Self

Create a new font renderer with a custom atlas size.

pub fn with_config( context: Arc<GraphicsContext>, font_system: FontSystem, config: TextRendererConfig, ) -> Self

Create a new font renderer with custom configuration.

pub fn measure_text(&self, text: &Text) -> (f32, f32)

Measure text dimensions without rendering.

pub fn buffer_bounds(&self, buffer: &TextBuffer) -> (f32, f32)

Get the logical (unscaled) bounds of a prepared text buffer.

pub fn get_text_metrics(&self, text: &Text) -> TextMetrics

Get font metrics for the given text style.

pub fn get_baseline_offset(&self, text: &Text) -> f32

Get the baseline offset from the top of the text bounding box.

pub fn set_render_mode(&mut self, mode: TextRenderMode)

Set the text render mode (Bitmap or SDF).

pub fn render_mode(&self) -> TextRenderMode

Get the current render mode.

pub fn set_sdf_config(&mut self, config: SdfConfig)

Set SDF configuration.

pub fn sdf_config(&self) -> &SdfConfig

Get the current SDF configuration.

pub fn select_render_mode(font_size: f32, has_effects: bool) -> TextRenderMode

Determine the appropriate render mode based on font size and effects.

• Small text (< 24px) without effects: use Bitmap for sharpness
• Large text (>= 24px) or text with effects: use SDF for quality

pub fn set_viewport(&mut self, viewport: Viewport)

Set the viewport for rendering.

pub fn prepare(&mut self, text: &Text) -> TextBuffer

Prepare text for rendering.

pub fn draw_text(&mut self, buffer: &mut TextBuffer, position: Vec2)

Draw text at a position.

The position represents the top-left corner of the text’s bounding box.

pub fn draw_text_with_effects( &mut self, buffer: &mut TextBuffer, position: Vec2, effects: &TextEffects, )

Draw text with effects at a position using SDF rendering.

pub fn draw_text_with_decoration( &mut self, buffer: &mut TextBuffer, position: Vec2, text: &Text, )

Draw text with decoration (underline, strikethrough, background).

This method handles both the text rendering and any decorations. Decorations are rendered in the correct order:

• Background: behind text
• Text glyphs
• Underline/strikethrough: on top of text

Arguments

• buffer - The prepared text buffer
• position - Top-left position of the text
• text - The Text object containing decoration configuration

pub fn render(&mut self, render_pass: &mut RenderPass<'_>)

Render all queued text to the given render pass.

Automatically selects bitmap or SDF pipeline based on the current render mode. Renders in the correct order:

1. Background decorations (behind text)
2. Text glyphs
3. Line decorations (underline, strikethrough - on top of text)

pub fn font_system(&self) -> Arc<RwLock<FontSystem>>

Get the font system.

pub fn swash_cache(&self) -> Arc<RwLock<SwashCache>>

Get the swash cache.

pub fn atlas_size(&self) -> u32

Get the atlas size in pixels.

pub fn atlas_texture_view(&self) -> &TextureView

Get the atlas texture view for binding.

pub fn atlas_sampler(&self) -> &Sampler

Get the atlas sampler for binding.

pub fn is_atlas_dirty(&self) -> bool

Check if the atlas has pending changes.

pub fn upload_atlas_if_dirty(&mut self)

Upload atlas data to GPU if dirty.

pub fn ensure_glyph_in_atlas( &mut self, cache_key: CacheKey, ) -> Option<&AtlasEntry>

Ensure a glyph is in the atlas using a cache key.

pub fn get_glyph_placement( &mut self, cache_key: CacheKey, ) -> Option<GlyphPlacement>

Get glyph placement information.

pub fn ensure_glyph_with_placement( &mut self, cache_key: CacheKey, ) -> Option<(AtlasEntry, GlyphPlacement)>

Ensure a glyph is in the atlas and get its placement info.

pub fn get_atlas_entry(&self, cache_key: CacheKey) -> Option<&AtlasEntry>

Get an atlas entry by cache key (if it exists).

Trait Implementations

impl TextRender for FontRenderer

fn prepare(&mut self, text: &Text) -> TextBuffer

Prepare text for rendering.

fn draw_text(&mut self, buffer: &mut TextBuffer, position: Vec2)

Draw text at a position.

fn render(&mut self, render_pass: &mut RenderPass<'_>)

Render all queued text to the given render pass.

fn measure_text(&self, text: &Text) -> (f32, f32)

Measure text dimensions without rendering.

fn set_viewport(&mut self, viewport: Viewport)

Set the viewport for rendering.

fn buffer_bounds(&self, buffer: &TextBuffer) -> (f32, f32)

Get the logical (unscaled) bounds of a prepared text buffer.