@lightningtv/renderer 3.0.0-beta1

package/dist/src/core/CoreTextNode.js

@@ -0,0 +1,331 @@
+/*
+ * 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 { CoreNode, UpdateType } from './CoreNode.js';
+import { assertTruthy } from '../utils.js';
+import { Matrix3d } from './lib/Matrix3d.js';
+/**
+ * An CoreNode in the Renderer scene graph that renders text.
+ *
+ * @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.
+ *
+ * The text renderer can be overridden by setting the `textRendererOverride`
+ *
+ * The `texture` and `shader` properties are managed by loaded text renderer and
+ * should not be set directly.
+ *
+ * For non-text rendering, see {@link CoreNode}.
+ */
+export class CoreTextNode extends CoreNode {
+    textRenderer;
+    trState;
+    _textRendererOverride = null;
+    constructor(stage, props, textRenderer) {
+        super(stage, props);
+        this._textRendererOverride = props.textRendererOverride;
+        this.textRenderer = textRenderer;
+        const textRendererState = this.createState({
+            x: this.absX,
+            y: this.absY,
+            width: props.width,
+            height: props.height,
+            textAlign: props.textAlign,
+            color: props.color,
+            zIndex: props.zIndex,
+            contain: props.contain,
+            scrollable: props.scrollable,
+            scrollY: props.scrollY,
+            offsetY: props.offsetY,
+            letterSpacing: props.letterSpacing,
+            debug: props.debug,
+            fontFamily: props.fontFamily,
+            fontSize: props.fontSize,
+            fontStretch: props.fontStretch,
+            fontStyle: props.fontStyle,
+            fontWeight: props.fontWeight,
+            text: props.text,
+            lineHeight: props.lineHeight,
+            maxLines: props.maxLines,
+            textBaseline: props.textBaseline,
+            verticalAlign: props.verticalAlign,
+            overflowSuffix: props.overflowSuffix,
+        });
+        this.trState = textRendererState;
+    }
+    onTextLoaded = () => {
+        const { contain } = this;
+        const setWidth = this.trState.props.width;
+        const setHeight = this.trState.props.height;
+        const calcWidth = this.trState.textW || 0;
+        const calcHeight = this.trState.textH || 0;
+        if (contain === 'both') {
+            this.props.width = setWidth;
+            this.props.height = setHeight;
+        }
+        else if (contain === 'width') {
+            this.props.width = setWidth;
+            this.props.height = calcHeight;
+        }
+        else if (contain === 'none') {
+            this.props.width = calcWidth;
+            this.props.height = calcHeight;
+        }
+        this.updateLocalTransform();
+        // Incase the RAF loop has been stopped already before text was loaded,
+        // we request a render so it can be drawn.
+        this.stage.requestRender();
+        this.emit('loaded', {
+            type: 'text',
+            dimensions: {
+                width: this.trState.textW || 0,
+                height: this.trState.textH || 0,
+            },
+        });
+    };
+    onTextFailed = (target, error) => {
+        this.emit('failed', {
+            type: 'text',
+            error,
+        });
+    };
+    get width() {
+        return this.props.width;
+    }
+    set width(value) {
+        this.props.width = value;
+        this.textRenderer.set.width(this.trState, value);
+        // If not containing, we must update the local transform to account for the
+        // new width
+        if (this.contain === 'none') {
+            this.setUpdateType(UpdateType.Local);
+        }
+    }
+    get height() {
+        return this.props.height;
+    }
+    set height(value) {
+        this.props.height = value;
+        this.textRenderer.set.height(this.trState, value);
+        // If not containing in the horizontal direction, we must update the local
+        // transform to account for the new height
+        if (this.contain !== 'both') {
+            this.setUpdateType(UpdateType.Local);
+        }
+    }
+    get color() {
+        return this.trState.props.color;
+    }
+    set color(value) {
+        this.textRenderer.set.color(this.trState, value);
+    }
+    get text() {
+        return this.trState.props.text;
+    }
+    set text(value) {
+        this.textRenderer.set.text(this.trState, value);
+    }
+    get textRendererOverride() {
+        return this._textRendererOverride;
+    }
+    set textRendererOverride(value) {
+        this._textRendererOverride = value;
+        this.textRenderer.destroyState(this.trState);
+        const textRenderer = this.stage.resolveTextRenderer(this.trState.props, this._textRendererOverride);
+        if (!textRenderer) {
+            console.warn('Text Renderer not found for font', this.trState.props.fontFamily);
+            return;
+        }
+        this.textRenderer = textRenderer;
+        this.trState = this.createState(this.trState.props);
+    }
+    get fontSize() {
+        return this.trState.props.fontSize;
+    }
+    set fontSize(value) {
+        this.textRenderer.set.fontSize(this.trState, value);
+    }
+    get fontFamily() {
+        return this.trState.props.fontFamily;
+    }
+    set fontFamily(value) {
+        this.textRenderer.set.fontFamily(this.trState, value);
+    }
+    get fontStretch() {
+        return this.trState.props.fontStretch;
+    }
+    set fontStretch(value) {
+        this.textRenderer.set.fontStretch(this.trState, value);
+    }
+    get fontStyle() {
+        return this.trState.props.fontStyle;
+    }
+    set fontStyle(value) {
+        this.textRenderer.set.fontStyle(this.trState, value);
+    }
+    get fontWeight() {
+        return this.trState.props.fontWeight;
+    }
+    set fontWeight(value) {
+        this.textRenderer.set.fontWeight(this.trState, value);
+    }
+    get textAlign() {
+        return this.trState.props.textAlign;
+    }
+    set textAlign(value) {
+        this.textRenderer.set.textAlign(this.trState, value);
+    }
+    get contain() {
+        return this.trState.props.contain;
+    }
+    set contain(value) {
+        this.textRenderer.set.contain(this.trState, value);
+    }
+    get scrollable() {
+        return this.trState.props.scrollable;
+    }
+    set scrollable(value) {
+        this.textRenderer.set.scrollable(this.trState, value);
+    }
+    get scrollY() {
+        return this.trState.props.scrollY;
+    }
+    set scrollY(value) {
+        this.textRenderer.set.scrollY(this.trState, value);
+    }
+    get offsetY() {
+        return this.trState.props.offsetY;
+    }
+    set offsetY(value) {
+        this.textRenderer.set.offsetY(this.trState, value);
+    }
+    get letterSpacing() {
+        return this.trState.props.letterSpacing;
+    }
+    set letterSpacing(value) {
+        this.textRenderer.set.letterSpacing(this.trState, value);
+    }
+    get lineHeight() {
+        return this.trState.props.lineHeight;
+    }
+    set lineHeight(value) {
+        this.textRenderer.set.lineHeight(this.trState, value);
+    }
+    get maxLines() {
+        return this.trState.props.maxLines;
+    }
+    set maxLines(value) {
+        this.textRenderer.set.maxLines(this.trState, value);
+    }
+    get textBaseline() {
+        return this.trState.props.textBaseline;
+    }
+    set textBaseline(value) {
+        this.textRenderer.set.textBaseline(this.trState, value);
+    }
+    get verticalAlign() {
+        return this.trState.props.verticalAlign;
+    }
+    set verticalAlign(value) {
+        this.textRenderer.set.verticalAlign(this.trState, value);
+    }
+    get overflowSuffix() {
+        return this.trState.props.overflowSuffix;
+    }
+    set overflowSuffix(value) {
+        this.textRenderer.set.overflowSuffix(this.trState, value);
+    }
+    get debug() {
+        return this.trState.props.debug;
+    }
+    set debug(value) {
+        this.textRenderer.set.debug(this.trState, value);
+    }
+    update(delta, parentClippingRect) {
+        super.update(delta, parentClippingRect);
+        assertTruthy(this.globalTransform);
+        // globalTransform is updated in super.update(delta)
+        this.textRenderer.set.x(this.trState, this.globalTransform.tx);
+        this.textRenderer.set.y(this.trState, this.globalTransform.ty);
+    }
+    checkBasicRenderability() {
+        if (this.worldAlpha === 0 || this.isOutOfBounds() === true) {
+            return false;
+        }
+        if (this.trState && this.trState.props.text !== '') {
+            return true;
+        }
+        return false;
+    }
+    setRenderable(isRenderable) {
+        super.setRenderable(isRenderable);
+        this.textRenderer.setIsRenderable(this.trState, isRenderable);
+    }
+    renderQuads(renderer) {
+        assertTruthy(this.globalTransform);
+        // If the text renderer does not support rendering quads, fallback to the
+        // default renderQuads method
+        if (!this.textRenderer.renderQuads) {
+            super.renderQuads(renderer);
+            return;
+        }
+        // If the text renderer does support rendering quads, use it...
+        // Prevent quad rendering if parent has a render texture
+        // and this node is not the render texture
+        if (this.parentHasRenderTexture) {
+            if (!renderer.renderToTextureActive) {
+                return;
+            }
+            // Prevent quad rendering if parent render texture is not the active render texture
+            if (this.parentRenderTexture !== renderer.activeRttNode) {
+                return;
+            }
+        }
+        if (this.parentHasRenderTexture && this.props.parent?.rtt) {
+            this.globalTransform = Matrix3d.identity();
+            if (this.localTransform) {
+                this.globalTransform.multiply(this.localTransform);
+            }
+        }
+        assertTruthy(this.globalTransform);
+        this.textRenderer.renderQuads(this);
+    }
+    /**
+     * Destroy the node and cleanup all resources
+     */
+    destroy() {
+        super.destroy();
+        this.textRenderer.destroyState(this.trState);
+    }
+    /**
+     * Resolve a text renderer and a new state based on the current text renderer props provided
+     * @param props
+     * @returns
+     */
+    createState(props) {
+        const textRendererState = this.textRenderer.createState(props, this);
+        textRendererState.emitter.on('loaded', this.onTextLoaded);
+        textRendererState.emitter.on('failed', this.onTextFailed);
+        this.textRenderer.scheduleUpdateState(textRendererState);
+        return textRendererState;
+    }
+}
+//# sourceMappingURL=CoreTextNode.js.map

package/dist/src/core/CoreTextNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreTextNode.js","sourceRoot":"","sources":["../../../src/core/CoreTextNode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAUH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAsB,MAAM,eAAe,CAAC;AAQzE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAmB7C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACxC,YAAY,CAAe;IAC3B,OAAO,CAAoB;IACnB,qBAAqB,GAC3B,IAAI,CAAC;IAEP,YACE,KAAY,EACZ,KAAwB,EACxB,YAA0B;QAE1B,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,oBAAoB,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;YACzC,CAAC,EAAE,IAAI,CAAC,IAAI;YACZ,CAAC,EAAE,IAAI,CAAC,IAAI;YACZ,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,cAAc,EAAE,KAAK,CAAC,cAAc;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC;IACnC,CAAC;IAEO,YAAY,GAAyB,GAAG,EAAE;QAChD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QAE3C,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC;QAChC,CAAC;aAAM,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;QACjC,CAAC;aAAM,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,uEAAuE;QACvE,0CAA0C;QAC1C,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;gBAC9B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;aAChC;SAC8B,CAAC,CAAC;IACrC,CAAC,CAAC;IAEM,YAAY,GAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC7D,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,EAAE,MAAM;YACZ,KAAK;SAC0B,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,IAAa,KAAK;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,IAAa,KAAK,CAAC,KAAa;QAC9B,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEjD,2EAA2E;QAC3E,YAAY;QACZ,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,IAAa,MAAM;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,IAAa,MAAM,CAAC,KAAa;QAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAElD,0EAA0E;QAC1E,0CAA0C;QAC1C,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,IAAa,KAAK;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAClC,CAAC;IAED,IAAa,KAAK,CAAC,KAAa;QAC9B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED,IAAI,oBAAoB,CAAC,KAAgD;QACvE,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACnC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CACjD,IAAI,CAAC,OAAO,CAAC,KAAK,EAClB,IAAI,CAAC,qBAAqB,CAC3B,CAAC;QAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CACV,kCAAkC,EAClC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAC9B,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;IACrC,CAAC;IAED,IAAI,QAAQ,CAAC,KAAoC;QAC/C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,IAAI,UAAU,CAAC,KAAsC;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;IACxC,CAAC;IAED,IAAI,WAAW,CAAC,KAAuC;QACrD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,SAAS,CAAC,KAAqC;QACjD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,IAAI,UAAU,CAAC,KAAsC;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,SAAS,CAAC,KAAqC;QACjD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,OAAO,CAAC,KAAmC;QAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,IAAI,UAAU,CAAC,KAAsC;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,OAAO,CAAC,KAAmC;QAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAI,OAAO,CAAC,KAAmC;QAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,KAAyC;QACzD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,IAAI,UAAU,CAAC,KAAsC;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;IACrC,CAAC;IAED,IAAI,QAAQ,CAAC,KAAoC;QAC/C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC;IACzC,CAAC;IAED,IAAI,YAAY,CAAC,KAAwC;QACvD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;IAC1C,CAAC;IAED,IAAI,aAAa,CAAC,KAAyC;QACzD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;IAC3C,CAAC;IAED,IAAI,cAAc,CAAC,KAA0C;QAC3D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAClC,CAAC;IAED,IAAI,KAAK,CAAC,KAAiC;QACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAEQ,MAAM,CAAC,KAAa,EAAE,kBAAiC;QAC9D,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QAExC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEnC,oDAAoD;QACpD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IAEQ,uBAAuB;QAC9B,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;YAC3D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEQ,aAAa,CAAC,YAAqB;QAC1C,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAChE,CAAC;IAEQ,WAAW,CAAC,QAAsB;QACzC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEnC,yEAAyE;QACzE,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,+DAA+D;QAE/D,wDAAwD;QACxD,0CAA0C;QAC1C,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,mFAAmF;YACnF,IAAI,IAAI,CAAC,mBAAmB,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;gBACxD,OAAO;YACT,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;YAC1D,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEnC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACM,OAAO;QACd,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,KAAc;QAChC,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAErE,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1D,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1D,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;QAEzD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;CACF"}

package/dist/src/core/CoreTextureManager.d.ts

@@ -0,0 +1,253 @@
+import { ImageWorkerManager } from './lib/ImageWorker.js';
+import type { CoreRenderer } from './renderers/CoreRenderer.js';
+import { ColorTexture } from './textures/ColorTexture.js';
+import { ImageTexture } from './textures/ImageTexture.js';
+import { NoiseTexture } from './textures/NoiseTexture.js';
+import { SubTexture } from './textures/SubTexture.js';
+import { RenderTexture } from './textures/RenderTexture.js';
+import { type Texture } from './textures/Texture.js';
+import { EventEmitter } from '../common/EventEmitter.js';
+import type { Stage } from './Stage.js';
+/**
+ * Augmentable map of texture class types
+ *
+ * @remarks
+ * This interface can be augmented by other modules/apps to add additional
+ * texture types. The ones included directly here are the ones that are
+ * included in the core library.
+ */
+export interface TextureMap {
+    ColorTexture: typeof ColorTexture;
+    ImageTexture: typeof ImageTexture;
+    NoiseTexture: typeof NoiseTexture;
+    SubTexture: typeof SubTexture;
+    RenderTexture: typeof RenderTexture;
+}
+export type ExtractProps<Type> = Type extends {
+    z$__type__Props: infer Props;
+} ? Props : never;
+/**
+ * Contains information about the texture manager's internal state
+ * for debugging purposes.
+ */
+export interface TextureManagerDebugInfo {
+    keyCacheSize: number;
+}
+export interface TextureManagerSettings {
+    numImageWorkers: number;
+    createImageBitmapSupport: 'auto' | 'basic' | 'options' | 'full';
+}
+export type ResizeModeOptions = {
+    /**
+     * Specifies that the image should be resized to cover the specified dimensions.
+     */
+    type: 'cover';
+    /**
+     * The horizontal clipping position
+     * To clip the left, set clipX to 0. To clip the right, set clipX to 1.
+     * clipX 0.5 will clip a equal amount from left and right
+     *
+     * @defaultValue 0.5
+     */
+    clipX?: number;
+    /**
+     * The vertical clipping position
+     * To clip the top, set clipY to 0. To clip the bottom, set clipY to 1.
+     * clipY 0.5 will clip a equal amount from top and bottom
+     *
+     * @defaultValue 0.5
+     */
+    clipY?: number;
+} | {
+    /**
+     * Specifies that the image should be resized to fit within the specified dimensions.
+     */
+    type: 'contain';
+};
+/**
+ * Universal options for all texture types
+ *
+ * @remarks
+ * Texture Options provide a way to specify options that are relevant to the
+ * texture loading process (including caching) and specifically for how a
+ * texture is rendered within a specific Node (or set of Nodes).
+ *
+ * They are not used in determining the cache key for a texture (except if
+ * the `cacheKey` option is provided explicitly to oveerride the default
+ * cache key for the texture instance) nor are they stored/referenced within
+ * the texture instance itself. Instead, the options are stored/referenced
+ * within individual Nodes. So a single texture instance can be used in
+ * multiple Nodes each using a different set of options.
+ */
+export interface TextureOptions {
+    /**
+     * Preload the texture immediately even if it's not being rendered to the
+     * screen.
+     *
+     * @remarks
+     * This allows the texture to be used immediately without any delay when it
+     * is first needed for rendering. Otherwise the loading process will start
+     * when the texture is first rendered, which may cause a delay in that texture
+     * being shown properly.
+     *
+     * @defaultValue `false`
+     */
+    preload?: boolean;
+    /**
+     * Prevent clean up of the texture when it is no longer being used.
+     *
+     * @remarks
+     * This is useful when you want to keep the texture in memory for later use.
+     * Regardless of whether the texture is being used or not, it will not be
+     * cleaned up.
+     *
+     * @defaultValue `false`
+     */
+    preventCleanup?: boolean;
+    /**
+     * Flip the texture horizontally when rendering
+     *
+     * @defaultValue `false`
+     */
+    flipX?: boolean;
+    /**
+     * Flip the texture vertically when rendering
+     *
+     * @defaultValue `false`
+     */
+    flipY?: boolean;
+    /**
+     * You can use resizeMode to determine the clipping automatically from the width
+     * and height of the source texture. This can be convenient if you are unsure about
+     * the exact image sizes but want the image to cover a specific area.
+     *
+     * The resize modes cover and contain are supported
+     */
+    resizeMode?: ResizeModeOptions;
+}
+export declare class CoreTextureManager extends EventEmitter {
+    /**
+     * Map of textures by cache key
+     */
+    keyCache: Map<string, Texture>;
+    /**
+     * Map of cache keys by texture
+     */
+    inverseKeyCache: WeakMap<Texture, string>;
+    /**
+     * Map of texture constructors by their type name
+     */
+    txConstructors: Partial<TextureMap>;
+    private downloadTextureSourceQueue;
+    private priorityQueue;
+    private uploadTextureQueue;
+    private initialized;
+    private stage;
+    private numImageWorkers;
+    imageWorkerManager: ImageWorkerManager | null;
+    hasCreateImageBitmap: boolean;
+    imageBitmapSupported: {
+        basic: boolean;
+        options: boolean;
+        full: boolean;
+    };
+    hasWorker: boolean;
+    /**
+     * Renderer that this texture manager is associated with
+     *
+     * @remarks
+     * This MUST be set before the texture manager is used. Otherwise errors
+     * will occur when using the texture manager.
+     */
+    renderer: CoreRenderer;
+    /**
+     * The current frame time in milliseconds
+     *
+     * @remarks
+     * This is used to populate the `lastRenderableChangeTime` property of
+     * {@link Texture} instances when their renderable state changes.
+     *
+     * Set by stage via `updateFrameTime` method.
+     */
+    frameTime: number;
+    constructor(stage: Stage, settings: TextureManagerSettings);
+    registerTextureType<Type extends keyof TextureMap>(textureType: Type, textureClass: TextureMap[Type]): void;
+    private initialize;
+    /**
+     * Enqueue a texture for downloading its source image.
+     */
+    enqueueDownloadTextureSource(texture: Texture): void;
+    /**
+     * Enqueue a texture for uploading to the GPU.
+     *
+     * @param texture - The texture to upload
+     */
+    enqueueUploadTexture(texture: Texture): void;
+    /**
+     * Create a texture
+     *
+     * @param textureType - The type of texture to create
+     * @param props - The properties to use for the texture
+     */
+    createTexture<Type extends keyof TextureMap>(textureType: Type, props: ExtractProps<TextureMap[Type]>): InstanceType<TextureMap[Type]>;
+    orphanTexture(texture: Texture): void;
+    /**
+     * Override loadTexture to use the batched approach.
+     *
+     * @param texture - The texture to load
+     * @param immediate - Whether to prioritize the texture for immediate loading
+     */
+    loadTexture(texture: Texture, priority?: boolean): void;
+    /**
+     * Upload a texture to the GPU
+     *
+     * @param texture Texture to upload
+     */
+    uploadTexture(texture: Texture): void;
+    /**
+     * Check if a texture is being processed
+     */
+    isProcessingTexture(texture: Texture): boolean;
+    /**
+     * Process a limited number of downloads and uploads.
+     *
+     * @param maxItems - The maximum number of items to process
+     */
+    processSome(maxProcessingTime: number): void;
+    hasUpdates(): boolean;
+    /**
+     * Initialize a texture to the cache
+     *
+     * @param texture Texture to cache
+     * @param cacheKey Cache key for the texture
+     */
+    initTextureToCache(texture: Texture, cacheKey: string): void;
+    /**
+     * Get a texture from the cache
+     *
+     * @param cacheKey
+     */
+    getTextureFromCache(cacheKey: string): Texture | undefined;
+    /**
+     * Remove a texture from the cache
+     *
+     * @remarks
+     * Called by Texture Cleanup when a texture is freed.
+     *
+     * @param texture
+     */
+    removeTextureFromCache(texture: Texture): void;
+    /**
+     * Remove texture from the queue's
+     *
+     * @param texture - The texture to remove
+     */
+    removeTextureFromQueue(texture: Texture): void;
+    /**
+     * Resolve a parent texture from the cache or fallback to the provided texture.
+     *
+     * @param texture - The provided texture to resolve.
+     * @returns The cached or provided texture.
+     */
+    resolveParentTexture(texture: ImageTexture): Texture;
+}