Struct wgpu_glyph::GlyphBrush

pub struct GlyphBrush<'font, Depth, H = DefaultSectionHasher> { /* fields omitted */ }

Object allowing glyph drawing, containing cache state. Manages glyph positioning cacheing, glyph draw caching & efficient GPU texture cache updating and re-sizing on demand.

Build using a GlyphBrushBuilder.

Methods

impl<'font, Depth, H: BuildHasher> GlyphBrush<'font, Depth, H>

pub fn queue<'a, S>(&mut self, section: S) where
    S: Into<Cow<'a, VariedSection<'a>>>, 

Queues a section/layout to be drawn by the next call of draw_queued. Can be called multiple times to queue multiple sections for drawing.

Benefits from caching, see caching behaviour.

pub fn queue_custom_layout<'a, S, G>(&mut self, section: S, custom_layout: &G) where
    G: GlyphPositioner,
    S: Into<Cow<'a, VariedSection<'a>>>, 

Queues a section/layout to be drawn by the next call of draw_queued. Can be called multiple times to queue multiple sections for drawing.

Used to provide custom GlyphPositioner logic, if using built-in Layout simply use queue

Benefits from caching, see caching behaviour.

pub fn queue_pre_positioned(
    &mut self,
    glyphs: Vec<(PositionedGlyph<'font>, Color, FontId)>,
    bounds: Rect<f32>,
    z: f32
)

Queues pre-positioned glyphs to be processed by the next call of draw_queued. Can be called multiple times.

pub fn keep_cached_custom_layout<'a, S, G>(
    &mut self,
    section: S,
    custom_layout: &G
) where
    S: Into<Cow<'a, VariedSection<'a>>>,
    G: GlyphPositioner, 

Retains the section in the cache as if it had been used in the last draw-frame.

Should not be necessary unless using multiple draws per frame with distinct transforms, see caching behaviour.

pub fn keep_cached<'a, S>(&mut self, section: S) where
    S: Into<Cow<'a, VariedSection<'a>>>, 

Retains the section in the cache as if it had been used in the last draw-frame.

Should not be necessary unless using multiple draws per frame with distinct transforms, see caching behaviour.

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

Returns the available fonts.

The FontId corresponds to the index of the font data.

pub fn add_font_bytes<'a: 'font, B: Into<SharedBytes<'a>>>(
    &mut self,
    font_data: B
) -> FontId

Adds an additional font to the one(s) initially added on build.

Returns a new FontId to reference this font.

pub fn add_font<'a: 'font>(&mut self, font_data: Font<'a>) -> FontId

Adds an additional font to the one(s) initially added on build.

Returns a new FontId to reference this font.

impl<'font, H: BuildHasher> GlyphBrush<'font, (), H>

pub fn draw_queued(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    target_width: u32,
    target_height: u32
) -> Result<(), String>

Draws all queued sections onto a render target. See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

pub fn draw_queued_with_transform(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    transform: [f32; 16]
) -> Result<(), String>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection). See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

pub fn draw_queued_with_transform_and_scissoring(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    transform: [f32; 16],
    region: Region
) -> Result<(), String>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection) and a scissoring region. See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

impl<'font, H: BuildHasher> GlyphBrush<'font, DepthStencilStateDescriptor, H>

pub fn draw_queued(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    depth_stencil_attachment: RenderPassDepthStencilAttachmentDescriptor,
    target_width: u32,
    target_height: u32
) -> Result<(), String>

Draws all queued sections onto a render target. See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

pub fn draw_queued_with_transform(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    depth_stencil_attachment: RenderPassDepthStencilAttachmentDescriptor,
    transform: [f32; 16]
) -> Result<(), String>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection). See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

pub fn draw_queued_with_transform_and_scissoring(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    target: &TextureView,
    depth_stencil_attachment: RenderPassDepthStencilAttachmentDescriptor,
    transform: [f32; 16],
    region: Region
) -> Result<(), String>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection) and a scissoring region. See queue.

It does not submit the encoder command buffer to the device queue.

Trims the cache, see caching behaviour.

Panics

Panics if the provided target has a texture format that does not match the render_format provided on creation of the GlyphBrush.

Trait Implementations

impl<'_, H> Debug for GlyphBrush<'_, H>

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

Formats the value using the given formatter.

impl<'font, D, H: BuildHasher> GlyphCruncher<'font> for GlyphBrush<'font, D, H>

fn pixel_bounds_custom_layout<'a, S, L>(
    &mut self,
    section: S,
    custom_layout: &L
) -> Option<Rect<i32>> where
    L: GlyphPositioner + Hash,
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns the pixel bounding box for the input section using a custom layout. The box is a conservative whole number pixel rectangle that can contain the section.

fn glyphs_custom_layout<'a, 'b, S, L>(
    &'b mut self,
    section: S,
    custom_layout: &L
) -> PositionedGlyphIter<'b, 'font> where
    L: GlyphPositioner + Hash,
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns an iterator over the PositionedGlyphs of the given section with a custom layout.

fn fonts(&self) -> &[Font<'font>]

Returns the available fonts.

fn pixel_bounds<'a, S>(&mut self, section: S) -> Option<Rect<i32>> where
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns the pixel bounding box for the input section. The box is a conservative whole number pixel rectangle that can contain the section.

fn glyphs<'a, S>(
    &'b mut self,
    section: S
) -> Map<Iter<'b, (PositionedGlyph<'font>, [f32; 4], FontId)>, fn(&'b (PositionedGlyph<'font>, [f32; 4], FontId)) -> &'b PositionedGlyph<'font>> where
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns an iterator over the PositionedGlyphs of the given section.

fn glyph_bounds_custom_layout<'a, S, L>(
    &mut self,
    section: S,
    custom_layout: &L
) -> Option<Rect<f32>> where
    L: GlyphPositioner + Hash,
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns a bounding box for the section glyphs calculated using each glyph's vertical & horizontal metrics.

fn glyph_bounds<'a, S>(&mut self, section: S) -> Option<Rect<f32>> where
    S: Into<Cow<'a, VariedSection<'a>>>, 

Returns a bounding box for the section glyphs calculated using each glyph's vertical & horizontal metrics.