@luma.gl/engine 9.0.0-alpha.9 → 9.0.0-beta.10

package/dist/model/model.d.ts

@@ -0,0 +1,219 @@
+import type { TypedArray, RenderPipelineProps, RenderPipelineParameters } from '@luma.gl/core';
+import type { BufferLayout, VertexArray, TransformFeedback } from '@luma.gl/core';
+import type { AttributeInfo, Binding, UniformValue, PrimitiveTopology } from '@luma.gl/core';
+import { Device, Buffer } from '@luma.gl/core';
+import { RenderPipeline, RenderPass, UniformStore } from '@luma.gl/core';
+import type { ShaderModule, PlatformInfo } from '@luma.gl/shadertools';
+import { ShaderAssembler } from '@luma.gl/shadertools';
+import type { Geometry } from "../geometry/geometry.js";
+import { GPUGeometry } 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";
+export type ModelProps = Omit<RenderPipelineProps, 'vs' | 'fs'> & {
+    source?: string;
+    vs: string | null;
+    fs: string | null;
+    /** 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;
+    /** Parameters that are built into the pipeline */
+    parameters?: RenderPipelineParameters;
+    /** Geometry */
+    geometry?: GPUGeometry | Geometry | null;
+    /** Vertex count */
+    vertexCount?: number;
+    /** instance count */
+    instanceCount?: number;
+    indexBuffer?: Buffer | null;
+    /** @note this is really a map of buffers, not a map of attributes */
+    attributes?: Record<string, Buffer>;
+    /**   */
+    constantAttributes?: Record<string, TypedArray>;
+    /** Some applications intentionally supply unused attributes */
+    ignoreUnknownAttributes?: boolean;
+    /** @internal For use with {@link TransformFeedback}, WebGL only. */
+    varyings?: string[];
+    transformFeedback?: TransformFeedback;
+    /** Mapped uniforms for shadertool modules */
+    moduleSettings?: Record<string, Record<string, any>>;
+    /** Show shader source in browser? */
+    debugShaders?: 'never' | 'errors' | 'warnings' | 'always';
+    /** Factory used to create a {@link RenderPipeline}. 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 Model {
+    static defaultProps: Required<ModelProps>;
+    readonly device: Device;
+    readonly id: string;
+    readonly source: string;
+    readonly vs: string;
+    readonly fs: string;
+    readonly pipelineFactory: PipelineFactory;
+    readonly shaderFactory: ShaderFactory;
+    userData: {
+        [key: string]: any;
+    };
+    /** The render pipeline GPU parameters, depth testing etc */
+    parameters: RenderPipelineParameters;
+    /** The primitive topology */
+    topology: PrimitiveTopology;
+    /** Buffer layout */
+    bufferLayout: BufferLayout[];
+    /** Vertex count */
+    vertexCount: number;
+    /** instance count */
+    instanceCount: number;
+    /** Index buffer */
+    indexBuffer: Buffer | null;
+    /** Buffer-valued attributes */
+    bufferAttributes: Record<string, Buffer>;
+    /** Constant-valued attributes */
+    constantAttributes: Record<string, TypedArray>;
+    /** Bindings (textures, samplers, uniform buffers) */
+    bindings: Record<string, Binding>;
+    /** Sets uniforms @deprecated Use uniform buffers and setBindings() for portability*/
+    uniforms: Record<string, UniformValue>;
+    /**
+     * VertexArray
+     * @note not implemented: if bufferLayout is updated, vertex array has to be rebuilt!
+     * @todo - allow application to define multiple vertex arrays?
+     * */
+    vertexArray: VertexArray;
+    /** TransformFeedback, WebGL 2 only. */
+    transformFeedback: TransformFeedback | null;
+    /** The underlying GPU "program". @note May be recreated if parameters change */
+    pipeline: RenderPipeline;
+    /** ShaderInputs instance */
+    shaderInputs: ShaderInputs;
+    _uniformStore: UniformStore;
+    _attributeInfos: Record<string, AttributeInfo>;
+    _gpuGeometry: GPUGeometry | null;
+    private _getModuleUniforms;
+    private props;
+    _pipelineNeedsUpdate: string | false;
+    private _needsRedraw;
+    private _destroyed;
+    /** "Time" of last draw. Monotonically increasing timestamp */
+    _lastDrawTimestamp: number;
+    constructor(device: Device, props: ModelProps);
+    destroy(): void;
+    /** Query redraw status. Clears the status. */
+    needsRedraw(): false | string;
+    /** Mark the model as needing a redraw */
+    setNeedsRedraw(reason: string): void;
+    predraw(): void;
+    draw(renderPass: RenderPass): boolean;
+    /**
+     * Updates the optional geometry
+     * Geometry, set topology and bufferLayout
+     * @note Can trigger a pipeline rebuild / pipeline cache fetch on WebGPU
+     */
+    setGeometry(geometry: GPUGeometry | Geometry | null): void;
+    /**
+     * Updates the primitive topology ('triangle-list', 'triangle-strip' etc).
+     * @note Triggers a pipeline rebuild / pipeline cache fetch on WebGPU
+     */
+    setTopology(topology: PrimitiveTopology): void;
+    /**
+     * Updates the buffer layout.
+     * @note Triggers a pipeline rebuild / pipeline cache fetch
+     */
+    setBufferLayout(bufferLayout: BufferLayout[]): void;
+    /**
+     * Set GPU parameters.
+     * @note Can trigger a pipeline rebuild / pipeline cache fetch.
+     * @param parameters
+     */
+    setParameters(parameters: RenderPipelineParameters): 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;
+    updateShaderInputs(): void;
+    /**
+     * Sets bindings (textures, samplers, uniform buffers)
+     */
+    setBindings(bindings: Record<string, Binding>): void;
+    /**
+     * Updates optional transform feedback. WebGL only.
+     */
+    setTransformFeedback(transformFeedback: TransformFeedback | null): void;
+    /**
+     * Sets the index buffer
+     * @todo - how to unset it if we change geometry?
+     */
+    setIndexBuffer(indexBuffer: Buffer | null): void;
+    /**
+     * Sets attributes (buffers)
+     * @note Overrides any attributes previously set with the same name
+     */
+    setAttributes(buffers: Record<string, Buffer>, options?: {
+        ignoreUnknownAttributes?: boolean;
+    }): void;
+    /**
+     * Sets constant attributes
+     * @note Overrides any attributes previously set with the same name
+     * Constant attributes are only supported in WebGL, not in WebGPU
+     * Any attribute that is disabled in the current vertex array object
+     * is read from the context's global constant value for that attribute location.
+     * @param constantAttributes
+     */
+    setConstantAttributes(attributes: Record<string, TypedArray>): void;
+    /**
+     * Sets individual uniforms
+     * @deprecated WebGL only, use uniform buffers for portability
+     * @param uniforms
+     */
+    setUniforms(uniforms: Record<string, UniformValue>): void;
+    /**
+     * @deprecated Updates shader module settings (which results in uniforms being set)
+     */
+    updateModuleSettings(props: Record<string, any>): void;
+    /** Get the timestamp of the latest updated bound GPU memory resource (buffer/texture). */
+    _getBindingsUpdateTimestamp(): number;
+    /**
+     * 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: GPUGeometry): void;
+    /** Mark pipeline as needing update */
+    _setPipelineNeedsUpdate(reason: string): void;
+    /** Update pipeline if needed */
+    _updatePipeline(): RenderPipeline;
+    /** Throttle draw call logging */
+    _lastLogTime: number;
+    _logOpen: boolean;
+    _logDrawCallStart(): void;
+    _logDrawCallEnd(): void;
+    protected _drawCount: number;
+    _logFramebuffer(renderPass: RenderPass): void;
+    _getAttributeDebugTable(): Record<string, Record<string, unknown>>;
+    _getBufferOrConstantValues(attribute: Buffer | TypedArray, dataType: any): string;
+}
+/** Create a shadertools platform info from the Device */
+export declare function getPlatformInfo(device: Device): PlatformInfo;
+//# sourceMappingURL=model.d.ts.map

package/dist/model/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model/model.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,UAAU,EAAE,mBAAmB,EAAE,wBAAwB,EAAC,MAAM,eAAe,CAAC;AAC7F,OAAO,KAAK,EAAC,YAAY,EAAU,WAAW,EAAE,iBAAiB,EAAC,MAAM,eAAe,CAAC;AACxF,OAAO,KAAK,EAAC,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAC3F,OAAO,EAAC,MAAM,EAAiB,MAAM,EAAgC,MAAM,eAAe,CAAC;AAC3F,OAAO,EAAC,cAAc,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAIvE,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAC,eAAe,EAA0B,MAAM,sBAAsB,CAAC;AAE9E,OAAO,KAAK,EAAC,QAAQ,EAAC,gCAA6B;AACnD,OAAO,EAAC,WAAW,EAAkB,oCAAiC;AACtE,OAAO,EAAC,YAAY,EAAC,4BAAyB;AAC9C,OAAO,EAAC,eAAe,EAAC,mCAAgC;AACxD,OAAO,EAAC,aAAa,EAAC,iCAA8B;AAOpD,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,GAAG,IAAI,CAAC,GAAG;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB,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,kDAAkD;IAClD,UAAU,CAAC,EAAE,wBAAwB,CAAC;IAEtC,eAAe;IACf,QAAQ,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;IAEzC,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,QAAQ;IACR,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAChD,+DAA+D;IAC/D,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEtC,6CAA6C;IAC7C,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAErD,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IAE1D,mGAAmG;IACnG,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,KAAK;IAChB,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,CAyBvC;IAEF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAM;IAIpC,4DAA4D;IAC5D,UAAU,EAAE,wBAAwB,CAAC;IAErC,6BAA6B;IAC7B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,oBAAoB;IACpB,YAAY,EAAE,YAAY,EAAE,CAAC;IAI7B,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAK;IAE1B,mBAAmB;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAQ;IAClC,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAC9C,iCAAiC;IACjC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAM;IACpD,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IACvC,qFAAqF;IACrF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAM;IAE5C;;;;SAIK;IACL,WAAW,EAAE,WAAW,CAAC;IAEzB,uCAAuC;IACvC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAEnD,gFAAgF;IAChF,QAAQ,EAAE,cAAc,CAAC;IAEzB,4BAA4B;IAC5B,YAAY,EAAE,YAAY,CAAC;IAE3B,aAAa,EAAE,YAAY,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAM;IACpD,YAAY,EAAE,WAAW,GAAG,IAAI,CAAQ;IACxC,OAAO,CAAC,kBAAkB,CAAuE;IACjG,OAAO,CAAC,KAAK,CAAuB;IAEpC,oBAAoB,EAAE,MAAM,GAAG,KAAK,CAAmB;IACvD,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,UAAU,CAAS;IAE3B,8DAA8D;IAC9D,kBAAkB,EAAE,MAAM,CAAM;gBAEpB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAsH7C,OAAO,IAAI,IAAI;IAef,8CAA8C;IAC9C,WAAW,IAAI,KAAK,GAAG,MAAM;IAU7B,yCAAyC;IACzC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC,OAAO;IAOP,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAiDrC;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,WAAW,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI;IAa1D;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI;IAO9C;;;OAGG;IACH,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI;IAqBnD;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,wBAAwB;IASlD;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAKzC;;;OAGG;IACH,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAK7C,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAWjD,kBAAkB,IAAI,IAAI;IAM1B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAKpD;;OAEG;IACH,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,GAAG,IAAI;IAKvE;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAKhD;;;OAGG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,OAAO,CAAC,EAAE;QAAC,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAC,GAC5C,IAAI;IAkCP;;;;;;;OAOG;IACH,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,IAAI;IAgBnE;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,IAAI;IAQzD;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAUtD,0FAA0F;IAC1F,2BAA2B,IAAI,MAAM;IAcrC;;;;OAIG;IACH,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAqBtD,sCAAsC;IACtC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAK7C,gCAAgC;IAChC,eAAe,IAAI,cAAc;IAsDjC,iCAAiC;IACjC,YAAY,SAAK;IACjB,QAAQ,UAAS;IAEjB,iBAAiB,IAAI,IAAI;IAazB,eAAe,IAAI,IAAI;IAwBvB,SAAS,CAAC,UAAU,SAAK;IACzB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAe7C,uBAAuB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA4BlE,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,EAAE,QAAQ,EAAE,GAAG,GAAG,MAAM;CAMlF;AAkBD,yDAAyD;AACzD,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAS5D"}