1 unstable release

0.0.1 Dec 23, 2023

#27 in #wgsl

Apache-2.0 OR MIT

63KB
1.5K SLoC

A crate to generate WGSL text from rust code.

When to use

  • When you want to compose multiple WGSL pieces into one WGSL text, so that you can generate shader module from it.
  • When you want to modify WGSL piece such as deletion.

Example

// ref: https://www.w3.org/TR/WGSL/
use my_wgsl::*;

#[wgsl_decl_struct]
struct PointLight {
    position: vec3f,
    color: vec3f,
}

#[wgsl_decl_struct]
struct LightStorage {
    pointCount: u32,
    point: array<PointLight>,
}

fn foo() {
    let mut builder = Builder::new();

    wgsl_structs![builder, PointLight, LightStorage];

    wgsl_bind!(
        builder, group(0) binding(0) var<storage> lights : LightStorage
    );
    wgsl_bind!(
        builder, group(1) binding(0) var baseColorSampler : sampler
    );
    wgsl_bind!(
        builder, group(1) binding(1) var baseColorTexture : texture_2d<f32>
    );

    wgsl_fn!(builder,
        #[fragment]
        fn fragmentMain(#[location(0)] worldPos : vec3f,
                        #[location(1)] normal : vec3f,
                        #[location(2)] uv : vec2f) -> #[location(0)] vec4f {
            // Sample the base color of the surface from a texture.
            let baseColor = textureSample(baseColorTexture, baseColorSampler, uv);

            let N = normalize(normal);
            var surfaceColor = vec3f(0);

            // Loop over the scene point lights.
            for (var i = 0u; i < lights.pointCount; ++i) {
                let worldToLight = lights.point[i].position - worldPos;
                let dist = length(worldToLight);
                let dir = normalize(worldToLight);

                // Determine the contribution of this light to the surface color.
                let radiance = lights.point[i].color * (1 / pow(dist, 2));
                let nDotL = max(dot(N, dir), 0);

                // Accumulate light contribution to the surface color.
                surfaceColor += baseColor.rgb * radiance * nDotL;
            }

            // Return the accumulated surface color.
            return vec4(surfaceColor, baseColor.a);
        }
    );

    let wgsl: String = builder.build();
    // You can use `wgsl` to make shader module.
}

Dependencies

~0.4–0.8MB
~20K SLoC