wgpu/README.md

This is an active GitHub mirror of the WebGPU native implementation in Rust, which now lives in Mozilla-central. Issues and pull requests are accepted, but we merge them in m-c manually and then sync to GitHub instead of landing directly here.

---

WebGPU

This is an experimental WebGPU implementation as a native static library. It's written in Rust and is based on gfx-hal and Rendy libraries. The corresponding WebIDL specification can be found at gpuweb project.

The implementation consists of the following parts:

1. wgpu-native - the native implementation of WebGPU as a C API library
2. wgpu-remote - remoting layer to work with WebGPU across the process boundary
3. ffi - the C headers generated by cbindgen for both of the libraries

Supported platforms:

• Vulkan on Windows and Linux
• D3D12 and D3D11 on Windows
• Metal on macOS and iOS

Usage

This repository contains C-language examples that link to the native library targets and perform basic rendering and computation. To run the C triangle example, install a C compiler + glfw 3, then run these commands at the root of the repo:

rustup toolchain install nightly
cargo install cbindgen
make examples-native
cd examples/hello_triangle_c/build
./hello_triangle

The idiomatic Rust wrapper lives in https://github.com/gfx-rs/wgpu-rs and provides a number of more complex examples to get a feel of the API.