@lightningjs/renderer 0.0.1

package/dist/src/core/scene/Scene.js

@@ -0,0 +1,106 @@
+/*
+ * 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.
+ */
+export class Scene {
+    /**
+     * Root node of the scene
+     *
+     * @type {Node}
+     * @memberof Scene
+     */
+    root;
+    constructor(root) {
+        this.root = root;
+    }
+    /**
+     * Get all nodes of a specific type
+     * @param type
+     * @returns
+     */
+    getNodeByType(type) {
+        return [];
+    }
+    /**
+     * Find a node by id
+     * @param id
+     * @returns
+     */
+    getNodeById(id) {
+        return null;
+    }
+    /**
+     * Create a new node
+     * @param parent
+     * @returns
+     */
+    // public createNode(settings: Partial<INodeWritableProps> = {}): NodeTypes {
+    //   return createNode(settings);
+    // }
+    /**
+     * create a new RectangleNode
+     * @param w
+     * @param h
+     * @param parent
+     * @returns
+     */
+    // public rectangle(w: number, h: number, parent: NodeTypes | null = null) {
+    //   // TODO: Fix this
+    //   // return this.create(new RectangleNode(w, h), parent);
+    // }
+    /**
+     * Create a new CircleNode
+     * @param r
+     * @param parent
+     * @returns
+     */
+    // public circle(r: number, parent: NodeTypes | null = null) {
+    //   // TODO: Fix this
+    //   // return this.create(new CircleNode(r), parent);
+    // }
+    /**
+     * Create a new TextNode
+     * @param text
+     * @param parent
+     * @returns
+     */
+    // public text(text = '', parent: NodeTypes | null = null) {
+    //   // TODO: Fix this
+    //   // return this.create(new TextNode(text), parent);
+    // }
+    /**
+     * Setup and attaching Node
+     * @param node
+     * @param parent
+     * @returns
+     */
+    // private create(node: NodeTypes, parent: NodeTypes | null = null): NodeTypes {
+    //   if (!parent) {
+    //     parent = this.root;
+    //   }
+    //   node.parent = parent;
+    //   return node;
+    // }
+    /**
+     * Update the scene
+     * @param delta
+     */
+    update(delta) {
+        this.root.update(delta);
+    }
+}
+//# sourceMappingURL=Scene.js.map

package/dist/src/core/scene/Scene.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scene.js","sourceRoot":"","sources":["../../../../src/core/scene/Scene.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAMH,MAAM,OAAO,KAAK;IAChB;;;;;OAKG;IACI,IAAI,CAAW;IAEtB,YAAY,IAAc;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,IAAY;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,6EAA6E;IAC7E,iCAAiC;IACjC,IAAI;IAEJ;;;;;;OAMG;IACH,4EAA4E;IAC5E,sBAAsB;IACtB,4DAA4D;IAC5D,IAAI;IAEJ;;;;;OAKG;IACH,8DAA8D;IAC9D,sBAAsB;IACtB,sDAAsD;IACtD,IAAI;IAEJ;;;;;OAKG;IACH,4DAA4D;IAC5D,sBAAsB;IACtB,uDAAuD;IACvD,IAAI;IAEJ;;;;;OAKG;IACH,gFAAgF;IAChF,mBAAmB;IACnB,0BAA0B;IAC1B,MAAM;IAEN,0BAA0B;IAC1B,iBAAiB;IACjB,IAAI;IAEJ;;;OAGG;IACI,MAAM,CAAC,KAAa;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF"}

package/dist/src/core/text-rendering/TextTextureRendererUtils.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Returns CSS font setting string for use in canvas context.
+ *
+ * @param fontFace
+ * @param fontStyle
+ * @param fontSize
+ * @param precision
+ * @param defaultFontFace
+ * @returns
+ */
+export declare function getFontSetting(fontFace: string | string[], fontStyle: string, fontSize: number, precision: number, defaultFontFace: string): string;
+/**
+ * Returns true if the given character is a zero-width space.
+ *
+ * @param space
+ */
+export declare function isZeroWidthSpace(space: string): boolean;
+/**
+ * Returns true if the given character is a zero-width space or a regular space.
+ *
+ * @param space
+ */
+export declare function isSpace(space: string): boolean;
+/**
+ * Converts a string into an array of tokens and the words between them.
+ *
+ * @param tokenRegex
+ * @param text
+ */
+export declare function tokenizeString(tokenRegex: RegExp, text: string): string[];
+/**
+ * Measure the width of a string accounting for letter spacing.
+ *
+ * @param context
+ * @param word
+ * @param space
+ */
+export declare function measureText(context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, word: string, space?: number): number;
+export interface WrapTextResult {
+    l: string[];
+    n: number[];
+}
+/**
+ * Applies newlines to a string to have it optimally fit into the horizontal
+ * bounds set by the Text object's wordWrapWidth property.
+ *
+ * @param context
+ * @param text
+ * @param wordWrapWidth
+ * @param letterSpacing
+ * @param indent
+ */
+export declare function wrapText(context: CanvasRenderingContext2D, text: string, wordWrapWidth: number, letterSpacing: number, indent: number): WrapTextResult;

package/dist/src/core/text-rendering/TextTextureRendererUtils.js

@@ -0,0 +1,156 @@
+/*
+ * 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.
+ */
+/**
+ * Returns CSS font setting string for use in canvas context.
+ *
+ * @param fontFace
+ * @param fontStyle
+ * @param fontSize
+ * @param precision
+ * @param defaultFontFace
+ * @returns
+ */
+export function getFontSetting(fontFace, fontStyle, fontSize, precision, defaultFontFace) {
+    let ff = fontFace;
+    if (!Array.isArray(ff)) {
+        ff = [ff];
+    }
+    const ffs = [];
+    for (let i = 0, n = ff.length; i < n; i++) {
+        let curFf = ff[i];
+        // Replace the default font face `null` with the actual default font face set
+        // on the stage.
+        if (curFf === null || curFf === undefined) {
+            curFf = defaultFontFace;
+        }
+        if (curFf === 'serif' || curFf === 'sans-serif') {
+            ffs.push(curFf);
+        }
+        else {
+            ffs.push(`"${curFf}"`);
+        }
+    }
+    return `${fontStyle} ${fontSize * precision}px ${ffs.join(',')}`;
+}
+/**
+ * Returns true if the given character is a zero-width space.
+ *
+ * @param space
+ */
+export function isZeroWidthSpace(space) {
+    return space === '' || space === '\u200B';
+}
+/**
+ * Returns true if the given character is a zero-width space or a regular space.
+ *
+ * @param space
+ */
+export function isSpace(space) {
+    return isZeroWidthSpace(space) || space === ' ';
+}
+/**
+ * Converts a string into an array of tokens and the words between them.
+ *
+ * @param tokenRegex
+ * @param text
+ */
+export function tokenizeString(tokenRegex, text) {
+    const delimeters = text.match(tokenRegex) || [];
+    const words = text.split(tokenRegex) || [];
+    const final = [];
+    for (let i = 0; i < words.length; i++) {
+        final.push(words[i], delimeters[i]);
+    }
+    final.pop();
+    return final.filter((word) => word != '');
+}
+/**
+ * Measure the width of a string accounting for letter spacing.
+ *
+ * @param context
+ * @param word
+ * @param space
+ */
+export function measureText(context, word, space = 0) {
+    if (!space) {
+        return context.measureText(word).width;
+    }
+    return word.split('').reduce((acc, char) => {
+        // Zero-width spaces should not include letter spacing.
+        // And since we know the width of a zero-width space is 0, we can skip
+        // measuring it.
+        if (isZeroWidthSpace(char)) {
+            return acc;
+        }
+        return acc + context.measureText(char).width + space;
+    }, 0);
+}
+/**
+ * Applies newlines to a string to have it optimally fit into the horizontal
+ * bounds set by the Text object's wordWrapWidth property.
+ *
+ * @param context
+ * @param text
+ * @param wordWrapWidth
+ * @param letterSpacing
+ * @param indent
+ */
+export function wrapText(context, text, wordWrapWidth, letterSpacing, indent) {
+    // Greedy wrapping algorithm that will wrap words as the line grows longer.
+    // than its horizontal bounds.
+    const spaceRegex = / |\u200B/g;
+    const lines = text.split(/\r?\n/g);
+    let allLines = [];
+    const realNewlines = [];
+    for (let i = 0; i < lines.length; i++) {
+        const resultLines = [];
+        let result = '';
+        let spaceLeft = wordWrapWidth - indent;
+        const words = lines[i].split(spaceRegex);
+        const spaces = lines[i].match(spaceRegex) || [];
+        for (let j = 0; j < words.length; j++) {
+            const space = spaces[j - 1] || '';
+            const word = words[j];
+            const wordWidth = measureText(context, word, letterSpacing);
+            const wordWidthWithSpace = wordWidth + measureText(context, space, letterSpacing);
+            if (j === 0 || wordWidthWithSpace > spaceLeft) {
+                // Skip printing the newline if it's the first word of the line that is.
+                // greater than the word wrap width.
+                if (j > 0) {
+                    resultLines.push(result);
+                    result = '';
+                }
+                result += word;
+                spaceLeft = wordWrapWidth - wordWidth - (j === 0 ? indent : 0);
+            }
+            else {
+                spaceLeft -= wordWidthWithSpace;
+                result += space + word;
+            }
+        }
+        resultLines.push(result);
+        result = '';
+        allLines = allLines.concat(resultLines);
+        if (i < lines.length - 1) {
+            realNewlines.push(allLines.length);
+        }
+    }
+    return { l: allLines, n: realNewlines };
+}
+//# sourceMappingURL=TextTextureRendererUtils.js.map

package/dist/src/core/text-rendering/TextTextureRendererUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextTextureRendererUtils.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/TextTextureRendererUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC5B,QAA2B,EAC3B,SAAiB,EACjB,QAAgB,EAChB,SAAiB,EACjB,eAAuB;IAEvB,IAAI,EAAE,GAAG,QAAQ,CAAC;IAElB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACtB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;KACX;IAED,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QACzC,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAClB,6EAA6E;QAC7E,gBAAgB;QAChB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,KAAK,GAAG,eAAe,CAAC;SACzB;QACD,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,YAAY,EAAE;YAC/C,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACjB;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;SACxB;KACF;IAED,OAAO,GAAG,SAAS,IAAI,QAAQ,GAAG,SAAS,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,OAAO,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,QAAQ,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,GAAG,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,UAAkB,EAAE,IAAY;IAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IAChD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IAE3C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACrC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC;KACvC;IACD,KAAK,CAAC,GAAG,EAAE,CAAC;IACZ,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,OAAqE,EACrE,IAAY,EACZ,KAAK,GAAG,CAAC;IAET,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;KACxC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACzC,uDAAuD;QACvD,sEAAsE;QACtE,gBAAgB;QAChB,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;IACvD,CAAC,EAAE,CAAC,CAAC,CAAC;AACR,CAAC;AAOD;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAiC,EACjC,IAAY,EACZ,aAAqB,EACrB,aAAqB,EACrB,MAAc;IAEd,2EAA2E;IAC3E,8BAA8B;IAC9B,MAAM,UAAU,GAAG,WAAW,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnC,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACrC,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,SAAS,GAAG,aAAa,GAAG,MAAM,CAAC;QACvC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACvB,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;YAC5D,MAAM,kBAAkB,GACtB,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;YACzD,IAAI,CAAC,KAAK,CAAC,IAAI,kBAAkB,GAAG,SAAS,EAAE;gBAC7C,wEAAwE;gBACxE,oCAAoC;gBACpC,IAAI,CAAC,GAAG,CAAC,EAAE;oBACT,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACzB,MAAM,GAAG,EAAE,CAAC;iBACb;gBACD,MAAM,IAAI,IAAI,CAAC;gBACf,SAAS,GAAG,aAAa,GAAG,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAChE;iBAAM;gBACL,SAAS,IAAI,kBAAkB,CAAC;gBAChC,MAAM,IAAI,KAAK,GAAG,IAAI,CAAC;aACxB;SACF;QAED,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,GAAG,EAAE,CAAC;QAEZ,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAExC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACpC;KACF;IAED,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC;AAC1C,CAAC"}

package/dist/src/core/text-rendering/TrFontManager.d.ts

@@ -0,0 +1,25 @@
+import type { TrFontFace } from './font-face-types/TrFontFace.js';
+import type { TextRendererMap, TrFontProps } from './renderers/TextRenderer.js';
+/**
+ * Structure mapping font family names to a set of font faces.
+ */
+export interface FontFamilyMap {
+    [familyName: string]: Set<TrFontFace>;
+}
+export declare class TrFontManager {
+    private textRenderers;
+    constructor(textRenderers: Partial<TextRendererMap>);
+    addFontFace(font: TrFontFace): void;
+    /**
+     * Utility method to resolve a single font face from a list of prioritized family maps based on
+     * a set of font properties.
+     *
+     * @remarks
+     * These are to be used by a text renderer to resolve a font face if needed.
+     *
+     * @param familyMapsByPriority
+     * @param props
+     * @returns
+     */
+    static resolveFontFace(familyMapsByPriority: FontFamilyMap[], props: TrFontProps): TrFontFace | undefined;
+}

package/dist/src/core/text-rendering/TrFontManager.js

@@ -0,0 +1,75 @@
+/*
+ * 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 { SdfTrFontFace } from './font-face-types/SdfTrFontFace/SdfTrFontFace.js';
+import { WebTrFontFace } from './font-face-types/WebTrFontFace.js';
+export class TrFontManager {
+    textRenderers;
+    constructor(textRenderers) {
+        this.textRenderers = textRenderers;
+        // Intentionally left blank
+    }
+    addFontFace(font) {
+        // All the font face to all of the text renderers that support it
+        for (const trId in this.textRenderers) {
+            const tr = this.textRenderers[trId];
+            if (tr && tr.isFontFaceSupported(font)) {
+                tr.addFontFace(font);
+            }
+        }
+    }
+    /**
+     * Utility method to resolve a single font face from a list of prioritized family maps based on
+     * a set of font properties.
+     *
+     * @remarks
+     * These are to be used by a text renderer to resolve a font face if needed.
+     *
+     * @param familyMapsByPriority
+     * @param props
+     * @returns
+     */
+    static resolveFontFace(familyMapsByPriority, props) {
+        const closeFaces = [];
+        const exactMatch = familyMapsByPriority.reduce((prev, fontFamiles) => {
+            if (prev) {
+                return prev;
+            }
+            const fontFaces = fontFamiles[props.fontFamily];
+            if (!fontFaces) {
+                return undefined;
+            }
+            const fontFacesCopy = new Set(fontFaces);
+            // Remove any font faces that don't match the style exactly
+            // TODO: In the future we may enhance this to find the best match
+            // based on font weight, style, etc.
+            // See https://www.w3.org/TR/2018/REC-css-fonts-3-20180920/#font-matching-algorithm
+            for (const fontFace of fontFacesCopy) {
+                if (fontFace.descriptors.stretch !== props.fontStretch ||
+                    fontFace.descriptors.style !== props.fontStyle ||
+                    fontFace.descriptors.weight !== props.fontWeight) {
+                    fontFacesCopy.delete(fontFace);
+                }
+            }
+            // Return the first font face that matches the style exactly
+            return fontFacesCopy.values().next().value;
+        }, undefined);
+        return exactMatch || closeFaces[0];
+    }
+}
+//# sourceMappingURL=TrFontManager.js.map

package/dist/src/core/text-rendering/TrFontManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TrFontManager.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/TrFontManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAEjF,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAUnE,MAAM,OAAO,aAAa;IACJ;IAApB,YAAoB,aAAuC;QAAvC,kBAAa,GAAb,aAAa,CAA0B;QACzD,2BAA2B;IAC7B,CAAC;IAEM,WAAW,CAAC,IAAgB;QACjC,iEAAiE;QACjE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,IAA6B,CAAC,CAAC;YAC7D,IAAI,EAAE,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;gBACtC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;aACtB;SACF;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,eAAe,CAC3B,oBAAqC,EACrC,KAAkB;QAElB,MAAM,UAAU,GAAoB,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,oBAAoB,CAAC,MAAM,CAC5C,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE;YACpB,IAAI,IAAI,EAAE;gBACR,OAAO,IAAI,CAAC;aACb;YACD,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAChD,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;YAEzC,2DAA2D;YAC3D,iEAAiE;YACjE,oCAAoC;YACpC,mFAAmF;YACnF,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE;gBACpC,IACE,QAAQ,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC,WAAW;oBAClD,QAAQ,CAAC,WAAW,CAAC,KAAK,KAAK,KAAK,CAAC,SAAS;oBAC9C,QAAQ,CAAC,WAAW,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,EAChD;oBACA,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;iBAChC;aACF;YAED,4DAA4D;YAC5D,OAAO,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;QAC7C,CAAC,EACD,SAAS,CACV,CAAC;QAEF,OAAO,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;CACF"}

package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.d.ts

@@ -0,0 +1,29 @@
+import type { Stage } from '../../../Stage.js';
+import { ImageTexture } from '../../../textures/ImageTexture.js';
+import { TrFontFace, type TrFontFaceDescriptors } from '../TrFontFace.js';
+import type { FontShaper } from './internal/FontShaper.js';
+import { type SdfFontData } from './internal/SdfFontShaper.js';
+type SdfFontType = 'ssdf' | 'msdf';
+declare module '../TrFontFace.js' {
+    interface TrFontFaceMap {
+        ssdf: SdfTrFontFace<'ssdf'>;
+        msdf: SdfTrFontFace<'msdf'>;
+    }
+}
+interface GlyphAtlasEntry {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export declare class SdfTrFontFace<FontTypeT extends SdfFontType = SdfFontType> extends TrFontFace {
+    readonly type: FontTypeT;
+    readonly texture: ImageTexture;
+    readonly data: SdfFontData | undefined;
+    readonly shaper: FontShaper | undefined;
+    readonly glyphMap: Map<number, SdfFontData['chars'][0]>;
+    constructor(fontFamily: string, descriptors: Partial<TrFontFaceDescriptors>, type: FontTypeT, stage: Stage, atlasUrl: string, atlasDataUrl: string);
+    getAtlasEntry(glyphId: number): GlyphAtlasEntry;
+    private checkLoaded;
+}
+export {};

package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js

@@ -0,0 +1,88 @@
+/*
+ * 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 type { Renderer } from '../../../Renderer';
+import { assertTruthy } from '../../../../utils.js';
+import { WebGlCoreRenderer } from '../../../renderers/webgl/WebGlCoreRenderer.js';
+import { ImageTexture } from '../../../textures/ImageTexture.js';
+import { TrFontFace } from '../TrFontFace.js';
+import { SdfFontShaper } from './internal/SdfFontShaper.js';
+export class SdfTrFontFace extends TrFontFace {
+    type;
+    texture;
+    data;
+    shaper;
+    glyphMap = new Map();
+    constructor(fontFamily, descriptors, type, stage, atlasUrl, atlasDataUrl) {
+        super(fontFamily, descriptors);
+        this.type = type;
+        const renderer = stage.renderer;
+        assertTruthy(renderer instanceof WebGlCoreRenderer, 'SDF Font Faces can only be used with the WebGL Renderer');
+        this.texture = stage.txManager.loadTexture('ImageTexture', {
+            src: atlasUrl,
+            // IMPORTANT: The SDF shader requires the alpha channel to NOT be
+            // premultiplied on the atlas texture. If it is premultiplied, the
+            // rendering of SDF glyphs (especially single-channel SDF fonts) will
+            // be very jagged.
+            premultiplyAlpha: false,
+        }, {
+            preload: true,
+        });
+        // TODO: Add texture loaded support
+        // this.texture.on('loaded', () => {
+        //   this.checkLoaded();
+        // });
+        // Set this.data to the fetched data from dataUrl
+        fetch(atlasDataUrl)
+            .then(async (response) => {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.data = await response.json();
+            // We know `data` is defined here, because we just set it
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this.shaper = new SdfFontShaper(this.data);
+            // Add all the glyphs to the glyph map
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this.data.chars.forEach((glyph) => {
+                this.glyphMap.set(glyph.id, glyph);
+            });
+            this.checkLoaded();
+        })
+            .catch(console.error);
+    }
+    getAtlasEntry(glyphId) {
+        const glyph = this.glyphMap.get(glyphId);
+        if (glyph === undefined) {
+            throw new Error(`Glyph ${glyphId} not found in font ${this.fontFamily}`);
+        }
+        return {
+            x: glyph.x,
+            y: glyph.y,
+            width: glyph.width,
+            height: glyph.height,
+        };
+    }
+    checkLoaded() {
+        if (this.loaded)
+            return;
+        if ( /*this.texture.loaded && */this.data) {
+            this.loaded = true;
+            this.emit('loaded');
+        }
+    }
+}
+//# sourceMappingURL=SdfTrFontFace.js.map

package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdfTrFontFace.js","sourceRoot":"","sources":["../../../../../../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,qDAAqD;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,UAAU,EAA8B,MAAM,kBAAkB,CAAC;AAE1E,OAAO,EAAE,aAAa,EAAoB,MAAM,6BAA6B,CAAC;AAkB9E,MAAM,OAAO,aAEX,SAAQ,UAAU;IACF,IAAI,CAAY;IAChB,OAAO,CAAe;IACtB,IAAI,CAA0B;IAC9B,MAAM,CAAyB;IAC/B,QAAQ,GAAyC,IAAI,GAAG,EAAE,CAAC;IAE3E,YACE,UAAkB,EAClB,WAA2C,EAC3C,IAAe,EACf,KAAY,EACZ,QAAgB,EAChB,YAAoB;QAEpB,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,YAAY,CACV,QAAQ,YAAY,iBAAiB,EACrC,yDAAyD,CAC1D,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,CACxC,cAAc,EACd;YACE,GAAG,EAAE,QAAQ;YACb,iEAAiE;YACjE,kEAAkE;YAClE,qEAAqE;YACrE,kBAAkB;YAClB,gBAAgB,EAAE,KAAK;SACxB,EACD;YACE,OAAO,EAAE,IAAI;SACd,CACF,CAAC;QAEF,mCAAmC;QACnC,oCAAoC;QACpC,wBAAwB;QACxB,MAAM;QAEN,iDAAiD;QACjD,KAAK,CAAC,YAAY,CAAC;aAChB,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACvB,mEAAmE;YAClE,IAAI,CAAC,IAAoB,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnD,yDAAyD;YACzD,oEAAoE;YACnE,IAAI,CAAC,MAAqB,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,IAAK,CAAC,CAAC;YAC5D,sCAAsC;YACtC,oEAAoE;YACpE,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,CAAC,CAAC;aACD,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,aAAa,CAAC,OAAe;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,sBAAsB,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;SAC1E;QACD,OAAO;YACL,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB,CAAC;IACJ,CAAC;IAEO,WAAW;QACjB,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,KAAI,2BAA4B,IAAI,CAAC,IAAI,EAAE;YACxC,IAAI,CAAC,MAAkB,GAAG,IAAI,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACrB;IACH,CAAC;CACF"}

package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.d.ts

@@ -0,0 +1,103 @@
+import type { PeekableIterator } from '../../../renderers/SdfTextRenderer/internal/PeekableGenerator.js';
+/**
+ * HarfBuzz compatible glyph position info
+ */
+export interface GlyphPosition {
+    /**
+     * how much the line advances after drawing this glyph when setting text in horizontal direction.
+     */
+    xAdvance: number;
+    /**
+     * how much the line advances after drawing this glyph when setting text in vertical direction.
+     */
+    yAdvance: number;
+    /**
+     * how much the glyph moves on the X-axis before drawing it, this should not affect how much the line advances.
+     */
+    xOffset: number;
+    /**
+     * how much the glyph moves on the Y-axis before drawing it, this should not affect how much the line advances.
+     */
+    yOffset: number;
+}
+/**
+ * HarfBuzz compatible glyph info
+ */
+export interface GlyphInfo {
+    /**
+     * Glyph ID
+     */
+    glyphId: number;
+    /**
+     * First codepoint in the cluster this glyph was mapped from.
+     */
+    codepoint: number;
+    /**
+     * the index of the character in the original text that corresponds to this hb_glyph_info_t
+     * This is useful for mapping back from glyphs to characters.
+     */
+    cluster: number;
+}
+/**
+ * HarfBuzz compatible glyph extents
+ */
+export interface GlyphExtents {
+    /**
+     * The X offset from the origin to the leftmost part of the glyph.
+     * This is negative for right-to-left scripts.
+     */
+    xBearing: number;
+    /**
+     * The Y offset from the origin to the topmost part of the glyph.
+     * This is negative for bottom-to-top scripts.
+     */
+    yBearing: number;
+    /**
+     * Distance from the top extremum of the glyph to the bottom extremum.
+     * This is always positive.
+     */
+    width: number;
+    /**
+     * Distance from the left extremum of the glyph to the right extremum.
+     * This is always positive.
+     */
+    height: number;
+}
+export interface UnmappedCharacterInfo {
+    mapped: false;
+    /**
+     * The Unicode code point of the character.
+     */
+    codepoint: number;
+    /**
+     * The index of the character in the original text that corresponds to this hb_glyph_info_t
+     * This is useful for mapping back from glyphs to characters.
+     */
+    cluster: number;
+}
+export type MappedGlyphInfo = {
+    mapped: true;
+} & GlyphInfo & GlyphPosition & GlyphExtents;
+/**
+ * For performance reasons, all properties are required to reduce need for checking for undefined values.
+ */
+export interface FontShaperProps {
+    /**
+     * Letter spacing
+     *
+     * @default 0
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing
+     **/
+    letterSpacing: number;
+}
+export declare abstract class FontShaper {
+    /**
+     * Returns the glyph IDs of the next
+     *
+     * @remarks
+     * If this returns undefined, a glyph for the next codepoint(s) could not be found.
+     *
+     * @param codepoints
+     */
+    abstract shapeText(props: FontShaperProps, codepoints: PeekableIterator<number>): Generator<MappedGlyphInfo | UnmappedCharacterInfo, void>;
+}