3D engine that AI agents drive
Wireframe pass: delete per-frame GL buffers, accept lazy bundle growth (part of #732)
Nguyen Xuan And893315d608b
diff --git a/changes/732-wireframe-pass.size.md b/changes/732-wireframe-pass.size.mdindex fd6b96d8..401b784c 100644--- a/changes/732-wireframe-pass.size.md+++ b/changes/732-wireframe-pass.size.md@@ -1 +1,2 @@- goal:agent-scene: 60 bytes gzip for the pass name and its one-line colour legend in scene_capabilities, which an agent needs to read the wireframe picture; the drawing code loads only for a job that asks for the pass+- scene:agent-scene+lazy: 76 bytes gzip, the same pass name and colour legend in scene_capabilities plus the one-line entry in render-passes that lets an addon finish the pass; an agent needs both to read the wireframe picture, and the drawing code is a separate lazy modulediff --git a/src/wireframe-pass.js b/src/wireframe-pass.jsindex b6c69348..80ce2d04 100644--- a/src/wireframe-pass.js+++ b/src/wireframe-pass.js@@ -61,7 +61,6 @@ out vec4 outputColor;void main() { outputColor = vec4(colors[int(edgeKind + 0.5)], 1.0); }`;const programs = new WeakMap();-const meshBuffers = new WeakMap();function programFor(renderer) {let program = programs.get(renderer);@@ -80,14 +79,10 @@ function programFor(renderer) {return program;}-// One instanced vertex array per geometry: each segment is an instance of the six corners of a screen-space quad.-function buffersFor(renderer, geometry) {- let perContext = meshBuffers.get(renderer);- if (!perContext) {- perContext = new WeakMap();- meshBuffers.set(renderer, perContext);- }- let entry = perContext.get(geometry);+// One instanced vertex array per geometry for the frame being drawn: each segment is an instance of the six corners of a+// screen-space quad. The entries live in `frameEntries` and drawWireframe deletes their GL objects when the frame is done.+function buffersFor(renderer, geometry, frameEntries) {+ let entry = frameEntries.get(geometry);if (entry) return entry;let wireframe;try {@@ -96,7 +91,7 @@ function buffersFor(renderer, geometry) {// Geometry that has no polygon view (every triangle collapses, no triangles) is listed as skipped instead of failing the job.if (!(error instanceof RangeError || error instanceof TypeError)) throw error;entry = { unreadable: true, count: 0 };- perContext.set(geometry, entry);+ frameEntries.set(geometry, entry);return entry;}const context = renderer.context;@@ -111,8 +106,8 @@ function buffersFor(renderer, geometry) {context.vertexAttribPointer(location, size, context.FLOAT, false, stride, offset);context.vertexAttribDivisor(location, 1);}- entry = { vertexArray, count: wireframe.count, counts: wireframe.counts, truncated: wireframe.truncated };- perContext.set(geometry, entry);+ entry = { buffer, vertexArray, count: wireframe.count, counts: wireframe.counts, truncated: wireframe.truncated };+ frameEntries.set(geometry, entry);return entry;}@@ -120,6 +115,14 @@ function drawnParts(renderer) {return renderer.batches.filter(batch => renderer.drawsInOpaqueLoop(batch)).flatMap(batch => batch.parts);}+function releaseEntries(context, frameEntries) {+ for (const entry of frameEntries.values()) {+ if (!entry.vertexArray) continue;+ context.deleteVertexArray(entry.vertexArray);+ context.deleteBuffer(entry.buffer);+ }+}+function faultCounts(counts) {const { regular, ...faults } = counts;return faults;@@ -150,27 +153,32 @@ function drawWireframe(renderer) {let partsOmitted = 0;let partsSkipped = 0;let truncated = false;- for (const part of drawnParts(renderer)) {- const entry = buffersFor(renderer, part.geometry);- if (entry.unreadable) {- partsSkipped++;- continue;- }- if (drawn + entry.count > MAXIMUM_WIREFRAME_FRAME_SEGMENTS) {- partsOmitted++;- continue;+ const frameEntries = new Map();+ try {+ for (const part of drawnParts(renderer)) {+ const entry = buffersFor(renderer, part.geometry, frameEntries);+ if (entry.unreadable) {+ partsSkipped++;+ continue;+ }+ if (drawn + entry.count > MAXIMUM_WIREFRAME_FRAME_SEGMENTS) {+ partsOmitted++;+ continue;+ }+ drawn += entry.count;+ truncated ||= entry.truncated;+ for (const name of WIREFRAME_KINDS) totals[name] += entry.counts[name];+ const faults = faultCounts(entry.counts);+ if (Object.values(faults).some(count => count > 0)) faulty.push({ part: part.name, ...faults });+ mat4.multiply(modelViewProjection, viewProjection, part.matrix);+ context.uniformMatrix4fv(program.modelViewProjection, false, modelViewProjection);+ context.bindVertexArray(entry.vertexArray);+ context.drawArraysInstanced(context.TRIANGLES, 0, 6, entry.count);}- drawn += entry.count;- truncated ||= entry.truncated;- for (const name of WIREFRAME_KINDS) totals[name] += entry.counts[name];- const faults = faultCounts(entry.counts);- if (Object.values(faults).some(count => count > 0)) faulty.push({ part: part.name, ...faults });- mat4.multiply(modelViewProjection, viewProjection, part.matrix);- context.uniformMatrix4fv(program.modelViewProjection, false, modelViewProjection);- context.bindVertexArray(entry.vertexArray);- context.drawArraysInstanced(context.TRIANGLES, 0, 6, entry.count);+ } finally {+ context.bindVertexArray(null);+ releaseEntries(context, frameEntries);}- context.bindVertexArray(null);context.depthMask(true);context.depthFunc(reversed ? context.GREATER : context.LESS);context.enable(context.CULL_FACE);diff --git a/tests/wireframe-pass.test.js b/tests/wireframe-pass.test.jsindex c6e49b40..d7acfc00 100644--- a/tests/wireframe-pass.test.js+++ b/tests/wireframe-pass.test.js@@ -101,6 +101,19 @@ test('the report names at most the worst parts and says how many it left out', (assert.equal(report.faultyPartsOmitted, 3);});+test('the buffers and vertex arrays a frame creates are deleted when the frame is done', () => {+ const calls = [];+ const geometry = openBoxGeometry();+ const parts = [{ name: 'a', geometry, matrix: identity() }, { name: 'b', geometry, matrix: identity() }, { name: 'c', geometry: openBoxGeometry(), matrix: identity() }];+ const renderer = rendererWith(parts, calls);+ withWireframe(renderer, () => renderer.passSupport.copyToCanvas());+ const count = name => calls.filter(call => call[0] === name).length;+ assert.equal(count('createBuffer'), 2, 'One buffer per distinct geometry, shared by parts that use it.');+ assert.equal(count('deleteBuffer'), count('createBuffer'));+ assert.equal(count('deleteVertexArray'), count('createVertexArray'));+ assert.ok(count('deleteVertexArray') > 0);+});+test('a frame that never reaches the canvas copy is an error, and the overlay is removed', () => {const renderer = rendererWith([], []);assert.throws(() => withWireframe(renderer, () => {}), /drew no frame/);