Struct wgpu_text::TextBrush

pub struct TextBrush<F = FontArc, H = DefaultSectionHasher> { /* private fields */ }

Wrapper over glyph_brush::GlyphBrush. In charge of drawing text.

Used for queuing and rendering text with TextBrush::draw.

Implementations

impl<F, H> TextBrush<F, H>

where F: Font + Sync, H: BuildHasher,

pub fn queue<'a, S>( &mut self, device: &Device, queue: &Queue, sections: Vec<S> ) -> Result<(), BrushError>

where S: Into<Cow<'a, Section<'a>>>,

Queues section for drawing, processes all queued text and updates the inner vertex buffer, unless the text vertices remain unmodified when compared to the last frame.

If utilizing depth, the sections list should have Sections ordered from furthest to closest. They will be drawn in the order they are given.

• This method should be called every frame.

If not called when required, the draw functions will continue drawing data from the inner vertex buffer meaning they will redraw old vertices.

To learn about GPU texture caching, see caching behaviour

pub fn glyph_bounds<'a, S>(&mut self, section: S) -> Option<Rect>

where S: Into<Cow<'a, Section<'a>>>,

Returns a bounding box for the section glyphs calculated using each glyph’s vertical & horizontal metrics. For more info, read about GlyphCruncher::glyph_bounds.

pub fn glyphs_iter<'a, 'b, S>(&'b mut self, section: S) -> SectionGlyphIter<'b>

where S: Into<Cow<'a, Section<'a>>>,

Returns an iterator over the PositionedGlyphs of the given section.

pub fn fonts(&self) -> &[F]

Returns the available fonts.

The FontId corresponds to the index of the font data.

pub fn draw<'pass>(&'pass self, rpass: &mut RenderPass<'pass>)

Draws all sections queued with queue function.

pub fn resize_view(&self, width: f32, height: f32, queue: &Queue)

Resizes the view matrix. Updates the default orthographic view matrix with provided dimensions and uses it for rendering.

Run this function whenever the surface config is resized. Surface dimensions are most commonly width and height.

Matrix:

pub fn ortho(width: f32, height: f32) -> [[f32; 4]; 4] {
    [
        [2.0 / width, 0.0,          0.0, 0.0],
        [0.0,        -2.0 / height, 0.0, 0.0],
        [0.0,         0.0,          1.0, 0.0],
        [-1.0,        1.0,          0.0, 1.0]
    ]
}

pub fn update_matrix<M>(&self, matrix: M, queue: &Queue)

where M: Into<Matrix>,

Resizes the view. Updates text rendering matrix with the provided one.

Use Self::resize_view() to update and replace the current render matrix with a default orthographic matrix.

Feel free to use [ortho()] to create more complex matrices by yourself.