Small, lightweight and fast library for rendering text with wgpu.

Last update: Nov 30, 2022

Overview

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(&section);
        
        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.

Generic framebuffer implementation in Rust for use with embedded-graphics library

Fraramebuffer implementation for Rust's Embedded-graphics Framebuffer approach helps to deal with display flickering when you update multiple parts of

9 Nov 29, 2022

Python library for embedding large graphs in 2D space, using force-directed layouts.

Graph Force A python/rust library for embedding graphs in 2D space, using force-directed layouts. Installation pip install graph_force Usage The first

159 Dec 29, 2022

CLI for image processing with histograms, binary treshold and other functions

Image-Processing-CLI-in-Rust CLI for processing images in Rust. Some implementation is custom and for some functionality it uses 3rd party libraries.

25 Jul 24, 2022

GLFW3 bindings and idiomatic wrapper for Rust.

glfw-rs GLFW bindings and wrapper for The Rust Programming Language. Example extern crate glfw; use glfw::{Action, Context, Key}; fn main() { le

546 Jan 3, 2023

Safe and rich Rust wrapper around the Vulkan API

Vulkano See also vulkano.rs. Vulkano is a Rust wrapper around the Vulkan graphics API. It follows the Rust philosophy, which is that as long as you do

3.6k Jan 3, 2023

A high-performance SVG renderer, powered by Rust based resvg and napi-rs.

resvg-js resvg-js is a high-performance SVG renderer, powered by Rust based resvg and napi-rs. Fast, safe and zero dependencies! No need for node-gyp

744 Jan 7, 2023

A simple and elegant, pipewire graph editor

pw-viz A simple and elegant, pipewire graph editor This is still a WIP, node layouting is kinda jank at the moment. Installation A compiled binary is

180 Dec 27, 2022

A cargo subcommand for creating GraphViz DOT files and dependency graphs

cargo-graph Linux: A cargo subcommand for building GraphViz DOT files of dependency graphs. This subcommand was originally based off and inspired by t

213 Nov 24, 2022

Szalinski: A Tool for Synthesizing Structured CAD Models with Equality Saturation and Inverse Transformations

24 Aug 15, 2022

Comments

Expose brush dependencies, simplify BrushBuilder

Make important dependencies accessible for the end user. Like FontRef for example, so a brush can be stored in a struct.

In my project I have a state struct so I can split a lot of the render code, but I can't use your library because dependencies are private. Anyway keep up the good work.
enhancement

opened by Norlock 3
Update WGSL to new syntax

I also changed the example to use FIFO instead of MAILBOX since FIFO is guaranteed to be available everywhere. I couldn't get it to run at all on M1 Mac otherwise.
enhancement

opened by aztecrex 1
Expose glyph_brush::GlyphCruncher in TextBrush

It would be useful to me to be able to figure out exactly how much space a particular Section will need before it is drawn. This would allow me to compute a layout with other text sections, and other types of drawings. My understanding is that the GlyphCruncher trait in glyph_brush can measure a Section using the glyph_bounds method. Is there a way to use this trait with a TextBrush?

Since glyph_brush::Glyph_Brush implements the trait, and TextBrush is a wrapper around GlyphBrush, it should be pretty simple to add some new methods to TextBrush to allow for measuring text before drawing. Alternatively, the inner brush could be made public, so that traits and methods from glyph_brush could be used, though I think this would require a reexport of glyph_brush. I'm not sure which approach would be best.

Thanks for the awesome crate!
enhancement good first issue

opened by Dieff 0

Releases(v0.6.3)

v0.6.3(Jul 8, 2022)

Update to wgpu version 0.13.1
Source code(tar.gz)
Source code(zip)
v0.6.0(Apr 3, 2022)

Reduced amount of needed arguments, fixed depth texture issue where it was created every frame, docs update, simplified code.
Source code(tar.gz)
Source code(zip)
v0.3.0(Mar 30, 2022)

First release of wgpu-text which has all needed features.
Source code(tar.gz)
Source code(zip)