Struct luminance_glyph::GlyphBrush

pub struct GlyphBrush<B, F = FontArc, H = DefaultSectionHasher>where
    B: GlyphBrushBackend,{ /* private fields */ }

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.

Implementations

impl<B, F: Font, H: BuildHasher> GlyphBrush<B, F, H>where
    B: GlyphBrushBackend,

pub fn queue<'a, S>(&mut self, section: S)where
    S: Into<Cow<'a, Section<'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, Section<'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<SectionGlyph>,
    extra: Vec<Extra>,
    bounds: Rect
)

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, Section<'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, Section<'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) -> &[F]

Returns the available fonts.

The FontId corresponds to the index of the font data.

pub fn add_font(&mut self, font: F) -> FontId

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

Returns a new FontId to reference this font.

impl<B, F: Font + Sync, H: BuildHasher> GlyphBrush<B, F, H>where
    B: GlyphBrushBackend,

pub fn draw_queued<'a>(
    &mut self,
    pipeline: &mut LuminancePipeline<'a, B>,
    shading_gate: &mut ShadingGate<'a, B>,
    target_width: u32,
    target_height: u32
) -> Result<(), PipelineError>

Draws all queued sections onto a render target. See 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<'a>(
    &mut self,
    pipeline: &mut LuminancePipeline<'a, B>,
    shading_gate: &mut ShadingGate<'a, B>,
    transform: [f32; 16]
) -> Result<(), PipelineError>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection). See 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<'a>(
    &mut self,
    pipeline: &mut LuminancePipeline<'a, B>,
    shading_gate: &mut ShadingGate<'a, B>,
    transform: [f32; 16],
    region: Region
) -> Result<(), PipelineError>

Draws all queued sections onto a render target, applying a position transform (e.g. a projection) and a scissoring region. See 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 process_queued<C>(&mut self, context: &mut C)where
    C: GraphicsContext<Backend = B>,

pub fn process_queued_with_vertex_constructor<C>(
    &mut self,
    context: &mut C,
    into_vertex: impl Fn(GlyphVertex<'_>) -> Instance
)where
    C: GraphicsContext<Backend = B>,

Trait Implementations

impl<B, F, H> Debug for GlyphBrush<B, F, H>where
    B: GlyphBrushBackend,

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

Formats the value using the given formatter.

impl<B, F: Font, H: BuildHasher> GlyphCruncher<F, Extra> for GlyphBrush<B, F, H>where
    B: GlyphBrushBackend,

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

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

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

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

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

Returns the available fonts.

fn glyphs<'a, S, 'b>(&'b mut self, section: S) -> Iter<'b, SectionGlyph>where
    X: 'a,
    S: Into<Cow<'a, Section<'a, X>>>,

Returns an iterator over the PositionedGlyphs of the given section.

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

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