@luma.gl/webgl 9.0.0-beta.1 → 9.0.0-beta.10

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

@@ -1,107 +1,141 @@
+// 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 {
-  constructor(device, props) {
-    super(device, props);
-    this.device = void 0;
-    this.glParameters = void 0;
-    this.device = device;
-    pushContextState(this.device.gl);
-    this.setParameters(this.props.parameters);
-    this.clear();
-  }
-  end() {
-    popContextState(this.device.gl);
-    if (this.props.framebuffer) {
-      setGLParameters(this.device, {
-        framebuffer: null
-      });
+    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();
     }
-  }
-  pushDebugGroup(groupLabel) {}
-  popDebugGroup() {}
-  insertDebugMarker(markerLabel) {}
-  setParameters() {
-    let parameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const glParameters = {};
-    if (this.props.framebuffer) {
-      glParameters.framebuffer = this.props.framebuffer;
+    end() {
+        popContextState(this.device.gl);
+        if (this.props.framebuffer) {
+            setGLParameters(this.device.gl, { framebuffer: null });
+        }
+        // should add commands to CommandEncoder.
     }
-    if (this.props.depthReadOnly) {
-      glParameters.depthMask = !this.props.depthReadOnly;
+    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);
     }
-    glParameters.stencilMask = this.props.stencilReadOnly ? 0 : 1;
-    glParameters[35977] = this.props.discard;
-    if (parameters.viewport) {
-      if (parameters.viewport.length >= 6) {
-        glParameters.viewport = parameters.viewport.slice(0, 4);
-        glParameters.depthRange = [parameters.viewport[4], parameters.viewport[5]];
-      } else {
-        glParameters.viewport = parameters.viewport;
-      }
+    beginOcclusionQuery(queryIndex) {
+        const webglQuerySet = this.props.occlusionQuerySet;
+        webglQuerySet?.beginOcclusionQuery();
     }
-    glParameters.scissorTest = Boolean(parameters.scissorRect);
-    if (parameters.scissorRect) {
-      glParameters.scissor = parameters.scissorRect;
+    endOcclusionQuery() {
+        const webglQuerySet = this.props.occlusionQuerySet;
+        webglQuerySet?.endOcclusionQuery();
     }
-    if (parameters.blendConstant) {
-      glParameters.blendColor = parameters.blendConstant;
+    // 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
+            // }
+        }
     }
-    if (parameters.stencilReference) {
-      console.warn('RenderPassParameters.stencilReference not yet implemented in WebGL');
-      parameters[2967] = parameters.stencilReference;
+    /**
+     * 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;
+            }
+        });
     }
-    this.glParameters = glParameters;
-    setGLParameters(this.device, glParameters);
-  }
-  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) {
-      withGLParameters(this.device, glParameters, () => {
-        this.device.gl.clear(clearMask);
-      });
-    }
-  }
-  clearColorBuffer() {
-    let drawBuffer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    let value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [0, 0, 0, 0];
-    withGLParameters(this.device.gl2, {
-      framebuffer: this.props.framebuffer
-    }, () => {
-      switch (value.constructor) {
-        case Int32Array:
-          this.device.gl2.clearBufferiv(GL_COLOR, drawBuffer, value);
-          break;
-        case Uint32Array:
-          this.device.gl2.clearBufferuiv(GL_COLOR, drawBuffer, value);
-          break;
-        case Float32Array:
-        default:
-          this.device.gl2.clearBufferfv(GL_COLOR, drawBuffer, value);
-          break;
-      }
-    });
-  }
 }
-//# sourceMappingURL=webgl-render-pass.js.map

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

@@ -2,9 +2,9 @@ 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';
-import { WEBGLShader } from './webgl-shader';
-import { WEBGLTransformFeedback } from './webgl-transform-feedback';
+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 declare class WEBGLRenderPipeline extends RenderPipeline {
     /** The WebGL device that created this render pipeline */
@@ -32,8 +32,6 @@ export declare class WEBGLRenderPipeline extends RenderPipeline {
      * @todo needed for portable model
      */
     setBindings(bindings: Record<string, Binding>): void;
-    /** This function is @deprecated, use uniform buffers */
-    setUniforms(uniforms: Record<string, UniformValue>): 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
@@ -51,7 +49,18 @@ export declare class WEBGLRenderPipeline extends RenderPipeline {
         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)

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":"AAGA,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,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAK3C,OAAO,EAAC,sBAAsB,EAAC,MAAM,4BAA4B,CAAC;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;IAqClD,OAAO,IAAI,IAAI;IAQxB;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAiDpD,wDAAwD;IACxD,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAWlD;;;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;IA+GX,SAAS,CAAC,eAAe;IA4BzB;;;;OAIG;IACH,sBAAsB;IAatB,iDAAiD;IACjD,cAAc;IAgFd;;;OAGG;IACH,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"}