@lightningjs/renderer 0.0.1

package/dist/src/core/CoreTextNode.js

@@ -0,0 +1,251 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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 } from './CoreNode.js';
+export class CoreTextNode extends CoreNode {
+    textRenderer;
+    trState;
+    updateScheduled;
+    _textRendererOverride = null;
+    constructor(stage, props) {
+        super(stage, props);
+        this.updateScheduled = false;
+        // console.log('fontfamily', props.fontFamily)
+        this._textRendererOverride = props.textRendererOverride;
+        const { resolvedTextRenderer, textRendererState } = this.resolveTextRendererAndState({
+            x: this.absX,
+            y: this.absY,
+            width: props.width,
+            height: props.height,
+            textAlign: props.textAlign,
+            color: props.color,
+            alpha: props.alpha,
+            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,
+        }, undefined);
+        this.textRenderer = resolvedTextRenderer;
+        this.trState = textRendererState;
+    }
+    onTextLoaded = () => {
+        this.emit('textLoaded', {
+            width: this.trState.textW,
+            height: this.trState.textH,
+        });
+    };
+    onTextFailed = (target, error) => {
+        this.emit('textFailed', error);
+    };
+    get width() {
+        return this.trState.props.width;
+    }
+    set width(value) {
+        this.textRenderer.set.width(this.trState, value);
+        this.updateText();
+    }
+    get height() {
+        return this.trState.props.height;
+    }
+    set height(value) {
+        this.textRenderer.set.height(this.trState, value);
+        this.updateText();
+    }
+    get alpha() {
+        return this.trState.props.alpha;
+    }
+    set alpha(value) {
+        this.textRenderer.set.alpha(this.trState, value);
+        this.updateText();
+    }
+    get color() {
+        return this.trState.props.color;
+    }
+    set color(value) {
+        this.textRenderer.set.color(this.trState, value);
+        this.updateText();
+    }
+    get text() {
+        return this.trState.props.text;
+    }
+    set text(value) {
+        this.textRenderer.set.text(this.trState, value);
+        this.updateText();
+    }
+    get textRendererOverride() {
+        return this._textRendererOverride;
+    }
+    set textRendererOverride(value) {
+        this._textRendererOverride = value;
+        const { resolvedTextRenderer, textRendererState } = this.resolveTextRendererAndState(this.trState.props, this.trState);
+        this.textRenderer = resolvedTextRenderer;
+        this.trState = textRendererState;
+    }
+    get fontSize() {
+        return this.trState.props.fontSize;
+    }
+    set fontSize(value) {
+        this.textRenderer.set.fontSize(this.trState, value);
+        this.updateText();
+    }
+    get fontFamily() {
+        return this.trState.props.fontFamily;
+    }
+    set fontFamily(value) {
+        this.textRenderer.set.fontFamily(this.trState, value);
+        this.updateText();
+    }
+    get fontStretch() {
+        return this.trState.props.fontStretch;
+    }
+    set fontStretch(value) {
+        this.textRenderer.set.fontStretch(this.trState, value);
+        this.updateText();
+    }
+    get fontStyle() {
+        return this.trState.props.fontStyle;
+    }
+    set fontStyle(value) {
+        this.textRenderer.set.fontStyle(this.trState, value);
+        this.updateText();
+    }
+    get fontWeight() {
+        return this.trState.props.fontWeight;
+    }
+    set fontWeight(value) {
+        this.textRenderer.set.fontWeight(this.trState, value);
+        this.updateText();
+    }
+    get textAlign() {
+        return this.trState.props.textAlign;
+    }
+    set textAlign(value) {
+        this.textRenderer.set.textAlign(this.trState, value);
+        this.updateText();
+    }
+    get contain() {
+        return this.trState.props.contain;
+    }
+    set contain(value) {
+        this.textRenderer.set.contain(this.trState, value);
+        this.updateText();
+    }
+    get scrollable() {
+        return this.trState.props.scrollable;
+    }
+    set scrollable(value) {
+        this.textRenderer.set.scrollable(this.trState, value);
+        this.updateText();
+    }
+    get scrollY() {
+        return this.trState.props.scrollY;
+    }
+    set scrollY(value) {
+        this.textRenderer.set.scrollY(this.trState, value);
+        this.updateText();
+    }
+    get offsetY() {
+        return this.trState.props.offsetY;
+    }
+    set offsetY(value) {
+        this.textRenderer.set.offsetY(this.trState, value);
+        this.updateText();
+    }
+    get letterSpacing() {
+        return this.trState.props.letterSpacing;
+    }
+    set letterSpacing(value) {
+        this.textRenderer.set.letterSpacing(this.trState, value);
+        this.updateText();
+    }
+    get debug() {
+        return this.trState.props.debug;
+    }
+    set debug(value) {
+        this.textRenderer.set.debug(this.trState, value);
+        this.updateText();
+    }
+    update(delta) {
+        super.update(delta);
+        this.textRenderer.set.x(this.trState, this.worldContext.px);
+        this.textRenderer.set.y(this.trState, this.worldContext.py);
+        if (this.trState.status === 'loading') {
+            this.updateText();
+        }
+    }
+    updateText() {
+        if (this.updateScheduled) {
+            return;
+        }
+        this.updateScheduled = true;
+        queueMicrotask(() => {
+            this.updateScheduled = false;
+            this.textRenderer.updateState(this.trState);
+        });
+    }
+    renderQuads(renderer) {
+        this.textRenderer.renderQuads(this.trState);
+    }
+    /**
+     * Resolve a text renderer and a new state based on the current text renderer props provided
+     * @param props
+     * @returns
+     */
+    resolveTextRendererAndState(props, prevState) {
+        const resolvedTextRenderer = this.stage.resolveTextRenderer(props, this._textRendererOverride);
+        const textRendererState = resolvedTextRenderer.createState(props);
+        const stateEvents = ['loading', 'loaded', 'failed'];
+        if (prevState) {
+            // Remove the old event listeners from previous state obj there was one
+            stateEvents.forEach((eventName) => {
+                prevState.emitter.off(eventName);
+            });
+        }
+        // Forward basic status events from the text renderer state
+        textRendererState.emitter.on('loading', () => {
+            // This event will be fired only once between the `loading` and `loaded`
+            // event ONLY if the font is not already loaded
+            textRendererState.emitter.once('fontLoaded', () => {
+                // When it's fired we must run update to make sure the text renders
+                this.updateText();
+            });
+            textRendererState.emitter.once('loaded', () => {
+                // Make sure we stop listening for fontLoaded events
+                textRendererState.emitter.off('fontLoaded');
+            });
+        });
+        textRendererState.emitter.on('loaded', this.onTextLoaded);
+        textRendererState.emitter.on('failed', this.onTextFailed);
+        this.updateText();
+        // TODO: Handle text renderer errors
+        return {
+            resolvedTextRenderer,
+            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;AAQH,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAkB7D,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACxC,YAAY,CAAe;IAC3B,OAAO,CAAoB;IAC3B,eAAe,CAAU;IACjB,qBAAqB,GAC3B,IAAI,CAAC;IAEP,YAAY,KAAY,EAAE,KAAwB;QAChD,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,8CAA8C;QAC9C,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,oBAAoB,CAAC;QACxD,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,GAC/C,IAAI,CAAC,2BAA2B,CAC9B;YACE,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,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;SACjB,EACD,SAAS,CACV,CAAC;QACJ,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC;IACnC,CAAC;IAEO,YAAY,GAA2B,GAAG,EAAE;QAClD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;YACzB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;SAC3B,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,YAAY,GAA2B,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC/D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,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;QACjD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,IAAa,MAAM;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;IACnC,CAAC;IAED,IAAa,MAAM,CAAC,KAAa;QAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACjD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACjD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QAChD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED,IAAI,oBAAoB,CAAC,KAAgD;QACvE,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;QAEnC,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,GAC/C,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC;IACnC,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;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACtD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACvD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACrD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACtD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACrD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACtD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACnD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACzD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,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;QACjD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEQ,MAAM,CAAC,KAAa;QAC3B,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE;YACrC,IAAI,CAAC,UAAU,EAAE,CAAC;SACnB;IACH,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO;SACR;QACD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,cAAc,CAAC,GAAG,EAAE;YAClB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEQ,WAAW,CAAC,QAAsB;QACzC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACK,2BAA2B,CACjC,KAAc,EACd,SAA6B;QAK7B,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CACzD,KAAK,EACL,IAAI,CAAC,qBAAqB,CAC3B,CAAC;QAEF,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAElE,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,SAAS,EAAE;YACb,uEAAuE;YACvE,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;SACJ;QAED,2DAA2D;QAC3D,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC3C,wEAAwE;YACxE,+CAA+C;YAC/C,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;gBAChD,mEAAmE;gBACnE,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,CAAC,CAAC,CAAC;YAEH,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;gBAC5C,oDAAoD;gBACpD,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,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;QAC1D,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,oCAAoC;QAEpC,OAAO;YACL,oBAAoB;YACpB,iBAAiB;SAClB,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,173 @@
+import type { CoreContextTexture } from './renderers/CoreContextTexture.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 type { Texture } from './textures/Texture.js';
+/**
+ * Augmentable map of texture 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;
+}
+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;
+    idCacheSize: number;
+}
+/**
+ * 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;
+    /**
+     * ID to use for this texture.
+     *
+     * @remarks
+     * This is for internal use only as an optimization.
+     *
+     * @privateRemarks
+     * This is used to avoid having to look up the texture in the texture cache
+     * by its cache key. Theoretically this should be faster.
+     *
+     * @defaultValue Automatically generated
+     */
+    id?: number;
+    /**
+     * Cache key to use for this texture
+     *
+     * @remarks
+     * If this is set, the texture will be cached using this key. If a texture
+     * with the same key is already cached, it will be returned instead of
+     * creating a new texture.
+     *
+     * If this is not set (undefined), it will be automatically generated via
+     * the specified `Texture`'s `makeCacheKey()` method.
+     *
+     * @defaultValue Automatically generated via `Texture.makeCacheKey()`
+     */
+    cacheKey?: string | false;
+    /**
+     * Flip the texture horizontally when rendering
+     *
+     * @defaultValue `false`
+     */
+    flipX?: boolean;
+    /**
+     * Flip the texture vertically when rendering
+     *
+     * @defaultValue `false`
+     */
+    flipY?: boolean;
+}
+export declare class CoreTextureManager {
+    /**
+     * Amount of used memory defined in pixels
+     */
+    usedMemory: number;
+    txConstructors: Partial<TextureMap>;
+    textureKeyCache: Map<string, Texture>;
+    textureIdCache: Map<number, Texture>;
+    ctxTextureCache: WeakMap<Texture, CoreContextTexture>;
+    textureRefCountMap: WeakMap<Texture, {
+        cacheKey: string | false;
+        count: number;
+    }>;
+    /**
+     * 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;
+    constructor();
+    registerTextureType<Type extends keyof TextureMap>(textureType: Type, textureClass: TextureMap[Type]): void;
+    loadTexture<Type extends keyof TextureMap>(textureType: Type, props: ExtractProps<TextureMap[Type]>, options?: TextureOptions | null): InstanceType<TextureMap[Type]>;
+    /**
+     * Add a `Texture` to the texture cache by its texture desc ID and cache key
+     *
+     * @remarks
+     * This is used internally by the `CoreTextureManager` to cache textures
+     * when they are created.
+     *
+     * It handles updating the texture ID cache, texture key cache, and texture
+     * reference count map.
+     *
+     * @param textureDescId
+     * @param cacheKey
+     * @param texture
+     */
+    private addTextureIdToCache;
+    /**
+     * Remove a `Texture` from the texture cache by its texture desc ID
+     *
+     * @remarks
+     * This is called externally by when we know that the `TextureDesc` has been
+     * garbage collected. This allows us to remove the `Texture` from the cache
+     * so that it can be garbage collected as well.
+     *
+     * @param textureDescId
+     */
+    removeTextureIdFromCache(textureDescId: number): void;
+    /**
+     * Get an object containing debug information about the texture manager.
+     *
+     * @returns
+     */
+    getDebugInfo(): TextureManagerDebugInfo;
+    /**
+     * Get a CoreContextTexture for the given Texture source.
+     *
+     * @remarks
+     * If the texture source already has an allocated CoreContextTexture, it will be
+     * returned from the cache. Otherwise, a new CoreContextTexture will be created
+     * and cached.
+     *
+     * ContextTextures are stored in a WeakMap, so they will be garbage collected
+     * when the Texture source is no longer referenced.
+     *
+     * @param textureSource
+     * @returns
+     */
+    getCtxTexture(textureSource: Texture): CoreContextTexture;
+}

package/dist/src/core/CoreTextureManager.js

@@ -0,0 +1,190 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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 { ColorTexture } from './textures/ColorTexture.js';
+import { ImageTexture } from './textures/ImageTexture.js';
+import { NoiseTexture } from './textures/NoiseTexture.js';
+import { SubTexture } from './textures/SubTexture.js';
+export class CoreTextureManager {
+    /**
+     * Amount of used memory defined in pixels
+     */
+    usedMemory = 0;
+    txConstructors = {};
+    textureKeyCache = new Map();
+    textureIdCache = new Map();
+    ctxTextureCache = new WeakMap();
+    textureRefCountMap = new WeakMap();
+    /**
+     * 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;
+    constructor() {
+        // Register default known texture types
+        this.registerTextureType('ImageTexture', ImageTexture);
+        this.registerTextureType('ColorTexture', ColorTexture);
+        this.registerTextureType('NoiseTexture', NoiseTexture);
+        this.registerTextureType('SubTexture', SubTexture);
+    }
+    registerTextureType(textureType, textureClass) {
+        this.txConstructors[textureType] = textureClass;
+    }
+    loadTexture(textureType, props, options = null) {
+        const TextureClass = this.txConstructors[textureType];
+        if (!TextureClass) {
+            throw new Error(`Texture type "${textureType}" is not registered`);
+        }
+        let texture;
+        // If an ID is specified, try to get the texture from the ID cache first
+        if (options?.id !== undefined && this.textureIdCache.has(options.id)) {
+            // console.log('Getting texture by texture desc ID', options.id);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            texture = this.textureIdCache.get(options.id);
+        }
+        // If the texture is not found in the ID cache, try to get it from the key cache
+        if (!texture) {
+            const descId = options?.id;
+            const cacheKey = options?.cacheKey ?? TextureClass.makeCacheKey(props);
+            if (cacheKey && this.textureKeyCache.has(cacheKey)) {
+                // console.log('Getting texture by cache key', cacheKey);
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                texture = this.textureKeyCache.get(cacheKey);
+            }
+            else {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                texture = new TextureClass(this, props);
+            }
+            if (descId) {
+                this.addTextureIdToCache(descId, cacheKey, texture);
+            }
+        }
+        if (options?.preload) {
+            const ctxTx = this.getCtxTexture(texture);
+            ctxTx.load();
+        }
+        return texture;
+    }
+    /**
+     * Add a `Texture` to the texture cache by its texture desc ID and cache key
+     *
+     * @remarks
+     * This is used internally by the `CoreTextureManager` to cache textures
+     * when they are created.
+     *
+     * It handles updating the texture ID cache, texture key cache, and texture
+     * reference count map.
+     *
+     * @param textureDescId
+     * @param cacheKey
+     * @param texture
+     */
+    addTextureIdToCache(textureDescId, cacheKey, texture) {
+        const { textureIdCache, textureRefCountMap } = this;
+        textureIdCache.set(textureDescId, texture);
+        if (textureRefCountMap.has(texture)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            textureRefCountMap.get(texture).count++;
+        }
+        else {
+            textureRefCountMap.set(texture, { cacheKey, count: 1 });
+            if (cacheKey) {
+                this.textureKeyCache.set(cacheKey, texture);
+            }
+        }
+    }
+    /**
+     * Remove a `Texture` from the texture cache by its texture desc ID
+     *
+     * @remarks
+     * This is called externally by when we know that the `TextureDesc` has been
+     * garbage collected. This allows us to remove the `Texture` from the cache
+     * so that it can be garbage collected as well.
+     *
+     * @param textureDescId
+     */
+    removeTextureIdFromCache(textureDescId) {
+        const { textureIdCache, textureRefCountMap } = this;
+        const texture = textureIdCache.get(textureDescId);
+        if (!texture) {
+            throw new Error(`Texture ID ${textureDescId} is not in the texture ID cache`);
+        }
+        textureIdCache.delete(textureDescId);
+        if (textureRefCountMap.has(texture)) {
+            const refCountObj = textureRefCountMap.get(texture);
+            assertTruthy(refCountObj);
+            refCountObj.count--;
+            if (refCountObj.count === 0) {
+                textureRefCountMap.delete(texture);
+                // If the texture is not referenced anywhere else, remove it from the key cache
+                // as well.
+                // This should allow the `Texture` instance to be garbage collected.
+                if (refCountObj.cacheKey) {
+                    this.textureKeyCache.delete(refCountObj.cacheKey);
+                }
+            }
+        }
+    }
+    /**
+     * Get an object containing debug information about the texture manager.
+     *
+     * @returns
+     */
+    getDebugInfo() {
+        // const textureSet = new Set<Texture>();
+        // for (const texture of this.textureIdCache.values()) {
+        //   textureSet.add(texture);
+        // }
+        // for (const texture of this.textureKeyCache.values()) {
+        //   textureSet.add(texture);
+        // }
+        // TODO: Output number of bytes used by textures
+        return {
+            keyCacheSize: this.textureKeyCache.size,
+            idCacheSize: this.textureIdCache.size,
+        };
+    }
+    /**
+     * Get a CoreContextTexture for the given Texture source.
+     *
+     * @remarks
+     * If the texture source already has an allocated CoreContextTexture, it will be
+     * returned from the cache. Otherwise, a new CoreContextTexture will be created
+     * and cached.
+     *
+     * ContextTextures are stored in a WeakMap, so they will be garbage collected
+     * when the Texture source is no longer referenced.
+     *
+     * @param textureSource
+     * @returns
+     */
+    getCtxTexture(textureSource) {
+        if (this.ctxTextureCache.has(textureSource)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return this.ctxTextureCache.get(textureSource);
+        }
+        const texture = this.renderer.createCtxTexture(textureSource);
+        this.ctxTextureCache.set(textureSource, texture);
+        return texture;
+    }
+}
+//# sourceMappingURL=CoreTextureManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CoreTextureManager.js","sourceRoot":"","sources":["../../../src/core/CoreTextureManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAyGtD,MAAM,OAAO,kBAAkB;IAC7B;;OAEG;IACH,UAAU,GAAG,CAAC,CAAC;IAEf,cAAc,GAAwB,EAAE,CAAC;IAEzC,eAAe,GAAyB,IAAI,GAAG,EAAE,CAAC;IAClD,cAAc,GAAyB,IAAI,GAAG,EAAE,CAAC;IAEjD,eAAe,GAAyC,IAAI,OAAO,EAAE,CAAC;IACtE,kBAAkB,GAGd,IAAI,OAAO,EAAE,CAAC;IAElB;;;;;;OAMG;IACH,QAAQ,CAAgB;IAExB;QACE,uCAAuC;QACvC,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,mBAAmB,CACjB,WAAiB,EACjB,YAA8B;QAE9B,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;IAClD,CAAC;IAED,WAAW,CACT,WAAiB,EACjB,KAAqC,EACrC,UAAiC,IAAI;QAErC,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,qBAAqB,CAAC,CAAC;SACpE;QACD,IAAI,OAA4B,CAAC;QACjC,wEAAwE;QACxE,IAAI,OAAO,EAAE,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACpE,iEAAiE;YACjE,oEAAoE;YACpE,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAE,CAAC;SAChD;QACD,gFAAgF;QAChF,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,MAAM,GAAG,OAAO,EAAE,EAAE,CAAC;YAC3B,MAAM,QAAQ,GACZ,OAAO,EAAE,QAAQ,IAAI,YAAY,CAAC,YAAY,CAAC,KAAY,CAAC,CAAC;YAC/D,IAAI,QAAQ,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAClD,yDAAyD;gBACzD,oEAAoE;gBACpE,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;aAC/C;iBAAM;gBACL,qGAAqG;gBACrG,OAAO,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,KAAY,CAAC,CAAC;aAChD;YACD,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;aACrD;SACF;QACD,IAAI,OAAO,EAAE,OAAO,EAAE;YACpB,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAC1C,KAAK,CAAC,IAAI,EAAE,CAAC;SACd;QACD,OAAO,OAAyC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,mBAAmB,CACzB,aAAqB,EACrB,QAAwB,EACxB,OAAgB;QAEhB,MAAM,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QACpD,cAAc,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YACnC,oEAAoE;YACpE,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,KAAK,EAAE,CAAC;SAC1C;aAAM;YACL,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACxD,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7C;SACF;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,wBAAwB,CAAC,aAAqB;QAC5C,MAAM,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QACpD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,cAAc,aAAa,iCAAiC,CAC7D,CAAC;SACH;QACD,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACrC,IAAI,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YACnC,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACpD,YAAY,CAAC,WAAW,CAAC,CAAC;YAC1B,WAAW,CAAC,KAAK,EAAE,CAAC;YACpB,IAAI,WAAW,CAAC,KAAK,KAAK,CAAC,EAAE;gBAC3B,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACnC,+EAA+E;gBAC/E,WAAW;gBACX,oEAAoE;gBACpE,IAAI,WAAW,CAAC,QAAQ,EAAE;oBACxB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;iBACnD;aACF;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,yCAAyC;QACzC,wDAAwD;QACxD,6BAA6B;QAC7B,IAAI;QACJ,yDAAyD;QACzD,6BAA6B;QAC7B,IAAI;QACJ,gDAAgD;QAChD,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;YACvC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI;SACtC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,aAAsB;QAClC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YAC3C,oEAAoE;YACpE,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAE,CAAC;SACjD;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAE9D,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

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

@@ -0,0 +1,15 @@
+/**
+ *  Represents a 2D transformation context, providing a 2x2 matrix for transformations.
+ */
+export declare class Matrix2DContext {
+    alpha: number;
+    px: number;
+    py: number;
+    ta: number;
+    tb: number;
+    tc: number;
+    td: number;
+    isIdentity(): boolean;
+    isIdentityMatrix(): boolean;
+    isSquare(): boolean;
+}