wgpu-text
wgpu-text is a wrapper over glyph-brush for fast and easy text rendering in wgpu.
This project was inspired by and is similar to wgpu_glyph, but has additional features and is simpler. Also there is no need to include glyph-brush in your project.
Some features are directly implemented from glyph-brush so you should go trough Section docs and Section examples for better understanding of managing and adding text.
Installation
Add the following to your Cargo.toml file:
[dependencies]
wgpu_text = "0.6.1"
Usage
use wgpu_text::BrushBuilder;
use wgpu_text::section::{Section, Text, Layout, HorizontalAlign};
let brush = BrushBuilder::using_font_bytes(font).unwrap()
/* .initial_cache_size((1024, 1024))) */ // use this to avoid resizing cache texture
/* .with_depth_testing(true) */ // enable/disable depth testing
.build(&device, &config);
// Directly implemented from glyph_brush.
let section = Section::default()
.add_text(Text::new("Hello World"))
.with_layout(Layout::default().h_align(HorizontalAlign::Center));
// on window resize:
brush.resize_view(config.width as f32, config.height as f32, &queue);
// window event loop:
winit::event::Event::RedrawRequested(_) => {
// Has to be queued every frame.
brush.queue(§ion);
let text_buffer = brush.draw(&device, &view, &queue);
// Has to be submitted last so text won't be overlapped.
queue.submit([some_other_encoder.finish(), text_buffer]);
frame.present();
}
Examples
For more detailed examples look trough examples.
cargo run --example <example-name>
Run examples with --release for true performance.
Features
Besides basic text rendering and glyph-brush features, there are some features that add customization:
builtin matrix - default matrix for orthographic projection, feel free to use it for creating custom matrices
custom matrix - ability of providing a custom matrix for purposes of custom view, rotation... (the downside is that it applies to all rendered text)
depth testing - by adding z coordinate, text can be set on top or below other text (if enabled)
Goals
- try to improve docs
- maybe some new features
- (wgpu stuff: maybe change to StagingBelt instead of Queue)
Contributing
All contributions are welcome.
28 Dec 16, 2022
2 Dec 14, 2022
9 Nov 29, 2022
159 Dec 29, 2022
49 Sep 4, 2024
25 Jul 24, 2022
546 Jan 3, 2023
3.6k Jan 3, 2023
744 Jan 7, 2023
5 Mar 27, 2022
1.8k Jan 7, 2023
34 Jul 6, 2024
69 Sep 20, 2022
40 Dec 18, 2022
63 Jan 1, 2023
2k Jan 9, 2023
122 Dec 29, 2022
177 Nov 22, 2022
12 Nov 3, 2022