@woosh/meep-engine 3.28.0 → 3.30.0

package/src/shade/renderer/lightmap/GPULightMap.js

@@ -1,337 +1,350 @@
-import { assert } from "../../../core/assert.js";
-import { FrameGraph } from "../../../engine/graphics/render/frame_graph/FrameGraph.js";
-import { ShadeGPUCommandContext } from "../../device/ShadeGPUCommandContext.js";
-import { graph_image_pass } from "../shader/graph/graph_image_pass.js";
-import { graph_import_texture } from "../shader/graph/graph_import_texture.js";
-import { GPUTextureContext } from "../texture/GPUTextureContext.js";
-import { texture_mip_level_count } from "../../util/texture_mip_extent.js";
-import { HILBERT_R2_INDEX_TEXTURE } from "../texture/noise/HILBERT_R2_INDEX_TEXTURE.js";
-import { TextureFilterType } from "../texture/TextureFilterType.js";
-import { graph_draw_lightmap_viz_buffer } from "./bake/raster/graph_draw_lightmap_viz_buffer.js";
-import { shader_lightmap_denoise_sh } from "./bake/shader_lightmap_denoise_sh.js";
-import { shader_lightmap_dilate } from "./bake/shader_lightmap_dilate.js";
-import { shader_lightmap_viz_to_sh } from "./bake/shader_lightmap_viz_to_sh.js";
-import { DEFAULT_LIGHTMAP_RESOLUTION } from "./DEFAULT_LIGHTMAP_RESOLUTION.js";
-
-const MAX_LIGHT_MAP_SIZE = DEFAULT_LIGHTMAP_RESOLUTION;
-const BAKE_TILE_SIZE = 256;
-
-
-export class GPULightMap {
-
-    /**
-     *
-     * @type {GPUTextureContext|null}
-     */
-    texture_Y = null;
-    /**
-     *
-     * @type {GPUTextureContext|null}
-     */
-    texture_CoCg = null;
-    /**
-     *
-     * @type {GPUTextureContext|null}
-     */
-    texture_flat = null;
-
-    /**
-     * Stores [mesh_id, triangle_id] as vec2<u32>
-     * @type {GPUTextureContext|null}
-     */
-    texture_viz = null;
-
-    /**
-     *
-     * @return {number}
-     */
-    get resolution() {
-        return this.texture_Y.descriptor.size.width;
-    }
-
-    /**
-     *
-     * @param {GPUDevice} device
-     */
-    constructor(device) {
-        const resolution = MAX_LIGHT_MAP_SIZE;
-
-        const mip_count = Math.min(
-            3,
-            texture_mip_level_count(resolution, resolution, 1, "2d")
-        );
-
-        const texture_Y = new GPUTextureContext(device);
-
-        texture_Y.resize(resolution, resolution);
-        texture_Y.descriptor.label = "Lightmap Y/ sh2";
-        texture_Y.descriptor.format = "rgba16float";
-        texture_Y.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        texture_Y.descriptor.mipLevelCount = mip_count;
-
-        const texture_CoCg = new GPUTextureContext(device);
-        texture_CoCg.resize(resolution, resolution);
-        texture_CoCg.descriptor.label = "Lightmap CoCg";
-        texture_CoCg.descriptor.format = "rg16float";
-        texture_CoCg.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        texture_CoCg.descriptor.mipLevelCount = mip_count;
-
-        this.texture_Y = texture_Y;
-        this.texture_CoCg = texture_CoCg;
-
-        // flat
-
-        const texture_flat = new GPUTextureContext(device);
-        texture_flat.resize(resolution, resolution);
-        texture_flat.descriptor.label = "Lightmap flat";
-        texture_flat.descriptor.format = "rgba16float";
-        texture_flat.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        texture_flat.descriptor.mipLevelCount = mip_count;
-
-        this.texture_flat = texture_flat;
-
-        const texture_viz = new GPUTextureContext(device);
-        texture_viz.resize(resolution, resolution);
-        texture_viz.descriptor.label = "Lightmap viz";
-        texture_viz.descriptor.format = "rg32uint";
-        texture_viz.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        texture_viz.descriptor.mipLevelCount = 1;
-
-        this.texture_viz = texture_viz;
-    }
-
-    /**
-     * @type {GPUSceneContext}
-     */
-    #scene
-
-    /**
-     * @type {GraphicsContext}
-     */
-    #graphics
-
-    /**
-     * @type {GPUTextureContext}
-     */
-    #bake_tile_sh_Y = null;
-    /**
-     *
-     * @type {GPUTextureContext}
-     */
-    #bake_tile_sh_CoCg = null;
-    #bake_tile_next = 0;
-    #bake_full_iteration_count = 0;
-
-    /**
-     *
-     * @param {GPUSceneContext} scene_ctx
-     * @param {GraphicsContext} graphics
-     */
-    bake_start(scene_ctx, graphics) {
-        assert.isNull(this.#bake_tile_sh_Y, 'bake_tiles'); // didn't clean up
-
-        this.#scene = scene_ctx;
-        this.#graphics = graphics;
-
-        const graph = new FrameGraph("Lightmap Bake/start");
-        // prepare viz buffer
-
-        const r_materials = graphics.materials_resident;
-
-
-        r_materials.ensure_scene_materials(scene_ctx);
-        r_materials.update();
-
-        const viz_buffer = graph_import_texture(graph, this.texture_viz);
-
-        graph_draw_lightmap_viz_buffer({
-            graph,
-            output: viz_buffer,
-            scene: scene_ctx,
-        });
-
-        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/start');
-
-        cmd.encodeGraph(graph);
-
-
-        cmd.finish();
-
-        // create bake tiles
-        this.#create_bake_tile();
-
-        this.#bake_tile_next = 0;
-        this.#bake_full_iteration_count = 0;
-    }
-
-    #create_bake_tile() {
-
-        const device = this.#graphics.device;
-
-        const tile_Y = new GPUTextureContext(device);
-
-        tile_Y.descriptor.dimension = "2d";
-        tile_Y.descriptor.label = "Lightmap bake tile / Y";
-        tile_Y.descriptor.format = "rgba32float";
-        tile_Y.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        tile_Y.descriptor.mipLevelCount = 1;
-        tile_Y.resize(BAKE_TILE_SIZE, BAKE_TILE_SIZE);
-
-        this.#bake_tile_sh_Y = tile_Y;
-
-        const tile_CoCg = new GPUTextureContext(device);
-
-        tile_CoCg.descriptor.dimension = "2d";
-        tile_CoCg.descriptor.label = "Lightmap bake tile / CoCg";
-        tile_CoCg.descriptor.format = "rg32float";
-        tile_CoCg.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
-        tile_CoCg.descriptor.mipLevelCount = 1;
-        tile_CoCg.resize(BAKE_TILE_SIZE, BAKE_TILE_SIZE);
-
-        this.#bake_tile_sh_CoCg = tile_CoCg;
-    }
-
-    /**
-     * Perform a single step of baking
-     */
-    bake_update() {
-        const graphics = this.#graphics;
-        const scene_ctx = this.#scene;
-        const r_materials = graphics.materials_resident;
-
-
-        const graph = new FrameGraph("Lightmap Bake/update");
-
-        // pick a tile to update
-        const bake_tile_index = this.#bake_tile_next;
-        this.#bake_tile_next = (bake_tile_index + 1) % this.#bake_tile_sh_Y.descriptor.size.width;
-
-        if (this.#bake_tile_next === 0) {
-            // full cycle
-            this.#bake_full_iteration_count++;
-        }
-
-        const viz_buffer = graph_import_texture(graph, this.texture_viz);
-
-        // load the tile from the light map to update
-
-        // bake a single tile of the light map
-        graph_image_pass({
-            graph,
-            shader: shader_lightmap_viz_to_sh,
-            output: [
-                graph_import_texture(graph, this.texture_Y),
-                graph_import_texture(graph, this.texture_CoCg),
-            ],
-            inputs: {
-                viz_buffer,
-
-                materials: r_materials.buffer_materials,
-                textures: r_materials.textureView,
-                tNoise: graphics.textures.obtain(HILBERT_R2_INDEX_TEXTURE).obtainView(),
-
-                light_data: scene_ctx.lights.buffer_data,
-                tEnvironment: scene_ctx.lights.environment.obtainView(),
-
-                tlas: scene_ctx.tlas.buffer,
-                blas_lookup: scene_ctx.geometries.blas.buffer_metadata,
-                blas_data: scene_ctx.geometries.blas.buffer_data,
-
-                scene_database: scene_ctx.scene_database_buffer,
-                geometries: scene_ctx.geometries.buffer_metadata,
-            }
-        });
-
-        // after enough accumulation, use baking shader with feedback - sampling light map along the way to improve convergence and get infinite bounce
-
-
-        // write the tile out to the light map
-        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/update');
-
-        cmd.encodeGraph(graph);
-
-
-        cmd.finish();
-    }
-
-    bake_end() {
-        const graphics = this.#graphics;
-        const graph = new FrameGraph("Lightmap Bake/end");
-
-        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/end');
-
-
-        const resolution1 = this.resolution;
-
-        const texture_Y1 = graph_import_texture(graph, this.texture_Y);
-        const texture_CoCg1 = graph_import_texture(graph, this.texture_CoCg);
-        const texture_viz1 = graph_import_texture(graph, this.texture_viz);
-
-        // denoise
-        const [temp_Y, temp_CoCg] = graph_image_pass({
-            graph,
-            shader: shader_lightmap_denoise_sh,
-            output_resolution: [resolution1, resolution1],
-            inputs: {
-                lightmap_Y: texture_Y1,
-                lightmap_CoCg: texture_CoCg1,
-                viz_buffer: texture_viz1,
-                settings: {
-                    step_size: 1
-                }
-            }
-        });
-
-        // TODO blend seams
-
-        // dilate the chart to provide a margin for mipmaps
-        graph_image_pass({
-            graph,
-            output: [
-                texture_Y1,
-                texture_CoCg1,
-            ],
-            shader: shader_lightmap_dilate,
-            inputs: {
-                lightmap_Y: temp_Y,
-                lightmap_CoCg: temp_CoCg,
-                viz_buffer: texture_viz1,
-            }
-        });
-
-        // generate mips
-        const mipmaps = graphics.textures.mipmaps;
-
-
-        cmd.encodeGraph(graph);
-
-        mipmaps.generateMipmap(this.texture_Y.gpu_texture, this.texture_Y.descriptor, TextureFilterType.Linear, cmd.gpu_encoder);
-        mipmaps.generateMipmap(this.texture_CoCg.gpu_texture, this.texture_CoCg.descriptor, TextureFilterType.Linear, cmd.gpu_encoder);
-
-
-        cmd.finish();
-
-        // cleanup bake tiles
-        this.#bake_tile_sh_Y.destroy();
-        this.#bake_tile_sh_Y = null;
-
-        this.#bake_tile_sh_CoCg.destroy();
-        this.#bake_tile_sh_CoCg = null;
-    }
-
-    /**
-     *
-     * @param {GPUSceneContext} scene_ctx
-     * @param {GraphicsContext} graphics
-     */
-    bake(scene_ctx, graphics) {
-        assert.defined(scene_ctx, 'scene_ctx');
-        assert.defined(graphics, 'graphics');
-
-        this.bake_start(scene_ctx, graphics);
-        this.bake_update();
-        this.bake_end();
-
-    }
-
+import { assert } from "../../../core/assert.js";
+import { FrameGraph } from "../../../engine/graphics/render/frame_graph/FrameGraph.js";
+import { ShadeGPUCommandContext } from "../../device/ShadeGPUCommandContext.js";
+import { graph_image_pass } from "../shader/graph/graph_image_pass.js";
+import { graph_import_texture } from "../shader/graph/graph_import_texture.js";
+import { GPUTextureContext } from "../texture/GPUTextureContext.js";
+import { texture_mip_level_count } from "../../util/texture_mip_extent.js";
+import { HILBERT_R2_INDEX_TEXTURE } from "../texture/noise/HILBERT_R2_INDEX_TEXTURE.js";
+import { TextureFilterType } from "../texture/TextureFilterType.js";
+import { graph_draw_lightmap_viz_buffer } from "./bake/raster/graph_draw_lightmap_viz_buffer.js";
+import { shader_lightmap_denoise_sh } from "./bake/shader_lightmap_denoise_sh.js";
+import { shader_lightmap_dilate } from "./bake/shader_lightmap_dilate.js";
+import { shader_lightmap_viz_to_sh } from "./bake/shader_lightmap_viz_to_sh.js";
+import { DEFAULT_LIGHTMAP_RESOLUTION } from "./DEFAULT_LIGHTMAP_RESOLUTION.js";
+
+const MAX_LIGHT_MAP_SIZE = DEFAULT_LIGHTMAP_RESOLUTION;
+const BAKE_TILE_SIZE = 256;
+
+
+export class GPULightMap {
+
+    /**
+     *
+     * @type {GPUTextureContext|null}
+     */
+    texture_Y = null;
+    /**
+     *
+     * @type {GPUTextureContext|null}
+     */
+    texture_CoCg = null;
+    /**
+     *
+     * @type {GPUTextureContext|null}
+     */
+    texture_flat = null;
+
+    /**
+     * Stores [mesh_id, triangle_id] as vec2<u32>
+     * @type {GPUTextureContext|null}
+     */
+    texture_viz = null;
+
+    /**
+     *
+     * @return {number}
+     */
+    get resolution() {
+        return this.texture_Y.descriptor.size.width;
+    }
+
+    /**
+     *
+     * @param {GPUDevice} device
+     */
+    constructor(device) {
+        const resolution = MAX_LIGHT_MAP_SIZE;
+
+        const mip_count = Math.min(
+            3,
+            texture_mip_level_count(resolution, resolution, 1, "2d")
+        );
+
+        const texture_Y = new GPUTextureContext(device);
+
+        texture_Y.resize(resolution, resolution);
+        texture_Y.descriptor.label = "Lightmap Y/ sh2";
+        texture_Y.descriptor.format = "rgba16float";
+        texture_Y.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        texture_Y.descriptor.mipLevelCount = mip_count;
+
+        const texture_CoCg = new GPUTextureContext(device);
+        texture_CoCg.resize(resolution, resolution);
+        texture_CoCg.descriptor.label = "Lightmap CoCg";
+        texture_CoCg.descriptor.format = "rg16float";
+        texture_CoCg.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        texture_CoCg.descriptor.mipLevelCount = mip_count;
+
+        this.texture_Y = texture_Y;
+        this.texture_CoCg = texture_CoCg;
+
+        // flat
+
+        const texture_flat = new GPUTextureContext(device);
+        texture_flat.resize(resolution, resolution);
+        texture_flat.descriptor.label = "Lightmap flat";
+        texture_flat.descriptor.format = "rgba16float";
+        texture_flat.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        texture_flat.descriptor.mipLevelCount = mip_count;
+
+        this.texture_flat = texture_flat;
+
+        const texture_viz = new GPUTextureContext(device);
+        texture_viz.resize(resolution, resolution);
+        texture_viz.descriptor.label = "Lightmap viz";
+        texture_viz.descriptor.format = "rg32uint";
+        texture_viz.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        texture_viz.descriptor.mipLevelCount = 1;
+
+        this.texture_viz = texture_viz;
+    }
+
+    /**
+     * @type {GPUSceneContext}
+     */
+    #scene
+
+    /**
+     * @type {GraphicsContext}
+     */
+    #graphics
+
+    /**
+     * @type {GPUTextureContext}
+     */
+    #bake_tile_sh_Y = null;
+    /**
+     *
+     * @type {GPUTextureContext}
+     */
+    #bake_tile_sh_CoCg = null;
+    #bake_tile_next = 0;
+    #bake_full_iteration_count = 0;
+
+    /**
+     *
+     * @param {GPUSceneContext} scene_ctx
+     * @param {GraphicsContext} graphics
+     */
+    bake_start(scene_ctx, graphics) {
+        assert.isNull(this.#bake_tile_sh_Y, 'bake_tiles'); // didn't clean up
+
+        this.#scene = scene_ctx;
+        this.#graphics = graphics;
+
+        const graph = new FrameGraph("Lightmap Bake/start");
+        // prepare viz buffer
+
+        const r_materials = graphics.materials_resident;
+
+
+        r_materials.ensure_scene_materials(scene_ctx);
+        r_materials.update();
+
+        const viz_buffer = graph_import_texture(graph, this.texture_viz);
+
+        graph_draw_lightmap_viz_buffer({
+            graph,
+            output: viz_buffer,
+            scene: scene_ctx,
+        });
+
+        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/start');
+
+        cmd.encodeGraph(graph);
+
+
+        cmd.finish();
+
+        // create bake tiles
+        this.#create_bake_tile();
+
+        this.#bake_tile_next = 0;
+        this.#bake_full_iteration_count = 0;
+    }
+
+    #create_bake_tile() {
+
+        const device = this.#graphics.device;
+
+        const tile_Y = new GPUTextureContext(device);
+
+        tile_Y.descriptor.dimension = "2d";
+        tile_Y.descriptor.label = "Lightmap bake tile / Y";
+        tile_Y.descriptor.format = "rgba32float";
+        tile_Y.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        tile_Y.descriptor.mipLevelCount = 1;
+        tile_Y.resize(BAKE_TILE_SIZE, BAKE_TILE_SIZE);
+
+        this.#bake_tile_sh_Y = tile_Y;
+
+        const tile_CoCg = new GPUTextureContext(device);
+
+        tile_CoCg.descriptor.dimension = "2d";
+        tile_CoCg.descriptor.label = "Lightmap bake tile / CoCg";
+        tile_CoCg.descriptor.format = "rg32float";
+        tile_CoCg.descriptor.usage |= GPUTextureUsage.RENDER_ATTACHMENT;
+        tile_CoCg.descriptor.mipLevelCount = 1;
+        tile_CoCg.resize(BAKE_TILE_SIZE, BAKE_TILE_SIZE);
+
+        this.#bake_tile_sh_CoCg = tile_CoCg;
+    }
+
+    /**
+     * Perform a single step of baking
+     */
+    bake_update() {
+        const graphics = this.#graphics;
+        const scene_ctx = this.#scene;
+        const r_materials = graphics.materials_resident;
+
+
+        const graph = new FrameGraph("Lightmap Bake/update");
+
+        // pick a tile to update
+        const bake_tile_index = this.#bake_tile_next;
+        this.#bake_tile_next = (bake_tile_index + 1) % this.#bake_tile_sh_Y.descriptor.size.width;
+
+        if (this.#bake_tile_next === 0) {
+            // full cycle
+            this.#bake_full_iteration_count++;
+        }
+
+        const viz_buffer = graph_import_texture(graph, this.texture_viz);
+
+        // load the tile from the light map to update
+
+        // bake a single tile of the light map
+        graph_image_pass({
+            graph,
+            shader: shader_lightmap_viz_to_sh,
+            output: [
+                graph_import_texture(graph, this.texture_Y),
+                graph_import_texture(graph, this.texture_CoCg),
+            ],
+            inputs: {
+                viz_buffer,
+
+                materials: r_materials.buffer_materials,
+                textures: r_materials.textureView,
+                tNoise: graphics.textures.obtain(HILBERT_R2_INDEX_TEXTURE).obtainView(),
+
+                light_data: scene_ctx.lights.buffer_data,
+                tEnvironment: scene_ctx.lights.environment.obtainView(),
+
+                tlas: scene_ctx.tlas.buffer,
+                blas_lookup: scene_ctx.geometries.blas.buffer_metadata,
+                blas_data: scene_ctx.geometries.blas.buffer_data,
+
+                scene_database: scene_ctx.scene_database_buffer,
+                geometries: scene_ctx.geometries.buffer_metadata,
+            }
+        });
+
+        // after enough accumulation, use baking shader with feedback - sampling light map along the way to improve convergence and get infinite bounce
+
+
+        // write the tile out to the light map
+        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/update');
+
+        cmd.encodeGraph(graph);
+
+
+        cmd.finish();
+    }
+
+    bake_end() {
+        const graphics = this.#graphics;
+        const graph = new FrameGraph("Lightmap Bake/end");
+
+        const cmd = ShadeGPUCommandContext.create(graphics, 'Lightmap Bake/end');
+
+
+        const resolution1 = this.resolution;
+
+        const texture_Y1 = graph_import_texture(graph, this.texture_Y);
+        const texture_CoCg1 = graph_import_texture(graph, this.texture_CoCg);
+        const texture_viz1 = graph_import_texture(graph, this.texture_viz);
+
+        // denoise
+        const [temp_Y, temp_CoCg] = graph_image_pass({
+            graph,
+            shader: shader_lightmap_denoise_sh,
+            output_resolution: [resolution1, resolution1],
+            inputs: {
+                lightmap_Y: texture_Y1,
+                lightmap_CoCg: texture_CoCg1,
+                viz_buffer: texture_viz1,
+                settings: {
+                    step_size: 1
+                }
+            }
+        });
+
+        // TODO blend seams
+
+        // dilate the chart to provide a margin for mipmaps
+        graph_image_pass({
+            graph,
+            output: [
+                texture_Y1,
+                texture_CoCg1,
+            ],
+            shader: shader_lightmap_dilate,
+            inputs: {
+                lightmap_Y: temp_Y,
+                lightmap_CoCg: temp_CoCg,
+                viz_buffer: texture_viz1,
+            }
+        });
+
+        // generate mips
+        const mipmaps = graphics.textures.mipmaps;
+
+
+        cmd.encodeGraph(graph);
+
+        /**
+         * The mip passes record into our encoder, so their scratch buffer and textures are still
+         * referenced by commands that have not been submitted. They are destroyed after `finish()`,
+         * not before it: a destroyed resource in a submit has the whole command buffer rejected, and
+         * that command buffer is the lightmap bake.
+         * @type {{destroy: function():void}[]}
+         */
+        const mip_scratch = [];
+
+        mipmaps.generateMipmap(this.texture_Y.gpu_texture, this.texture_Y.descriptor, TextureFilterType.Linear, cmd.gpu_encoder, mip_scratch);
+        mipmaps.generateMipmap(this.texture_CoCg.gpu_texture, this.texture_CoCg.descriptor, TextureFilterType.Linear, cmd.gpu_encoder, mip_scratch);
+
+
+        cmd.finish();
+
+        for (const resource of mip_scratch) {
+            resource.destroy();
+        }
+
+        // cleanup bake tiles
+        this.#bake_tile_sh_Y.destroy();
+        this.#bake_tile_sh_Y = null;
+
+        this.#bake_tile_sh_CoCg.destroy();
+        this.#bake_tile_sh_CoCg = null;
+    }
+
+    /**
+     *
+     * @param {GPUSceneContext} scene_ctx
+     * @param {GraphicsContext} graphics
+     */
+    bake(scene_ctx, graphics) {
+        assert.defined(scene_ctx, 'scene_ctx');
+        assert.defined(graphics, 'graphics');
+
+        this.bake_start(scene_ctx, graphics);
+        this.bake_update();
+        this.bake_end();
+
+    }
+
 }