@lightningjs/renderer 2.15.0 → 2.16.0

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

@@ -0,0 +1,212 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2025 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.
+ */
+/**
+ * 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);
+}
+/**
+ * Get the font metrics for a font face.
+ *
+ * @remarks
+ * This function will attempt to grab the explicitly defined metrics from the
+ * font face first. If the font face does not have metrics defined, it will
+ * attempt to calculate the metrics using the browser's measureText method.
+ *
+ * If the browser does not support the font metrics API, it will use some
+ * default values.
+ *
+ * @param context
+ * @param fontFace
+ * @param fontSize
+ * @returns
+ */
+export function calculateFontMetrics(context, fontFamily, fontSize) {
+    // If the font face doesn't have metrics defined, we fallback to using the
+    // browser's measureText method to calculate take a best guess at the font
+    // actual font's metrics.
+    // - fontBoundingBox[Ascent|Descent] is the best estimate but only supported
+    //   in Chrome 87+ (2020), Firefox 116+ (2023), and Safari 11.1+ (2018).
+    //   - It is an estimate as it can vary between browsers.
+    // - actualBoundingBox[Ascent|Descent] is less accurate and supported in
+    //   Chrome 77+ (2019), Firefox 74+ (2020), and Safari 11.1+ (2018).
+    // - If neither are supported, we'll use some default values which will
+    //   get text on the screen but likely not be great.
+    // NOTE: It's been decided not to rely on fontBoundingBox[Ascent|Descent]
+    // as it's browser support is limited and it also tends to produce higher than
+    // expected values. It is instead HIGHLY RECOMMENDED that developers provide
+    // explicit metrics in the font face definition.
+    const browserMetrics = context.measureText('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
+    console.warn(`Font metrics not provided for Canvas Web font ${fontFamily}. ` +
+        'Using fallback values. It is HIGHLY recommended you use the latest ' +
+        'version of the Lightning 3 `msdf-generator` tool to extract the default ' +
+        'metrics for the font and provide them in the Canvas Web font definition.');
+    let metrics;
+    if (browserMetrics.actualBoundingBoxDescent &&
+        browserMetrics.actualBoundingBoxAscent) {
+        metrics = {
+            ascender: browserMetrics.actualBoundingBoxAscent / fontSize,
+            descender: -browserMetrics.actualBoundingBoxDescent / fontSize,
+            lineGap: 0.2,
+        };
+    }
+    else {
+        // If the browser doesn't support the font metrics API, we'll use some
+        // default values.
+        metrics = {
+            ascender: 0.8,
+            descender: -0.2,
+            lineGap: 0.2,
+        };
+    }
+    return metrics;
+}
+/**
+ * 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=Utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/Utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH;;;;;;;;;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,CAAC;QACvB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACZ,CAAC;IAED,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAClB,6EAA6E;QAC7E,gBAAgB;QAChB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,GAAG,eAAe,CAAC;QAC1B,CAAC;QACD,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;YAChD,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;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,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC;IACxC,CAAC;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,CAAC;QACX,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC;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,CAAC;YAC3B,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;IACvD,CAAC,EAAE,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAqE,EACrE,UAAkB,EAClB,QAAgB;IAEhB,0EAA0E;IAC1E,0EAA0E;IAC1E,yBAAyB;IACzB,4EAA4E;IAC5E,wEAAwE;IACxE,yDAAyD;IACzD,wEAAwE;IACxE,oEAAoE;IACpE,uEAAuE;IACvE,oDAAoD;IACpD,yEAAyE;IACzE,8EAA8E;IAC9E,4EAA4E;IAC5E,gDAAgD;IAChD,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CACxC,sDAAsD,CACvD,CAAC;IACF,OAAO,CAAC,IAAI,CACV,iDAAiD,UAAU,IAAI;QAC7D,qEAAqE;QACrE,0EAA0E;QAC1E,0EAA0E,CAC7E,CAAC;IACF,IAAI,OAA8B,CAAC;IACnC,IACE,cAAc,CAAC,wBAAwB;QACvC,cAAc,CAAC,uBAAuB,EACtC,CAAC;QACD,OAAO,GAAG;YACR,QAAQ,EAAE,cAAc,CAAC,uBAAuB,GAAG,QAAQ;YAC3D,SAAS,EAAE,CAAC,cAAc,CAAC,wBAAwB,GAAG,QAAQ;YAC9D,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,sEAAsE;QACtE,kBAAkB;QAClB,OAAO,GAAG;YACR,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,CAAC,GAAG;YACf,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,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,CAAC;QACtC,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,CAAC;YACtC,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,CAAC;gBAC9C,wEAAwE;gBACxE,oCAAoC;gBACpC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACzB,MAAM,GAAG,EAAE,CAAC;gBACd,CAAC;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;YACjE,CAAC;iBAAM,CAAC;gBACN,SAAS,IAAI,kBAAkB,CAAC;gBAChC,MAAM,IAAI,KAAK,GAAG,IAAI,CAAC;YACzB,CAAC;QACH,CAAC;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,CAAC;YACzB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC;AAC1C,CAAC"}

package/dist/src/core/text-rendering/canvas/Settings.d.ts

@@ -0,0 +1,53 @@
+import type { RGBA } from '../../lib/utils.js';
+import type { TextAlign, TextBaseline, TextFontStyle, TextVerticalAlign, TextWordBreak } from '../TextRenderer.js';
+/**
+ * Text Overflow Values
+ */
+export type TextOverflow = 'ellipsis' | 'clip' | (string & Record<never, never>);
+/**
+ * Text Texture Settings
+ */
+export interface Settings {
+    w: number;
+    h: number;
+    text: string;
+    fontStyle: TextFontStyle;
+    fontSize: number;
+    fontBaselineRatio: number;
+    fontFamily: string | null;
+    wordWrap: boolean;
+    wordWrapWidth: number;
+    wordBreak: TextWordBreak;
+    textOverflow: TextOverflow | null;
+    lineHeight: number | null;
+    textBaseline: TextBaseline;
+    textAlign: TextAlign;
+    verticalAlign: TextVerticalAlign;
+    offsetY: number | null;
+    maxLines: number;
+    maxHeight: number | null;
+    overflowSuffix: string;
+    precision: number;
+    textColor: RGBA;
+    paddingLeft: number;
+    paddingRight: number;
+    shadow: boolean;
+    shadowColor: RGBA;
+    shadowOffsetX: number;
+    shadowOffsetY: number;
+    shadowBlur: number;
+    highlight: boolean;
+    highlightHeight: number;
+    highlightColor: RGBA;
+    highlightOffset: number;
+    highlightPaddingLeft: number;
+    highlightPaddingRight: number;
+    letterSpacing: number;
+    textIndent: number;
+    cutSx: number;
+    cutSy: number;
+    cutEx: number;
+    cutEy: number;
+    advancedRenderer: boolean;
+    textRenderIssueMargin: number;
+}

package/dist/src/core/text-rendering/canvas/Settings.js

@@ -0,0 +1,20 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2025 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.
+ */
+export {};
+//# sourceMappingURL=Settings.js.map

package/dist/src/core/text-rendering/canvas/Settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../../../src/core/text-rendering/canvas/Settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}

package/dist/src/core/text-rendering/canvas/Utils.d.ts

@@ -0,0 +1,19 @@
+import { TextBaseline, type NormalizedFontMetrics } from '../TextRenderer.js';
+export declare const measureText: (context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, word: string, space?: number) => number;
+export declare const wrapWord: (context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, word: string, wordWrapWidth: number, suffix: string, letterSpacing: number) => string;
+export declare const wrapText: (context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, text: string, wordWrapWidth: number, letterSpacing: number, indent: number) => {
+    l: string[];
+    n: number[];
+};
+export declare const isNormalizedFontMetrics: (obj: unknown) => obj is NormalizedFontMetrics;
+/**
+ * Calculate height for the canvas
+ *
+ * @param textBaseline
+ * @param fontSize
+ * @param lineHeight
+ * @param numLines
+ * @param offsetY
+ * @returns
+ */
+export declare const calcHeight: (textBaseline: TextBaseline, fontSize: number, lineHeight: number, numLines: number, offsetY: number | null) => number;

package/dist/src/core/text-rendering/canvas/Utils.js

@@ -0,0 +1,139 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2025 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 { TextBaseline } from '../TextRenderer.js';
+import { isZeroWidthSpace } from '../Utils.js';
+export const measureText = (context, word, space = 0) => {
+    if (space === 0) {
+        return context.measureText(word).width;
+    }
+    return word.split('').reduce((acc, char) => {
+        if (isZeroWidthSpace(char) === true) {
+            return acc;
+        }
+        return acc + context.measureText(char).width + space;
+    }, 0);
+};
+// Helper functions
+export const wrapWord = (context, word, wordWrapWidth, suffix, letterSpacing) => {
+    const suffixWidth = measureText(context, suffix, letterSpacing);
+    const wordLen = word.length;
+    const wordWidth = measureText(context, word, letterSpacing);
+    if (wordWidth <= wordWrapWidth) {
+        return word;
+    }
+    let cutoffIndex = Math.floor((wordWrapWidth * wordLen) / wordWidth);
+    let truncWordWidth = measureText(context, word.substring(0, cutoffIndex), letterSpacing) +
+        suffixWidth;
+    if (truncWordWidth > wordWrapWidth) {
+        while (cutoffIndex > 0) {
+            truncWordWidth =
+                measureText(context, word.substring(0, cutoffIndex), letterSpacing) +
+                    suffixWidth;
+            if (truncWordWidth > wordWrapWidth) {
+                cutoffIndex -= 1;
+            }
+            else {
+                break;
+            }
+        }
+    }
+    else {
+        while (cutoffIndex < wordLen) {
+            truncWordWidth =
+                measureText(context, word.substring(0, cutoffIndex), letterSpacing) +
+                    suffixWidth;
+            if (truncWordWidth < wordWrapWidth) {
+                cutoffIndex += 1;
+            }
+            else {
+                cutoffIndex -= 1;
+                break;
+            }
+        }
+    }
+    return (word.substring(0, cutoffIndex) +
+        (wordWrapWidth >= suffixWidth ? suffix : ''));
+};
+export const wrapText = (context, text, wordWrapWidth, letterSpacing, indent) => {
+    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 line = lines[i] ?? '';
+        const words = line.split(spaceRegex);
+        const spaces = line.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) {
+                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 };
+};
+export const isNormalizedFontMetrics = (obj) => {
+    return (typeof obj === 'object' &&
+        obj !== null &&
+        'ascender' in obj &&
+        typeof obj.ascender === 'number' &&
+        'descender' in obj &&
+        typeof obj.descender === 'number' &&
+        'lineGap' in obj &&
+        typeof obj.lineGap === 'number');
+};
+/**
+ * Calculate height for the canvas
+ *
+ * @param textBaseline
+ * @param fontSize
+ * @param lineHeight
+ * @param numLines
+ * @param offsetY
+ * @returns
+ */
+export const calcHeight = (textBaseline, fontSize, lineHeight, numLines, offsetY) => {
+    const baselineOffset = textBaseline !== TextBaseline.bottom ? 0.5 * fontSize : 0;
+    return (lineHeight * (numLines - 1) +
+        baselineOffset +
+        Math.max(lineHeight, fontSize) +
+        (offsetY || 0));
+};
+//# sourceMappingURL=Utils.js.map

package/dist/src/core/text-rendering/canvas/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../../src/core/text-rendering/canvas/Utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAA8B,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAAqE,EACrE,IAAY,EACZ,KAAK,GAAG,CAAC,EACT,EAAE;IACF,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACzC,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;IACvD,CAAC,EAAE,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AAEF,mBAAmB;AACnB,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,OAAqE,EACrE,IAAY,EACZ,aAAqB,EACrB,MAAc,EACd,aAAqB,EACrB,EAAE;IACF,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;IAC5B,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC5D,IAAI,SAAS,IAAI,aAAa,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,aAAa,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IACpE,IAAI,cAAc,GAChB,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,aAAa,CAAC;QACnE,WAAW,CAAC;IACd,IAAI,cAAc,GAAG,aAAa,EAAE,CAAC;QACnC,OAAO,WAAW,GAAG,CAAC,EAAE,CAAC;YACvB,cAAc;gBACZ,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,aAAa,CAAC;oBACnE,WAAW,CAAC;YACd,IAAI,cAAc,GAAG,aAAa,EAAE,CAAC;gBACnC,WAAW,IAAI,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,WAAW,GAAG,OAAO,EAAE,CAAC;YAC7B,cAAc;gBACZ,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,aAAa,CAAC;oBACnE,WAAW,CAAC;YACd,IAAI,cAAc,GAAG,aAAa,EAAE,CAAC;gBACnC,WAAW,IAAI,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,WAAW,IAAI,CAAC,CAAC;gBACjB,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,CACL,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC;QAC9B,CAAC,aAAa,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,OAAqE,EACrE,IAAY,EACZ,aAAqB,EACrB,aAAqB,EACrB,MAAc,EACd,EAAE;IACF,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,CAAC;QACtC,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,SAAS,GAAG,aAAa,GAAG,MAAM,CAAC;QACvC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5B,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,CAAC;gBAC9C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACzB,MAAM,GAAG,EAAE,CAAC;gBACd,CAAC;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;YACjE,CAAC;iBAAM,CAAC;gBACN,SAAS,IAAI,kBAAkB,CAAC;gBAChC,MAAM,IAAI,KAAK,GAAG,IAAI,CAAC;YACzB,CAAC;QACH,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,GAAG,EAAE,CAAC;QACZ,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,GAAY,EACkB,EAAE;IAChC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,UAAU,IAAI,GAAG;QACjB,OAAQ,GAA6B,CAAC,QAAQ,KAAK,QAAQ;QAC3D,WAAW,IAAI,GAAG;QAClB,OAAQ,GAA8B,CAAC,SAAS,KAAK,QAAQ;QAC7D,SAAS,IAAI,GAAG;QAChB,OAAQ,GAA4B,CAAC,OAAO,KAAK,QAAQ,CAC1D,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,YAA0B,EAC1B,QAAgB,EAChB,UAAkB,EAClB,QAAgB,EAChB,OAAsB,EACtB,EAAE;IACF,MAAM,cAAc,GAAG,YAAY,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,OAAO,CACL,UAAU,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;QAC3B,cAAc;QACd,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC;QAC9B,CAAC,OAAO,IAAI,CAAC,CAAC,CACf,CAAC;AACJ,CAAC,CAAC"}

package/dist/src/core/text-rendering/canvas/calculateRenderInfo.d.ts

@@ -0,0 +1,37 @@
+import { type NormalizedFontMetrics } from '../TextRenderer.js';
+import type { Settings } from './Settings.js';
+export interface RenderInfo {
+    w: number;
+    h: number;
+    lines: string[];
+    precision: number;
+    remainingText: string;
+    moreTextLines: boolean;
+    width: number;
+    innerWidth: number;
+    height: number;
+    fontSize: number;
+    cutSx: number;
+    cutSy: number;
+    cutEx: number;
+    cutEy: number;
+    lineHeight: number;
+    defLineHeight: number;
+    lineWidths: number[];
+    offsetY: number;
+    paddingLeft: number;
+    paddingRight: number;
+    letterSpacing: number;
+    textIndent: number;
+    metrics: NormalizedFontMetrics;
+}
+export interface LineType {
+    text: string;
+    x: number;
+    y: number;
+    w: number;
+}
+export declare function calculateRenderInfo({ context, settings, }: {
+    context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D;
+    settings: Settings;
+}): RenderInfo;