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

package/dist/computation.d.ts

@@ -0,0 +1,95 @@
+import type { TypedArray } from '@luma.gl/core';
+import type { ComputePipelineProps, Shader, Binding } from '@luma.gl/core';
+import { Device, Buffer, ComputePipeline, ComputePass, UniformStore } from '@luma.gl/core';
+import type { ShaderModule, PlatformInfo } from '@luma.gl/shadertools';
+import { ShaderAssembler } from '@luma.gl/shadertools';
+import { ShaderInputs } from "./shader-inputs.js";
+import { PipelineFactory } from "./lib/pipeline-factory.js";
+import { ShaderFactory } from "./lib/shader-factory.js";
+export type ComputationProps = Omit<ComputePipelineProps, 'shader'> & {
+    source?: string;
+    /** shadertool shader modules (added to shader code) */
+    modules?: ShaderModule[];
+    /** Shadertool module defines (configures shader code)*/
+    defines?: Record<string, string | number | boolean>;
+    /** Shader inputs, used to generated uniform buffers and bindings */
+    shaderInputs?: ShaderInputs;
+    /** Bindings */
+    bindings?: Record<string, Binding>;
+    /** Show shader source in browser? */
+    debugShaders?: 'never' | 'errors' | 'warnings' | 'always';
+    /** Factory used to create a {@link ComputePipeline}. Defaults to {@link Device} default factory. */
+    pipelineFactory?: PipelineFactory;
+    /** Factory used to create a {@link Shader}. Defaults to {@link Device} default factory. */
+    shaderFactory?: ShaderFactory;
+    /** Shader assembler. Defaults to the ShaderAssembler.getShaderAssembler() */
+    shaderAssembler?: ShaderAssembler;
+};
+/**
+ * v9 Model API
+ * A model
+ * - automatically reuses pipelines (programs) when possible
+ * - automatically rebuilds pipelines if necessary to accommodate changed settings
+ * shadertools integration
+ * - accepts modules and performs shader transpilation
+ */
+export declare class Computation {
+    static defaultProps: Required<ComputationProps>;
+    readonly device: Device;
+    readonly id: string;
+    readonly pipelineFactory: PipelineFactory;
+    readonly shaderFactory: ShaderFactory;
+    userData: {
+        [key: string]: any;
+    };
+    /** Bindings (textures, samplers, uniform buffers) */
+    bindings: Record<string, Binding>;
+    /** The underlying GPU "program". @note May be recreated if parameters change */
+    pipeline: ComputePipeline;
+    /** the underlying compiled compute shader */
+    shader: Shader;
+    source: string;
+    /** ShaderInputs instance */
+    shaderInputs: ShaderInputs;
+    _uniformStore: UniformStore;
+    _pipelineNeedsUpdate: string | false;
+    private _getModuleUniforms;
+    private props;
+    private _destroyed;
+    constructor(device: Device, props: ComputationProps);
+    destroy(): void;
+    predraw(): void;
+    dispatch(computePass: ComputePass, x: number, y?: number, z?: number): void;
+    /**
+     * Updates the vertex count (used in draw calls)
+     * @note Any attributes with stepMode=vertex need to be at least this big
+     */
+    setVertexCount(vertexCount: number): void;
+    /**
+     * Updates the instance count (used in draw calls)
+     * @note Any attributes with stepMode=instance need to be at least this big
+     */
+    setInstanceCount(instanceCount: number): void;
+    setShaderInputs(shaderInputs: ShaderInputs): void;
+    /**
+     * Updates shader module settings (which results in uniforms being set)
+     */
+    setShaderModuleProps(props: Record<string, any>): void;
+    updateShaderInputs(): void;
+    /**
+     * Sets bindings (textures, samplers, uniform buffers)
+     */
+    setBindings(bindings: Record<string, Binding>): void;
+    _setPipelineNeedsUpdate(reason: string): void;
+    _updatePipeline(): ComputePipeline;
+    /** Throttle draw call logging */
+    _lastLogTime: number;
+    _logOpen: boolean;
+    _logDrawCallStart(): void;
+    _logDrawCallEnd(): void;
+    protected _drawCount: number;
+    _getBufferOrConstantValues(attribute: Buffer | TypedArray, dataType: any): string;
+}
+/** Create a shadertools platform info from the Device */
+export declare function getPlatformInfo(device: Device): PlatformInfo;
+//# sourceMappingURL=computation.d.ts.map

package/dist/computation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"computation.d.ts","sourceRoot":"","sources":["../src/computation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAgB,oBAAoB,EAAE,MAAM,EAAE,OAAO,EAAC,MAAM,eAAe,CAAC;AACxF,OAAO,EAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAGzF,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAC,eAAe,EAA0B,MAAM,sBAAsB,CAAC;AAC9E,OAAO,EAAC,YAAY,EAAC,2BAAwB;AAC7C,OAAO,EAAC,eAAe,EAAC,kCAA+B;AACvD,OAAO,EAAC,aAAa,EAAC,gCAA6B;AAMnD,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,uDAAuD;IACvD,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAGpD,oEAAoE;IACpE,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IAE1D,oGAAoG;IACpG,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,2FAA2F;IAC3F,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,6EAA6E;IAC7E,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,WAAW;IACtB,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAkB7C;IAEF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEtC,QAAQ,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAM;IAEpC,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IAEvC,gFAAgF;IAChF,QAAQ,EAAE,eAAe,CAAC;IAC1B,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,4BAA4B;IAC5B,YAAY,EAAE,YAAY,CAAC;IAE3B,aAAa,EAAE,YAAY,CAAC;IAE5B,oBAAoB,EAAE,MAAM,GAAG,KAAK,CAAmB;IAEvD,OAAO,CAAC,kBAAkB,CAAuE;IACjG,OAAO,CAAC,KAAK,CAA6B;IAE1C,OAAO,CAAC,UAAU,CAAS;gBAEf,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB;IAwDnD,OAAO,IAAI,IAAI;IAUf,OAAO;IAKP,QAAQ,CAAC,WAAW,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAyB3E;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAIzC;;;OAGG;IACH,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAI7C,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAUjD;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAgBtD,kBAAkB,IAAI,IAAI;IAI1B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAIpD,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI7C,eAAe,IAAI,eAAe;IAgClC,iCAAiC;IACjC,YAAY,SAAK;IACjB,QAAQ,UAAS;IAEjB,iBAAiB,IAAI,IAAI;IAazB,eAAe,IAAI,IAAI;IAgBvB,SAAS,CAAC,UAAU,SAAK;IAGzB,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,EAAE,QAAQ,EAAE,GAAG,GAAG,MAAM;CAMlF;AAED,yDAAyD;AACzD,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAS5D"}

package/dist/computation.js

@@ -0,0 +1,248 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+import { Buffer, ComputePipeline, UniformStore } from '@luma.gl/core';
+import { log, uid, isNumberArray } from '@luma.gl/core';
+import { getTypedArrayFromDataType } from '@luma.gl/core';
+import { ShaderAssembler, getShaderLayoutFromWGSL } from '@luma.gl/shadertools';
+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';
+const LOG_DRAW_PRIORITY = 2;
+const LOG_DRAW_TIMEOUT = 10000;
+/**
+ * v9 Model API
+ * A model
+ * - automatically reuses pipelines (programs) when possible
+ * - automatically rebuilds pipelines if necessary to accommodate changed settings
+ * shadertools integration
+ * - accepts modules and performs shader transpilation
+ */
+export class Computation {
+    static defaultProps = {
+        ...ComputePipeline.defaultProps,
+        id: 'unnamed',
+        handle: undefined,
+        userData: {},
+        source: '',
+        modules: [],
+        defines: {},
+        bindings: undefined,
+        shaderInputs: undefined,
+        pipelineFactory: undefined,
+        shaderFactory: undefined,
+        shaderAssembler: ShaderAssembler.getDefaultShaderAssembler(),
+        debugShaders: undefined
+    };
+    device;
+    id;
+    pipelineFactory;
+    shaderFactory;
+    userData = {};
+    /** Bindings (textures, samplers, uniform buffers) */
+    bindings = {};
+    /** The underlying GPU "program". @note May be recreated if parameters change */
+    pipeline;
+    /** the underlying compiled compute shader */
+    shader;
+    source;
+    /** ShaderInputs instance */
+    shaderInputs;
+    _uniformStore;
+    _pipelineNeedsUpdate = 'newly created';
+    _getModuleUniforms;
+    props;
+    _destroyed = false;
+    constructor(device, props) {
+        if (device.type !== 'webgpu') {
+            throw new Error('Computation is only supported in WebGPU');
+        }
+        this.props = { ...Computation.defaultProps, ...props };
+        props = this.props;
+        this.id = props.id || uid('model');
+        this.device = device;
+        Object.assign(this.userData, props.userData);
+        // Setup shader module inputs
+        const moduleMap = Object.fromEntries(this.props.modules?.map(module => [module.name, module]) || []);
+        this.setShaderInputs(props.shaderInputs || new ShaderInputs(moduleMap));
+        // Support WGSL shader layout introspection
+        // TODO - Don't modify props!!
+        this.props.shaderLayout ||= getShaderLayoutFromWGSL(this.props.source);
+        // 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()) || [];
+        this.pipelineFactory =
+            props.pipelineFactory || PipelineFactory.getDefaultPipelineFactory(this.device);
+        this.shaderFactory = props.shaderFactory || ShaderFactory.getDefaultShaderFactory(this.device);
+        const { source, getUniforms } = this.props.shaderAssembler.assembleShader({
+            platformInfo,
+            ...this.props,
+            modules
+        });
+        this.source = source;
+        this._getModuleUniforms = getUniforms;
+        // Create the pipeline
+        // @note order is important
+        this.pipeline = this._updatePipeline();
+        // Apply any dynamic settings that will not trigger pipeline change
+        if (props.bindings) {
+            this.setBindings(props.bindings);
+        }
+        // Catch any access to non-standard props
+        Object.seal(this);
+    }
+    destroy() {
+        if (this._destroyed)
+            return;
+        this.pipelineFactory.release(this.pipeline);
+        this.shaderFactory.release(this.shader);
+        this._uniformStore.destroy();
+        this._destroyed = true;
+    }
+    // Draw call
+    predraw() {
+        // Update uniform buffers if needed
+        this.updateShaderInputs();
+    }
+    dispatch(computePass, x, y, z) {
+        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()?
+            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);
+            computePass.setPipeline(this.pipeline);
+            // @ts-expect-error
+            computePass.setBindings([]);
+            computePass.dispatch(x, y, z);
+        }
+        finally {
+            this._logDrawCallEnd();
+        }
+    }
+    // Update fixed fields (can trigger pipeline rebuild)
+    // Update dynamic fields
+    /**
+     * Updates the vertex count (used in draw calls)
+     * @note Any attributes with stepMode=vertex need to be at least this big
+     */
+    setVertexCount(vertexCount) {
+        // this.vertexCount = vertexCount;
+    }
+    /**
+     * Updates the instance count (used in draw calls)
+     * @note Any attributes with stepMode=instance need to be at least this big
+     */
+    setInstanceCount(instanceCount) {
+        // this.instanceCount = instanceCount;
+    }
+    setShaderInputs(shaderInputs) {
+        this.shaderInputs = shaderInputs;
+        this._uniformStore = new UniformStore(this.shaderInputs.modules);
+        // Create uniform buffer bindings for all modules
+        for (const moduleName of Object.keys(this.shaderInputs.modules)) {
+            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];
+        }
+    }
+    updateShaderInputs() {
+        this._uniformStore.setUniforms(this.shaderInputs.getUniformValues());
+    }
+    /**
+     * Sets bindings (textures, samplers, uniform buffers)
+     */
+    setBindings(bindings) {
+        Object.assign(this.bindings, bindings);
+    }
+    _setPipelineNeedsUpdate(reason) {
+        this._pipelineNeedsUpdate = this._pipelineNeedsUpdate || reason;
+    }
+    _updatePipeline() {
+        if (this._pipelineNeedsUpdate) {
+            let prevShader = null;
+            if (this.pipeline) {
+                log.log(1, `Model ${this.id}: Recreating pipeline because "${this._pipelineNeedsUpdate}".`)();
+                prevShader = this.shader;
+            }
+            this._pipelineNeedsUpdate = false;
+            this.shader = this.shaderFactory.createShader({
+                id: `${this.id}-fragment`,
+                stage: 'compute',
+                source: this.source,
+                debug: this.props.debugShaders
+            });
+            this.pipeline = this.pipelineFactory.createComputePipeline({
+                ...this.props,
+                shader: this.shader
+            });
+            if (prevShader) {
+                this.shaderFactory.release(prevShader);
+            }
+        }
+        return this.pipeline;
+    }
+    /** Throttle draw call logging */
+    _lastLogTime = 0;
+    _logOpen = false;
+    _logDrawCallStart() {
+        // IF level is 4 or higher, log every frame.
+        const logDrawTimeout = log.level > 3 ? 0 : LOG_DRAW_TIMEOUT;
+        if (log.level < 2 || Date.now() - this._lastLogTime < logDrawTimeout) {
+            return;
+        }
+        this._lastLogTime = Date.now();
+        this._logOpen = true;
+        log.group(LOG_DRAW_PRIORITY, `>>> DRAWING MODEL ${this.id}`, { collapsed: log.level <= 2 })();
+    }
+    _logDrawCallEnd() {
+        if (this._logOpen) {
+            // const shaderLayoutTable = getDebugTableForShaderLayout(this.pipeline.props.shaderLayout, this.id);
+            // log.table(logLevel, attributeTable)();
+            // log.table(logLevel, uniformTable)();
+            // log.table(LOG_DRAW_PRIORITY, shaderLayoutTable)();
+            const uniformTable = this.shaderInputs.getDebugTable();
+            log.table(LOG_DRAW_PRIORITY, uniformTable)();
+            log.groupEnd(LOG_DRAW_PRIORITY)();
+            this._logOpen = false;
+        }
+    }
+    _drawCount = 0;
+    // TODO - fix typing of luma data types
+    _getBufferOrConstantValues(attribute, dataType) {
+        const TypedArrayConstructor = getTypedArrayFromDataType(dataType);
+        const typedArray = attribute instanceof Buffer ? new TypedArrayConstructor(attribute.debugData) : attribute;
+        return typedArray.toString();
+    }
+}
+/** Create a shadertools platform info from the Device */
+export function getPlatformInfo(device) {
+    return {
+        type: device.type,
+        shaderLanguage: device.info.shadingLanguage,
+        shaderLanguageVersion: device.info.shadingLanguageVersion,
+        gpu: device.info.gpu,
+        // HACK - we pretend that the DeviceFeatures is a Set, it has a similar API
+        features: device.features
+    };
+}

package/dist/debug/copy-texture-to-image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"copy-texture-to-image.d.ts","sourceRoot":"","sources":["../../src/debug/copy-texture-to-image.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAInD;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GAAG,WAAW,EAC7B,OAAO,CAAC,EAAE,yBAAyB,GAClC,gBAAgB,CAMlB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,OAAO,GAAG,WAAW,EAC7B,OAAO,GAAE,yBAA8B,GACtC,MAAM,CA4BR"}
+{"version":3,"file":"copy-texture-to-image.d.ts","sourceRoot":"","sources":["../../src/debug/copy-texture-to-image.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAGnD;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GAAG,WAAW,EAC7B,OAAO,CAAC,EAAE,yBAAyB,GAClC,gBAAgB,CAMlB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,OAAO,GAAG,WAAW,EAC7B,OAAO,GAAE,yBAA8B,GACtC,MAAM,CAyBR"}

package/dist/debug/copy-texture-to-image.js

@@ -1,7 +1,6 @@
 // luma.gl
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
-import { GL } from '@luma.gl/constants';
 import { flipRows, scalePixels } from "./pixel-data-utils.js";
 /**
  * Reads pixels from a Framebuffer or Texture object into an HTML Image
@@ -23,8 +22,7 @@ export function copyTextureToImage(source, options) {
  * @param options
  */
 export function copyTextureToDataUrl(source, options = {}) {
-    const { sourceAttachment = GL.COLOR_ATTACHMENT0, // TODO - support gl.readBuffer
-    targetMaxHeight = Number.MAX_SAFE_INTEGER } = options;
+    const { sourceAttachment, targetMaxHeight = Number.MAX_SAFE_INTEGER } = options;
     let data = source.device.readPixelsToArrayWebGL(source, { sourceAttachment });
     // Scale down
     let { width, height } = source;