Struct PackageBuilder 

pub struct PackageBuilder { /* private fields */ }

A builder that generates code for WESL packages.

WESL packages are bundles of shader files that can be reused in other projects, like Rust crates. See the consumer example to see how to use them.

This type is mainly designed to be used in a build script (build.rs file). Add wesl to the build-dependencies of your project and enable the package feature flag.

Usage

// in build.rs
fn main() {
   wesl::package::PackageBuilder::new("my_package")
       // read all wesl files in the directory "src/shaders"
       .scan_root("src/shaders")
       .expect("failed to scan WESL files")
       // validation is optional
       .validate()
       .inspect_err(|e| eprintln!("{e}"))
       .expect("validation error")
       // write "my_package.rs" in OUT_DIR
       .build_artifact()
       .expect("failed to build artifact");
}

Then, in your lib.rs file, expose the generated module with the wesl_core::wesl_pkg macro.

wesl::wesl_pkg!(pub my_package);

The package name must be a valid rust identifier, E.g. it must not contain dashes -. Dashes are replaced with underscores _.

Implementations

impl PackageBuilder

pub fn new(name: &str) -> Self

pub fn add_package(self, pkg: &'static StaticPackage) -> Self

Add a package dependency.

Learn more about packages in PackageBuilder.

pub fn add_packages( self, pkgs: impl IntoIterator<Item = &'static StaticPackage>, ) -> Self

Add several package dependencies.

Learn more about packages in PackageBuilder.

pub fn scan_root( self, pkg_root_dir: impl AsRef<Path>, ) -> Result<Package, ScanDirectoryError>

Read all files to include in the package, starting from the package root directory.

The package will include all .wesl and .wgsl files reachable from the package root, recursively.

pub fn scan_toml( self, toml_path: impl AsRef<Path>, ) -> Result<Package, TomlError>

Reads a wesl.toml file and builds a package from its configuration.

The wesl.toml file should be located in the given directory and contain:

• edition (required), root, include, exclude as top-level keys
• [dependencies] section (optional)

Example

wesl::package::PackageBuilder::new("my_package")
    .scan_toml(".")  // looks for ./wesl.toml
    .expect("failed to scan WESL files")
    .build_artifact()
    .expect("failed to build artifact");