Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Blatko1/wgpu-text
📜A simple 2D text renderer for wgpu📜
https://github.com/Blatko1/wgpu-text
2d font glyph graphics render rust text wgpu
Last synced: 22 days ago
JSON representation
📜A simple 2D text renderer for wgpu📜
- Host: GitHub
- URL: https://github.com/Blatko1/wgpu-text
- Owner: Blatko1
- License: mit
- Created: 2022-02-27T16:00:50.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T21:41:36.000Z (8 months ago)
- Last Synced: 2024-05-02T12:10:18.024Z (7 months ago)
- Topics: 2d, font, glyph, graphics, render, rust, text, wgpu
- Language: Rust
- Homepage: https://docs.rs/wgpu_text
- Size: 1.53 MB
- Stars: 79
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-2d-graphics-rendering - wgpu-text
README
# wgpu-text
[](https://github.com/Blatko1/wgpu-text/actions)
[](https://github.com/Blatko1/wgpu-text/blob/master/LICENSE)
[](https://crates.io/crates/wgpu_text)
[](https://docs.rs/wgpu_text)
**`wgpu-text`** is a wrapper over **[`glyph-brush`](https://github.com/alexheretic/glyph-brush)** for **fast** and **easy** text rendering by **_[`wgpu`](https://github.com/gfx-rs/wgpu)_**. It supports **.otf** and **.ttf** fonts.
This project was inspired by and is similar to **[`wgpu_glyph`](https://github.com/hecrj/wgpu_glyph)** but has additional features and is more straightforward. Also, there is no need to include **glyph-brush** in your project.
Since the **glyph-brush** crate is *reexported* and being heavily dependent on, it's recommended to go through [Section docs](https://docs.rs/glyph_brush/latest/glyph_brush/struct.Section.html) and [Section examples](https://github.com/alexheretic/glyph-brush/tree/master/gfx-glyph/examples) for better understanding of managing and adding text.
## **Installation**
Add the following to your `Cargo.toml` file:
```toml
[dependencies]
wgpu_text = "0.9.1"
```
## **Usage**
```rust
use wgpu_text::{glyph_brush::{Section as TextSection, Text}, BrushBuilder, TextBrush};
let brush = BrushBuilder::using_font_bytes(font).unwrap()
/* .initial_cache_size((16_384, 16_384))) */ // use this to avoid resizing cache texture
.build(&device, config.width, config.height, config.format);
// Directly implemented from glyph_brush.
let section = TextSection::default().add_text(Text::new("Hello World"));
// on window resize:
brush.resize_view(config.width as f32, config.height as f32, &queue);
// window event loop:
winit::event::Event::RedrawRequested(_) => {
// Before are created Encoder and frame TextureView.
// Crashes if inner cache exceeds limits.
brush.queue(&device, &queue, [§ion, ...]).unwrap();
{
let mut rpass = encoder.begin_render_pass(...);
brush.draw(&mut rpass);
}
queue.submit([encoder.finish()]);
frame.present();
}
```
## **Examples**
For more detailed examples, look through [examples](https://github.com/Blatko1/wgpu_text/tree/master/examples).
* `cargo run --example `
Run examples with `--release` for accurate performance.
## **Features**
Besides basic text rendering and **glyph-brush** features, some features add customization:
- **builtin matrix** - default matrix for orthographic projection (feel free to use it for creating custom matrices)
- **custom matrix** - grants the ability to provide a custom matrix for purposes of custom view, rotation, etc. (the downside is that it applies to all rendered text)
- **depth testing** - by adding a *z* coordinate, text can be set on top or below other text (if enabled). Watch out for the queueing order when queueing *text sections*. You should queue them from the furthest to the closest (according to the *z* coordinate, bigger the *z*, more further it is).
## **Contributing**
All kinds of contributions are welcome.