* Added GLSL to ShaderSource behind Feature lock * Used full path for Naga's FastHashMap and ShaderStage rather than add them as a pub include * changed spirv and glsl web feature to web-shader-translation. Now requires glsl or spirv to be choosen along with the web-shader-translation to unlock their usage * Changed the Description of the Glsl enum * Added README update * Made With with * added catch all that panics if web-shader-translation is not enabled with spirv or glsl * added Compiler condition to prevent the catch all unless glsl or spirv exists without web-shader-translation * We decided to use [target.'cfg(target_arch = wasm32)'.dependencies.naga] within cargo to include wgsl-out in the Web backend unconditionally, which removed the need for a panic * Removed wasm targets section from readme as it is no longer needed * Named Glsl fields to make them more understandable as to what they are for * Fixed the enum usage for GLSL and Added documentation for the fields
2.1 KiB
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.
wgpu-rs can target both the natively supported backends and WASM directly.
See our gallery and the wiki page for the list of libraries and applications using wgpu-rs.
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* 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
The following environment variables can be used to configure how the framework examples run:
-
WGPU_BACKENDOptions:
vulkan,metal,dx11,dx12,gl,webgpuIf unset a default backend is chosen based on what is supported by your system.
-
WGPU_POWER_PREFOptions:
low,highIf unset a low power adapter is preferred.
-
WGPU_ADAPTER_NAMESelect a specific adapter by specifying a substring of the adapter name.
Run Examples on the Web (wasm32-unknown-unknown)
See wiki article.
Shaders
WGSL is the main shading language of WebGPU.
Users can run the naga binary in the following way to convert their SPIR-V shaders to WGSL:
cargo run -- <input.spv> <output.wgsl>
In addition, SPIR-V can be used by enabling the spirv feature and GLSL can be enabled by enabling the glsl feature at the cost of slightly increased build times.