Struct CompileResult 

pub struct CompileResult {
    pub syntax: TranslationUnit,
    pub modules: Vec<Module>,
    pub sourcemap: Option<BasicSourceMap>,
    pub used_items: UsedItems,
}

Result of Compiler::compile.

This type contains the resulting WGSL syntax tree, the sourcemap (if enabled), and the list of used modules/declarations.

It implements std::fmt::Display, call to_string() to get the compiled WGSL.

Fields

syntax: TranslationUnit

The syntax tree of the resulting

modules: Vec<Module>

sourcemap: Option<BasicSourceMap>

used_items: UsedItems

Implementations

impl CompileResult

pub fn write_to_file(&self, path: impl AsRef<Path>) -> Result<()>

Write the compiled result to a file.

pub fn emit_rerun_if_changed(&self)

Emit rerun-if-changed instructions so the build script reruns only if the shader files are modified.

pub fn write_artifact(&self, artifact_name: &str)

Write the result in rust’s OUT_DIR.

This function is meant to be used in a build.rs workflow. The output WGSL will be accessed with the wesl_core::include_wesl macro. See the crate documentation for a usage example.

Panics

Panics when the output file cannot be written.

Trait Implementations

impl Clone for CompileResult

fn clone(&self) -> CompileResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CompileResult

fn default() -> CompileResult

Returns the “default value” for a type.

impl Display for CompileResult

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

Formats the value using the given formatter.