Files
wgpu/wgpu
Kevin Reid c1934dc07f RenderPassDescriptor: make label lifetime match doc, and make names descriptive. (#2654)
Lifetime names like `<'a, 'b>` mean that the reader must look at how
they are used to understand them. By changing them to `'tex` (lifetime
of borrows of the texture views the documentation describes) and `'desc`
(everything else), and mentioning them in the documentation, it's more
obvious which role each one plays.

For consistency, I also changed `begin_render_pass()`,
`RenderPassColorAttachment`, and `RenderPassDepthStencilAttachment` to
use matching lifetime names.

Also, this made it clear that the `Label` had the wrong lifetime --
the docs say that the texture views have a different lifetime from
“everything else”, but the `Label` in fact had the same lifetime as
the texture views, so I changed it to the `'desc` (formerly `'b`)
lifetime. (On review of change history, this mismatch was previously
introduced in commit 632f828eda9af1f6f18c74398b5f40644cf02f03.)
This change is definitely safe because I followed the data flow down
to `BasePass::new` which promptly calls `to_string()` on the label,
thus converting it to owned data.
2022-05-12 22:16:53 -07:00
..
2022-05-11 20:17:32 -07:00
2022-04-15 22:22:48 +03:00
2022-05-03 04:28:17 +00:00

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_BACKEND

    Options: vulkan, metal, dx11, dx12, gl, webgpu

    If unset a default backend is chosen based on what is supported by your system.

  • WGPU_POWER_PREF

    Options: low, high

    If unset a low power adapter is preferred.

  • WGPU_ADAPTER_NAME

    Select 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.