@lightningjs/renderer 3.0.0-beta15 → 3.0.0-beta17

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

@@ -1,118 +0,0 @@
-import { EventEmitter } from '../../../common/EventEmitter.js';
-/**
- * Augmentable map of font type IDs to font types
- *
- * @example
- * ```ts
- * declare module './TrFontFace' {
- *   interface TrFontFaceMap {
- *     canvas: CanvasTrFontFace;
- *   }
- * }
- * ```
- */
-export interface TrFontFaceMap {
-}
-/**
- * Descriptors defining a font face.
- *
- * Used when selecting a font face from a font family.
- *
- * @remarks
- * Based on the `@font-face` CSS rule. Not all descriptors are supported by all
- * text renderers.
- *
- * @see https://www.w3.org/TR/css-fonts-3/#font-face-rule
- */
-export interface TrFontFaceDescriptors {
-    style: 'normal' | 'italic' | 'oblique';
-    weight: 'normal' | 'bold' | number;
-    stretch: 'normal' | 'ultra-condensed' | 'extra-condensed' | 'condensed' | 'semi-condensed' | 'semi-expanded' | 'expanded' | 'extra-expanded' | 'ultra-expanded';
-    unicodeRange?: string;
-    display?: FontDisplay;
-    featureSettings?: string;
-}
-export interface FontMetrics {
-    /**
-     * The distance, in font units, from the baseline to the highest point of the font.
-     */
-    ascender: number;
-    /**
-     * The distance, in font units, from the baseline to the lowest point of the font.
-     */
-    descender: number;
-    /**
-     * The additional space used in the calculation of the default line height in font units.
-     */
-    lineGap: number;
-    /**
-     * The number of font units per 1 EM.
-     */
-    unitsPerEm: number;
-}
-export interface NormalizedFontMetrics {
-    /**
-     * The distance, as a fraction of 1 EM, from the baseline to the highest point of the font.
-     *
-     * @remarks
-     * This value should be positive.
-     */
-    ascender: number;
-    /**
-     * The distance, as a fraction of 1 EM, from the baseline to the lowest point of the font.
-     *
-     * @remarks
-     * This value should be positive.
-     */
-    descender: number;
-    /**
-     * The additional space used in the calculation of the default line height as a fraction of 1 EM
-     *
-     * @remarks
-     * This value should be positive.
-     */
-    lineGap: number;
-}
-export interface TrFontFaceOptions {
-    fontFamily: string;
-    descriptors: Partial<TrFontFaceDescriptors>;
-    /**
-     * Font metrics used for layout and default line height calculations.
-     *
-     * @remarks
-     * Provides the font metrics in order to ensure consistent text layout across
-     * different font types (Canvas/Web, SDF, etc.).
-     *
-     * **Important**: We HIGHLY recommend providing these metrics for both SDF
-     * and Web/Canvas fonts. You can use the Lightning 3 [msdf-generator](https://github.com/lightning-js/msdf-generator/)
-     * tool to generate these metrics from a font file. The metrics generated by
-     * this tool can be used with both SDF and Web/Canvas fonts.
-     *
-     * If not provided, a warning will be logged and the text layout may not be
-     * consistent across different font types.
-     *
-     * If not provided, the metrics will be gathered depending on the font type.
-     * - For SDF fonts, the metrics will be gathered from the font atlas data.
-     *   If the font is generated using Lightning 3's msdf-generator tool, the
-     *   metrics will be the most accurate.
-     * - For Web/Canvas fonts, the metrics will be gathered from the
-     *   CanvasRenderingContext2D.measureText() method. The accuracy/consistency
-     *   of these metrics depends on the browser implementation. And will not
-     *   guarantee the line-by-line alignment of text with SDF fonts.
-     */
-    metrics?: FontMetrics;
-}
-export declare class TrFontFace extends EventEmitter {
-    readonly fontFamily: string;
-    readonly descriptors: TrFontFaceDescriptors;
-    readonly loaded: boolean;
-    readonly metrics: NormalizedFontMetrics | null;
-    constructor(options: TrFontFaceOptions);
-    /**
-     * Convert a TrFontFaceDescriptors to a FontFaceDescriptors which differ slightly
-     *
-     * @param descriptors
-     * @returns
-     */
-    static convertToCssFontFaceDescriptors(descriptors: TrFontFaceDescriptors): FontFaceDescriptors;
-}

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

@@ -1,63 +0,0 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { EventEmitter } from '../../../common/EventEmitter.js';
-export class TrFontFace extends EventEmitter {
-    fontFamily;
-    descriptors;
-    loaded = false;
-    metrics = null;
-    constructor(options) {
-        super();
-        const { fontFamily, descriptors, metrics } = options;
-        if (metrics) {
-            // Normalize metrics to be in the range of 0 to 1
-            this.metrics = {
-                ascender: metrics.ascender / metrics.unitsPerEm,
-                descender: metrics.descender / metrics.unitsPerEm,
-                lineGap: metrics.lineGap / metrics.unitsPerEm,
-            };
-        }
-        this.fontFamily = fontFamily;
-        this.descriptors = {
-            style: 'normal',
-            weight: 'normal',
-            stretch: 'normal',
-            ...descriptors,
-        };
-    }
-    /**
-     * Convert a TrFontFaceDescriptors to a FontFaceDescriptors which differ slightly
-     *
-     * @param descriptors
-     * @returns
-     */
-    static convertToCssFontFaceDescriptors(descriptors) {
-        return {
-            style: descriptors.style,
-            weight: typeof descriptors.weight === 'number'
-                ? `${descriptors.weight}`
-                : descriptors.weight,
-            stretch: descriptors.stretch,
-            unicodeRange: descriptors.unicodeRange,
-            featureSettings: descriptors.featureSettings,
-            display: descriptors.display,
-        };
-    }
-}
-//# sourceMappingURL=TrFontFace.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"TrFontFace.js","sourceRoot":"","sources":["../../../../../src/core/text-rendering/font-face-types/TrFontFace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAuH/D,MAAM,OAAO,UAAW,SAAQ,YAAY;IAC1B,UAAU,CAAS;IACnB,WAAW,CAAwB;IACnC,MAAM,GAAY,KAAK,CAAC;IACxB,OAAO,GAAiC,IAAI,CAAC;IAE7D,YAAY,OAA0B;QACpC,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAErD,IAAI,OAAO,EAAE,CAAC;YACZ,iDAAiD;YACjD,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,UAAU;gBAC/C,SAAS,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,UAAU;gBACjD,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU;aAC9C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG;YACjB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,QAAQ;YACjB,GAAG,WAAW;SACf,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,+BAA+B,CAC3C,WAAkC;QAElC,OAAO;YACL,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,MAAM,EACJ,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ;gBACpC,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE;gBACzB,CAAC,CAAC,WAAW,CAAC,MAAM;YACxB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,YAAY,EAAE,WAAW,CAAC,YAAY;YACtC,eAAe,EAAE,WAAW,CAAC,eAAe;YAC5C,OAAO,EAAE,WAAW,CAAC,OAAO;SAC7B,CAAC;IACJ,CAAC;CACF"}

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

@@ -1,14 +0,0 @@
-import { TrFontFace, type TrFontFaceOptions } from './TrFontFace.js';
-declare module './TrFontFace.js' {
-    interface TrFontFaceMap {
-        web: WebTrFontFace;
-    }
-}
-export interface WebTrFontFaceOptions extends TrFontFaceOptions {
-    fontUrl: string;
-}
-export declare class WebTrFontFace extends TrFontFace {
-    readonly fontFace: FontFace;
-    readonly fontUrl: string;
-    constructor(options: WebTrFontFaceOptions);
-}

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

@@ -1,66 +0,0 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { TrFontFace, } from './TrFontFace.js';
-export class WebTrFontFace extends TrFontFace {
-    fontFace;
-    fontUrl;
-    constructor(options) {
-        super(options);
-        const { fontFamily, fontUrl } = options;
-        // Filter out parentheses from fontUrl
-        const fontUrlWithoutParentheses = fontUrl.replace(/\(|\)/g, '');
-        // Defaults for descriptors resolved in the super constructor
-        const determinedDescriptors = this.descriptors;
-        // Convert TrFontFaceDescriptors to CSS FontFaceDescriptors
-        let cssDescriptors = {
-            style: determinedDescriptors.style,
-            weight: typeof determinedDescriptors.weight === 'number'
-                ? `${determinedDescriptors.weight}`
-                : determinedDescriptors.weight,
-            stretch: determinedDescriptors.stretch,
-            unicodeRange: determinedDescriptors.unicodeRange,
-            featureSettings: determinedDescriptors.featureSettings,
-            display: determinedDescriptors.display,
-        };
-        for (const k in cssDescriptors) {
-            const key = k;
-            if (cssDescriptors[key] === undefined) {
-                delete cssDescriptors[key];
-            }
-        }
-        const fontFace = new FontFace(fontFamily, `url(${fontUrlWithoutParentheses})`, cssDescriptors);
-        if (fontUrlWithoutParentheses.length > 0) {
-            fontFace
-                .load()
-                .then(() => {
-                this.loaded = true;
-                this.emit('loaded');
-            })
-                .catch(console.error);
-        }
-        else {
-            // Default font
-            this.loaded = true;
-            this.emit('loaded');
-        }
-        this.fontFace = fontFace;
-        this.fontUrl = fontUrl;
-    }
-}
-//# sourceMappingURL=WebTrFontFace.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"WebTrFontFace.js","sourceRoot":"","sources":["../../../../../src/core/text-rendering/font-face-types/WebTrFontFace.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,UAAU,GAGX,MAAM,iBAAiB,CAAC;AAYzB,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3B,QAAQ,CAAW;IACnB,OAAO,CAAS;IAEhC,YAAY,OAA6B;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAExC,sCAAsC;QACtC,MAAM,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEhE,6DAA6D;QAC7D,MAAM,qBAAqB,GAAG,IAAI,CAAC,WAAW,CAAC;QAE/C,2DAA2D;QAC3D,IAAI,cAAc,GAAwB;YACxC,KAAK,EAAE,qBAAqB,CAAC,KAAK;YAClC,MAAM,EACJ,OAAO,qBAAqB,CAAC,MAAM,KAAK,QAAQ;gBAC9C,CAAC,CAAC,GAAG,qBAAqB,CAAC,MAAM,EAAE;gBACnC,CAAC,CAAC,qBAAqB,CAAC,MAAM;YAClC,OAAO,EAAE,qBAAqB,CAAC,OAAO;YACtC,YAAY,EAAE,qBAAqB,CAAC,YAAY;YAChD,eAAe,EAAE,qBAAqB,CAAC,eAAe;YACtD,OAAO,EAAE,qBAAqB,CAAC,OAAO;SACvC,CAAC;QAEF,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,CAA8B,CAAC;YAC3C,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;gBACtC,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,UAAU,EACV,OAAO,yBAAyB,GAAG,EACnC,cAAc,CACf,CAAC;QAEF,IAAI,yBAAyB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,QAAQ;iBACL,IAAI,EAAE;iBACN,IAAI,CAAC,GAAG,EAAE;gBACR,IAAI,CAAC,MAAkB,GAAG,IAAI,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC,CAAC;iBACD,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,eAAe;YACd,IAAI,CAAC,MAAkB,GAAG,IAAI,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF"}

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

@@ -1 +0,0 @@
-export declare function fetchJson(url: string, responseType?: XMLHttpRequestResponseType): Promise<unknown>;

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

@@ -1,38 +0,0 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2020 Metrological
- *
- * 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 function fetchJson(url, responseType = '') {
-    return new Promise((resolve, reject) => {
-        const xhr = new XMLHttpRequest();
-        xhr.responseType = responseType;
-        xhr.onreadystatechange = function () {
-            if (xhr.readyState == XMLHttpRequest.DONE) {
-                // On most devices like WebOS and Tizen, the file protocol returns 0 while http(s) protocol returns 200
-                if (xhr.status === 0 || xhr.status === 200) {
-                    resolve(xhr.response);
-                }
-                else {
-                    reject(xhr.statusText);
-                }
-            }
-        };
-        xhr.open('GET', url, true);
-        xhr.send(null);
-    });
-}
-//# sourceMappingURL=utils.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../src/core/text-rendering/font-face-types/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,SAAS,CACvB,GAAW,EACX,eAA2C,EAAE;IAE7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,GAAG,CAAC,YAAY,GAAG,YAAY,CAAC;QAChC,GAAG,CAAC,kBAAkB,GAAG;YACvB,IAAI,GAAG,CAAC,UAAU,IAAI,cAAc,CAAC,IAAI,EAAE,CAAC;gBAC1C,uGAAuG;gBACvG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBAC3C,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxB,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAC3B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts

@@ -1,59 +0,0 @@
-import type { CoreNode } from '../../CoreNode.js';
-import type { CoreTextNode } from '../../CoreTextNode.js';
-import type { Stage } from '../../Stage.js';
-import type { TrFontFace } from '../font-face-types/TrFontFace.js';
-import { WebTrFontFace } from '../font-face-types/WebTrFontFace.js';
-import { LightningTextTextureRenderer, type RenderInfo } from './LightningTextTextureRenderer.js';
-import { TextRenderer, type TextRendererState, type TrFontProps, type TrPropSetters, type TrProps } from './TextRenderer.js';
-declare module './TextRenderer.js' {
-    interface TextRendererMap {
-        canvas: CanvasTextRenderer;
-    }
-}
-export interface CanvasTextRendererState extends TextRendererState {
-    node: CoreTextNode;
-    props: TrProps;
-    fontInfo: {
-        fontFace: WebTrFontFace;
-        cssString: string;
-        loaded: boolean;
-    } | undefined;
-    textureNode: CoreNode | undefined;
-    lightning2TextRenderer: LightningTextTextureRenderer;
-    renderInfo: RenderInfo | undefined;
-}
-export declare class CanvasTextRenderer extends TextRenderer<CanvasTextRendererState> {
-    protected canvas: OffscreenCanvas | HTMLCanvasElement;
-    protected context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D;
-    /**
-     * Font family map used to store web font faces that were added to the
-     * canvas text renderer.
-     */
-    private fontFamilies;
-    private fontFamilyArray;
-    type: 'canvas' | 'sdf';
-    constructor(stage: Stage);
-    getPropertySetters(): Partial<TrPropSetters<CanvasTextRendererState>>;
-    canRenderFont(props: TrFontProps): boolean;
-    isFontFaceSupported(fontFace: TrFontFace): boolean;
-    addFontFace(fontFace: TrFontFace): void;
-    createState(props: TrProps, node: CoreTextNode): CanvasTextRendererState;
-    updateState(state: CanvasTextRendererState): void;
-    renderSingleCanvasPage(state: CanvasTextRendererState): void;
-    loadFont: (state: CanvasTextRendererState) => void;
-    calculateRenderInfo(state: CanvasTextRendererState): RenderInfo;
-    renderQuads(): void;
-    destroyState(state: CanvasTextRendererState): void;
-    /**
-     * Invalidate the layout cache stored in the state. This will cause the text
-     * to be re-rendered on the next update.
-     *
-     * @remarks
-     * This also invalidates the visible window cache.
-     *
-     * @param state
-     */
-    private invalidateLayoutCache;
-    private onFontLoaded;
-    private onFontLoadError;
-}