wgpu-text

wgpu-text is a wrapper over glyph-brush for fast and easy text rendering in wgpu. It accepts .otf and .ttf fonts.

This project was inspired by and is similar to wgpu_glyph but has additional features and is more straightforward. Also, there is no need to include glyph-brush in your project.

Some features are directly implemented from glyph-brush, so it's recommended to go through Section docs and Section examples for better understanding of managing and adding text.

Installation

Add the following to your Cargo.toml file:

toml [dependencies] wgpu_text = "0.7.0"

Usage

```rust use wgpu_text::section::{Section, Text, Layout, HorizontalAlign, BrushBuilder};

let brush = BrushBuilder::usingfontbytes(font).unwrap() /* .initialcachesize((16384, 16384))) / // use this to avoid resizing cache texture / .with_depth() */ // enables depth testing .build(&device, &config);

// Directly implemented from glyphbrush. let section = Section::default().addtext(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() => { // Has to be queued every frame. brush.queue(&section); // Crashes if inner cache exceeds limits. brush.processqueued(&device, &queue).unwrap();

    let text_buffer = brush.draw(&device, &view);

    // Submit last to avoid overlaps.
    queue.submit([some_other_cmd_buffer, text_buffer]);

    frame.present();
}

```

Examples

For more detailed examples, look through examples.

• cargo run --example <example-name>

Run examples with --release for accurate performance.

Features

Besides basic text rendering and glyph-brush features, some features add customization:

• custom render-to view - you can specify a custom texture view for it to render the text to instead of rendering it onto the frame view
• 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)

Future

• wgpu stuff: maybe change to StagingBelt instead of Queue
• mip-mapping example if possible

Contributing

All contributions are welcome.