Struct CaptionBlock 

pub struct CaptionBlock {
    pub text: WispText,
    pub background_color: Color,
    pub corner_radius_ndc: f32,
    pub padding_ndc: f32,
    pub width_ndc: f32,
    pub text_resolution_px: (u32, u32),
}

Builder for a wrapped caption block with a rounded-rect background.

Fields

text: WispText

The caption’s content.

background_color: Color

Background fill (e.g. semi-transparent black for legibility).

corner_radius_ndc: f32

Background corner radius in local NDC.

padding_ndc: f32

Padding inside the background, in local NDC (uniform on all four sides).

width_ndc: f32

Total width the background should occupy in local NDC. The text wraps to width_ndc - 2 × padding_ndc.

text_resolution_px: (u32, u32)

Texture resolution used to rasterize the text. Higher = sharper glyphs but more GPU memory + cache cost.

Implementations

impl CaptionBlock

pub fn from_text(text: WispText) -> Self

Construct a default block with text only — defaults match the in-app caption style (semi-transparent dark background, small rounded corners, ample padding).

pub fn with_background(self, color: Color) -> Self

Builder — replace the background color.

pub fn with_radius(self, radius_ndc: f32) -> Self

Builder — replace the corner radius.

pub fn with_padding(self, padding_ndc: f32) -> Self

Builder — replace the padding.

pub fn with_width(self, width_ndc: f32) -> Self

Builder — replace the total width.

pub fn with_text(self, text: WispText) -> Self

Builder — replace the text content.

pub fn with_style(self, style: WispTextStyle) -> Self

Builder — replace the style on the inner text.

pub fn layout( &self, app: &Application, pipeline: &TextTexturePipeline, ) -> CaptionLayout

Layout the caption. Measures the text inside width_ndc - 2*padding, sizes the background, and produces a CaptionLayout ready to be attached to a container.

Trait Implementations

impl Clone for CaptionBlock

fn clone(&self) -> CaptionBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptionBlock

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

Formats the value using the given formatter.

impl Default for CaptionBlock

fn default() -> Self

Returns the “default value” for a type.