@lightningjs/renderer 2.13.0 → 2.13.1

package/dist/src/main-api/RendererMain.js

@@ -0,0 +1,367 @@
+/*
+ * 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 { ManualCountTextureUsageTracker, } from './texture-usage-trackers/ManualCountTextureUsageTracker.js';
+import { FinalizationRegistryTextureUsageTracker } from './texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js';
+import { EventEmitter } from '../common/EventEmitter.js';
+import { Inspector } from './Inspector.js';
+import { santizeCustomDataMap } from '../render-drivers/utils.js';
+import { isProductionEnvironment } from '../utils.js';
+/**
+ * The Renderer Main API
+ *
+ * @remarks
+ * This is the primary class used to configure and operate the Renderer.
+ *
+ * It is used to create and destroy Nodes, as well as Texture and Shader
+ * references.
+ *
+ * Example:
+ * ```ts
+ * import { RendererMain, MainCoreDriver } from '@lightningjs/renderer';
+ *
+ * // Initialize the Renderer
+ * const renderer = new RendererMain(
+ *   {
+ *     appWidth: 1920,
+ *     appHeight: 1080
+ *   },
+ *   'app',
+ *   new MainCoreDriver(),
+ * );
+ * ```
+ */
+export class RendererMain extends EventEmitter {
+    root = null;
+    driver;
+    canvas;
+    settings;
+    inspector = null;
+    nodes = new Map();
+    nextTextureId = 1;
+    /**
+     * Texture Usage Tracker for Usage Based Texture Garbage Collection
+     *
+     * @remarks
+     * For internal use only. DO NOT ACCESS.
+     */
+    textureTracker;
+    /**
+     * Constructs a new Renderer instance
+     *
+     * @param settings Renderer settings
+     * @param target Element ID or HTMLElement to insert the canvas into
+     * @param driver Core Driver to use
+     */
+    constructor(settings, target, driver) {
+        super();
+        const resolvedSettings = {
+            appWidth: settings.appWidth || 1920,
+            appHeight: settings.appHeight || 1080,
+            txMemByteThreshold: settings.txMemByteThreshold || 124e6,
+            boundsMargin: settings.boundsMargin || 0,
+            deviceLogicalPixelRatio: settings.deviceLogicalPixelRatio || 1,
+            devicePhysicalPixelRatio: settings.devicePhysicalPixelRatio || window.devicePixelRatio,
+            clearColor: settings.clearColor ?? 0x00000000,
+            coreExtensionModule: settings.coreExtensionModule || null,
+            experimental_FinalizationRegistryTextureUsageTracker: settings.experimental_FinalizationRegistryTextureUsageTracker ?? false,
+            textureCleanupOptions: settings.textureCleanupOptions || {},
+            fpsUpdateInterval: settings.fpsUpdateInterval || 0,
+            numImageWorkers: settings.numImageWorkers !== undefined ? settings.numImageWorkers : 2,
+            enableContextSpy: settings.enableContextSpy ?? false,
+            enableInspector: settings.enableInspector ?? false,
+            renderMode: settings.renderMode ?? 'webgl',
+        };
+        this.settings = resolvedSettings;
+        const { appWidth, appHeight, deviceLogicalPixelRatio, devicePhysicalPixelRatio, enableInspector, } = resolvedSettings;
+        const releaseCallback = (textureId) => {
+            this.driver.releaseTexture(textureId);
+        };
+        const useFinalizationRegistryTracker = resolvedSettings.experimental_FinalizationRegistryTextureUsageTracker &&
+            typeof FinalizationRegistry === 'function';
+        this.textureTracker = useFinalizationRegistryTracker
+            ? new FinalizationRegistryTextureUsageTracker(releaseCallback)
+            : new ManualCountTextureUsageTracker(releaseCallback, this.settings.textureCleanupOptions);
+        const deviceLogicalWidth = appWidth * deviceLogicalPixelRatio;
+        const deviceLogicalHeight = appHeight * deviceLogicalPixelRatio;
+        this.driver = driver;
+        const canvas = document.createElement('canvas');
+        this.canvas = canvas;
+        canvas.width = deviceLogicalWidth * devicePhysicalPixelRatio;
+        canvas.height = deviceLogicalHeight * devicePhysicalPixelRatio;
+        canvas.style.width = `${deviceLogicalWidth}px`;
+        canvas.style.height = `${deviceLogicalHeight}px`;
+        let targetEl;
+        if (typeof target === 'string') {
+            targetEl = document.getElementById(target);
+        }
+        else {
+            targetEl = target;
+        }
+        if (!targetEl) {
+            throw new Error('Could not find target element');
+        }
+        // Hook up the driver's callbacks
+        driver.onCreateNode = (node) => {
+            this.nodes.set(node.id, node);
+        };
+        driver.onBeforeDestroyNode = (node) => {
+            this.nodes.delete(node.id);
+        };
+        driver.onFpsUpdate = (fpsData) => {
+            this.emit('fpsUpdate', fpsData);
+        };
+        driver.onFrameTick = (frameTickData) => {
+            this.emit('frameTick', frameTickData);
+        };
+        driver.onIdle = () => {
+            this.emit('idle');
+        };
+        targetEl.appendChild(canvas);
+        if (enableInspector && !isProductionEnvironment()) {
+            this.inspector = new Inspector(canvas, resolvedSettings);
+        }
+    }
+    /**
+     * Initialize the renderer
+     *
+     * @remarks
+     * This method must be called and resolved asyncronously before any other
+     * methods are called.
+     */
+    async init() {
+        await this.driver.init(this, this.settings, this.canvas);
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        this.root = this.driver.getRootNode();
+    }
+    /**
+     * Create a new scene graph node
+     *
+     * @remarks
+     * A node is the main graphical building block of the Renderer scene graph. It
+     * can be a container for other nodes, or it can be a leaf node that renders a
+     * solid color, gradient, image, or specific texture, using a specific shader.
+     *
+     * To create a text node, see {@link createTextNode}.
+     *
+     * See {@link INode} for more details.
+     *
+     * @param props
+     * @returns
+     */
+    createNode(props) {
+        if (this.inspector) {
+            return this.inspector.createNode(this.driver, this.resolveNodeDefaults(props));
+        }
+        return this.driver.createNode(this.resolveNodeDefaults(props));
+    }
+    /**
+     * Create a new scene graph text node
+     *
+     * @remarks
+     * A text node is the second graphical building block of the Renderer scene
+     * graph. It renders text using a specific text renderer that is automatically
+     * chosen based on the font requested and what type of fonts are installed
+     * into an app via a CoreExtension.
+     *
+     * See {@link ITextNode} for more details.
+     *
+     * @param props
+     * @returns
+     */
+    createTextNode(props) {
+        const fontSize = props.fontSize ?? 16;
+        const data = {
+            ...this.resolveNodeDefaults(props),
+            text: props.text ?? '',
+            textRendererOverride: props.textRendererOverride ?? null,
+            fontSize,
+            fontFamily: props.fontFamily ?? 'sans-serif',
+            fontStyle: props.fontStyle ?? 'normal',
+            fontWeight: props.fontWeight ?? 'normal',
+            fontStretch: props.fontStretch ?? 'normal',
+            textAlign: props.textAlign ?? 'left',
+            contain: props.contain ?? 'none',
+            scrollable: props.scrollable ?? false,
+            scrollY: props.scrollY ?? 0,
+            offsetY: props.offsetY ?? 0,
+            letterSpacing: props.letterSpacing ?? 0,
+            lineHeight: props.lineHeight, // `undefined` is a valid value
+            maxLines: props.maxLines ?? 0,
+            textBaseline: props.textBaseline ?? 'alphabetic',
+            verticalAlign: props.verticalAlign ?? 'middle',
+            overflowSuffix: props.overflowSuffix ?? '...',
+            debug: props.debug ?? {},
+        };
+        if (this.inspector) {
+            return this.inspector.createTextNode(this.driver, data);
+        }
+        return this.driver.createTextNode(data);
+    }
+    /**
+     * Resolves the default property values for a Node
+     *
+     * @remarks
+     * This method is used internally by the RendererMain to resolve the default
+     * property values for a Node. It is exposed publicly so that it can be used
+     * by Core Driver implementations.
+     *
+     * @param props
+     * @returns
+     */
+    resolveNodeDefaults(props) {
+        const color = props.color ?? 0xffffffff;
+        const colorTl = props.colorTl ?? props.colorTop ?? props.colorLeft ?? color;
+        const colorTr = props.colorTr ?? props.colorTop ?? props.colorRight ?? color;
+        const colorBl = props.colorBl ?? props.colorBottom ?? props.colorLeft ?? color;
+        const colorBr = props.colorBr ?? props.colorBottom ?? props.colorRight ?? color;
+        const data = santizeCustomDataMap(props.data ?? {});
+        return {
+            x: props.x ?? 0,
+            y: props.y ?? 0,
+            width: props.width ?? 0,
+            height: props.height ?? 0,
+            alpha: props.alpha ?? 1,
+            autosize: props.autosize ?? false,
+            clipping: props.clipping ?? false,
+            color,
+            colorTop: props.colorTop ?? color,
+            colorBottom: props.colorBottom ?? color,
+            colorLeft: props.colorLeft ?? color,
+            colorRight: props.colorRight ?? color,
+            colorBl,
+            colorBr,
+            colorTl,
+            colorTr,
+            zIndex: props.zIndex ?? 0,
+            zIndexLocked: props.zIndexLocked ?? 0,
+            parent: props.parent ?? null,
+            texture: props.texture ?? null,
+            shader: props.shader ?? null,
+            // Since setting the `src` will trigger a texture load, we need to set it after
+            // we set the texture. Otherwise, problems happen.
+            src: props.src ?? '',
+            scale: props.scale ?? null,
+            scaleX: props.scaleX ?? props.scale ?? 1,
+            scaleY: props.scaleY ?? props.scale ?? 1,
+            mount: props.mount ?? 0,
+            mountX: props.mountX ?? props.mount ?? 0,
+            mountY: props.mountY ?? props.mount ?? 0,
+            pivot: props.pivot ?? 0.5,
+            pivotX: props.pivotX ?? props.pivot ?? 0.5,
+            pivotY: props.pivotY ?? props.pivot ?? 0.5,
+            rotation: props.rotation ?? 0,
+            rtt: props.rtt ?? false,
+            data: data,
+        };
+    }
+    /**
+     * Destroy a node
+     *
+     * @remarks
+     * This method destroys a node but does not destroy its children.
+     *
+     * @param node
+     * @returns
+     */
+    destroyNode(node) {
+        if (this.inspector) {
+            this.inspector.destroyNode(node);
+        }
+        return this.driver.destroyNode(node);
+    }
+    /**
+     * Create a new texture reference
+     *
+     * @remarks
+     * This method creates a new reference to a texture. The texture is not
+     * loaded until it is used on a node.
+     *
+     * It can be assigned to a node's `texture` property, or it can be used
+     * when creating a SubTexture.
+     *
+     * @param textureType
+     * @param props
+     * @param options
+     * @returns
+     */
+    createTexture(textureType, props, options) {
+        const id = this.nextTextureId++;
+        const desc = {
+            descType: 'texture',
+            txType: textureType,
+            props,
+            options: {
+                ...options,
+                // This ID is used to identify the texture in the CoreTextureManager's
+                // ID Texture Map cache.
+                id,
+            },
+        };
+        this.textureTracker.registerTexture(desc);
+        return desc;
+    }
+    /**
+     * Create a new shader reference
+     *
+     * @remarks
+     * This method creates a new reference to a shader. The shader is not
+     * loaded until it is used on a Node.
+     *
+     * It can be assigned to a Node's `shader` property.
+     *
+     * @param shaderType
+     * @param props
+     * @returns
+     */
+    createShader(shaderType, props) {
+        return {
+            descType: 'shader',
+            shType: shaderType,
+            props: props,
+        };
+    }
+    /**
+     * Get a Node by its ID
+     *
+     * @param id
+     * @returns
+     */
+    getNodeById(id) {
+        return this.nodes.get(id) || null;
+    }
+    toggleFreeze() {
+        throw new Error('Not implemented');
+    }
+    advanceFrame() {
+        throw new Error('Not implemented');
+    }
+    /**
+     * Re-render the current frame without advancing any running animations.
+     *
+     * @remarks
+     * Any state changes will be reflected in the re-rendered frame. Useful for
+     * debugging.
+     *
+     * May not do anything if the render loop is running on a separate worker.
+     */
+    rerender() {
+        throw new Error('Not implemented');
+    }
+}
+//# sourceMappingURL=RendererMain.js.map

package/dist/src/main-api/RendererMain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RendererMain.js","sourceRoot":"","sources":["../../../src/main-api/RendererMain.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAgBH,OAAO,EACL,8BAA8B,GAE/B,MAAM,4DAA4D,CAAC;AACpE,OAAO,EAAE,uCAAuC,EAAE,MAAM,qEAAqE,CAAC;AAE9H,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AA8OtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,YAAa,SAAQ,YAAY;IACnC,IAAI,GAAiB,IAAI,CAAC;IAC1B,MAAM,CAAc;IACpB,MAAM,CAAoB;IAC1B,QAAQ,CAA2C;IACpD,SAAS,GAAqB,IAAI,CAAC;IACnC,KAAK,GAAuB,IAAI,GAAG,EAAE,CAAC;IACtC,aAAa,GAAG,CAAC,CAAC;IAE1B;;;;;OAKG;IACI,cAAc,CAAsB;IAE3C;;;;;;OAMG;IACH,YACE,QAA8B,EAC9B,MAA4B,EAC5B,MAAmB;QAEnB,KAAK,EAAE,CAAC;QACR,MAAM,gBAAgB,GAAmC;YACvD,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,IAAI;YACnC,SAAS,EAAE,QAAQ,CAAC,SAAS,IAAI,IAAI;YACrC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,IAAI,KAAK;YACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,IAAI,CAAC;YACxC,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB,IAAI,CAAC;YAC9D,wBAAwB,EACtB,QAAQ,CAAC,wBAAwB,IAAI,MAAM,CAAC,gBAAgB;YAC9D,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,UAAU;YAC7C,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,IAAI,IAAI;YACzD,oDAAoD,EAClD,QAAQ,CAAC,oDAAoD,IAAI,KAAK;YACxE,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,IAAI,EAAE;YAC3D,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,IAAI,CAAC;YAClD,eAAe,EACb,QAAQ,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACvE,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,IAAI,KAAK;YACpD,eAAe,EAAE,QAAQ,CAAC,eAAe,IAAI,KAAK;YAClD,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,OAAO;SAC3C,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QAEjC,MAAM,EACJ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,GAChB,GAAG,gBAAgB,CAAC;QAErB,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC5C,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC;QAEF,MAAM,8BAA8B,GAClC,gBAAgB,CAAC,oDAAoD;YACrE,OAAO,oBAAoB,KAAK,UAAU,CAAC;QAC7C,IAAI,CAAC,cAAc,GAAG,8BAA8B;YAClD,CAAC,CAAC,IAAI,uCAAuC,CAAC,eAAe,CAAC;YAC9D,CAAC,CAAC,IAAI,8BAA8B,CAChC,eAAe,EACf,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACpC,CAAC;QAEN,MAAM,kBAAkB,GAAG,QAAQ,GAAG,uBAAuB,CAAC;QAC9D,MAAM,mBAAmB,GAAG,SAAS,GAAG,uBAAuB,CAAC;QAEhE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,KAAK,GAAG,kBAAkB,GAAG,wBAAwB,CAAC;QAC7D,MAAM,CAAC,MAAM,GAAG,mBAAmB,GAAG,wBAAwB,CAAC;QAE/D,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,kBAAkB,IAAI,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,mBAAmB,IAAI,CAAC;QAEjD,IAAI,QAA4B,CAAC;QACjC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,MAAM,CAAC;QACpB,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,iCAAiC;QACjC,MAAM,CAAC,YAAY,GAAG,CAAC,IAAI,EAAE,EAAE;YAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QAEF,MAAM,CAAC,mBAAmB,GAAG,CAAC,IAAI,EAAE,EAAE;YACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC;QAEF,MAAM,CAAC,WAAW,GAAG,CAAC,OAAO,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC;QAEF,MAAM,CAAC,WAAW,GAAG,CAAC,aAAa,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACxC,CAAC,CAAC;QAEF,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,CAAC,CAAC;QAEF,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAE7B,IAAI,eAAe,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YAClD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACzD,4EAA4E;QAC3E,IAAI,CAAC,IAAc,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,KAAkC;QAC3C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAC9B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAChC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,KAAsC;QACnD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG;YACX,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC;YAClC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;YACtB,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,IAAI,IAAI;YACxD,QAAQ;YACR,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,YAAY;YAC5C,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,QAAQ;YACtC,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,QAAQ;YACxC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,QAAQ;YAC1C,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,MAAM;YACpC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,MAAM;YAChC,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,KAAK;YACrC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,CAAC;YAC3B,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,CAAC;YAC3B,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC;YACvC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,+BAA+B;YAC7D,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,CAAC;YAC7B,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,YAAY;YAChD,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,QAAQ;YAC9C,cAAc,EAAE,KAAK,CAAC,cAAc,IAAI,KAAK;YAC7C,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;SACzB,CAAC;QAEF,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,KAAkC;QACpD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,UAAU,CAAC;QACxC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC;QAC5E,MAAM,OAAO,GACX,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC;QAC/D,MAAM,OAAO,GACX,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC;QACjE,MAAM,OAAO,GACX,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC;QAClE,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAEpD,OAAO;YACL,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;YACf,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;YACf,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC;YACvB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC;YACzB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC;YACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;YACjC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;YACjC,KAAK;YACL,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;YACjC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,KAAK;YACvC,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,KAAK;YACnC,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,KAAK;YACrC,OAAO;YACP,OAAO;YACP,OAAO;YACP,OAAO;YACP,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC;YACzB,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,CAAC;YACrC,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI;YAC5B,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI;YAC5B,+EAA+E;YAC/E,kDAAkD;YAClD,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,EAAE;YACpB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;YACxC,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;YACxC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC;YACvB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;YACxC,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC;YACxC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,GAAG;YACzB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,GAAG;YAC1C,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,GAAG;YAC1C,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,CAAC;YAC7B,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,KAAK;YACvB,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CAAC,IAAW;QACrB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,WAAmB,EACnB,KAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,WAAW;YACnB,KAAK;YACL,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,sEAAsE;gBACtE,wBAAwB;gBACxB,EAAE;aACH;SACmC,CAAC;QACvC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,IAAkB,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,UAAkB,EAClB,KAA0C;QAE1C,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,KAA2C;SACnD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,EAAU;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;IACpC,CAAC;IAED,YAAY;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,YAAY;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ;QACN,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF"}

package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts

@@ -0,0 +1,9 @@
+import type { TextureRef } from '../RendererMain.js';
+import { TextureUsageTracker } from './TextureUsageTracker.js';
+export declare class FinalizationRegistryTextureUsageTracker extends TextureUsageTracker {
+    private registry;
+    constructor(releaseCallback: (textureDescId: number) => void);
+    registerTexture(texture: TextureRef): void;
+    incrementTextureRefCount(): void;
+    decrementTextureRefCount(): void;
+}

package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.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 { TextureUsageTracker } from './TextureUsageTracker.js';
+export class FinalizationRegistryTextureUsageTracker extends TextureUsageTracker {
+    registry;
+    constructor(releaseCallback) {
+        super(releaseCallback);
+        this.registry = new FinalizationRegistry(releaseCallback);
+    }
+    registerTexture(texture) {
+        assertTruthy(texture.options?.id, 'Texture must have an ID to be registered');
+        this.registry.register(texture, texture.options?.id);
+    }
+    incrementTextureRefCount() {
+        // No-op for FinalizationRegistry
+    }
+    decrementTextureRefCount() {
+        // No-op for FinalizationRegistry
+    }
+}
+//# sourceMappingURL=FinalizationRegistryTextureUsageTracker.js.map

package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FinalizationRegistryTextureUsageTracker.js","sourceRoot":"","sources":["../../../../src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,MAAM,OAAO,uCAAwC,SAAQ,mBAAmB;IACtE,QAAQ,CAA+B;IAE/C,YAAY,eAAgD;QAC1D,KAAK,CAAC,eAAe,CAAC,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAoB,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAEQ,eAAe,CAAC,OAAmB;QAC1C,YAAY,CACV,OAAO,CAAC,OAAO,EAAE,EAAE,EACnB,0CAA0C,CAC3C,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACvD,CAAC;IACQ,wBAAwB;QAC/B,iCAAiC;IACnC,CAAC;IACQ,wBAAwB;QAC/B,iCAAiC;IACnC,CAAC;CACF"}

package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts

@@ -0,0 +1,56 @@
+import type { TextureRef } from '../RendererMain.js';
+import { TextureUsageTracker } from './TextureUsageTracker.js';
+interface TextureRefInfo {
+    /**
+     * Texture Reference ID
+     */
+    id: number;
+    /**
+     * The number of references to this texture that are currently assigned to
+     * Nodes.
+     */
+    nodeRefCount: number;
+    /**
+     * The last time the texture reference count was updated.
+     *
+     * @remarks
+     * This is used to determine when a texture is no longer referenced by any
+     * Nodes and can be removed from the GPU.
+     */
+    lastUpdate: number;
+}
+export interface ManualCountTextureUsageTrackerOptions {
+    /**
+     * The interval at which to check if textures that are no longer referenced
+     * by any Nodes can be released from the Core Space Texture Usage Cache.
+     *
+     * @remarks
+     * Only valid when the {@link ManualCountTextureUsageTracker} is used.
+     *
+     * @defaultValue 10000 (10 seconds)
+     */
+    textureCleanupIntervalMs?: number;
+    /**
+     * The age at which a texture is considered to be no longer referenced by any
+     * Nodes and can be released from the Core Space Texture Usage Cache.
+     *
+     * @remarks
+     * Only valid when the {@link ManualCountTextureUsageTracker} is used.
+     *
+     * @defaultValue 60000 (1 minute)
+     */
+    textureCleanupAgeThreadholdMs?: number;
+}
+/**
+ * Usage-based Texture Garbage Collection Registry
+ */
+export declare class ManualCountTextureUsageTracker extends TextureUsageTracker {
+    textureMap: Map<number, TextureRefInfo>;
+    zeroReferenceTextureSet: Set<TextureRefInfo>;
+    options: Required<ManualCountTextureUsageTrackerOptions>;
+    constructor(releaseCallback: (textureDescId: number) => void, options: ManualCountTextureUsageTrackerOptions);
+    registerTexture(texture: TextureRef): void;
+    incrementTextureRefCount(texture: TextureRef): void;
+    decrementTextureRefCount(texture: TextureRef): void;
+}
+export {};

package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js

@@ -0,0 +1,101 @@
+/*
+ * 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 { TextureUsageTracker } from './TextureUsageTracker.js';
+/**
+ * Usage-based Texture Garbage Collection Registry
+ */
+export class ManualCountTextureUsageTracker extends TextureUsageTracker {
+    textureMap = new Map();
+    zeroReferenceTextureSet = new Set();
+    options;
+    constructor(releaseCallback, options) {
+        super(releaseCallback);
+        this.options = {
+            textureCleanupIntervalMs: options.textureCleanupIntervalMs ?? 10000,
+            textureCleanupAgeThreadholdMs: options.textureCleanupAgeThreadholdMs ?? 60000,
+        };
+        // Periodically check for textures that are no longer referenced by any
+        // Nodes and notify RendererMain to release them.
+        setInterval(() => {
+            const now = Date.now();
+            const thresholdMs = this.options.textureCleanupAgeThreadholdMs;
+            for (const textureRefInfo of this.zeroReferenceTextureSet) {
+                if (now - textureRefInfo.lastUpdate > thresholdMs) {
+                    this.releaseCallback(textureRefInfo.id);
+                    this.textureMap.delete(textureRefInfo.id);
+                    this.zeroReferenceTextureSet.delete(textureRefInfo);
+                }
+            }
+        }, this.options.textureCleanupIntervalMs);
+    }
+    registerTexture(texture) {
+        const textureId = texture.options?.id;
+        assertTruthy(textureId, 'Texture must have an id to be registered');
+        if (!this.textureMap.has(textureId)) {
+            const textureRefInfo = {
+                id: textureId,
+                nodeRefCount: 0,
+                lastUpdate: Date.now(),
+            };
+            this.textureMap.set(textureId, textureRefInfo);
+            this.zeroReferenceTextureSet.add(textureRefInfo);
+        }
+    }
+    incrementTextureRefCount(texture) {
+        const textureId = texture.options?.id;
+        assertTruthy(textureId, 'Texture must have an id to be registered');
+        let textureRefInfo = this.textureMap.get(textureId);
+        if (!textureRefInfo) {
+            // Texture has not been registered yet, so register it now.
+            // This may happen if the TextureRef was cleaned up from the registry
+            // but was still alive in memory and eventually re-used.
+            this.registerTexture(texture);
+            textureRefInfo = this.textureMap.get(textureId);
+        }
+        assertTruthy(textureRefInfo, 'Texture must have been registered');
+        if (texture.txType === 'SubTexture') {
+            // If this is a SubTexture, then increment the reference count of the
+            // parent texture as well.
+            this.incrementTextureRefCount(texture.props.texture);
+        }
+        textureRefInfo.nodeRefCount++;
+        textureRefInfo.lastUpdate = Date.now();
+        if (this.zeroReferenceTextureSet.has(textureRefInfo)) {
+            this.zeroReferenceTextureSet.delete(textureRefInfo);
+        }
+    }
+    decrementTextureRefCount(texture) {
+        const textureId = texture.options?.id;
+        assertTruthy(textureId, 'Texture must have an id to be registered');
+        const textureRefInfo = this.textureMap.get(textureId);
+        assertTruthy(textureRefInfo, 'Texture must have been registered');
+        textureRefInfo.nodeRefCount--;
+        textureRefInfo.lastUpdate = Date.now();
+        if (textureRefInfo.nodeRefCount === 0) {
+            this.zeroReferenceTextureSet.add(textureRefInfo);
+        }
+        if (texture.txType === 'SubTexture') {
+            // If this is a SubTexture, then decrement the reference count of the
+            // parent texture as well.
+            this.decrementTextureRefCount(texture.props.texture);
+        }
+    }
+}
+//# sourceMappingURL=ManualCountTextureUsageTracker.js.map

package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualCountTextureUsageTracker.js","sourceRoot":"","sources":["../../../../src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AA6C/D;;GAEG;AACH,MAAM,OAAO,8BAA+B,SAAQ,mBAAmB;IACrE,UAAU,GAAgC,IAAI,GAAG,EAAE,CAAC;IACpD,uBAAuB,GAAwB,IAAI,GAAG,EAAE,CAAC;IACzD,OAAO,CAAkD;IAEzD,YACE,eAAgD,EAChD,OAA8C;QAE9C,KAAK,CAAC,eAAe,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG;YACb,wBAAwB,EAAE,OAAO,CAAC,wBAAwB,IAAI,KAAK;YACnE,6BAA6B,EAC3B,OAAO,CAAC,6BAA6B,IAAI,KAAK;SACjD,CAAC;QACF,uEAAuE;QACvE,iDAAiD;QACjD,WAAW,CAAC,GAAG,EAAE;YACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC;YAC/D,KAAK,MAAM,cAAc,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC1D,IAAI,GAAG,GAAG,cAAc,CAAC,UAAU,GAAG,WAAW,EAAE,CAAC;oBAClD,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;oBACxC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;oBAC1C,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;QACH,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,eAAe,CAAC,OAAmB;QACjC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACtC,YAAY,CAAC,SAAS,EAAE,0CAA0C,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACpC,MAAM,cAAc,GAAmB;gBACrC,EAAE,EAAE,SAAS;gBACb,YAAY,EAAE,CAAC;gBACf,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE;aACvB,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YAC/C,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,wBAAwB,CAAC,OAAmB;QAC1C,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACtC,YAAY,CAAC,SAAS,EAAE,0CAA0C,CAAC,CAAC;QACpE,IAAI,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,2DAA2D;YAC3D,qEAAqE;YACrE,wDAAwD;YACxD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAC9B,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC;QACD,YAAY,CAAC,cAAc,EAAE,mCAAmC,CAAC,CAAC;QAClE,IAAI,OAAO,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACpC,qEAAqE;YACrE,0BAA0B;YAC1B,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QACD,cAAc,CAAC,YAAY,EAAE,CAAC;QAC9B,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,wBAAwB,CAAC,OAAmB;QAC1C,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACtC,YAAY,CAAC,SAAS,EAAE,0CAA0C,CAAC,CAAC;QACpE,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtD,YAAY,CAAC,cAAc,EAAE,mCAAmC,CAAC,CAAC;QAClE,cAAc,CAAC,YAAY,EAAE,CAAC;QAC9B,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,cAAc,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACpC,qEAAqE;YACrE,0BAA0B;YAC1B,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF"}

package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts

@@ -0,0 +1,32 @@
+import type { TextureRef } from '../RendererMain.js';
+/**
+ * Texture Usage Tracker for Usage Based Texture Garbage Collection
+ */
+export declare abstract class TextureUsageTracker {
+    protected releaseCallback: (textureDescId: number) => void;
+    constructor(releaseCallback: (textureDescId: number) => void);
+    /**
+     * Register a texture with the tracker.
+     *
+     * @param texture
+     */
+    abstract registerTexture(texture: TextureRef): void;
+    /**
+     * Increment the reference count for a texture.
+     *
+     * @remarks
+     * This should be called anytime a Node sets a new texture.
+     *
+     * @param texture
+     */
+    abstract incrementTextureRefCount(texture: TextureRef): void;
+    /**
+     * Decrement the Node reference count for a texture.
+     *
+     * @remarks
+     * This should be called anytime a Node removes a texture.
+     *
+     * @param texture
+     */
+    abstract decrementTextureRefCount(texture: TextureRef): void;
+}

package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+/**
+ * Texture Usage Tracker for Usage Based Texture Garbage Collection
+ */
+export class TextureUsageTracker {
+    releaseCallback;
+    constructor(releaseCallback) {
+        this.releaseCallback = releaseCallback;
+    }
+}
+//# sourceMappingURL=TextureUsageTracker.js.map

package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextureUsageTracker.js","sourceRoot":"","sources":["../../../../src/main-api/texture-usage-trackers/TextureUsageTracker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH;;GAEG;AACH,MAAM,OAAgB,mBAAmB;IACjB;IAAtB,YAAsB,eAAgD;QAAhD,oBAAe,GAAf,eAAe,CAAiC;IAAG,CAAC;CA4B3E"}