Struct TextRendererConfig 

pub struct TextRendererConfig {
    pub atlas_size: u32,
    pub sdf: SdfConfig,
    pub surface_format: TextureFormat,
    pub depth_format: Option<TextureFormat>,
}

Configuration for text renderer backends.

Controls atlas texture sizes and surface formats for pipelines. Smaller atlases use less memory but may need to evict glyphs more frequently.

Memory Usage

Config	Atlas Size	Memory/Atlas	Bitmap Total	Hybrid Total
small()	512x512	0.5 MB	1 MB	2 MB
medium()	1024x1024	2 MB	4 MB	8 MB
large()	2048x2048	4 MB	8 MB	16 MB

Example

use astrelis_text::{BitmapTextRenderer, TextRendererConfig};

// For memory-constrained environments
let renderer = BitmapTextRenderer::with_config(
    context,
    font_system,
    TextRendererConfig::small()
);

// Create from window for automatic format matching
let renderer = FontRenderer::with_config(
    context,
    font_system,
    TextRendererConfig::from_window(&window)
);

Fields

atlas_size: u32

Atlas texture size (width and height, must be power of 2). Default: 2048

sdf: SdfConfig

SDF-specific settings (only used by SDF/Hybrid renderers).

surface_format: TextureFormat

Surface texture format for pipelines. Default: Bgra8UnormSrgb

depth_format: Option<TextureFormat>

Depth format for z-ordering. None disables depth testing. Default: None

Implementations

impl TextRendererConfig

pub fn new() -> Self

Create default configuration (2048x2048 atlas, ~8 MB per atlas).

pub fn from_window(window: &RenderWindow) -> Self

Create configuration from a RenderWindow, inheriting its format settings.

This is the recommended way to create a config as it ensures pipeline-renderpass format compatibility automatically.

pub fn small() -> Self

Small config for memory-constrained environments (512x512, ~0.5 MB per atlas).

Best for applications with limited text or embedded devices.

pub fn medium() -> Self

Medium config (~1024x1024, ~2 MB per atlas).

Good balance for most applications.

pub fn large() -> Self

Large config for text-heavy applications (2048x2048, ~4 MB per atlas).

Best for applications with lots of unique glyphs or fonts.

pub fn with_atlas_size(self, size: u32) -> Self

Set custom atlas size.

Arguments

• size - Atlas width and height (should be power of 2)

pub fn with_sdf_config(self, config: SdfConfig) -> Self

Set SDF configuration.

pub fn with_surface_format(self, format: TextureFormat) -> Self

Set surface format for pipelines.

pub fn with_depth(self, format: TextureFormat) -> Self

Enable depth testing with the specified format.

pub fn without_depth(self) -> Self

Disable depth testing.

Trait Implementations

impl Clone for TextRendererConfig

fn clone(&self) -> TextRendererConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextRendererConfig

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

Formats the value using the given formatter.

impl Default for TextRendererConfig

fn default() -> Self

Returns the “default value” for a type.