bin+lib wgsl-minifier

A command-line tool for minifying WGSL shaders

10 releases (5 breaking)

0.6.0 Aug 15, 2024
0.5.0 Jun 22, 2024
0.4.2 Jun 22, 2024
0.4.1 Mar 11, 2024
0.3.2 Nov 20, 2023

#280 in Game dev

Download history 138/week @ 2024-07-03 104/week @ 2024-07-10 42/week @ 2024-07-17 32/week @ 2024-07-24 19/week @ 2024-07-31 2/week @ 2024-08-07 138/week @ 2024-08-14 10/week @ 2024-08-21 12/week @ 2024-08-28 7/week @ 2024-09-04 30/week @ 2024-09-11 24/week @ 2024-09-18 40/week @ 2024-09-25 22/week @ 2024-10-02 54/week @ 2024-10-16

121 downloads per month
Used in 4 crates (2 directly)

MIT license

17KB
312 lines

WGSL Minifier

crates.io docs.rs crates.io

A small tool built on top of Naga that makes WGSL shaders smaller by performing simple dead code elimination, stripping names of non-exported functions and local variables, and removing as much whitespace as possible.

Usage

To minify your WGSL shader, simply run the following:

cargo install wgsl-minifier
wgsl-minifier path/to/your/shader.wgsl path/to/minified/output.wgsl

As a library

To use this crate as a library, for example in a game engine or larger preprocessor, two calls must be made. The first strips identifiers to smaller ones where possible. The second removes unnecessary whitespace, commas, and parentheses in a source string:

let mut module = /* your source here, or */ naga::Module::default();

// Now minify!
wgsl_minifier::minify_module(&mut module);

// Write to WGSL string
let mut validator = naga::valid::Validator::new(
    naga::valid::ValidationFlags::all(),
    naga::valid::Capabilities::all(),
);
let info = validator.validate(&module).unwrap();
let output = naga::back::wgsl::write_string(&module, &info, naga::back::wgsl::WriterFlags::empty()).unwrap();

// Minify string
let output = wgsl_minifier::minify_wgsl_source(&output);

Dependencies

~7–14MB
~182K SLoC