@lightningjs/renderer 3.0.0-beta13 → 3.0.0-beta15

package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js

@@ -0,0 +1,269 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { assertTruthy } from '../../../utils.js';
+import { CoreContextTexture } from '../CoreContextTexture.js';
+import { isHTMLImageElement } from './internal/RendererUtils.js';
+const TRANSPARENT_TEXTURE_DATA = new Uint8Array([0, 0, 0, 0]);
+/**
+ * A wrapper around a WebGLTexture that handles loading the texture data
+ * from a Texture source and uploading it to the GPU as well as freeing
+ * the uploaded texture.
+ *
+ * @remarks
+ * When accessing the ctxTexture property, the texture will be loaded if
+ * it hasn't been already. ctxTexture will always return a valid WebGLTexture
+ * and trigger the loading/uploading of the texture's data if it hasn't been
+ * loaded yet.
+ */
+export class WebGlCoreCtxTexture extends CoreContextTexture {
+    glw;
+    _nativeCtxTexture = null;
+    _w = 0;
+    _h = 0;
+    constructor(glw, memManager, textureSource) {
+        super(memManager, textureSource);
+        this.glw = glw;
+    }
+    /**
+     * GL error check with direct state marking
+     * Uses cached error result to minimize function calls
+     */
+    checkGLError() {
+        // Skip if already failed to prevent double-processing
+        if (this.state === 'failed') {
+            return true;
+        }
+        const error = this.glw.getError();
+        if (error !== 0) {
+            this.state = 'failed';
+            this.textureSource.setState('failed', new Error(`WebGL Error: ${error}`));
+            return true;
+        }
+        return false;
+    }
+    get ctxTexture() {
+        if (this.state === 'freed') {
+            this.load();
+            return null;
+        }
+        assertTruthy(this._nativeCtxTexture);
+        return this._nativeCtxTexture;
+    }
+    get w() {
+        return this._w;
+    }
+    get h() {
+        return this._h;
+    }
+    /**
+     * Load the texture data from the Texture source and upload it to the GPU
+     *
+     * @remarks
+     * This method is called automatically when accessing the ctxTexture property
+     * if the texture hasn't been loaded yet. But it can also be called manually
+     * to force the texture to be pre-loaded prior to accessing the ctxTexture
+     * property.
+     */
+    async load() {
+        // If the texture is already loading or loaded, return resolved promise
+        if (this.state === 'loading' || this.state === 'loaded') {
+            return Promise.resolve();
+        }
+        this.state = 'loading';
+        this.textureSource.setState('loading');
+        // Await the native texture creation to ensure GPU buffer is fully allocated
+        this._nativeCtxTexture = this.createNativeCtxTexture();
+        if (this._nativeCtxTexture === null) {
+            this.state = 'failed';
+            this.textureSource.setState('failed', new Error('WebGL Texture creation failed'));
+            return;
+        }
+        try {
+            const { width, height } = await this.onLoadRequest();
+            // If the texture has been freed while loading, return early.
+            // Type assertion needed because state could change during async operations
+            if (this.state === 'freed') {
+                return;
+            }
+            this.state = 'loaded';
+            this._w = width;
+            this._h = height;
+            // Update the texture source's width and height so that it can be used
+            // for rendering.
+            this.textureSource.setState('loaded', { width, height });
+            this.textureSource.freeTextureData();
+        }
+        catch (err) {
+            // If the texture has been freed while loading, return early.
+            // Type assertion needed because state could change during async operations
+            if (this.state === 'freed') {
+                return;
+            }
+            // Ensure texture is marked as failed
+            this.state = 'failed';
+            this.textureSource.setState('failed');
+        }
+    }
+    /**
+     * Called when the texture data needs to be loaded and uploaded to a texture
+     */
+    async onLoadRequest() {
+        const { glw } = this;
+        const textureData = this.textureSource.textureData;
+        // Early return if texture is already failed
+        if (this.state === 'failed') {
+            return { width: 0, height: 0 };
+        }
+        if (textureData === null || this._nativeCtxTexture === null) {
+            this.state = 'failed';
+            this.textureSource.setState('failed', new Error('No texture data available'));
+            return { width: 0, height: 0 };
+        }
+        // Set to a 1x1 transparent texture
+        glw.texImage2D(0, glw.RGBA, 1, 1, 0, glw.RGBA, glw.UNSIGNED_BYTE, null);
+        this.setTextureMemUse(TRANSPARENT_TEXTURE_DATA.byteLength);
+        let width = 0;
+        let height = 0;
+        glw.activeTexture(0);
+        // High-performance error check - single call, direct state marking
+        if (this.checkGLError() === true) {
+            return { width: 0, height: 0 };
+        }
+        const tdata = textureData.data;
+        const format = glw.RGBA;
+        const formatBytes = 4;
+        const memoryPadding = 1.1; // Add padding to account for GPU Padding
+        // If textureData is null, the texture is empty (0, 0) and we don't need to
+        // upload any data to the GPU.
+        if ((typeof ImageBitmap !== 'undefined' && tdata instanceof ImageBitmap) ||
+            tdata instanceof ImageData ||
+            // not using typeof HTMLImageElement due to web worker
+            isHTMLImageElement(tdata)) {
+            width = tdata.width;
+            height = tdata.height;
+            glw.bindTexture(this._nativeCtxTexture);
+            glw.pixelStorei(glw.UNPACK_PREMULTIPLY_ALPHA_WEBGL, !!textureData.premultiplyAlpha);
+            glw.texImage2D(0, format, format, glw.UNSIGNED_BYTE, tdata);
+            // Check for errors after image upload operations
+            if (this.checkGLError() === true) {
+                return { width: 0, height: 0 };
+            }
+            this.setTextureMemUse(height * width * formatBytes * memoryPadding);
+        }
+        else if (tdata && 'mipmaps' in tdata && tdata.mipmaps) {
+            const { mipmaps, width = 0, height = 0, type, glInternalFormat } = tdata;
+            const view = type === 'ktx'
+                ? new DataView(mipmaps[0] ?? new ArrayBuffer(0))
+                : mipmaps[0];
+            glw.bindTexture(this._nativeCtxTexture);
+            glw.compressedTexImage2D(0, glInternalFormat, width, height, 0, view);
+            glw.texParameteri(glw.TEXTURE_WRAP_S, glw.CLAMP_TO_EDGE);
+            glw.texParameteri(glw.TEXTURE_WRAP_T, glw.CLAMP_TO_EDGE);
+            glw.texParameteri(glw.TEXTURE_MAG_FILTER, glw.LINEAR);
+            glw.texParameteri(glw.TEXTURE_MIN_FILTER, glw.LINEAR);
+            // Check for errors after compressed texture operations
+            if (this.checkGLError() === true) {
+                return { width: 0, height: 0 };
+            }
+            this.setTextureMemUse(view.byteLength);
+        }
+        else if (tdata && tdata instanceof Uint8Array) {
+            // Color Texture
+            width = 1;
+            height = 1;
+            glw.bindTexture(this._nativeCtxTexture);
+            glw.pixelStorei(glw.UNPACK_PREMULTIPLY_ALPHA_WEBGL, !!textureData.premultiplyAlpha);
+            glw.texImage2D(0, format, width, height, 0, format, glw.UNSIGNED_BYTE, tdata);
+            // Check for errors after color texture operations
+            if (this.checkGLError() === true) {
+                return { width: 0, height: 0 };
+            }
+            this.setTextureMemUse(width * height * formatBytes);
+        }
+        else {
+            console.error(`WebGlCoreCtxTexture.onLoadRequest: Unexpected textureData returned`, textureData);
+            this.state = 'failed';
+            this.textureSource.setState('failed', new Error('Unexpected texture data'));
+            return { width: 0, height: 0 };
+        }
+        return {
+            width,
+            height,
+        };
+    }
+    /**
+     * Free the WebGLTexture from the GPU
+     *
+     * @returns
+     */
+    free() {
+        if (this.state === 'freed') {
+            return;
+        }
+        this.state = 'freed';
+        this.textureSource.setState('freed');
+        this.release();
+    }
+    /**
+     * Release the WebGLTexture from the GPU without changing state
+     */
+    release() {
+        this._w = 0;
+        this._h = 0;
+        if (this._nativeCtxTexture !== null) {
+            this.glw.deleteTexture(this._nativeCtxTexture);
+            this.setTextureMemUse(0);
+            this._nativeCtxTexture = null;
+        }
+        // if the texture still has source data, free it
+        this.textureSource.freeTextureData();
+    }
+    /**
+     * Create native context texture asynchronously
+     *
+     * @remarks
+     * When this method resolves, the returned texture will be bound to the GL context state
+     * and fully ready for use. This ensures proper GPU resource allocation timing.
+     *
+     * @returns Promise that resolves to the native WebGL texture or null on failure
+     */
+    createNativeCtxTexture() {
+        const { glw } = this;
+        const nativeTexture = glw.createTexture();
+        if (!nativeTexture) {
+            return null;
+        }
+        // On initial load request, create a 1x1 transparent texture to use until
+        // the texture data is finally loaded.
+        glw.activeTexture(0);
+        glw.bindTexture(nativeTexture);
+        // linear texture filtering
+        glw.texParameteri(glw.TEXTURE_MAG_FILTER, glw.LINEAR);
+        glw.texParameteri(glw.TEXTURE_MIN_FILTER, glw.LINEAR);
+        // texture wrapping method
+        glw.texParameteri(glw.TEXTURE_WRAP_S, glw.CLAMP_TO_EDGE);
+        glw.texParameteri(glw.TEXTURE_WRAP_T, glw.CLAMP_TO_EDGE);
+        const error = glw.getError();
+        if (error !== 0) {
+            return null;
+        }
+        return nativeTexture;
+    }
+}
+//# sourceMappingURL=WebGlCoreCtxTexture.js.map

package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebGlCoreCtxTexture.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlCoreCtxTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,MAAM,wBAAwB,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE9D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,mBAAoB,SAAQ,kBAAkB;IAM7C;IALF,iBAAiB,GAAwB,IAAI,CAAC;IAChD,EAAE,GAAG,CAAC,CAAC;IACP,EAAE,GAAG,CAAC,CAAC;IAEf,YACY,GAAwB,EAClC,UAAgC,EAChC,aAAsB;QAEtB,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAJvB,QAAG,GAAH,GAAG,CAAqB;IAKpC,CAAC;IAED;;;OAGG;IACK,YAAY;QAClB,sDAAsD;QACtD,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,KAAK,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAC,CAAC;YAC1E,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,UAAU;QACZ,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI;QACR,uEAAuE;QACvE,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEvC,4EAA4E;QAC5E,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEvD,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,aAAa,CAAC,QAAQ,CACzB,QAAQ,EACR,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAC3C,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAErD,6DAA6D;YAC7D,2EAA2E;YAC3E,IAAK,IAAI,CAAC,KAAgB,KAAK,OAAO,EAAE,CAAC;gBACvC,OAAO;YACT,CAAC;YAED,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;YAChB,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC;YACjB,sEAAsE;YACtE,iBAAiB;YACjB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YACzD,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC;QACvC,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACtB,6DAA6D;YAC7D,2EAA2E;YAC3E,IAAK,IAAI,CAAC,KAAgB,KAAK,OAAO,EAAE,CAAC;gBACvC,OAAO;YACT,CAAC;YAED,qCAAqC;YACrC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QAEnD,4CAA4C;QAC5C,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACjC,CAAC;QAED,IAAI,WAAW,KAAK,IAAI,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,EAAE,CAAC;YAC5D,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,aAAa,CAAC,QAAQ,CACzB,QAAQ,EACR,IAAI,KAAK,CAAC,2BAA2B,CAAC,CACvC,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACjC,CAAC;QAED,mCAAmC;QACnC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,MAAM,GAAG,CAAC,CAAC;QAEf,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAErB,mEAAmE;QACnE,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC;QAC/B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC;QACxB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,aAAa,GAAG,GAAG,CAAC,CAAC,yCAAyC;QAEpE,2EAA2E;QAC3E,8BAA8B;QAC9B,IACE,CAAC,OAAO,WAAW,KAAK,WAAW,IAAI,KAAK,YAAY,WAAW,CAAC;YACpE,KAAK,YAAY,SAAS;YAC1B,sDAAsD;YACtD,kBAAkB,CAAC,KAAK,CAAC,EACzB,CAAC;YACD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YACpB,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YACtB,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACxC,GAAG,CAAC,WAAW,CACb,GAAG,CAAC,8BAA8B,EAClC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAC/B,CAAC;YAEF,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YAE5D,iDAAiD;YACjD,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC;gBACjC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;YACjC,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,aAAa,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACxD,MAAM,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;YACzE,MAAM,IAAI,GACR,IAAI,KAAK,KAAK;gBACZ,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;gBAChD,CAAC,CAAE,OAAO,CAAC,CAAC,CAAgC,CAAC;YAEjD,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAExC,GAAG,CAAC,oBAAoB,CAAC,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtE,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;YACzD,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;YACzD,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YACtD,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAEtD,uDAAuD;YACvD,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC;gBACjC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;YACjC,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,KAAK,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChD,gBAAgB;YAChB,KAAK,GAAG,CAAC,CAAC;YACV,MAAM,GAAG,CAAC,CAAC;YAEX,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACxC,GAAG,CAAC,WAAW,CACb,GAAG,CAAC,8BAA8B,EAClC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAC/B,CAAC;YAEF,GAAG,CAAC,UAAU,CACZ,CAAC,EACD,MAAM,EACN,KAAK,EACL,MAAM,EACN,CAAC,EACD,MAAM,EACN,GAAG,CAAC,aAAa,EACjB,KAAK,CACN,CAAC;YAEF,kDAAkD;YAClD,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC;gBACjC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;YACjC,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,KAAK,GAAG,MAAM,GAAG,WAAW,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,oEAAoE,EACpE,WAAW,CACZ,CAAC;YAEF,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,aAAa,CAAC,QAAQ,CACzB,QAAQ,EACR,IAAI,KAAK,CAAC,yBAAyB,CAAC,CACrC,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACjC,CAAC;QAED,OAAO;YACL,KAAK;YACL,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACrB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAEZ,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAChC,CAAC;QAED,gDAAgD;QAChD,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACO,sBAAsB;QAC9B,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAErB,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;QAC1C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,yEAAyE;QACzE,sCAAsC;QACtC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACrB,GAAG,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAE/B,2BAA2B;QAC3B,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACtD,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAEtD,0BAA0B;QAC1B,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;QACzD,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;QAEzD,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}

package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.d.ts

@@ -0,0 +1,34 @@
+import { CoreRenderOp } from '../CoreRenderOp.js';
+import { WebGlCoreShader } from './WebGlCoreShader.js';
+import type { WebGlCoreCtxTexture } from './WebGlCoreCtxTexture.js';
+import type { WebGlCoreRendererOptions } from './WebGlCoreRenderer.js';
+import type { BufferCollection } from './internal/BufferCollection.js';
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { RectWithValid } from '../../lib/utils.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+/**
+ * Can render multiple quads with multiple textures (up to vertex shader texture limit)
+ *
+ */
+export declare class WebGlCoreRenderOp extends CoreRenderOp {
+    readonly glw: WebGlContextWrapper;
+    readonly options: WebGlCoreRendererOptions;
+    readonly buffers: BufferCollection;
+    readonly shader: WebGlCoreShader;
+    readonly shaderProps: Record<string, unknown>;
+    readonly alpha: number;
+    readonly clippingRect: RectWithValid;
+    readonly dimensions: Dimensions;
+    readonly bufferIdx: number;
+    readonly zIndex: number;
+    readonly renderToTexture: boolean | undefined;
+    readonly parentHasRenderTexture: boolean | undefined;
+    readonly framebufferDimensions: Dimensions | undefined;
+    length: number;
+    numQuads: number;
+    textures: WebGlCoreCtxTexture[];
+    readonly maxTextures: number;
+    constructor(glw: WebGlContextWrapper, options: WebGlCoreRendererOptions, buffers: BufferCollection, shader: WebGlCoreShader, shaderProps: Record<string, unknown>, alpha: number, clippingRect: RectWithValid, dimensions: Dimensions, bufferIdx: number, zIndex: number, renderToTexture: boolean | undefined, parentHasRenderTexture: boolean | undefined, framebufferDimensions: Dimensions | undefined);
+    addTexture(texture: WebGlCoreCtxTexture): number;
+    draw(): void;
+}

package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.js

@@ -0,0 +1,114 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CoreRenderOp } from '../CoreRenderOp.js';
+import { WebGlCoreShader } from './WebGlCoreShader.js';
+/**
+ * Can render multiple quads with multiple textures (up to vertex shader texture limit)
+ *
+ */
+export class WebGlCoreRenderOp extends CoreRenderOp {
+    glw;
+    options;
+    buffers;
+    shader;
+    shaderProps;
+    alpha;
+    clippingRect;
+    dimensions;
+    bufferIdx;
+    zIndex;
+    renderToTexture;
+    parentHasRenderTexture;
+    framebufferDimensions;
+    length = 0;
+    numQuads = 0;
+    textures = [];
+    maxTextures;
+    constructor(glw, options, buffers, shader, shaderProps, alpha, clippingRect, dimensions, bufferIdx, zIndex, renderToTexture, parentHasRenderTexture, framebufferDimensions) {
+        super();
+        this.glw = glw;
+        this.options = options;
+        this.buffers = buffers;
+        this.shader = shader;
+        this.shaderProps = shaderProps;
+        this.alpha = alpha;
+        this.clippingRect = clippingRect;
+        this.dimensions = dimensions;
+        this.bufferIdx = bufferIdx;
+        this.zIndex = zIndex;
+        this.renderToTexture = renderToTexture;
+        this.parentHasRenderTexture = parentHasRenderTexture;
+        this.framebufferDimensions = framebufferDimensions;
+        this.maxTextures = shader.supportsIndexedTextures
+            ? glw.getParameter(glw.MAX_VERTEX_TEXTURE_IMAGE_UNITS)
+            : 1;
+    }
+    addTexture(texture) {
+        const { textures, maxTextures } = this;
+        let existingIdx = -1;
+        const texturesLength = textures.length;
+        for (let i = 0; i < texturesLength; i++) {
+            const t = textures[i];
+            if (t === texture) {
+                existingIdx = i;
+                break;
+            }
+        }
+        if (existingIdx !== -1) {
+            return existingIdx;
+        }
+        if (texturesLength >= maxTextures) {
+            return 0xffffffff;
+        }
+        this.textures.push(texture);
+        return texturesLength;
+    }
+    draw() {
+        const { glw, shader, shaderProps, options } = this;
+        const { shManager } = options;
+        shManager.useShader(shader);
+        shader.bindRenderOp(this, shaderProps);
+        // TODO: Reduce calculations required
+        const quadIdx = (this.bufferIdx / 24) * 6 * 2;
+        // Clipping
+        if (this.clippingRect.valid) {
+            const { x, y, width, height } = this.clippingRect;
+            const pixelRatio = this.parentHasRenderTexture ? 1 : options.pixelRatio;
+            const canvasHeight = options.canvas.height;
+            const clipX = Math.round(x * pixelRatio);
+            const clipWidth = Math.round(width * pixelRatio);
+            const clipHeight = Math.round(height * pixelRatio);
+            let clipY = Math.round(canvasHeight - clipHeight - y * pixelRatio);
+            // if parent has render texture, we need to adjust the scissor rect
+            // to be relative to the parent's framebuffer
+            if (this.parentHasRenderTexture) {
+                clipY = this.framebufferDimensions
+                    ? this.framebufferDimensions.height - this.dimensions.height
+                    : 0;
+            }
+            glw.setScissorTest(true);
+            glw.scissor(clipX, clipY, clipWidth, clipHeight);
+        }
+        else {
+            glw.setScissorTest(false);
+        }
+        glw.drawElements(glw.TRIANGLES, 6 * this.numQuads, glw.UNSIGNED_SHORT, quadIdx);
+    }
+}
+//# sourceMappingURL=WebGlCoreRenderOp.js.map

package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebGlCoreRenderOp.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlCoreRenderOp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAQvD;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IAOtC;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IAlBX,MAAM,GAAG,CAAC,CAAC;IACX,QAAQ,GAAG,CAAC,CAAC;IACb,QAAQ,GAA0B,EAAE,CAAC;IAC5B,WAAW,CAAS;IAE7B,YACW,GAAwB,EACxB,OAAiC,EACjC,OAAyB,EACzB,MAAuB,EACvB,WAAoC,EACpC,KAAa,EACb,YAA2B,EAC3B,UAAsB,EACtB,SAAiB,EACjB,MAAc,EACd,eAAoC,EACpC,sBAA2C,EAC3C,qBAA6C;QAEtD,KAAK,EAAE,CAAC;QAdC,QAAG,GAAH,GAAG,CAAqB;QACxB,YAAO,GAAP,OAAO,CAA0B;QACjC,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAiB;QACvB,gBAAW,GAAX,WAAW,CAAyB;QACpC,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAe;QAC3B,eAAU,GAAV,UAAU,CAAY;QACtB,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAQ;QACd,oBAAe,GAAf,eAAe,CAAqB;QACpC,2BAAsB,GAAtB,sBAAsB,CAAqB;QAC3C,0BAAqB,GAArB,qBAAqB,CAAwB;QAGtD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,uBAAuB;YAC/C,CAAC,CAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,8BAA8B,CAAY;YAClE,CAAC,CAAC,CAAC,CAAC;IACR,CAAC;IAED,UAAU,CAAC,OAA4B;QACrC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACvC,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;QACrB,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;gBAClB,WAAW,GAAG,CAAC,CAAC;gBAChB,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YAClC,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,IAAI;QACF,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACnD,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAE9B,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEvC,qCAAqC;QACrC,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE9C,WAAW;QACX,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;YAC5B,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;YAClD,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;YACxE,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YAE3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC;YACzC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;YACnD,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;YAEnE,mEAAmE;YACnE,6CAA6C;YAC7C,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAChC,KAAK,GAAG,IAAI,CAAC,qBAAqB;oBAChC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM;oBAC5D,CAAC,CAAC,CAAC,CAAC;YACR,CAAC;YAED,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACzB,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,GAAG,CAAC,YAAY,CACd,GAAG,CAAC,SAAS,EACb,CAAC,GAAG,IAAI,CAAC,QAAQ,EACjB,GAAG,CAAC,cAAc,EAClB,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts

@@ -0,0 +1,133 @@
+import { CoreRenderer, type BufferInfo, type CoreRendererOptions, type QuadOptions } from '../CoreRenderer.js';
+import { WebGlCoreRenderOp } from './WebGlCoreRenderOp.js';
+import type { CoreContextTexture } from '../CoreContextTexture.js';
+import { type CoreWebGlParameters, type CoreWebGlExtensions, type WebGlColor } from './internal/RendererUtils.js';
+import { Texture } from '../../textures/Texture.js';
+import { CoreShaderManager } from '../../CoreShaderManager.js';
+import { BufferCollection } from './internal/BufferCollection.js';
+import { WebGlCoreShader } from './WebGlCoreShader.js';
+import { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import { type CoreNode } from '../../CoreNode.js';
+import type { BaseShaderController } from '../../../main-api/ShaderController.js';
+export type WebGlCoreRendererOptions = CoreRendererOptions;
+interface CoreWebGlSystem {
+    parameters: CoreWebGlParameters;
+    extensions: CoreWebGlExtensions;
+}
+export declare class WebGlCoreRenderer extends CoreRenderer {
+    glw: WebGlContextWrapper;
+    system: CoreWebGlSystem;
+    quadBuffer: ArrayBuffer;
+    fQuadBuffer: Float32Array;
+    uiQuadBuffer: Uint32Array;
+    renderOps: WebGlCoreRenderOp[];
+    curBufferIdx: number;
+    curRenderOp: WebGlCoreRenderOp | null;
+    rttNodes: CoreNode[];
+    activeRttNode: CoreNode | null;
+    defShaderCtrl: BaseShaderController;
+    defaultShader: WebGlCoreShader;
+    quadBufferCollection: BufferCollection;
+    clearColor: WebGlColor;
+    /**
+     * White pixel texture used by default when no texture is specified.
+     */
+    quadBufferUsage: number;
+    numQuadsRendered: number;
+    /**
+     * Whether the renderer is currently rendering to a texture.
+     */
+    renderToTextureActive: boolean;
+    constructor(options: WebGlCoreRendererOptions);
+    reset(): void;
+    getShaderManager(): CoreShaderManager;
+    createCtxTexture(textureSource: Texture): CoreContextTexture;
+    /**
+     * This function adds a quad (a rectangle composed of two triangles) to the WebGL rendering pipeline.
+     *
+     * It takes a set of options that define the quad's properties, such as its dimensions, colors, texture, shader, and transformation matrix.
+     * The function first updates the shader properties with the current dimensions if necessary, then sets the default texture if none is provided.
+     * It then checks if a new render operation is needed, based on the current shader and clipping rectangle.
+     * If a new render operation is needed, it creates one and updates the current render operation.
+     * The function then adjusts the texture coordinates based on the texture options and adds the texture to the texture manager.
+     *
+     * Finally, it calculates the vertices for the quad, taking into account any transformations, and adds them to the quad buffer.
+     * The function updates the length and number of quads in the current render operation, and updates the current buffer index.
+     */
+    addQuad(params: QuadOptions): void;
+    /**
+     * Replace the existing RenderOp with a new one that uses the specified Shader
+     * and starts at the specified buffer index.
+     *
+     * @param shader
+     * @param bufferIdx
+     */
+    private newRenderOp;
+    /**
+     * Add a texture to the current RenderOp. If the texture cannot be added to the
+     * current RenderOp, a new RenderOp will be created and the texture will be added
+     * to that one.
+     *
+     * If the texture cannot be added to the new RenderOp, an error will be thrown.
+     *
+     * @param texture
+     * @param bufferIdx
+     * @param recursive
+     * @returns Assigned Texture Index of the texture in the render op
+     */
+    private addTexture;
+    /**
+     * Test if the current Render operation can be reused for the specified parameters.
+     * @param params
+     * @returns
+     */
+    reuseRenderOp(params: QuadOptions): boolean;
+    /**
+     * add RenderOp to the render pipeline
+     */
+    addRenderOp(renderable: WebGlCoreRenderOp): void;
+    /**
+     * Render the current set of RenderOps to render to the specified surface.
+     *
+     * TODO: 'screen' is the only supported surface at the moment.
+     *
+     * @param surface
+     */
+    render(surface?: 'screen' | CoreContextTexture): void;
+    getQuadCount(): number;
+    renderToTexture(node: CoreNode): void;
+    /**
+     * Inserts an RTT node into `this.rttNodes` while maintaining the correct rendering order based on hierarchy.
+     *
+     * Rendering order for RTT nodes is critical when nested RTT nodes exist in a parent-child relationship.
+     * Specifically:
+     *  - Child RTT nodes must be rendered before their RTT-enabled parents to ensure proper texture composition.
+     *  - If an RTT node is added and it has existing RTT children, it should be rendered after those children.
+     *
+     * This function addresses both cases by:
+     * 1. **Checking Upwards**: It traverses the node's hierarchy upwards to identify any RTT parent
+     *    already in `rttNodes`. If an RTT parent is found, the new node is placed before this parent.
+     * 2. **Checking Downwards**: It traverses the node’s children recursively to find any RTT-enabled
+     *    children that are already in `rttNodes`. If such children are found, the new node is inserted
+     *    after the last (highest index) RTT child node.
+     *
+     * The final calculated insertion index ensures the new node is positioned in `rttNodes` to respect
+     * both parent-before-child and child-before-parent rendering rules, preserving the correct order
+     * for the WebGL renderer.
+     *
+     * @param node - The RTT-enabled CoreNode to be added to `rttNodes` in the appropriate hierarchical position.
+     */
+    private insertRTTNodeInOrder;
+    private findMaxChildRTTIndex;
+    renderRTTNodes(): void;
+    removeRTTNode(node: CoreNode): void;
+    getBufferInfo(): BufferInfo | null;
+    getDefShaderCtr(): BaseShaderController;
+    /**
+     * Updates the WebGL context's clear color and clears the color buffer.
+     *
+     * @param color - The color to set as the clear color, represented as a 32-bit integer.
+     */
+    updateClearColor(color: number): void;
+}
+export {};