0641ef6aa3
70: Wholesome update for wgpu-0.3 r=everyone a=kvark ~~This update is a little more opinionated, i.e. the BGL creation just accepts a slice of things instead of a descriptor. I believe the reason for descriptors in the upstream API is mostly techincal - it's more convenient to generate bindings in Googles giant codegen. Following it verbatim doesn't appear to be strictly necessary, especially if we can extract better usability from Rust features.~~ The change also disables "gl" feature for the release. We'll re-enable it once we can provide it nicely, it will not be a breaking change. I also noticed that barriers are not working correctly on the mipmap example. Will investigate separately - the native part is already published anyway. Edit: fixed by https://github.com/gfx-rs/wgpu/pull/302 Co-authored-by: Dzmitry Malyshau <dmalyshau@mozilla.com>
wgpu-rs
This is an idiomatic Rust wrapper over wgpu-native. It's designed to be suitable for general purpose graphics and computation needs of Rust community. It currently only works for the native platform, in the future aims to support WASM/Emscripten platforms as well.
Gallery
Usage
The library requires one of the following features enabled in order to run any of the examples:
- Vulkan
- Metal
- DirectX 12 (Dx12)
- DirectX 11 (Dx11)
- OpenGL (Gl)
These examples assume that necessary dependencies for the graphics backend are already installed.
Running an example
All examples are located under the examples directory. We are using the default syntax for running examples, as found in the Cargo documentation.
Cube
cargo run --example cube --features metal
cargo run --example cube --features vulkan
cargo run --example cube --features dx12
cargo run --example cube --features dx11
cargo run --example cube --features gl
Hello Compute
The "1", "2", "3", and "4" are arguments passed into the program. These arguments are used for the compute pipeline.
cargo run --example hello-compute --features metal 1 2 3 4
cargo run --example hello-compute --features vulkan 1 2 3 4
cargo run --example hello-compute --features dx12 1 2 3 4
cargo run --example hello-compute --features dx11 1 2 3 4
cargo run --example hello-compute --features gl 1 2 3 4
More examples can be found under the examples directory.
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
- imgui-wgpu - Dear ImGui interfacing
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 to do cargo update -p gfx-backend-dx12.