@lightningjs/renderer 2.13.5 → 2.14.0

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

@@ -1,118 +0,0 @@
-/*
- * 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';
-/**
- * Can render multiple quads with multiple textures (up to vertex shader texture limit)
- *
- */
-export class WebGlRenderOp extends CoreRenderOp {
-    renderer;
-    bufferIdx;
-    numQuads = 0;
-    textures = [];
-    /**
-     * need to improve this when TextRenderers are refactored
-     */
-    sdfShaderProps;
-    sdfNode;
-    maxTextures;
-    buffers;
-    shader;
-    width;
-    height;
-    clippingRect;
-    rtt;
-    parentHasRenderTexture;
-    framebufferDimensions;
-    alpha;
-    pixelRatio;
-    constructor(renderer, quad, bufferIdx) {
-        super();
-        this.renderer = renderer;
-        this.bufferIdx = bufferIdx;
-        this.buffers = quad.sdfBuffers || renderer.quadBufferCollection;
-        this.shader = quad.shader;
-        this.width = quad.width;
-        this.height = quad.height;
-        this.clippingRect = quad.clippingRect;
-        this.parentHasRenderTexture = quad.parentHasRenderTexture;
-        this.framebufferDimensions = quad.framebufferDimensions;
-        this.rtt = quad.rtt;
-        this.alpha = quad.alpha;
-        this.pixelRatio =
-            this.parentHasRenderTexture === true ? 1 : renderer.stage.pixelRatio;
-        /**
-         * related to line 51
-         */
-        this.sdfShaderProps = quad.sdfShaderProps;
-        this.maxTextures = this.shader.program.supportsIndexedTextures
-            ? renderer.glw.getParameter(renderer.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, options, stage } = this.renderer;
-        stage.shManager.useShader(this.shader.program);
-        this.shader.program.bindRenderOp(this);
-        // TODO: Reduce calculations required
-        const quadIdx = (this.bufferIdx / 32) * 6 * 2;
-        // Clipping
-        if (this.clippingRect.valid === true) {
-            const clipX = Math.round(this.clippingRect.x * this.pixelRatio);
-            const clipWidth = Math.round(this.clippingRect.width * this.pixelRatio);
-            const clipHeight = Math.round(this.clippingRect.height * this.pixelRatio);
-            let clipY = Math.round(options.canvas.height -
-                clipHeight -
-                this.clippingRect.y * this.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.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=WebGlRenderOp.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"WebGlRenderOp.js","sourceRoot":"","sources":["../../../../../src/core/renderers/webgl/WebGlRenderOp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAwBlD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY;IAsBlC;IAEA;IAvBX,QAAQ,GAAG,CAAC,CAAC;IACb,QAAQ,GAAsB,EAAE,CAAC;IAEjC;;OAEG;IACM,cAAc,CAAsC;IACpD,OAAO,CAA2B;IAClC,WAAW,CAAS;IACpB,OAAO,CAAmB;IAC1B,MAAM,CAAkB;IACxB,KAAK,CAAS;IACd,MAAM,CAAS;IACf,YAAY,CAAgB;IAC5B,GAAG,CAAU;IACb,sBAAsB,CAAU;IAChC,qBAAqB,CAAqB;IAC1C,KAAK,CAAS;IACd,UAAU,CAAS;IAE5B,YACW,QAAuB,EAChC,IAAyB,EAChB,SAAiB;QAE1B,KAAK,EAAE,CAAC;QAJC,aAAQ,GAAR,QAAQ,CAAe;QAEvB,cAAS,GAAT,SAAS,CAAQ;QAG1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,QAAQ,CAAC,oBAAoB,CAAC;QAChE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAyB,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC1D,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACxD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,UAAU;YACb,IAAI,CAAC,sBAAsB,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAEvE;;WAEG;QACH,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB;YAC5D,CAAC,CAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CACxB,QAAQ,CAAC,GAAG,CAAC,8BAA8B,CACjC;YACd,CAAC,CAAC,CAAC,CAAC;IACR,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,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,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE9C,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEvC,qCAAqC;QACrC,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9C,WAAW;QACX,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;YAChE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;YACxE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CACpB,OAAO,CAAC,MAAM,CAAC,MAAM;gBACnB,UAAU;gBACV,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CACxC,CAAC;YACF,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,MAAM;oBACjD,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/WebGlRenderer.d.ts

@@ -1,135 +0,0 @@
-import { CoreRenderer, type BufferInfo, type CoreRendererOptions, type QuadOptions } from '../CoreRenderer.js';
-import { WebGlRenderOp } from './WebGlRenderOp.js';
-import type { CoreContextTexture } from '../CoreContextTexture.js';
-import { type CoreWebGlParameters, type CoreWebGlExtensions, type WebGlColor } from './internal/RendererUtils.js';
-import { Texture, type TextureCoords } from '../../textures/Texture.js';
-import { BufferCollection } from './internal/BufferCollection.js';
-import { WebGlShaderProgram } from './WebGlShaderProgram.js';
-import { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
-import { type CoreNode } from '../../CoreNode.js';
-import type { WebGlShaderType } from './WebGlShaderNode.js';
-import { WebGlShaderNode } from './WebGlShaderNode.js';
-export type WebGlRendererOptions = CoreRendererOptions;
-interface CoreWebGlSystem {
-    parameters: CoreWebGlParameters;
-    extensions: CoreWebGlExtensions;
-}
-export declare class WebGlRenderer extends CoreRenderer {
-    glw: WebGlContextWrapper;
-    system: CoreWebGlSystem;
-    quadBuffer: ArrayBuffer;
-    fQuadBuffer: Float32Array;
-    uiQuadBuffer: Uint32Array;
-    renderOps: WebGlRenderOp[];
-    curBufferIdx: number;
-    curRenderOp: WebGlRenderOp | null;
-    rttNodes: CoreNode[];
-    activeRttNode: CoreNode | null;
-    defaultTextureCoords: TextureCoords;
-    defaultShaderNode: WebGlShaderNode | null;
-    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: WebGlRendererOptions);
-    reset(): void;
-    createShaderProgram(shaderType: WebGlShaderType, props: Record<string, unknown>): WebGlShaderProgram;
-    createShaderNode(shaderKey: string, shaderType: WebGlShaderType, props?: Record<string, unknown>, program?: WebGlShaderProgram): WebGlShaderNode<Record<string, unknown>>;
-    supportsShaderType(shaderType: Readonly<WebGlShaderType>): boolean;
-    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: WebGlRenderOp): 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;
-    getDefaultShaderNode(): WebGlShaderNode;
-    getTextureCoords(node: CoreNode): TextureCoords;
-    /**
-     * Sets the glClearColor to the specified color.   *
-     * @param color - The color to set as the clear color, represented as a 32-bit integer.
-     */
-    updateClearColor(color: number): void;
-}
-export {};