Crate glyph_brush
source ·Expand description
use glyph_brush::{
ab_glyph::FontArc, BrushAction, BrushError, GlyphBrushBuilder, Section, Text,
};
let dejavu = FontArc::try_from_slice(include_bytes!("../../fonts/DejaVuSans.ttf"))?;
let mut glyph_brush = GlyphBrushBuilder::using_font(dejavu).build();
glyph_brush.queue(Section::default().add_text(Text::new("Hello glyph_brush")));
glyph_brush.queue(some_other_section);
match glyph_brush.process_queued(
|rect, tex_data| update_texture(rect, tex_data),
|vertex_data| into_vertex(vertex_data),
) {
Ok(BrushAction::Draw(vertices)) => {
// Draw new vertices.
}
Ok(BrushAction::ReDraw) => {
// Re-draw last frame's vertices unmodified.
}
Err(BrushError::TextureTooSmall { suggested }) => {
// Enlarge texture + glyph_brush texture cache and retry.
}
}
Modules
Macros
Macro to delegate builder methods to an inner
glyph_brush::GlyphBrushBuilder
Structs
Default
extra
field type. Non-layout data for vertex generation.Id for a font.
Object allowing glyph drawing, containing cache state. Manages glyph positioning cacheing,
glyph draw caching & efficient GPU texture cache updating.
Builder for a
GlyphBrush
.Cut down version of a
GlyphBrush
that can calculate pixel bounds,
but is unable to actually render anything.Builder for a
GlyphCalculator
.GlyphCalculator
scoped cache lock.Data used to generate vertex information for a single glyph
A rectangle, with top-left corner at min, and bottom-right corner at max.
An object that contains all the info to render a varied section of text. That is one including
many parts with differing fonts/scales/colors bowing to a single layout.
A positioned glyph with info relating to the
SectionText
from which it was derived.Text to layout together using a font & scale.
SectionText
+ extra.Enums
Actions that should be taken after processing queue data
Built-in linebreaking logic.
Describes horizontal alignment preference for positioning & bounds.
Built-in
GlyphPositioner
implementations.Indicator that a character is a line break, soft or hard. Includes the offset (byte-index)
position.
Describes vertical alignment preference for positioning & bounds. Currently a placeholder
for future functionality.
Traits
Common glyph layout logic.
Type Definitions
A “practically collision free”
Section
hasherSectionGlyph
iterator.