@woosh/meep-engine 3.58.0 → 3.59.0

package/src/shade/renderer/texture/util/texture_fill_rectangle.js

@@ -1,267 +1,282 @@
-import { assert } from "../../../../core/assert.js";
-import { BinaryDataType } from "../../../../core/binary/type/BinaryDataType.js";
-import { Cache } from "../../../../core/cache/Cache.js";
-import { isArrayEqualStrict } from "../../../../core/collection/array/isArrayEqualStrict.js";
-import { computeHashFloatArray } from "../../../../core/math/hash/computeHashFloatArray.js";
-import { computeStringHash } from "../../../../core/primitives/strings/computeStringHash.js";
-import { RenderPipelineDescriptor } from "../../../descriptor/pipeline/render/RenderPipelineDescriptor.js";
-import { create_full_quad_pipeline_descriptor } from "../../shader/fullscreen/create_full_quad_pipeline_descriptor.js";
-import { CodeChunk } from "../../shader/compiler/CodeChunk.js";
-import { RenderPassColorAttachmentDescriptor } from "../../shader/pass/RenderPassColorAttachmentDescriptor.js";
-import { RenderPassDescriptor } from "../../shader/pass/RenderPassDescriptor.js";
-import { ShaderResourceSetDescriptor } from "../../shader/resource/ShaderResourceSetDescriptor.js";
-import { vertex_full_viewport_quad } from "../../shader/fullscreen/vertex_full_viewport_quad.js";
-import { DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR } from "../DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR.js";
-import { parse_gpu_texture_format } from "../../../descriptor/texture/format/parse_gpu_texture_format.js";
-import { wgsl_texture_format_is_depth } from "../format/wgsl_texture_format_is_depth.js";
-
-class PipelineKey {
-    /**
-     * @type {GPUTextureFormat}
-     */
-    format;
-
-    /**
-     *
-     * @type {number[]}
-     */
-    value = [0, 0, 0, 0]
-
-    /**
-     *
-     * @param {PipelineKey} other
-     * @return {boolean}
-     */
-    equals(other) {
-        return this.format === other.format
-            && isArrayEqualStrict(this.value, other.value);
-    }
-
-    hash() {
-        return computeStringHash(this.format)
-            ^ computeHashFloatArray(this.value);
-    }
-
-    /**
-     * @returns {PipelineKey}
-     */
-    static from(format, clearValue) {
-        // TODO validate clear value for format
-
-        const r = new PipelineKey();
-
-        r.format = format;
-        // copy — the key is retained by the pipeline cache, and a caller mutating its
-        // clear-value array would silently mutate the cached key with it
-        r.value = Array.from(clearValue);
-
-        return r;
-    }
-}
-
-/**
- *
- * @type {Cache<PipelineKey, RenderPassDescriptor>}
- */
-const pipeline_cache = new Cache();
-
-
-/**
- *
- * @param {PipelineKey} key
- * @returns {RenderPassDescriptor}
- */
-function create_pipeline_color(key) {
-    const d = new RenderPassDescriptor();
-
-    const spec = parse_gpu_texture_format(key.format);
-
-    assert.greaterThanOrEqual(key.value.length, spec.itemSize, 'value undeflow');
-
-    d.resources = ShaderResourceSetDescriptor.EMPTY;
-
-    let binary_type;
-    switch (spec.type) {
-        case BinaryDataType.Float32:
-            binary_type = 'f32';
-            break;
-        case BinaryDataType.Uint32:
-            binary_type = 'u32';
-            break
-        default:
-            throw new Error(`Unsupported type "${spec.type}"`);
-    }
-
-    let output_type;
-    if (spec.itemSize > 1) {
-        output_type = `vec${spec.itemSize}<${binary_type}>`;
-    } else {
-        output_type = binary_type;
-    }
-
-    const body = CodeChunk.from(
-        //language=WGSL
-        `
-@fragment
-fn main(
-    @builtin(position) coord: vec4<f32>,
-) -> @location(0) ${output_type}{
-    
-    return ${output_type}(${key.value.slice(0,spec.itemSize).join(', ')});
-}
-        `
-    );
-
-    const view_descriptor = DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR;
-
-    d.pipeline = create_full_quad_pipeline_descriptor({
-        label: `texture_fill_rectangle/`,
-        layout: d.resources.generatePipelineLayoutDescriptor(),
-        fragment_code: body.compile().text,
-        targets: [
-            {
-                format: view_descriptor.format,
-            }
-        ]
-    });
-
-    d.colorAttachments = [
-        RenderPassColorAttachmentDescriptor.from({
-            view: view_descriptor,
-        })
-    ];
-
-    return d;
-
-}
-
-/**
- *
- * @param {PipelineKey} key
- * @returns {RenderPassDescriptor}
- */
-function create_pipeline_depth(key) {
-    if (key.format !== 'depth32float') {
-        // TODO validate/add support for other depth formats
-        throw new Error(`Unsupported depth format "${key.format}"`);
-    }
-
-    const d = new RenderPassDescriptor();
-
-    d.resources = ShaderResourceSetDescriptor.EMPTY;
-
-    const clear_value = key.value[0];
-
-    assert.isNumber(clear_value, 'clear_value');
-
-    const body = CodeChunk.from(
-        //language=WGSL
-        `
-@fragment
-fn main(
-    @builtin(position) coord: vec4<f32>,
-) -> @builtin(frag_depth) f32{
-    
-    return f32(${clear_value});
-}
-        `
-    );
-
-    d.pipeline = RenderPipelineDescriptor.from({
-        label: `texture_fill_rectangle/depth`,
-        layout: d.resources.generatePipelineLayoutDescriptor(),
-        vertex: {
-            module: {
-                code: vertex_full_viewport_quad,
-            }
-        },
-        fragment: {
-            module: {
-                code: body.compile().text
-            }
-        },
-        depthStencil: {
-            format: 'depth32float',
-            depthWriteEnabled: true,
-            depthCompare: "always",
-            // disable stencil
-            stencilReadMask: 0,
-            stencilWriteMask: 0
-        },
-        primitive: {
-            topology: 'triangle-list',
-            cullMode: 'none',
-        }
-    });
-
-
-    return d;
-
-}
-
-/**
- * WebGPU lacks `clearTexture` command, this function performs similar function to pain a region of the texture with a solid color
- * Basic principle is simple - there is a custom pipeline per format/value combination, so don't go too overboard with values, or you'll be thrashing caches and causing shader recompilations.
- * @param {ShadeGPUCommandContext} encoder
- * @param {GPUTextureContext} target
- * @param {number[]} rectangle format: [x0, y0, width, height]
- * @param {number[]} fill_value
- */
-export function texture_fill_rectangle(
-    encoder,
-    target,
-    rectangle,
-    fill_value
-) {
-
-    assert.defined(encoder, 'encoder');
-    assert.defined(target, 'target');
-    assert.defined(rectangle, 'rectangle');
-    assert.defined(fill_value, 'fill_value');
-
-    const format = target.descriptor.format;
-
-    // clearing depth and color are different, so we have to differentiate
-
-    const is_depth = wgsl_texture_format_is_depth(format);
-
-    const key = PipelineKey.from(format, fill_value);
-
-    let pipeline;
-    let pass;
-
-    if (is_depth) {
-
-        pipeline = pipeline_cache.getOrCompute(key, create_pipeline_depth);
-        pass = pipeline.begin({
-            encoder,
-            loadOp: 'load',
-            storeOp: 'store',
-            depthTarget: target,
-        });
-
-    } else {
-
-        pipeline = pipeline_cache.getOrCompute(key, create_pipeline_color);
-        pass = pipeline.begin({
-            encoder,
-            loadOp: 'load',
-            storeOp: 'store',
-            colorTargets: [target],
-        });
-
-    }
-
-    pass.setViewport(
-        rectangle[0],
-        rectangle[1],
-        rectangle[2],
-        rectangle[3],
-        0,
-        1
-    );
-
-    pass.draw(3);
-
-    pass.end();
-}
+import { assert } from "../../../../core/assert.js";
+import { BinaryDataType } from "../../../../core/binary/type/BinaryDataType.js";
+import { Cache } from "../../../../core/cache/Cache.js";
+import { isArrayEqualStrict } from "../../../../core/collection/array/isArrayEqualStrict.js";
+import { computeHashFloatArray } from "../../../../core/math/hash/computeHashFloatArray.js";
+import { computeStringHash } from "../../../../core/primitives/strings/computeStringHash.js";
+import { RenderPipelineDescriptor } from "../../../descriptor/pipeline/render/RenderPipelineDescriptor.js";
+import { create_full_quad_pipeline_descriptor } from "../../shader/fullscreen/create_full_quad_pipeline_descriptor.js";
+import { CodeChunk } from "../../shader/compiler/CodeChunk.js";
+import { RenderPassColorAttachmentDescriptor } from "../../shader/pass/RenderPassColorAttachmentDescriptor.js";
+import { RenderPassDescriptor } from "../../shader/pass/RenderPassDescriptor.js";
+import { ShaderResourceSetDescriptor } from "../../shader/resource/ShaderResourceSetDescriptor.js";
+import { DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR } from "../DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR.js";
+import { parse_gpu_texture_format } from "../../../descriptor/texture/format/parse_gpu_texture_format.js";
+import { wgsl_texture_format_is_depth } from "../format/wgsl_texture_format_is_depth.js";
+
+//language=WGSL
+const vertex_full_viewport_quad_pos = `
+const pos = array<vec2<f32>, 3>(
+    vec2<f32>(-1.0, -1.0),
+    vec2<f32>( 3.0, -1.0),
+    vec2<f32>(-1.0,  3.0)
+);
+
+@vertex
+fn main(
+    @builtin(vertex_index) vertex_index : u32
+) -> @builtin(position) vec4<f32> {
+    return vec4<f32>(pos[vertex_index], 0.0, 1.0);
+}
+`;
+
+class PipelineKey {
+    /**
+     * @type {GPUTextureFormat}
+     */
+    format;
+
+    /**
+     *
+     * @type {number[]}
+     */
+    value = [0, 0, 0, 0]
+
+    /**
+     *
+     * @param {PipelineKey} other
+     * @return {boolean}
+     */
+    equals(other) {
+        return this.format === other.format
+            && isArrayEqualStrict(this.value, other.value);
+    }
+
+    hash() {
+        return computeStringHash(this.format)
+            ^ computeHashFloatArray(this.value);
+    }
+
+    /**
+     * @returns {PipelineKey}
+     */
+    static from(format, clearValue) {
+        // TODO validate clear value for format
+
+        const r = new PipelineKey();
+
+        r.format = format;
+        // copy — the key is retained by the pipeline cache, and a caller mutating its
+        // clear-value array would silently mutate the cached key with it
+        r.value = Array.from(clearValue);
+
+        return r;
+    }
+}
+
+/**
+ *
+ * @type {Cache<PipelineKey, RenderPassDescriptor>}
+ */
+const pipeline_cache = new Cache();
+
+/**
+ * @type {Map<GPUTextureFormat, RenderPassDescriptor>}
+ */
+const depth_pipeline_cache = new Map();
+
+
+/**
+ *
+ * @param {PipelineKey} key
+ * @returns {RenderPassDescriptor}
+ */
+function create_pipeline_color(key) {
+    const d = new RenderPassDescriptor();
+
+    const spec = parse_gpu_texture_format(key.format);
+
+    assert.greaterThanOrEqual(key.value.length, spec.itemSize, 'value undeflow');
+
+    d.resources = ShaderResourceSetDescriptor.EMPTY;
+
+    let binary_type;
+    switch (spec.type) {
+        case BinaryDataType.Float32:
+            binary_type = 'f32';
+            break;
+        case BinaryDataType.Uint32:
+            binary_type = 'u32';
+            break
+        default:
+            throw new Error(`Unsupported type "${spec.type}"`);
+    }
+
+    let output_type;
+    if (spec.itemSize > 1) {
+        output_type = `vec${spec.itemSize}<${binary_type}>`;
+    } else {
+        output_type = binary_type;
+    }
+
+    const body = CodeChunk.from(
+        //language=WGSL
+        `
+@fragment
+fn main(
+    @builtin(position) coord: vec4<f32>,
+) -> @location(0) ${output_type}{
+    
+    return ${output_type}(${key.value.slice(0,spec.itemSize).join(', ')});
+}
+        `
+    );
+
+    const view_descriptor = DEFAULT_RENDER_TARGET_VIEW_DESCRIPTOR;
+
+    d.pipeline = create_full_quad_pipeline_descriptor({
+        label: `texture_fill_rectangle/`,
+        layout: d.resources.generatePipelineLayoutDescriptor(),
+        fragment_code: body.compile().text,
+        targets: [
+            {
+                format: key.format,
+            }
+        ]
+    });
+
+    d.colorAttachments = [
+        RenderPassColorAttachmentDescriptor.from({
+            view: view_descriptor,
+        })
+    ];
+
+    return d;
+
+}
+
+/**
+ * Depth-only pipeline (`fragment` omitted — WebGPU no-color-output mode).
+ *
+ * Because {@link vertex_full_viewport_quad_pos} outputs $z_{\text{ndc}} = 0$, the viewport transform
+ * maps every fragment's depth to `minDepth`, so the fill value is supplied dynamically through
+ * `setViewport` and one pipeline serves every depth value for a given format.
+ *
+ * @param {GPUTextureFormat} format
+ * @returns {RenderPassDescriptor}
+ */
+function create_pipeline_depth(format) {
+    if (format !== 'depth32float') {
+        // TODO validate/add support for other depth formats
+        throw new Error(`Unsupported depth format "${format}"`);
+    }
+
+    const d = new RenderPassDescriptor();
+
+    d.resources = ShaderResourceSetDescriptor.EMPTY;
+
+    d.pipeline = RenderPipelineDescriptor.from({
+        label: `texture_fill_rectangle/depth`,
+        layout: d.resources.generatePipelineLayoutDescriptor(),
+        vertex: {
+            module: {
+                code: vertex_full_viewport_quad_pos,
+            },
+            entryPoint: 'main',
+        },
+        depthStencil: {
+            format: 'depth32float',
+            depthWriteEnabled: true,
+            depthCompare: "always",
+            // disable stencil
+            stencilReadMask: 0,
+            stencilWriteMask: 0
+        },
+        primitive: {
+            topology: 'triangle-list',
+            cullMode: 'none',
+        }
+    });
+
+
+    return d;
+
+}
+
+/**
+ * WebGPU lacks `clearTexture` command, this function performs similar function to pain a region of the texture with a solid color
+ * Basic principle is simple - there is a custom pipeline per format/value combination, so don't go too overboard with values, or you'll be thrashing caches and causing shader recompilations.
+ * @param {ShadeGPUCommandContext} encoder
+ * @param {GPUTextureContext} target
+ * @param {number[]} rectangle format: [x0, y0, width, height]
+ * @param {number[]} fill_value
+ */
+export function texture_fill_rectangle(
+    encoder,
+    target,
+    rectangle,
+    fill_value
+) {
+
+    assert.defined(encoder, 'encoder');
+    assert.defined(target, 'target');
+    assert.defined(rectangle, 'rectangle');
+    assert.defined(fill_value, 'fill_value');
+
+    const format = target.descriptor.format;
+
+    // clearing depth and color are different, so we have to differentiate
+
+    const is_depth = wgsl_texture_format_is_depth(format);
+
+    let pipeline;
+    let pass;
+    let min_depth = 0;
+
+    if (is_depth) {
+        min_depth = fill_value[0];
+
+        assert.isNumber(min_depth, 'clear_value');
+        assert.greaterThanOrEqual(min_depth, 0, 'clear_value >= 0');
+        assert.lessThanOrEqual(min_depth, 1, 'clear_value <= 1');
+
+        pipeline = depth_pipeline_cache.get(format);
+        if (pipeline === undefined) {
+            pipeline = create_pipeline_depth(format);
+            depth_pipeline_cache.set(format, pipeline);
+        }
+
+        pass = pipeline.begin({
+            encoder,
+            loadOp: 'load',
+            storeOp: 'store',
+            depthTarget: target,
+        });
+
+    } else {
+
+        const key = PipelineKey.from(format, fill_value);
+
+        pipeline = pipeline_cache.getOrCompute(key, create_pipeline_color);
+        pass = pipeline.begin({
+            encoder,
+            loadOp: 'load',
+            storeOp: 'store',
+            colorTargets: [target],
+        });
+
+    }
+
+    pass.setViewport(
+        rectangle[0],
+        rectangle[1],
+        rectangle[2],
+        rectangle[3],
+        min_depth,
+        1
+    );
+
+    pass.draw(3);
+
+    pass.end();
+}

package/src/shade/renderer/volumetrics/GPUViewVolumetrics.d.ts

@@ -22,8 +22,8 @@ export class GPUViewVolumetrics {
     set tile_size(v: number);
     /**
      * Size of one froxel in XY, in screen pixels. Smaller is finer fog detail at a cost that grows
-     * with the inverse square. The grid is resized on the next update and the TAA history dropped,
-     * so the frame after a change starts its accumulation over.
+     * with the inverse square. The grid is resized on the next update and the TAA history carries
+     * over: it spans the same screen uv at any froxel count.
      *
      * The grid's XY extent, `ceil(view resolution / tile_size)`, must stay within the device's
      * `maxTextureDimension3D`.
@@ -37,7 +37,8 @@ export class GPUViewVolumetrics {
     set resolution_z(v: number);
     /**
      * Number of froxel slices between the camera near and {@link froxel_far}. Cost grows linearly.
-     * The grid is resized on the next update and the TAA history dropped, as for {@link tile_size}.
+     * The grid is resized on the next update and the TAA history dropped, because the depth curve
+     * is built for the slice count.
      * @returns {number}
      */
     get resolution_z(): number;
@@ -73,9 +74,11 @@ export class GPUViewVolumetrics {
      * @param {ShaderSwitchSet} [options.shader_switches]
      * @param {import("../global_illumination/brick4/Brick4LightMap.js").Brick4LightMap} [options.brick4]
      * @param {import("../global_illumination/lpv/GPULightProbeVolume.js").GPULightProbeVolume} [options.lpv]
+     * @param {import("../global_illumination/probe_clipmap/GPUProbeClipmapGI.js").GPUProbeClipmapGI} options.probes
+     *   the renderer's probe clipmap GI, whose probes the irradiance clipmap binds in every mode
      * @returns {{resolved: number, metadata: number, irradiance: {Y: number, CoCg: number, uniform: number}}}
      */
-    graph_update({ graph, view, light_cluster_data, light_cluster_lookup, light_cluster_parameters, shadowmap_atlas, shader_switches, brick4, lpv, }: {
+    graph_update({ graph, view, light_cluster_data, light_cluster_lookup, light_cluster_parameters, shadowmap_atlas, shader_switches, brick4, lpv, probes, }: {
         graph: FrameGraph;
         view: GPUViewContext;
         light_cluster_data: number;
@@ -85,6 +88,7 @@ export class GPUViewVolumetrics {
         shader_switches?: ShaderSwitchSet;
         brick4?: import("../global_illumination/brick4/Brick4LightMap.js").Brick4LightMap;
         lpv?: import("../global_illumination/lpv/GPULightProbeVolume.js").GPULightProbeVolume;
+        probes: import("../global_illumination/probe_clipmap/GPUProbeClipmapGI.js").GPUProbeClipmapGI;
     }): {
         resolved: number;
         metadata: number;

package/src/shade/renderer/volumetrics/GPUViewVolumetrics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GPUViewVolumetrics.d.ts","sourceRoot":"","sources":["../../../../../src/shade/renderer/volumetrics/GPUViewVolumetrics.js"],"names":[],"mappings":"AAuBA;;;GAGG;AAEH;IA0MI;;;OAGG;IACH,+BAuCC;IA/MD;;OAEG;IACH,4BAOC;IAjBD;;OAEG;IACH,2BAEC;IAuCD;;OAEG;IACH,yBAIC;IApBD;;;;;;;;OAQG;IACH,wBAEC;IAoBD;;;OAGG;IACH,4BAMC;IAnBD;;;;OAIG;IACH,2BAEC;IAsCD;;OAEG;IACH,0BAEC;IAZD;;OAEG;IACH,yBAEC;IAwHD;;OAEG;IACH,+CAEC;IAED;;;;OAIG;IACH,sBAEC;IAED,gBAcC;IAsOD;;;;;;;;;;;;;;OAcG;IACH;QAZ+B,KAAK,EAAzB,UAAU;QACc,IAAI,EAA5B,cAAc;QAEE,kBAAkB,EAAlC,MAAM;QACU,oBAAoB,EAApC,MAAM;QACU,wBAAwB,EAAxC,MAAM;QACU,eAAe,EAA/B,MAAM;QACoB,eAAe,GAAzC,eAAe;QACoE,MAAM,GAAzF,OAAO,iDAAiD,EAAE,cAAc;QACkB,GAAG,GAA7F,OAAO,mDAAmD,EAAE,mBAAmB;QAC7E;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAC,CAAA;KAAC,CA6GxG;;CAEJ;yBA3nBY,OAAO,2DAA2D,EAAE,UAAU;6BAC9E,OAAO,2BAA2B,EAAE,cAAc;qCAX1B,8CAA8C;gCAXnD,uCAAuC"}
+{"version":3,"file":"GPUViewVolumetrics.d.ts","sourceRoot":"","sources":["../../../../../src/shade/renderer/volumetrics/GPUViewVolumetrics.js"],"names":[],"mappings":"AAuBA;;;GAGG;AAEH;IAkNI;;;OAGG;IACH,+BAuCC;IAvND;;OAEG;IACH,4BAOC;IAjBD;;OAEG;IACH,2BAEC;IA8CD;;OAEG;IACH,yBAIC;IApBD;;;;;;;;OAQG;IACH,wBAEC;IAqBD;;;OAGG;IACH,4BAMC;IApBD;;;;;OAKG;IACH,2BAEC;IAsCD;;OAEG;IACH,0BAEC;IAZD;;OAEG;IACH,yBAEC;IAwHD;;OAEG;IACH,+CAEC;IAED;;;;OAIG;IACH,sBAEC;IAED,gBAcC;IA+MD;;;;;;;;;;;;;;;;OAgBG;IACH;QAd+B,KAAK,EAAzB,UAAU;QACc,IAAI,EAA5B,cAAc;QAEE,kBAAkB,EAAlC,MAAM;QACU,oBAAoB,EAApC,MAAM;QACU,wBAAwB,EAAxC,MAAM;QACU,eAAe,EAA/B,MAAM;QACoB,eAAe,GAAzC,eAAe;QACoE,MAAM,GAAzF,OAAO,iDAAiD,EAAE,cAAc;QACkB,GAAG,GAA7F,OAAO,mDAAmD,EAAE,mBAAmB;QACgB,MAAM,EAArG,OAAO,2DAA2D,EAAE,iBAAiB;QAEnF;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAC,CAAA;KAAC,CA0HxG;;CAEJ;yBA3nBY,OAAO,2DAA2D,EAAE,UAAU;6BAC9E,OAAO,2BAA2B,EAAE,cAAc;qCAX1B,8CAA8C;gCAXnD,uCAAuC"}