mirror of https://github.com/gfx-rs/wgpu.git synced 2024-11-22 06:44:14 +00:00

Cross-platform, safe, pure-rust graphics api.

d3d12 gpu hacktoberfest metal opengl rust vulkan webgpu

Go to file

Dzmitry Malyshau 5ada8d9943 Fix full_range of arrays		2019-02-22 13:53:28 -05:00
examples	Shadow example shaders and improvements	2019-02-22 12:59:29 -05:00
gfx-examples	Fix full_range of arrays	2019-02-22 13:53:28 -05:00
wgpu-bindings	Swapchain resize, merged with the surface	2019-02-21 15:59:24 -05:00
wgpu-native	Fix full_range of arrays	2019-02-22 13:53:28 -05:00
wgpu-rs	Refactored tracking, now includes the views	2019-02-22 12:59:29 -05:00
.gitignore	Create C example	2018-09-23 13:25:05 -06:00
.travis.yml	Separate object identity from storage	2019-02-14 14:28:55 -05:00
bors.toml	CI scripts	2018-09-14 11:39:24 -04:00
Cargo.lock	rust: temporary vector of command buffers	2019-02-21 08:15:39 -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	Shadow example shaders and improvements	2019-02-22 12:59:29 -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

README.md

WebGPU

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.