@luma.gl/engine 9.0.0-beta.6 → 9.0.0-beta.7

package/dist/model/model.js

@@ -1,12 +1,13 @@
 // luma.gl
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
-import { Buffer, RenderPipeline, UniformStore } from '@luma.gl/core';
-import { log, uid, deepEqual, splitUniformsAndBindings, isNumberArray } from '@luma.gl/core';
+import { Buffer, Texture, TextureView, Sampler } from '@luma.gl/core';
+import { RenderPipeline, UniformStore } from '@luma.gl/core';
+import { log, uid, deepEqual, isObjectEmpty, splitUniformsAndBindings } from '@luma.gl/core';
 import { getTypedArrayFromDataType, getAttributeInfosFromLayouts } from '@luma.gl/core';
 import { ShaderAssembler, getShaderLayoutFromWGSL } from '@luma.gl/shadertools';
-import { ShaderInputs } from "../shader-inputs.js";
 import { makeGPUGeometry } from "../geometry/gpu-geometry.js";
+import { ShaderInputs } from "../shader-inputs.js";
 import { PipelineFactory } from "../lib/pipeline-factory.js";
 import { ShaderFactory } from "../lib/shader-factory.js";
 import { getDebugTableForShaderLayout } from "../debug/debug-shader-layout.js";
@@ -48,6 +49,7 @@ export class Model {
     };
     device;
     id;
+    source;
     vs;
     fs;
     pipelineFactory;
@@ -88,12 +90,15 @@ export class Model {
     /** ShaderInputs instance */
     shaderInputs;
     _uniformStore;
-    _pipelineNeedsUpdate = 'newly created';
     _attributeInfos = {};
     _gpuGeometry = null;
     _getModuleUniforms;
     props;
+    _pipelineNeedsUpdate = 'newly created';
+    _needsRedraw = 'initializing';
     _destroyed = false;
+    /** "Time" of last draw. Monotonically increasing timestamp */
+    _lastDrawTimestamp = -1;
     constructor(device, props) {
         this.props = { ...Model.defaultProps, ...props };
         props = this.props;
@@ -103,32 +108,36 @@ export class Model {
         // Setup shader module inputs
         const moduleMap = Object.fromEntries(this.props.modules?.map(module => [module.name, module]) || []);
         this.setShaderInputs(props.shaderInputs || new ShaderInputs(moduleMap));
-        const isWebGPU = this.device.info.type === 'webgpu';
-        // TODO - hack to support unified WGSL shader
-        // TODO - this is wrong, compile a single shader
-        if (this.props.source) {
-            if (isWebGPU) {
-                this.props.shaderLayout ||= getShaderLayoutFromWGSL(this.props.source);
-            }
-            this.props.fs = this.props.source;
-            this.props.vs = this.props.source;
-        }
-        // Support WGSL shader layout introspection
-        if (isWebGPU && typeof this.props.vs !== 'string') {
-            this.props.shaderLayout ||= getShaderLayoutFromWGSL(this.props.vs.wgsl);
-        }
         // Setup shader assembler
         const platformInfo = getPlatformInfo(device);
         // Extract modules from shader inputs if not supplied
         const modules = (this.props.modules?.length > 0 ? this.props.modules : this.shaderInputs?.getModules()) || [];
-        const { vs, fs, getUniforms } = this.props.shaderAssembler.assembleShaders({
-            platformInfo,
-            ...this.props,
-            modules
-        });
-        this.vs = vs;
-        this.fs = fs;
-        this._getModuleUniforms = getUniforms;
+        const isWebGPU = this.device.type === 'webgpu';
+        // WebGPU
+        // TODO - hack to support unified WGSL shader
+        // TODO - this is wrong, compile a single shader
+        if (isWebGPU && this.props.source) {
+            // WGSL
+            this.props.shaderLayout ||= getShaderLayoutFromWGSL(this.props.source);
+            const { source, getUniforms } = this.props.shaderAssembler.assembleShader({
+                platformInfo,
+                ...this.props,
+                modules
+            });
+            this.source = source;
+            this._getModuleUniforms = getUniforms;
+        }
+        else {
+            // GLSL
+            const { vs, fs, getUniforms } = this.props.shaderAssembler.assembleShaderPair({
+                platformInfo,
+                ...this.props,
+                modules
+            });
+            this.vs = vs;
+            this.fs = fs;
+            this._getModuleUniforms = getUniforms;
+        }
         this.vertexCount = this.props.vertexCount;
         this.instanceCount = this.props.instanceCount;
         this.topology = this.props.topology;
@@ -136,7 +145,7 @@ export class Model {
         this.parameters = this.props.parameters;
         // Geometry, if provided, sets topology and vertex cound
         if (props.geometry) {
-            this._gpuGeometry = this.setGeometry(props.geometry);
+            this.setGeometry(props.geometry);
         }
         this.pipelineFactory =
             props.pipelineFactory || PipelineFactory.getDefaultPipelineFactory(this.device);
@@ -194,31 +203,55 @@ export class Model {
             return;
         this.pipelineFactory.release(this.pipeline);
         this.shaderFactory.release(this.pipeline.vs);
-        this.shaderFactory.release(this.pipeline.fs);
+        if (this.pipeline.fs) {
+            this.shaderFactory.release(this.pipeline.fs);
+        }
         this._uniformStore.destroy();
+        // TODO - mark resource as managed and destroyIfManaged() ?
+        this._gpuGeometry?.destroy();
         this._destroyed = true;
     }
     // Draw call
+    /** Query redraw status. Clears the status. */
+    needsRedraw() {
+        // Catch any writes to already bound resources
+        if (this._getBindingsUpdateTimestamp() > this._lastDrawTimestamp) {
+            this.setNeedsRedraw('contents of bound textures or buffers updated');
+        }
+        const needsRedraw = this._needsRedraw;
+        this._needsRedraw = false;
+        return needsRedraw;
+    }
+    /** Mark the model as needing a redraw */
+    setNeedsRedraw(reason) {
+        this._needsRedraw ||= reason;
+    }
     predraw() {
         // Update uniform buffers if needed
         this.updateShaderInputs();
+        // Check if the pipeline is invalidated
+        this.pipeline = this._updatePipeline();
     }
     draw(renderPass) {
         this.predraw();
+        let drawSuccess;
         try {
             this._logDrawCallStart();
-            // Check if the pipeline is invalidated
-            // TODO - this is likely the worst place to do this from performance perspective. Perhaps add a predraw()?
+            // Update the pipeline if invalidated
+            // TODO - inside RenderPass is likely the worst place to do this from performance perspective.
+            // Application can call Model.predraw() to avoid this.
             this.pipeline = this._updatePipeline();
             // Set pipeline state, we may be sharing a pipeline so we need to set all state on every draw
             // Any caching needs to be done inside the pipeline functions
             this.pipeline.setBindings(this.bindings);
-            this.pipeline.setUniformsWebGL(this.uniforms);
+            if (!isObjectEmpty(this.uniforms)) {
+                this.pipeline.setUniformsWebGL(this.uniforms);
+            }
             const { indexBuffer } = this.vertexArray;
             const indexCount = indexBuffer
                 ? indexBuffer.byteLength / (indexBuffer.indexType === 'uint32' ? 4 : 2)
                 : undefined;
-            this.pipeline.draw({
+            drawSuccess = this.pipeline.draw({
                 renderPass,
                 vertexArray: this.vertexArray,
                 vertexCount: this.vertexCount,
@@ -231,6 +264,15 @@ export class Model {
             this._logDrawCallEnd();
         }
         this._logFramebuffer(renderPass);
+        // Update needsRedraw flag
+        if (drawSuccess) {
+            this._lastDrawTimestamp = this.device.timestamp;
+            this._needsRedraw = false;
+        }
+        else {
+            this._needsRedraw = 'waiting for resource initialization';
+        }
+        return drawSuccess;
     }
     // Update fixed fields (can trigger pipeline rebuild)
     /**
@@ -239,33 +281,16 @@ export class Model {
      * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
      */
     setGeometry(geometry) {
+        this._gpuGeometry?.destroy();
         const gpuGeometry = geometry && makeGPUGeometry(this.device, geometry);
-        this.setTopology(gpuGeometry.topology || 'triangle-list');
-        this.bufferLayout = mergeBufferLayouts(gpuGeometry.bufferLayout, this.bufferLayout);
-        if (this.vertexArray) {
-            this._setGeometryAttributes(gpuGeometry);
-        }
-        return gpuGeometry;
-    }
-    /**
-     * Updates the optional geometry attributes
-     * Geometry, sets several attributes, indexBuffer, and also vertex count
-     * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
-     */
-    _setGeometryAttributes(gpuGeometry) {
-        // Filter geometry attribute so that we don't issue warnings for unused attributes
-        const attributes = { ...gpuGeometry.attributes };
-        for (const [attributeName] of Object.entries(attributes)) {
-            if (!this.pipeline.shaderLayout.attributes.find(layout => layout.name === attributeName) &&
-                attributeName !== 'positions') {
-                delete attributes[attributeName];
+        if (gpuGeometry) {
+            this.setTopology(gpuGeometry.topology || 'triangle-list');
+            this.bufferLayout = mergeBufferLayouts(gpuGeometry.bufferLayout, this.bufferLayout);
+            if (this.vertexArray) {
+                this._setGeometryAttributes(gpuGeometry);
             }
         }
-        // TODO - delete previous geometry?
-        this.vertexCount = gpuGeometry.vertexCount;
-        this.setIndexBuffer(gpuGeometry.indices);
-        this.setAttributes(gpuGeometry.attributes, { ignoreUnknownAttributes: true });
-        this.setAttributes(attributes, { ignoreUnknownAttributes: this.props.ignoreUnknownAttributes });
+        this._gpuGeometry = gpuGeometry;
     }
     /**
      * Updates the primitive topology ('triangle-list', 'triangle-strip' etc).
@@ -285,7 +310,6 @@ export class Model {
         this.bufferLayout = this._gpuGeometry
             ? mergeBufferLayouts(bufferLayout, this._gpuGeometry.bufferLayout)
             : bufferLayout;
-        this._setPipelineNeedsUpdate('bufferLayout');
         // Recreate the pipeline
         this.pipeline = this._updatePipeline();
         // vertex array needs to be updated if we update buffer layout,
@@ -297,6 +321,7 @@ export class Model {
         if (this._gpuGeometry) {
             this._setGeometryAttributes(this._gpuGeometry);
         }
+        this._setPipelineNeedsUpdate('bufferLayout');
     }
     /**
      * Set GPU parameters.
@@ -316,6 +341,7 @@ export class Model {
      */
     setVertexCount(vertexCount) {
         this.vertexCount = vertexCount;
+        this.setNeedsRedraw('vertexCount');
     }
     /**
      * Updates the instance count (used in draw calls)
@@ -323,6 +349,7 @@ export class Model {
      */
     setInstanceCount(instanceCount) {
         this.instanceCount = instanceCount;
+        this.setNeedsRedraw('instanceCount');
     }
     setShaderInputs(shaderInputs) {
         this.shaderInputs = shaderInputs;
@@ -332,51 +359,26 @@ export class Model {
             const uniformBuffer = this._uniformStore.getManagedUniformBuffer(this.device, moduleName);
             this.bindings[`${moduleName}Uniforms`] = uniformBuffer;
         }
-    }
-    /**
-     * Updates shader module settings (which results in uniforms being set)
-     */
-    setShaderModuleProps(props) {
-        const uniforms = this._getModuleUniforms(props);
-        // Extract textures & framebuffers set by the modules
-        // TODO better way to extract bindings
-        const keys = Object.keys(uniforms).filter(k => {
-            const uniform = uniforms[k];
-            return !isNumberArray(uniform) && typeof uniform !== 'number' && typeof uniform !== 'boolean';
-        });
-        const bindings = {};
-        for (const k of keys) {
-            bindings[k] = uniforms[k];
-            delete uniforms[k];
-        }
+        this.setNeedsRedraw('shaderInputs');
     }
     updateShaderInputs() {
         this._uniformStore.setUniforms(this.shaderInputs.getUniformValues());
-    }
-    /**
-     * @deprecated Updates shader module settings (which results in uniforms being set)
-     */
-    updateModuleSettings(props) {
-        log.warn('Model.updateModuleSettings is deprecated. Use Model.shaderInputs.setProps()')();
-        const { bindings, uniforms } = splitUniformsAndBindings(this._getModuleUniforms(props));
-        Object.assign(this.bindings, bindings);
-        Object.assign(this.uniforms, uniforms);
+        // TODO - this is already tracked through buffer/texture update times?
+        this.setNeedsRedraw('shaderInputs');
     }
     /**
      * Sets bindings (textures, samplers, uniform buffers)
      */
     setBindings(bindings) {
         Object.assign(this.bindings, bindings);
+        this.setNeedsRedraw('bindings');
     }
     /**
-     * Sets individual uniforms
-     * @deprecated WebGL only, use uniform buffers for portability
-     * @param uniforms
-     * @returns self for chaining
+     * Updates optional transform feedback. WebGL only.
      */
-    setUniforms(uniforms) {
-        this.pipeline.setUniformsWebGL(uniforms);
-        Object.assign(this.uniforms, uniforms);
+    setTransformFeedback(transformFeedback) {
+        this.transformFeedback = transformFeedback;
+        this.setNeedsRedraw('transformFeedback');
     }
     /**
      * Sets the index buffer
@@ -384,12 +386,7 @@ export class Model {
      */
     setIndexBuffer(indexBuffer) {
         this.vertexArray.setIndexBuffer(indexBuffer);
-    }
-    /**
-     * Updates optional transform feedback. WebGL only.
-     */
-    setTransformFeedback(transformFeedback) {
-        this.transformFeedback = transformFeedback;
+        this.setNeedsRedraw('indexBuffer');
     }
     /**
      * Sets attributes (buffers)
@@ -419,6 +416,7 @@ export class Model {
                 log.warn(`Model(${this.id}): Ignoring buffer "${buffer.id}" for unknown attribute "${bufferName}"`)();
             }
         }
+        this.setNeedsRedraw('attributes');
     }
     /**
      * Sets constant attributes
@@ -438,10 +436,75 @@ export class Model {
                 log.warn(`Model "${this.id}: Ignoring constant supplied for unknown attribute "${attributeName}"`)();
             }
         }
+        this.setNeedsRedraw('constants');
+    }
+    // DEPRECATED METHODS
+    /**
+     * Sets individual uniforms
+     * @deprecated WebGL only, use uniform buffers for portability
+     * @param uniforms
+     */
+    setUniforms(uniforms) {
+        if (!isObjectEmpty(uniforms)) {
+            this.pipeline.setUniformsWebGL(uniforms);
+            Object.assign(this.uniforms, uniforms);
+        }
+        this.setNeedsRedraw('uniforms');
+    }
+    /**
+     * @deprecated Updates shader module settings (which results in uniforms being set)
+     */
+    updateModuleSettings(props) {
+        log.warn('Model.updateModuleSettings is deprecated. Use Model.shaderInputs.setProps()')();
+        const { bindings, uniforms } = splitUniformsAndBindings(this._getModuleUniforms(props));
+        Object.assign(this.bindings, bindings);
+        Object.assign(this.uniforms, uniforms);
+        this.setNeedsRedraw('moduleSettings');
+    }
+    // Internal methods
+    /** Get the timestamp of the latest updated bound GPU memory resource (buffer/texture). */
+    _getBindingsUpdateTimestamp() {
+        let timestamp = 0;
+        for (const binding of Object.values(this.bindings)) {
+            if (binding instanceof TextureView) {
+                timestamp = Math.max(timestamp, binding.texture.updateTimestamp);
+            }
+            else if (binding instanceof Buffer || binding instanceof Texture) {
+                timestamp = Math.max(timestamp, binding.updateTimestamp);
+            }
+            else if (!(binding instanceof Sampler)) {
+                timestamp = Math.max(timestamp, binding.buffer.updateTimestamp);
+            }
+        }
+        return timestamp;
+    }
+    /**
+     * Updates the optional geometry attributes
+     * Geometry, sets several attributes, indexBuffer, and also vertex count
+     * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
+     */
+    _setGeometryAttributes(gpuGeometry) {
+        // Filter geometry attribute so that we don't issue warnings for unused attributes
+        const attributes = { ...gpuGeometry.attributes };
+        for (const [attributeName] of Object.entries(attributes)) {
+            if (!this.pipeline.shaderLayout.attributes.find(layout => layout.name === attributeName) &&
+                attributeName !== 'positions') {
+                delete attributes[attributeName];
+            }
+        }
+        // TODO - delete previous geometry?
+        this.vertexCount = gpuGeometry.vertexCount;
+        this.setIndexBuffer(gpuGeometry.indices);
+        this.setAttributes(gpuGeometry.attributes, { ignoreUnknownAttributes: true });
+        this.setAttributes(attributes, { ignoreUnknownAttributes: this.props.ignoreUnknownAttributes });
+        this.setNeedsRedraw('geometry attributes');
     }
+    /** Mark pipeline as needing update */
     _setPipelineNeedsUpdate(reason) {
-        this._pipelineNeedsUpdate = this._pipelineNeedsUpdate || reason;
+        this._pipelineNeedsUpdate ||= reason;
+        this.setNeedsRedraw(reason);
     }
+    /** Update pipeline if needed */
     _updatePipeline() {
         if (this._pipelineNeedsUpdate) {
             let prevShaderVs = null;
@@ -455,17 +518,21 @@ export class Model {
             const vs = this.shaderFactory.createShader({
                 id: `${this.id}-vertex`,
                 stage: 'vertex',
-                source: this.vs,
+                source: this.source || this.vs,
                 debug: this.props.debugShaders
             });
-            const fs = this.fs
-                ? this.shaderFactory.createShader({
+            let fs = null;
+            if (this.source) {
+                fs = vs;
+            }
+            else if (this.fs) {
+                fs = this.shaderFactory.createShader({
                     id: `${this.id}-fragment`,
                     stage: 'fragment',
-                    source: this.fs,
+                    source: this.source || this.fs,
                     debug: this.props.debugShaders
-                })
-                : null;
+                });
+            }
             this.pipeline = this.pipelineFactory.createRenderPipeline({
                 ...this.props,
                 bufferLayout: this.bufferLayout,
@@ -576,7 +643,7 @@ function mergeBufferLayouts(layouts1, layouts2) {
 /** Create a shadertools platform info from the Device */
 export function getPlatformInfo(device) {
     return {
-        type: device.info.type,
+        type: device.type,
         shaderLanguage: device.info.shadingLanguage,
         shaderLanguageVersion: device.info.shadingLanguageVersion,
         gpu: device.info.gpu,

package/dist/scenegraph/model-node.d.ts

@@ -13,6 +13,6 @@ export declare class ModelNode extends ScenegraphNode {
     constructor(props: ModelNodeProps);
     getBounds(): [number[], number[]] | null;
     destroy(): void;
-    draw(renderPass?: RenderPass): void;
+    draw(renderPass?: RenderPass): boolean;
 }
 //# sourceMappingURL=model-node.d.ts.map