Struct TextPass 

pub struct TextPass { /* private fields */ }

A shared text overlay pass without a depth test.

Implementations

impl TextPass

pub fn new(name: &'static str, font: Vec<u8>, bake_size_px: f32) -> Self

pub fn publish(&self, text: &str, draws: &[TextDraw])

The record queues text once per draw, in order, so a shadow placed first paints under the body.

pub fn ready(&self) -> bool

False when the font never parsed, so the pass draws nothing.

pub fn failure(&self) -> Option<String>

Trait Implementations

impl Clone for TextPass

fn clone(&self) -> TextPass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FramePass for TextPass

fn name(&self) -> &'static str

fn stage(&self) -> PassStage

fn record( &mut self, encoder: &mut CommandEncoder, target: &FrameTarget<'_>, ) -> Result<()>

fn attach(&mut self, gpu: &GpuContext, frame: FrameFormat) -> Result<()>

fn color_load(&self) -> ColorLoad

fn depth_convention(&self) -> Option<DepthConvention>

None means the pass writes no depth; Some must match the frame’s convention to register.

fn depth_read(&self) -> Option<DepthConvention>

fn shares_pass(&self) -> bool

True joins the stage’s shared render pass, so attach must build pipelines against the frame’s color and depth formats.

fn clear_color(&self) -> Color

Read before prepare, and only when color_load is Clear.

fn prepare( &mut self, _encoder: &mut CommandEncoder, _target: &FrameTarget<'_>, ) -> Result<(), Error>

Encoder work for a sharing pass; runs just before its render pass opens, not at frame start.

fn draw( &mut self, _pass: &mut RenderPass<'_>, _target: &FrameTarget<'_>, ) -> Result<(), Error>

Runs inside the shared pass, which owns the load ops; viewport and scissor carry over from earlier draws.