vello_gpu_shaders

Vello GPU Shaders

This crate contains the WESL programs and linked WGSL output, plus optionally generated GLSL shader programs, used by the Vello GPU renderer.

Features

• Single source of truth authored as WESL programs.
• Automated build step that links WESL, then uses naga to minify the resulting WGSL.
• Optional generation of minified GLSL and reflection metadata for WebGL.

Usage

This crate provides linked WGSL programs and the build step for GLSL programs used by Vello GPU.

Whenever the WESL shaders are updated, the build script automatically relinks and minifies the WGSL. When the glsl feature is enabled, it also regenerates the minified GLSL programs and reflection metadata used by vello_gpu.

To inspect the generated WebGL GLSL and the embedded compiled_shaders.rs module used by vello_gpu, create local copies by running:

cargo run -p vello_gpu_shaders --features glsl

The generated files will be written into the generated_glsl folder.

To retain authored identifiers and Naga's readable formatting for debugging, enable the diagnostic unminified feature as well:

cargo run -p vello_gpu_shaders --features glsl,unminified

Minimum supported Rust Version (MSRV)

This version of Vello GPU Shaders has been verified to compile with Rust 1.89 and later.

Future versions of Vello GPU Shaders might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases.

Click here if compiling fails.

As time has passed, some of Vello GPU's dependencies could have released versions with a higher Rust requirement. If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.

# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1

Community

Discussion of Vello GPU development happens in the Linebender Zulip, specifically the #vello channel. All public content can be read without logging in.

Contributions are welcome by pull request. The Rust code of conduct applies.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.