aeab013546
212: Improve BufferCopyView documentation r=kvark a=rukai groves suggested that the alignment/multiple requirements are not implemented yet. So I changed the documentation to reflect that. Ideally we would change the examples to demonstrate how to work around this requirement, but I think its best to wait until we know for certain that this IS a requirement, currently the WebGPU spec does not have this as a requirement. Additionally it seems like every example except for the skybox example failed to follow this part of the WebGPU spec. "Note: rowsPerImage must be zero for copies with a copySize.depth of 1, and must be greater than zero otherwise." So I fixed those examples and documented the requirement on the field. Co-authored-by: Rukai <rubickent@gmail.com>
wgpu-rs
wgpu-rs is an idiomatic Rust wrapper over wgpu-core. It's designed to be suitable for general purpose graphics and computation needs of Rust community.
Currently wgpu-rs works on native platforms, but WASM support is currently being added as well.
Gallery
Usage
How to Run Examples
All examples are located under the examples directory.
These examples use the default syntax for running examples, as found in the Cargo documentation. For example, to run the cube example:
cargo run --example cube
The hello-triangle and hello-compute examples show bare-bones setup without any helper code. For hello-compute, pass 4 numbers separated by spaces as arguments:
cargo run --example hello-compute 1 2 3 4
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
- iced - a cross-platform GUI library
- rgx - a 2D graphics library
- imgui-wgpu - Dear ImGui interfacing
- pixels - the easiest way to create a hardware-accelerated pixel frame buffer
- kas - tooKit Abstraction System
- oxidator - RTS game engine
- nannou - a creative coding framework
Also, libraries that have support for wgpu-rs:
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.