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

package/dist/adapter/resources/webgl-render-pass.js

@@ -1,21 +1,141 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { RenderPass } from '@luma.gl/api';
-export default class WEBGLRenderPass extends RenderPass {
-  constructor(device, props) {
-    super(device, props);
-
-    _defineProperty(this, "device", void 0);
-
-    this.device = device;
-  }
-
-  endPass() {}
-
-  pushDebugGroup(groupLabel) {}
-
-  popDebugGroup() {}
-
-  insertDebugMarker(markerLabel) {}
-
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+import { RenderPass } from '@luma.gl/core';
+import { GL } from '@luma.gl/constants';
+import { withGLParameters } from "../../context/state-tracker/with-parameters.js";
+import { setGLParameters } from "../../context/parameters/unified-parameter-api.js";
+import { pushContextState, popContextState } from "../../context/state-tracker/track-context-state.js";
+// Should collapse during minification
+const GL_DEPTH_BUFFER_BIT = 0x00000100;
+const GL_STENCIL_BUFFER_BIT = 0x00000400;
+const GL_COLOR_BUFFER_BIT = 0x00004000;
+const GL_COLOR = 0x1800;
+export class WEBGLRenderPass extends RenderPass {
+    device;
+    /** Parameters that should be applied before each draw call */
+    glParameters;
+    constructor(device, props) {
+        super(device, props);
+        this.device = device;
+        // TODO - do parameters (scissorRect) affect the clear operation?
+        pushContextState(this.device.gl);
+        this.setParameters(this.props.parameters);
+        // Hack - for now WebGL draws in "immediate mode" (instead of queueing the operations)...
+        this.clear();
+    }
+    end() {
+        popContextState(this.device.gl);
+        if (this.props.framebuffer) {
+            setGLParameters(this.device.gl, { framebuffer: null });
+        }
+        // should add commands to CommandEncoder.
+    }
+    pushDebugGroup(groupLabel) { }
+    popDebugGroup() { }
+    insertDebugMarker(markerLabel) { }
+    // beginOcclusionQuery(queryIndex: number): void;
+    // endOcclusionQuery(): void;
+    // executeBundles(bundles: Iterable<GPURenderBundle>): void;
+    /**
+     * Maps RenderPass parameters to GL parameters
+     */
+    setParameters(parameters = {}) {
+        const glParameters = {};
+        // Framebuffers are specified using parameters in WebGL
+        if (this.props.framebuffer) {
+            glParameters.framebuffer = this.props.framebuffer;
+        }
+        if (this.props.depthReadOnly) {
+            glParameters.depthMask = !this.props.depthReadOnly;
+        }
+        glParameters.stencilMask = this.props.stencilReadOnly ? 0 : 1;
+        glParameters[35977] = this.props.discard;
+        // Map the four renderpass parameters to WebGL parameters
+        if (parameters.viewport) {
+            // WebGPU viewports are 6 coordinates (X, Y, Z)
+            if (parameters.viewport.length >= 6) {
+                glParameters.viewport = parameters.viewport.slice(0, 4);
+                glParameters.depthRange = [parameters.viewport[4], parameters.viewport[5]];
+            }
+            else {
+                // WebGL viewports are 4 coordinates (X, Y)
+                glParameters.viewport = parameters.viewport;
+            }
+        }
+        glParameters.scissorTest = Boolean(parameters.scissorRect);
+        if (parameters.scissorRect) {
+            glParameters.scissor = parameters.scissorRect;
+        }
+        if (parameters.blendConstant) {
+            glParameters.blendColor = parameters.blendConstant;
+        }
+        if (parameters.stencilReference) {
+            // eslint-disable-next-line no-console
+            console.warn('RenderPassParameters.stencilReference not yet implemented in WebGL');
+            // parameters.stencilFunc = [func, ref, mask];
+            // Does this work?
+            parameters[2967] = parameters.stencilReference;
+        }
+        this.glParameters = glParameters;
+        setGLParameters(this.device.gl, glParameters);
+    }
+    beginOcclusionQuery(queryIndex) {
+        const webglQuerySet = this.props.occlusionQuerySet;
+        webglQuerySet?.beginOcclusionQuery();
+    }
+    endOcclusionQuery() {
+        const webglQuerySet = this.props.occlusionQuerySet;
+        webglQuerySet?.endOcclusionQuery();
+    }
+    // PRIVATE
+    /**
+     * Optionally clears depth, color and stencil buffers based on parameters
+     */
+    clear() {
+        const glParameters = { ...this.glParameters };
+        let clearMask = 0;
+        if (this.props.clearColor !== false) {
+            clearMask |= GL_COLOR_BUFFER_BIT;
+            glParameters.clearColor = this.props.clearColor;
+        }
+        if (this.props.clearDepth !== false) {
+            clearMask |= GL_DEPTH_BUFFER_BIT;
+            glParameters.clearDepth = this.props.clearDepth;
+        }
+        if (this.props.clearStencil !== false) {
+            clearMask |= GL_STENCIL_BUFFER_BIT;
+            glParameters.clearStencil = this.props.clearStencil;
+        }
+        if (clearMask !== 0) {
+            // Temporarily set any clear "colors" and call clear
+            withGLParameters(this.device.gl, glParameters, () => {
+                this.device.gl.clear(clearMask);
+            });
+            // TODO - clear multiple color attachments
+            // for (attachment of this.framebuffer.colorAttachments) {
+            //   this.clearColorBuffer
+            // }
+        }
+    }
+    /**
+     * WebGL2 - clear a specific color buffer
+     */
+    clearColorBuffer(drawBuffer = 0, value = [0, 0, 0, 0]) {
+        withGLParameters(this.device.gl, { framebuffer: this.props.framebuffer }, () => {
+            // Method selection per OpenGL ES 3 docs
+            switch (value.constructor) {
+                case Int32Array:
+                    this.device.gl.clearBufferiv(GL_COLOR, drawBuffer, value);
+                    break;
+                case Uint32Array:
+                    this.device.gl.clearBufferuiv(GL_COLOR, drawBuffer, value);
+                    break;
+                case Float32Array:
+                default:
+                    this.device.gl.clearBufferfv(GL_COLOR, drawBuffer, value);
+                    break;
+            }
+        });
+    }
 }
-//# sourceMappingURL=webgl-render-pass.js.map

package/dist/adapter/resources/webgl-render-pipeline.d.ts

@@ -1,38 +1,45 @@
-import type { RenderPipelineProps, RenderPass, Buffer, Binding, ShaderLayout } from '@luma.gl/api';
-import { RenderPipeline } from '@luma.gl/api';
-import WebGLDevice from '../webgl-device';
-import WEBGLShader from './webgl-shader';
-import WEBGLVertexArrayObject from '../objects/webgl-vertex-array-object';
+import type { UniformValue, RenderPipelineProps, Binding } from '@luma.gl/core';
+import type { ShaderLayout } from '@luma.gl/core';
+import type { RenderPass, VertexArray } from '@luma.gl/core';
+import { RenderPipeline } from '@luma.gl/core';
+import { WebGLDevice } from "../webgl-device.js";
+import { WEBGLShader } from "./webgl-shader.js";
+import { WEBGLTransformFeedback } from "./webgl-transform-feedback.js";
 /** Creates a new render pipeline */
-export default class WEBGLRenderPipeline extends RenderPipeline {
+export declare class WEBGLRenderPipeline extends RenderPipeline {
+    /** The WebGL device that created this render pipeline */
     device: WebGLDevice;
+    /** Handle to underlying WebGL program */
     handle: WebGLProgram;
+    /** vertex shader */
     vs: WEBGLShader;
+    /** fragment shader */
     fs: WEBGLShader;
-    layout: ShaderLayout;
+    /** The layout extracted from shader by WebGL introspection APIs */
+    introspectedLayout: ShaderLayout;
+    /** Uniforms set on this model */
+    uniforms: Record<string, UniformValue>;
+    /** Bindings set on this model */
+    bindings: Record<string, Binding>;
+    /** WebGL varyings */
     varyings: string[] | null;
-    vertexArrayObject: WEBGLVertexArrayObject;
-    _indexBuffer?: Buffer;
-    uniforms: Record<string, any>;
-    bindings: Record<string, any>;
-    _textureUniforms: Record<string, any>;
-    _textureIndexCounter: number;
     _uniformCount: number;
     _uniformSetters: Record<string, Function>;
     constructor(device: WebGLDevice, props: RenderPipelineProps);
     destroy(): void;
-    setIndexBuffer(indexBuffer: Buffer): void;
-    /** @todo needed for portable model */
-    setAttributes(attributes: Record<string, Buffer>): void;
-    /** @todo needed for portable model */
+    /**
+     * Bindings include: textures, samplers and uniform buffers
+     * @todo needed for portable model
+     */
     setBindings(bindings: Record<string, Binding>): void;
-    setUniforms(uniforms: Record<string, any>): void;
     /** @todo needed for portable model
      * @note The WebGL API is offers many ways to draw things
      * This function unifies those ways into a single call using common parameters with sane defaults
      */
     draw(options: {
-        renderPass?: RenderPass;
+        renderPass: RenderPass;
+        /** vertex attributes */
+        vertexArray: VertexArray;
         vertexCount?: number;
         indexCount?: number;
         instanceCount?: number;
@@ -40,16 +47,32 @@ export default class WEBGLRenderPipeline extends RenderPipeline {
         firstIndex?: number;
         firstInstance?: number;
         baseVertex?: number;
+        transformFeedback?: WEBGLTransformFeedback;
     }): boolean;
-    protected _compileAndLink(): void;
+    setUniformsWebGL(uniforms: Record<string, UniformValue>): void;
+    protected _linkShaders(): Promise<void>;
+    /** Report link status. First, check for shader compilation failures if linking fails */
+    _reportLinkStatus(status: 'success' | 'linking' | 'validation'): void;
+    /**
+     * Get the shader compilation status
+     * TODO - Load log even when no error reported, to catch warnings?
+     * https://gamedev.stackexchange.com/questions/30429/how-to-detect-glsl-warnings
+     */
+    _getLinkStatus(): 'success' | 'linking' | 'validation';
+    /** Use KHR_parallel_shader_compile extension if available */
+    _waitForLinkComplete(): Promise<void>;
     /**
      * Checks if all texture-values uniforms are renderable (i.e. loaded)
      * Update a texture if needed (e.g. from video)
      * Note: This is currently done before every draw call
      */
     _areTexturesRenderable(): boolean;
-    /** Apply any bindings */
+    /** Apply any bindings (before each draw call) */
     _applyBindings(): void;
+    /**
+     * Due to program sharing, uniforms need to be reset before every draw call
+     * (though caching will avoid redundant WebGL calls)
+     */
     _applyUniforms(): void;
 }
 //# sourceMappingURL=webgl-render-pipeline.d.ts.map

package/dist/adapter/resources/webgl-render-pipeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webgl-render-pipeline.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-render-pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,UAAU,EACV,MAAM,EACN,OAAO,EACP,YAAY,EAIb,MAAM,cAAc,CAAC;AACtB,OAAO,EAAC,cAAc,EAAgC,MAAM,cAAc,CAAC;AAU3E,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAE1C,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC,OAAO,sBAAsB,MAAM,sCAAsC,CAAC;AAI1E,oCAAoC;AACpC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,cAAc;IAC7D,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,EAAE,EAAE,WAAW,CAAC;IAChB,EAAE,EAAE,WAAW,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IAIrB,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAQ;IACjC,iBAAiB,EAAE,sBAAsB,CAAC;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IACnC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IACnC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAC3C,oBAAoB,EAAE,MAAM,CAAK;IACjC,aAAa,EAAE,MAAM,CAAK;IAC1B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAM;gBAEnC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,mBAAmB;IA4B3D,OAAO,IAAI,IAAI;IAQf,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAMzC,sCAAsC;IACtC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAwBvD,sCAAsC;IACtC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAqCpD,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAKzC;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE;QACZ,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO;IA2EX,SAAS,CAAC,eAAe;IA0BzB;;;;OAIG;IACH,sBAAsB;IAkBtB,yBAAyB;IACzB,cAAc;IA6Dd,cAAc;CASf"}
+{"version":3,"file":"webgl-render-pipeline.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-render-pipeline.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,YAAY,EAAE,mBAAmB,EAAE,OAAO,EAAC,MAAM,eAAe,CAAC;AAC9E,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAC,UAAU,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAC3D,OAAO,EAAC,cAAc,EAAsC,MAAM,eAAe,CAAC;AAUlF,OAAO,EAAC,WAAW,EAAC,2BAAwB;AAE5C,OAAO,EAAC,WAAW,EAAC,0BAAuB;AAK3C,OAAO,EAAC,sBAAsB,EAAC,sCAAmC;AAKlE,oCAAoC;AACpC,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,yDAAyD;IACzD,MAAM,EAAE,WAAW,CAAC;IACpB,yCAAyC;IACzC,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB;IACpB,EAAE,EAAE,WAAW,CAAC;IAChB,sBAAsB;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB,mEAAmE;IACnE,kBAAkB,EAAE,YAAY,CAAC;IAEjC,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAM;IAC5C,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IACvC,qBAAqB;IACrB,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAQ;IAEjC,aAAa,EAAE,MAAM,CAAK;IAC1B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAM;gBAEnC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,mBAAmB;IAyClD,OAAO,IAAI,IAAI;IAQxB;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAuDpD;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE;QACZ,UAAU,EAAE,UAAU,CAAC;QACvB,wBAAwB;QACxB,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;KAC5C,GAAG,OAAO;IAgGF,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;cAkBhD,YAAY;IA2B5B,wFAAwF;IACxF,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,YAAY;IAmB9D;;;;OAIG;IACH,cAAc,IAAI,SAAS,GAAG,SAAS,GAAG,YAAY;IAmBtD,6DAA6D;IACvD,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB3C;;;;OAIG;IACH,sBAAsB;IAatB,iDAAiD;IACjD,cAAc;IAyFd;;;OAGG;IACH,cAAc;CASf"}