Struct ShaderBuild 

pub struct ShaderBuild { /* private fields */ }

One crate’s shader-binding generation, run from its build script.

Implementations

impl ShaderBuild

pub fn discover(shader_root: impl AsRef<Path>) -> Result<Self, ShaderBuildError>

Returns a build of every .wgsl file under shader_root without a #define_import_path line.

A symlink to a directory is followed, and a directory reached twice is walked once. Note that the build stamp of stamp_commit follows no such link, and an edit to a shader in a linked directory changes no stamp.

Errors

Returns ShaderBuildError that lists the files. Files that are not .wgsl are never checked.

• ShaderBuildError::InvalidName for a .wgsl path below the root with a component that is not a Rust identifier or is a keyword, and for an entry point whose ShaderEntry variant is not a Rust identifier (self_.wgsl gives Self).
• ShaderBuildError::NameCollision for two entry points whose module paths, ShaderEntry variants or binding constants collide, and for an entry point whose module contains another entry point’s module.
• ShaderBuildError::ReservedName for a file named henad.wgsl or a directory named henad holding a .wgsl file at any depth under the root, for a .wgsl path starting with a name the generated bindings use, and for a root whose last component is henad.
• ShaderBuildError::Io for a file or directory that cannot be read.

pub fn new(shader_root: impl AsRef<Path>) -> Self

Returns a build with no entry points until Self::entry_point adds them.

pub fn entry_point(self, path: impl AsRef<Path>) -> Self

Adds the entry point path, relative to the shader root.

Note that the path is checked when Self::generate runs, in the same way as a discovered entry point: it lies under the root, and each of its components is a Rust identifier and not a keyword.

pub fn generate(self) -> Result<(), ShaderBuildError>

Writes shader_bindings.rs and binding_decls.rs to OUT_DIR, each only when its bytes change.

Prints a cargo:rerun-if-changed line for the shader root, which Cargo watches recursively, one for each entry point Self::entry_point added, and one for each file outside the root that an entry point imports. No line refers to a path under OUT_DIR.

Errors

Returns ShaderBuildError in these cases:

• ShaderBuildError::Environment when OUT_DIR is not set, and ShaderBuildError::Io for a file that cannot be read or written.
• ShaderBuildError::ReservedName for a shader root whose last component is henad or a reserved name under the root, and ShaderBuildError::ReservedImport for a module imported under a reserved name.
• ShaderBuildError::OutsideRoot for an entry point outside the root, and ShaderBuildError::InvalidName or ShaderBuildError::NameCollision for an entry point whose path gives no Rust name or repeats another entry’s name.
• ShaderBuildError::BindingLine, ShaderBuildError::UnsupportedBinding, ShaderBuildError::ModuleBinding and ShaderBuildError::BindingGap for bindings that the reader rejects.
• ShaderBuildError::Compose for a shader that does not compose.

Trait Implementations

impl Clone for ShaderBuild

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShaderBuild

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.