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.

Currently wgpu-rs works on native platforms, but WASM support is currently being added as well.

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)

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

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

Also, libraries that have support for wgpu-rs:

• conrod - shader-based UI
• grr-2d - experimental 2D renderer
• lyon - a path tessellation library

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.