|0.1.0||Aug 10, 2020|
#228 in WebAssembly
40 downloads per month
Used in 2 crates
wgpu is a cross-platform, safe, pure-rust graphics api. It runs natively on Vulkan, Metal, D3D12, D3D11, and OpenGLES; and on top of WebGPU on wasm.
The api is based on the WebGPU standard. It serves as the core of the WebGPU integration in Firefox, Servo, and Deno.
The repository hosts the following libraries:
- - User facing Rust API.
- - Internal WebGPU implementation.
- - Internal unsafe GPU API abstraction layer.
- - Rust types shared between all crates.
The following binaries:
cts_runner- WebGPU Conformance Test Suite runner using
player- standalone application for replaying the API traces.
wgpu-info- program that prints out information about all the adapters on the system or invokes a command for every adapter.
For an overview of all the components in the gfx-rs ecosystem, see the big picture.
If you are looking for a wgpu tutorial, look at the following:
To use wgpu in C/C++, you need wgpu-native.
If you want to use wgpu in other languages, there are many bindings to wgpu-native from languages such as Python, D, Julia, Kotlin, and more. See the list.
- - discussion of the library's development.
- - discussion of using the library and the surrounding ecosystem.
- - discussion of everything else.
We have a wiki that serves as a knowledge base.
|API||Windows||Linux & Android||macOS & iOS|
|DX12||✅ (W10 only)|
✅ = First Class Support — 🆗 = Best Effort Support — 🚧 = Unsupported, but support in progress
All testing and example infrastructure shares the same set of environment variables that determine which Backend/GPU it will run on.
WGPU_ADAPTER_NAMEwith a substring of the name of the adapter you want to use (ex.
NVIDIA GeForce 1080ti).
WGPU_BACKENDwith a comma separated list of the backends you want to use (
WGPU_POWER_PREFERENCEwith the power preference to choose when a specific adapter name isn't specified (
When running the CTS, use the variables
We have multiple methods of testing, each of which tests different qualities about wgpu. We automatically run our tests on CI if possible. The current state of CI testing:
|DX12/Windows 10||✔️ (over WARP)|
|DX11/Windows 10||🚧 (over WARP)|
|Metal/MacOS||❌ (no CPU runner)|
|Vulkan/Linux||🆗 (cts hangs)|
|GLES/Linux||❌ (egl fails init)|
All framework based examples have image comparison tested against their screenshot.
To run the test suite on the default device:
cargo test --no-fail-fast
There's logic which can automatically run the tests once for each adapter on your system.
cargo run --bin wgpu-info -- cargo test --no-fail-fast
Then to run an example's image comparison tests, run:
cargo test --example <example-name> --no-fail-fast
Or run a part of the integration test suite:
cargo test -p wgpu -- <name-of-test>
If you are a user and want a way to help contribute to wgpu, we always need more help writing test cases.
WebGPU includes a Conformance Test Suite to validate that implementations are working correctly. We can run this CTS against wgpu.
To run the CTS, first you need to check it out:
git clone https://github.com/gpuweb/cts.git cd cts # works in bash and powershell git checkout $(cat ../cts_runner/revision.txt)
To run a given set of tests:
# Must be inside the cts folder we just checked out, else this will fail cargo run --manifest-path ../cts_runner/Cargo.toml --frozen -- ./tools/run_deno --verbose "<test string>"
To find the full list of tests, go to the online cts viewer.
The list of currently enabled CTS tests can be found here.
wgpu uses the coordinate systems of D3D and Metal: