@lightningtv/renderer 2.16.1

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

@@ -0,0 +1,83 @@
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import { CoreShader } from '../CoreShader.js';
+import type { WebGlCoreCtxTexture } from './WebGlCoreCtxTexture.js';
+import type { WebGlCoreRenderOp } from './WebGlCoreRenderOp.js';
+import type { WebGlCoreRenderer } from './WebGlCoreRenderer.js';
+import type { BufferCollection } from './internal/BufferCollection.js';
+import { type ShaderOptions, type UniformMethodMap, type ShaderProgramSources } from './internal/ShaderUtils.js';
+/**
+ * Automatic shader prop for the dimensions of the Node being rendered
+ *
+ * @remarks
+ * Shader's who's rendering depends on the dimensions of the Node being rendered
+ * should extend this interface from their Prop interface type.
+ */
+export interface DimensionsShaderProp {
+    /**
+     * Dimensions of the Node being rendered (Auto-set by the renderer)
+     *
+     * @remarks
+     * DO NOT SET THIS. It is set automatically by the renderer.
+     * Any values set here will be ignored.
+     */
+    $dimensions?: Dimensions;
+}
+export interface AlphaShaderProp {
+    /**
+     * Alpha of the Node being rendered (Auto-set by the renderer)
+     *
+     * @remarks
+     * DO NOT SET THIS. It is set automatically by the renderer.
+     * Any values set here will be ignored.
+     */
+    $alpha?: number;
+}
+export declare abstract class WebGlCoreShader extends CoreShader {
+    protected boundBufferCollection: BufferCollection | null;
+    protected buffersBound: boolean;
+    protected program: WebGLProgram;
+    /**
+     * Vertex Array Object
+     *
+     * @remarks
+     * Used by WebGL2 Only
+     */
+    protected vao: WebGLVertexArrayObject | undefined;
+    protected renderer: WebGlCoreRenderer;
+    protected glw: WebGlContextWrapper;
+    protected attributeBuffers: Record<string, WebGLBuffer>;
+    protected attributeLocations: Record<string, number>;
+    protected attributeNames: string[];
+    protected uniformLocations: Record<string, WebGLUniformLocation>;
+    protected uniformTypes: Record<string, keyof UniformMethodMap>;
+    readonly supportsIndexedTextures: boolean;
+    constructor(options: ShaderOptions);
+    private bindBufferAttribute;
+    disableAttribute(location: number): void;
+    disableAttributes(): void;
+    /**
+     * Given two sets of Shader props destined for this Shader, determine if they can be batched together
+     * to reduce the number of draw calls.
+     *
+     * @remarks
+     * This is used by the {@link WebGlCoreRenderer} to determine if it can batch multiple consecutive draw
+     * calls into a single draw call.
+     *
+     * By default, this returns false (meaning no batching is allowed), but can be
+     * overridden by child classes to provide more efficient batching.
+     *
+     * @param propsA
+     * @param propsB
+     * @returns
+     */
+    canBatchShaderProps(propsA: Record<string, unknown>, propsB: Record<string, unknown>): boolean;
+    bindRenderOp(renderOp: WebGlCoreRenderOp, props: Record<string, unknown> | null): void;
+    getUniformLocation(name: string): WebGLUniformLocation | null;
+    bindBufferCollection(buffer: BufferCollection): void;
+    protected bindProps(props: Record<string, unknown>): void;
+    bindTextures(textures: WebGlCoreCtxTexture[]): void;
+    attach(): void;
+    detach(): void;
+    protected static shaderSources?: ShaderProgramSources;
+}

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

@@ -0,0 +1,233 @@
+/*
+ * 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, hasOwn } from '../../../utils.js';
+import { CoreShader } from '../CoreShader.js';
+import { createProgram, createShader, } from './internal/ShaderUtils.js';
+export class WebGlCoreShader extends CoreShader {
+    boundBufferCollection = null;
+    buffersBound = false;
+    program;
+    /**
+     * Vertex Array Object
+     *
+     * @remarks
+     * Used by WebGL2 Only
+     */
+    vao;
+    renderer;
+    glw;
+    attributeBuffers;
+    attributeLocations;
+    attributeNames;
+    uniformLocations;
+    uniformTypes;
+    supportsIndexedTextures;
+    constructor(options) {
+        super();
+        const renderer = (this.renderer = options.renderer);
+        const glw = (this.glw = this.renderer.glw);
+        this.supportsIndexedTextures = options.supportsIndexedTextures || false;
+        // Check that extensions are supported
+        const webGl2 = glw.isWebGl2();
+        const requiredExtensions = (webGl2 && options.webgl2Extensions) ||
+            (!webGl2 && options.webgl1Extensions) ||
+            [];
+        const glVersion = webGl2 ? '2.0' : '1.0';
+        requiredExtensions.forEach((extensionName) => {
+            if (!glw.getExtension(extensionName)) {
+                throw new Error(`Shader "${this.constructor.name}" requires extension "${extensionName}" for WebGL ${glVersion} but wasn't found`);
+            }
+        });
+        // Gather shader sources
+        // - If WebGL 2 and special WebGL 2 sources are provided, we copy those sources and delete
+        // the extra copy of them to save memory.
+        // TODO: This could be further made optimal by just caching the compiled shaders and completely deleting
+        // the source code
+        const shaderSources = options.shaderSources ||
+            this.constructor.shaderSources;
+        if (!shaderSources) {
+            throw new Error(`Shader "${this.constructor.name}" is missing shaderSources.`);
+        }
+        else if (webGl2 && shaderSources?.webGl2) {
+            shaderSources.fragment = shaderSources.webGl2.fragment;
+            shaderSources.vertex = shaderSources.webGl2.vertex;
+            delete shaderSources.webGl2;
+        }
+        const textureUnits = renderer.system.parameters.MAX_VERTEX_TEXTURE_IMAGE_UNITS;
+        const vertexSource = shaderSources.vertex instanceof Function
+            ? shaderSources.vertex(textureUnits)
+            : shaderSources.vertex;
+        const fragmentSource = shaderSources.fragment instanceof Function
+            ? shaderSources.fragment(textureUnits)
+            : shaderSources.fragment;
+        const vertexShader = createShader(glw, glw.VERTEX_SHADER, vertexSource);
+        const fragmentShader = createShader(glw, glw.FRAGMENT_SHADER, fragmentSource);
+        if (!vertexShader || !fragmentShader) {
+            throw new Error(`Unable to create the following shader(s): ${[
+                !vertexShader && 'VERTEX_SHADER',
+                !fragmentShader && 'FRAGMENT_SHADER',
+            ]
+                .filter(Boolean)
+                .join(' and ')}`);
+        }
+        const program = createProgram(glw, vertexShader, fragmentShader);
+        if (!program) {
+            throw new Error('Unable to create program');
+        }
+        this.program = program;
+        this.attributeLocations = {};
+        this.attributeBuffers = {};
+        this.attributeNames = [];
+        [...options.attributes].forEach((attributeName) => {
+            const location = glw.getAttribLocation(this.program, attributeName);
+            if (location < 0) {
+                throw new Error(`${this.constructor.name}: Vertex shader must have an attribute "${attributeName}"!`);
+            }
+            const buffer = glw.createBuffer();
+            if (!buffer) {
+                throw new Error(`${this.constructor.name}: Could not create buffer for attribute "${attributeName}"`);
+            }
+            this.attributeLocations[attributeName] = location;
+            this.attributeBuffers[attributeName] = buffer;
+            this.attributeNames.push(attributeName);
+        });
+        this.uniformLocations = {};
+        this.uniformTypes = {};
+        options.uniforms.forEach((uniform) => {
+            const location = glw.getUniformLocation(this.program, uniform.name);
+            this.uniformTypes[uniform.name] = uniform.uniform;
+            if (!location) {
+                console.warn(`Shader "${this.constructor.name}" could not get uniform location for "${uniform.name}"`);
+                return;
+            }
+            this.uniformLocations[uniform.name] = location;
+        });
+    }
+    bindBufferAttribute(location, buffer, attribute) {
+        const { glw } = this;
+        glw.enableVertexAttribArray(location);
+        glw.vertexAttribPointer(buffer, location, attribute.size, attribute.type, attribute.normalized, attribute.stride, attribute.offset);
+    }
+    disableAttribute(location) {
+        this.glw.disableVertexAttribArray(location);
+    }
+    disableAttributes() {
+        for (const loc in this.attributeLocations) {
+            this.disableAttribute(this.attributeLocations[loc]);
+        }
+        this.boundBufferCollection = null;
+    }
+    /**
+     * Given two sets of Shader props destined for this Shader, determine if they can be batched together
+     * to reduce the number of draw calls.
+     *
+     * @remarks
+     * This is used by the {@link WebGlCoreRenderer} to determine if it can batch multiple consecutive draw
+     * calls into a single draw call.
+     *
+     * By default, this returns false (meaning no batching is allowed), but can be
+     * overridden by child classes to provide more efficient batching.
+     *
+     * @param propsA
+     * @param propsB
+     * @returns
+     */
+    canBatchShaderProps(propsA, propsB) {
+        return false;
+    }
+    bindRenderOp(renderOp, props) {
+        this.bindBufferCollection(renderOp.buffers);
+        // Since we're not using batched rendering yet we can safely test
+        // for first texture only
+        if (renderOp.textures.length > 0 && renderOp.textures[0]?.ctxTexture) {
+            this.bindTextures(renderOp.textures);
+        }
+        const { glw, parentHasRenderTexture, renderToTexture } = renderOp;
+        // Skip if the parent and current operation both have render textures
+        if (renderToTexture && parentHasRenderTexture) {
+            return;
+        }
+        // Bind render texture framebuffer dimensions as resolution
+        // if the parent has a render texture
+        if (parentHasRenderTexture) {
+            const { width, height } = renderOp.framebufferDimensions || {};
+            // Force pixel ratio to 1.0 for render textures since they are always 1:1
+            // the final render texture will be rendered to the screen with the correct pixel ratio
+            glw.uniform1f(this.getUniformLocation('u_pixelRatio'), 1.0);
+            // Set resolution to the framebuffer dimensions
+            glw.uniform2f(this.getUniformLocation('u_resolution'), width ?? 0, height ?? 0);
+        }
+        else {
+            glw.uniform1f(this.getUniformLocation('u_pixelRatio'), renderOp.options.pixelRatio);
+            glw.uniform2f(this.getUniformLocation('u_resolution'), glw.canvas.width, glw.canvas.height);
+        }
+        if (props) {
+            // Bind optional automatic uniforms
+            // These are only bound if their keys are present in the props.
+            if (hasOwn(props, '$dimensions')) {
+                let dimensions = props.$dimensions;
+                if (!dimensions) {
+                    dimensions = renderOp.dimensions;
+                }
+                glw.uniform2f(this.getUniformLocation('u_dimensions'), dimensions.width, dimensions.height);
+            }
+            if (hasOwn(props, '$alpha')) {
+                let alpha = props.$alpha;
+                if (!alpha) {
+                    alpha = renderOp.alpha;
+                }
+                glw.uniform1f(this.getUniformLocation('u_alpha'), alpha);
+            }
+            this.bindProps(props);
+        }
+    }
+    getUniformLocation(name) {
+        return this.uniformLocations[name] || null;
+    }
+    bindBufferCollection(buffer) {
+        if (this.boundBufferCollection === buffer) {
+            return;
+        }
+        for (const attributeName in this.attributeLocations) {
+            const resolvedBuffer = buffer.getBuffer(attributeName);
+            const resolvedInfo = buffer.getAttributeInfo(attributeName);
+            assertTruthy(resolvedBuffer, `Buffer for "${attributeName}" not found`);
+            assertTruthy(resolvedInfo);
+            this.bindBufferAttribute(this.attributeLocations[attributeName], resolvedBuffer, resolvedInfo);
+        }
+        this.boundBufferCollection = buffer;
+    }
+    bindProps(props) {
+        // Implement in child class
+    }
+    bindTextures(textures) {
+        // no defaults
+    }
+    attach() {
+        this.glw.useProgram(this.program);
+        if (this.glw.isWebGl2() && this.vao) {
+            this.glw.bindVertexArray(this.vao);
+        }
+    }
+    detach() {
+        this.disableAttributes();
+    }
+    static shaderSources;
+}
+//# sourceMappingURL=WebGlCoreShader.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebGlCoreShader.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlCoreShader.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAK9C,OAAO,EACL,aAAa,EACb,YAAY,GAMb,MAAM,2BAA2B,CAAC;AA+BnC,MAAM,OAAgB,eAAgB,SAAQ,UAAU;IAC5C,qBAAqB,GAA4B,IAAI,CAAC;IACtD,YAAY,GAAG,KAAK,CAAC;IACrB,OAAO,CAAe;IAChC;;;;;OAKG;IACO,GAAG,CAAqC;IACxC,QAAQ,CAAoB;IAC5B,GAAG,CAAsB;IACzB,gBAAgB,CAA8B;IAC9C,kBAAkB,CAAyB;IAC3C,cAAc,CAAW;IACzB,gBAAgB,CAAuC;IACvD,YAAY,CAAyC;IACtD,uBAAuB,CAAU;IAE1C,YAAY,OAAsB;QAChC,KAAK,EAAE,CAAC;QACR,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,IAAI,KAAK,CAAC;QAExE,sCAAsC;QACtC,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,kBAAkB,GACtB,CAAC,MAAM,IAAI,OAAO,CAAC,gBAAgB,CAAC;YACpC,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,gBAAgB,CAAC;YACrC,EAAE,CAAC;QACL,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;QACzC,kBAAkB,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YAC3C,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,yBAAyB,aAAa,eAAe,SAAS,mBAAmB,CAClH,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,wBAAwB;QACxB,0FAA0F;QAC1F,yCAAyC;QACzC,wGAAwG;QACxG,kBAAkB;QAClB,MAAM,aAAa,GACjB,OAAO,CAAC,aAAa;YACpB,IAAI,CAAC,WAAsC,CAAC,aAAa,CAAC;QAC7D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,6BAA6B,CAC9D,CAAC;QACJ,CAAC;aAAM,IAAI,MAAM,IAAI,aAAa,EAAE,MAAM,EAAE,CAAC;YAC3C,aAAa,CAAC,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC;YACvD,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC;YACnD,OAAO,aAAa,CAAC,MAAM,CAAC;QAC9B,CAAC;QAED,MAAM,YAAY,GAChB,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAE5D,MAAM,YAAY,GAChB,aAAa,CAAC,MAAM,YAAY,QAAQ;YACtC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC;YACpC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;QAE3B,MAAM,cAAc,GAClB,aAAa,CAAC,QAAQ,YAAY,QAAQ;YACxC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC;YACtC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC;QAE7B,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,YAAY,CACjC,GAAG,EACH,GAAG,CAAC,eAAe,EACnB,cAAc,CACf,CAAC;QAEF,IAAI,CAAC,YAAY,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,6CAA6C;gBAC3C,CAAC,YAAY,IAAI,eAAe;gBAChC,CAAC,cAAc,IAAI,iBAAiB;aACrC;iBACE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,OAAO,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QACjE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,kBAAkB,GAAG,EAA4B,CAAC;QACvD,IAAI,CAAC,gBAAgB,GAAG,EAA4B,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QAEzB,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACpE,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,2CAA2C,aAAa,IAAI,CACrF,CAAC;YACJ,CAAC;YACD,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,4CAA4C,aAAa,GAAG,CACrF,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;YAClD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;YAC9C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,GAAG,EAA2C,CAAC;QACpE,IAAI,CAAC,YAAY,GAAG,EAA4C,CAAC;QACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAoB,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;YACpE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;YAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,CAAC,IAAI,CACV,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,yCAAyC,OAAO,CAAC,IAAI,GAAG,CACzF,CAAC;gBACF,OAAO;YACT,CAAC;YACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CACzB,QAAgB,EAChB,MAAmB,EACnB,SAAwB;QAExB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,GAAG,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAEtC,GAAG,CAAC,mBAAmB,CACrB,MAAM,EACN,QAAQ,EACR,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,UAAU,EACpB,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAM,CACjB,CAAC;IACJ,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC/B,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,iBAAiB;QACf,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAW,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CACjB,MAA+B,EAC/B,MAA+B;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY,CACV,QAA2B,EAC3B,KAAqC;QAErC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAE5C,iEAAiE;QACjE,yBAAyB;QACzB,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,sBAAsB,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC;QAElE,qEAAqE;QACrE,IAAI,eAAe,IAAI,sBAAsB,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,2DAA2D;QAC3D,qCAAqC;QACrC,IAAI,sBAAsB,EAAE,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,qBAAqB,IAAI,EAAE,CAAC;YAC/D,yEAAyE;YACzE,uFAAuF;YACvF,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC,CAAC;YAE5D,+CAA+C;YAC/C,GAAG,CAAC,SAAS,CACX,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EACvC,KAAK,IAAI,CAAC,EACV,MAAM,IAAI,CAAC,CACZ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,SAAS,CACX,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EACvC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAC5B,CAAC;YACF,GAAG,CAAC,SAAS,CACX,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EACvC,GAAG,CAAC,MAAM,CAAC,KAAK,EAChB,GAAG,CAAC,MAAM,CAAC,MAAM,CAClB,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,mCAAmC;YACnC,+DAA+D;YAC/D,IAAI,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,EAAE,CAAC;gBACjC,IAAI,UAAU,GAAG,KAAK,CAAC,WAAgC,CAAC;gBACxD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;gBACnC,CAAC;gBACD,GAAG,CAAC,SAAS,CACX,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EACvC,UAAU,CAAC,KAAK,EAChB,UAAU,CAAC,MAAM,CAClB,CAAC;YACJ,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC5B,IAAI,KAAK,GAAG,KAAK,CAAC,MAAuB,CAAC;gBAC1C,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;gBACzB,CAAC;gBACD,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAC7C,CAAC;IAED,oBAAoB,CAAC,MAAwB;QAC3C,IAAI,IAAI,CAAC,qBAAqB,KAAK,MAAM,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QACD,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACpD,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;YACvD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAC5D,YAAY,CAAC,cAAc,EAAE,eAAe,aAAa,aAAa,CAAC,CAAC;YACxE,YAAY,CAAC,YAAY,CAAC,CAAC;YAC3B,IAAI,CAAC,mBAAmB,CACtB,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAE,EACvC,cAAc,EACd,YAAY,CACb,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC;IACtC,CAAC;IAEkB,SAAS,CAAC,KAA8B;QACzD,2BAA2B;IAC7B,CAAC;IAED,YAAY,CAAC,QAA+B;QAC1C,cAAc;IAChB,CAAC;IAEQ,MAAM;QACb,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEQ,MAAM;QACb,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAES,MAAM,CAAC,aAAa,CAAwB;CACvD"}

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

@@ -0,0 +1,12 @@
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import type { RenderTexture } from '../../textures/RenderTexture.js';
+import { WebGlCtxTexture } from './WebGlCtxTexture.js';
+export declare class WebGlCtxRenderTexture extends WebGlCtxTexture {
+    textureSource: RenderTexture;
+    framebuffer: WebGLFramebuffer | null;
+    constructor(glw: WebGlContextWrapper, memManager: TextureMemoryManager, textureSource: RenderTexture);
+    onLoadRequest(): Promise<Dimensions>;
+    free(): void;
+}

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

@@ -0,0 +1,55 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2024 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 { WebGlCtxTexture } from './WebGlCtxTexture.js';
+export class WebGlCtxRenderTexture extends WebGlCtxTexture {
+    framebuffer = null;
+    constructor(glw, memManager, textureSource) {
+        super(glw, memManager, textureSource);
+    }
+    async onLoadRequest() {
+        const { glw } = this;
+        const nativeTexture = (this._nativeCtxTexture =
+            this.createNativeCtxTexture());
+        const { width, height } = this.textureSource;
+        // Create Framebuffer object
+        this.framebuffer = glw.createFramebuffer();
+        // Set the dimensions of the render texture
+        glw.texImage2D(0, glw.RGBA, width, height, 0, glw.RGBA, glw.UNSIGNED_BYTE, null);
+        // Update the texture memory manager
+        this.setTextureMemUse(width * height * 4);
+        // Bind the framebuffer
+        glw.bindFramebuffer(this.framebuffer);
+        // Attach the texture to the framebuffer
+        glw.framebufferTexture2D(glw.COLOR_ATTACHMENT0, nativeTexture, 0);
+        // Unbind the framebuffer
+        glw.bindFramebuffer(null);
+        return {
+            width,
+            height,
+        };
+    }
+    free() {
+        super.free();
+        // Delete the framebuffer
+        this.glw.deleteFramebuffer(this.framebuffer);
+        this.framebuffer = null;
+    }
+}
+//# sourceMappingURL=WebGlCtxRenderTexture.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebGlCtxRenderTexture.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlCtxRenderTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAGjD,WAAW,GAA4B,IAAI,CAAC;IAEnD,YACE,GAAwB,EACxB,UAAgC,EAChC,aAA4B;QAE5B,KAAK,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACxC,CAAC;IAEQ,KAAK,CAAC,aAAa;QAC1B,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,aAAa,GAAG,CAAC,IAAI,CAAC,iBAAiB;YAC3C,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QACjC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAE7C,4BAA4B;QAC5B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAE3C,2CAA2C;QAC3C,GAAG,CAAC,UAAU,CACZ,CAAC,EACD,GAAG,CAAC,IAAI,EACR,KAAK,EACL,MAAM,EACN,CAAC,EACD,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,aAAa,EACjB,IAAI,CACL,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,gBAAgB,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;QAE1C,uBAAuB;QACvB,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEtC,wCAAwC;QACxC,GAAG,CAAC,oBAAoB,CAAC,GAAG,CAAC,iBAAiB,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QAElE,yBAAyB;QACzB,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE1B,OAAO;YACL,KAAK;YACL,MAAM;SACP,CAAC;IACJ,CAAC;IAEQ,IAAI;QACX,KAAK,CAAC,IAAI,EAAE,CAAC;QAEb,yBAAyB;QACzB,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;CACF"}

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

@@ -0,0 +1,9 @@
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import type { SubTexture } from '../../textures/SubTexture.js';
+import { WebGlCtxTexture } from './WebGlCtxTexture.js';
+export declare class WebGlCtxSubTexture extends WebGlCtxTexture {
+    constructor(glw: WebGlContextWrapper, memManager: TextureMemoryManager, textureSource: SubTexture);
+    onLoadRequest(): Promise<Dimensions>;
+}

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

@@ -0,0 +1,38 @@
+/*
+ * 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 { WebGlCtxTexture } from './WebGlCtxTexture.js';
+export class WebGlCtxSubTexture extends WebGlCtxTexture {
+    constructor(glw, memManager, textureSource) {
+        super(glw, memManager, textureSource);
+    }
+    async onLoadRequest() {
+        const props = this.textureSource.textureData;
+        assertTruthy(props, 'SubTexture must have texture data');
+        if (props.data instanceof Uint8Array) {
+            // its a 1x1 Color Texture
+            return { width: 1, height: 1 };
+        }
+        return {
+            width: props.data?.width || 0,
+            height: props.data?.height || 0,
+        };
+    }
+}
+//# sourceMappingURL=WebGlCtxSubTexture.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebGlCtxSubTexture.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlCtxSubTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrD,YACE,GAAwB,EACxB,UAAgC,EAChC,aAAyB;QAEzB,KAAK,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACxC,CAAC;IAEQ,KAAK,CAAC,aAAa;QAC1B,MAAM,KAAK,GAAI,IAAI,CAAC,aAA4B,CAAC,WAAW,CAAC;QAC7D,YAAY,CAAC,KAAK,EAAE,mCAAmC,CAAC,CAAC;QAEzD,IAAI,KAAK,CAAC,IAAI,YAAY,UAAU,EAAE,CAAC;YACrC,0BAA0B;YAC1B,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACjC,CAAC;QAED,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC;YAC7B,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;SAChC,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,57 @@
+import type { Dimensions } from '../../../common/CommonTypes.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import type { Texture } from '../../textures/Texture.js';
+import { CoreContextTexture } from '../CoreContextTexture.js';
+/**
+ * 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 declare class WebGlCtxTexture extends CoreContextTexture {
+    protected glw: WebGlContextWrapper;
+    protected _nativeCtxTexture: WebGLTexture | null;
+    private _w;
+    private _h;
+    constructor(glw: WebGlContextWrapper, memManager: TextureMemoryManager, textureSource: Texture);
+    get ctxTexture(): WebGLTexture | null;
+    get w(): number;
+    get h(): number;
+    /**
+     * 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.
+     */
+    load(): void;
+    /**
+     * Called when the texture data needs to be loaded and uploaded to a texture
+     */
+    onLoadRequest(): Promise<Dimensions>;
+    /**
+     * Free the WebGLTexture from the GPU
+     *
+     * @returns
+     */
+    free(): void;
+    /**
+     * Create native context texture
+     *
+     * @remarks
+     * When this method returns the returned texture will be bound to the GL context state.
+     *
+     * @param width
+     * @param height
+     * @returns
+     */
+    protected createNativeCtxTexture(): WebGLTexture | null;
+}