c14c8e0830
306: Improve example friendliness: Don't busy-redraw in examples r=kvark a=khoek
Looking around for solid Rust graphics libraries, I was a bit shocked when the `wgpu-rs` examples made my whole X desktop environment in Ubuntu laggy---maximizing/minimizing other windows or moving any of them had very noticeable latency when an example was running.
This almost turned me off, but after playing around I found that this was just because of the
```rust
match event {
event::Event::MainEventsCleared => window.request_redraw(),
...
```
in all of the examples. Trying to add the least code possible I've replaced a `ControlFlow::Poll` with `ControlFlow::WaitUntil(...)` in the event loops and capped the redraws-per-second below 50, which completely solves this problem for me (plus the window resize response on the examples themselves are much improved, etc.).
I was just going for an unintrusive fix---this is by no means a perfect solution, but I think in the worst case it won't be any worse that what was there originally. Plus, I think it will make people like me who try to start by copying an example more likely to stick around in the short term.
Co-authored-by: Keeley Hoek <keeley@hoek.io>
wgpu-rs
wgpu-rs is an idiomatic Rust wrapper over wgpu-core. It's designed to be suitable for general purpose graphics and computation needs of Rust community.
wgpu-rs can target both the natively supported backends and WASM directly.
Gallery
Usage
How to Run Examples
All examples are located under the examples directory.
These examples use the default syntax for running examples, as found in the Cargo documentation. For example, to run the cube example:
cargo run --example cube
The hello-triangle and hello-compute examples show bare-bones setup without any helper code. For hello-compute, pass 4 numbers separated by spaces as arguments:
cargo run --example hello-compute 1 2 3 4
Run Examples on the Web (wasm32-unknown-unknown)
Running on the web is still work-in-progress. You may need to enable experimental flags on your browser. Check browser implementation status on webgpu.io.
To run examples on the wasm32-unknown-unknown target, first build the example as usual, then run wasm-bindgen:
# Install or update wasm-bindgen-cli
cargo install -f wasm-bindgen-cli
# Build with the wasm target
RUSTFLAGS=--cfg=web_sys_unstable_apis cargo build --target wasm32-unknown-unknown --example hello-triangle
# Generate bindings in a `target/generated` directory
wasm-bindgen --out-dir target/generated --web target/wasm32-unknown-unknown/debug/examples/hello-triangle.wasm
Create an index.html file into target/generated directory and add the following code:
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<script type="module">
import init from "./hello-triangle.js";
init();
</script>
</body>
</html>
Now run a web server locally inside the target/generated directory to see the hello-triangle in the browser.
e.g. python -m http.server
Friends
Shout out to the following projects that work best with wgpu-rs:
- wgpu_glyph - for your text-y rendering needs
- coffee - a whole 2D engine
- iced - a cross-platform GUI library
- rgx - a 2D graphics library
- imgui-wgpu - Dear ImGui interfacing
- pixels - the easiest way to create a hardware-accelerated pixel frame buffer
- kas - tooKit Abstraction System
- oxidator - RTS game engine
- nannou - a creative coding framework
- harmony - a modern 2D/3D engine
- wgpu-pbr - realtime PBR renderer for games
Also, libraries that have support for wgpu-rs:
Development
If you need to test local fixes to gfx-rs or other dependencies, the simplest way is to add a Cargo patch. For example, when working on DX12 backend on Windows, you can check out the "hal-0.2" branch of gfx-rs repo and add this to the end of "Cargo.toml":
[patch.crates-io]
gfx-backend-dx12 = { path = "../gfx/src/backend/dx12" }
gfx-hal = { path = "../gfx/src/hal" }
If a version needs to be changed, you need to do cargo update -p gfx-backend-dx12.