Cross-platform, safe, pure-rust graphics api.
Go to file
2019-02-12 16:48:56 -05:00
examples Command encoder interface 2019-02-12 16:48:56 -05:00
gfx-examples Command encoder interface 2019-02-12 16:48:56 -05:00
wgpu-bindings Command encoder interface 2019-02-12 16:48:56 -05:00
wgpu-native Command encoder interface 2019-02-12 16:48:56 -05:00
wgpu-rs Command encoder interface 2019-02-12 16:48:56 -05:00
.gitignore Create C example 2018-09-23 13:25:05 -06:00
.travis.yml Command encoder interface 2019-02-12 16:48:56 -05:00
bors.toml CI scripts 2018-09-14 11:39:24 -04:00
Cargo.lock Command encoder interface 2019-02-12 16:48:56 -05:00
Cargo.toml Basic gfx-examples framework 2019-02-02 21:02:33 -05:00
LICENSE Initial commit 2018-09-13 15:18:51 -04:00
Makefile Command encoder interface 2019-02-12 16:48:56 -05:00
README.md Document how to run examples 2019-02-12 22:01:49 +11:00
rustfmt.toml CI scripts 2018-09-14 11:39:24 -04:00

WebGPU

Build Status Crates.io Gitter

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

The implementation consists of the following parts:

  • wgpu-native - the native implementation of WebGPU as a C API library
  • wgpu-bindings - automatic generator of actual C headers
  • wgpu-remote - remoting layer to work with WebGPU across the process boundary
  • wgpu-rs - idiomatic Rust wrapper of the native library

Example

To run an example, simply cd to the examples or gfx-examples directory, then use cargo run with --features {backend} to specify the backend (where {backend} is either vulkan, dx12, dx11 or metal). For example:

# Clone the wgpu repository
git clone https://github.com/gfx-rs/wgpu
# Change directory to `examples`
cd wgpu/examples
# Vulkan (Linux/Windows)
cargo run --bin hello_triangle --features vulkan
# Metal (macOS/iOS)
cargo run --bin hello_triangle --features metal
# DirectX12 (Windows)
cargo run --bin hello_triangle --features dx12

cd ../gfx-examples
# Vulkan (Linux/Windows)
cargo run --bin cube --features vulkan
# Metal (macOS/iOS)
cargo run --bin cube --features metal
# DirectX12 (Windows)
cargo run --bin cube --features dx12

These examples assume that necessary dependencies for the graphics backend are already installed. For more information about installation and usage, refer to the Getting Started guide.