@lightningjs/renderer 3.0.0-beta11 → 3.0.0-beta13

package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js

@@ -1,71 +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 { updateWebSafeRadius, validateArrayLength4 } from './EffectUtils.js';
-import { ShaderEffect, } from './ShaderEffect.js';
-/**
- * Masks the current maskcolor with rounded corners similar to {@link RoundedRectangle}
- */
-export class RadiusEffect extends ShaderEffect {
-    static z$__type__Props;
-    name = 'radius';
-    static getEffectKey() {
-        return `radius`;
-    }
-    static uniforms = {
-        radius: {
-            value: 0,
-            method: 'uniform4fv',
-            type: 'vec4',
-            updateOnBind: true,
-            validator: validateArrayLength4,
-            updateProgramValue: updateWebSafeRadius,
-        },
-    };
-    static methods = {
-        fillMask: `
-      float function(float dist) {
-        return clamp(-dist, 0.0, 1.0);
-      }
-    `,
-        boxDist: `
-      float function(vec2 p, vec2 size, float radius) {
-        size -= vec2(radius);
-        vec2 d = abs(p) - size;
-        return min(max(d.x, d.y), 0.0) + length(max(d, 0.0)) - radius;
-      }
-    `,
-    };
-    static resolveDefaults(props) {
-        return {
-            radius: props.radius ?? 10,
-        };
-    }
-    static onShaderMask = `
-  vec2 halfDimensions = u_dimensions * 0.5;
-  float r = radius[0] * step(v_textureCoordinate.x, 0.5) * step(v_textureCoordinate.y, 0.5);
-  r = r + radius[1] * step(0.5, v_textureCoordinate.x) * step(v_textureCoordinate.y, 0.5);
-  r = r + radius[2] * step(0.5, v_textureCoordinate.x) * step(0.5, v_textureCoordinate.y);
-  r = r + radius[3] * step(v_textureCoordinate.x, 0.5) * step(0.5, v_textureCoordinate.y);
-  return $boxDist(v_textureCoordinate.xy * u_dimensions - halfDimensions, halfDimensions, r);
-  `;
-    static onEffectMask = `
-  return mix(vec4(0.0), maskColor, $fillMask(shaderMask));
-  `;
-}
-//# sourceMappingURL=RadiusEffect.js.map

package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RadiusEffect.js","sourceRoot":"","sources":["../../../../../../../src/core/renderers/webgl/shaders/effects/RadiusEffect.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EACL,YAAY,GAGb,MAAM,mBAAmB,CAAC;AA6B3B;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,MAAM,CAAC,eAAe,CAAoB;IACxB,IAAI,GAAG,QAAQ,CAAC;IAElC,MAAM,CAAU,YAAY;QAC1B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAU,QAAQ,GAAyB;QAC/C,MAAM,EAAE;YACN,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,IAAI;YAClB,SAAS,EAAE,oBAAoB;YAC/B,kBAAkB,EAAE,mBAAmB;SACxC;KACF,CAAC;IAEF,MAAM,CAAU,OAAO,GAA2B;QAChD,QAAQ,EAAE;;;;KAIT;QACD,OAAO,EAAE;;;;;;KAMR;KACF,CAAC;IAEF,MAAM,CAAU,eAAe,CAC7B,KAAwB;QAExB,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,YAAY,GAAG;;;;;;;GAO9B,CAAC;IAEF,MAAM,CAAU,YAAY,GAAG;;GAE9B,CAAC"}

package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts

@@ -1,115 +0,0 @@
-import type { EffectMap } from '../../../../CoreShaderManager.js';
-import type { ExtractProps } from '../../../../CoreTextureManager.js';
-import type { AlphaShaderProp, DimensionsShaderProp } from '../../WebGlCoreShader.js';
-import type { UniformInfo, UniformMethodMap } from '../../internal/ShaderUtils.js';
-export interface BaseEffectDesc {
-    name?: string;
-    type: keyof EffectMap;
-    props: Record<string, any>;
-}
-export interface EffectDesc<T extends {
-    name?: string;
-    type: keyof EffectMap;
-} = {
-    name?: string;
-    type: keyof EffectMap;
-}> extends BaseEffectDesc {
-    name?: T['name'];
-    type: T['type'];
-    props: ExtractProps<EffectMap[T['type']]>;
-}
-/**
- * Allows the `keyof EffectMap` to be mapped over and form an discriminated
- * union of all the EffectDescs structures individually.
- *
- * @remarks
- * When used like the following:
- * ```
- * MapEffectDescs<keyof EffectMap>[]
- * ```
- * The resultant type will be a discriminated union like so:
- * ```
- * (
- *   {
- *     name: 'effect1',
- *     type: 'radius',
- *     props?: {
- *       radius?: number | number[];
- *     }
- *   } |
- *   {
- *     name: 'effect2',
- *     type: 'border',
- *     props?: {
- *       width?: number;
- *       color?: number;
- *     }
- *   } |
- *   // ...
- * )[]
- * ```
- * Which means TypeScript will now base its type checking on the `type` field
- * and will know exactly what the `props` field should be based on the `type`
- * field.
- */
-type MapEffectDescs<T extends keyof EffectMap> = T extends keyof EffectMap ? EffectDesc<{
-    type: T;
-    name: string;
-}> : never;
-export type EffectDescUnion = MapEffectDescs<keyof EffectMap>;
-export interface ShaderEffectUniform {
-    value: number | number[] | boolean | string;
-    type: string;
-    method: keyof UniformMethodMap;
-    name?: string;
-    size?: (value: Record<string, unknown>) => number;
-    updateOnBind?: boolean;
-    updateProgramValue?: (programValues: ShaderEffectValueMap, shaderProps?: Record<string, unknown>) => void;
-    validator?: (value: any, props: Record<string, unknown>) => number | number[] | number[][];
-}
-export interface ShaderEffectValueMap extends DimensionsShaderProp, AlphaShaderProp {
-    value: ShaderEffectUniform['value'];
-    programValue: number | Float32Array | undefined;
-    method: keyof UniformMethodMap;
-    setUniformValue?: () => void | null;
-    hasValidator: boolean;
-    hasProgramValueUpdater: boolean;
-    updateOnBind: boolean;
-    validatedValue?: number | number[];
-}
-export interface ShaderEffectUniforms {
-    [key: string]: ShaderEffectUniform;
-}
-export interface DefaultEffectProps {
-    [key: string]: unknown;
-}
-export interface ShaderEffectOptions {
-    ref: string;
-    target: string;
-    props?: Record<string, unknown>;
-    uniforms?: ShaderEffectUniforms;
-    methods?: Record<string, string>;
-    onShaderMask?: ((value: Record<string, unknown>) => string) | string;
-    onColorize?: ((value: Record<string, unknown>) => string) | string;
-    onEffectMask?: ((value: Record<string, unknown>) => string) | string;
-}
-export declare abstract class ShaderEffect {
-    readonly priority = 1;
-    readonly name: string;
-    ref: string;
-    target: string;
-    passParameters: string;
-    declaredUniforms: string;
-    uniformInfo: Record<string, UniformInfo>;
-    static uniforms: ShaderEffectUniforms;
-    static methods?: Record<string, string>;
-    static onShaderMask?: ((value: Record<string, unknown>) => string) | string;
-    static onColorize?: ((value: Record<string, unknown>) => string) | string;
-    static onEffectMask?: ((value: Record<string, unknown>) => string) | string;
-    static getEffectKey(props: Record<string, unknown>): string;
-    static getMethodParameters(uniforms: ShaderEffectUniforms, props: Record<string, unknown>): string;
-    constructor(options: ShaderEffectOptions);
-    static resolveDefaults(props: Record<string, unknown>): Record<string, unknown>;
-    static makeEffectKey(props: Record<string, unknown>): string | false;
-}
-export {};

package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js

@@ -1,61 +0,0 @@
-export class ShaderEffect {
-    priority = 1;
-    name = '';
-    ref;
-    target;
-    passParameters = '';
-    declaredUniforms = '';
-    uniformInfo = {};
-    static uniforms = {};
-    static methods;
-    static onShaderMask;
-    static onColorize;
-    static onEffectMask;
-    static getEffectKey(props) {
-        return '';
-    }
-    static getMethodParameters(uniforms, props) {
-        const res = [];
-        for (const u in uniforms) {
-            const uni = uniforms[u];
-            let define = '';
-            if (uni.size) {
-                define = `[${uni.size(props)}]`;
-            }
-            res.push(`${uni.type} ${u}${define}`);
-        }
-        return res.join(',');
-    }
-    constructor(options) {
-        const { ref, target, props = {} } = options;
-        this.ref = ref;
-        this.target = target;
-        const uniformInfo = {};
-        const passParameters = [];
-        let declaredUniforms = '';
-        const uniforms = this.constructor.uniforms || {};
-        for (const u in uniforms) {
-            const unif = uniforms[u];
-            const uniType = unif.type;
-            //make unique uniform name
-            const uniformName = `${ref}_${u}`;
-            let define = '';
-            if (unif.size) {
-                define = `[${unif.size(props)}]`;
-            }
-            passParameters.push(uniformName);
-            declaredUniforms += `uniform ${uniType} ${uniformName}${define};`;
-            uniformInfo[u] = { name: uniformName, uniform: uniforms[u].method };
-        }
-        this.passParameters = passParameters.join(',');
-        this.declaredUniforms = declaredUniforms;
-        this.uniformInfo = uniformInfo;
-    }
-    static resolveDefaults(props) {
-        return {};
-    }
-    static makeEffectKey(props) {
-        return false;
-    }
-}
-//# sourceMappingURL=ShaderEffect.js.map

package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShaderEffect.js","sourceRoot":"","sources":["../../../../../../../src/core/renderers/webgl/shaders/effects/ShaderEffect.ts"],"names":[],"mappings":"AAsHA,MAAM,OAAgB,YAAY;IACvB,QAAQ,GAAG,CAAC,CAAC;IACb,IAAI,GAAW,EAAE,CAAC;IAE3B,GAAG,CAAS;IACZ,MAAM,CAAS;IAEf,cAAc,GAAG,EAAE,CAAC;IACpB,gBAAgB,GAAG,EAAE,CAAC;IACtB,WAAW,GAAgC,EAAE,CAAC;IAE9C,MAAM,CAAC,QAAQ,GAAyB,EAAE,CAAC;IAC3C,MAAM,CAAC,OAAO,CAA0B;IAExC,MAAM,CAAC,YAAY,CAAyD;IAE5E,MAAM,CAAC,UAAU,CAAyD;IAC1E,MAAM,CAAC,YAAY,CAAyD;IAE5E,MAAM,CAAC,YAAY,CAAC,KAA8B;QAChD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,CAAC,mBAAmB,CACxB,QAA8B,EAC9B,KAA8B;QAE9B,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;YACzB,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;gBACb,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;YAClC,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,YAAY,OAA4B;QACtC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;QAC5C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,WAAW,GAAgC,EAAE,CAAC;QACpD,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAI,IAAI,CAAC,WAAmC,CAAC,QAAQ,IAAI,EAAE,CAAC;QAE1E,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;YAC1B,0BAA0B;YAC1B,MAAM,WAAW,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;YAClC,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;YACnC,CAAC;YACD,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACjC,gBAAgB,IAAI,WAAW,OAAO,IAAI,WAAW,GAAG,MAAM,GAAG,CAAC;YAClE,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAE,CAAC,MAAM,EAAE,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,eAAe,CACpB,KAA8B;QAE9B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,KAA8B;QACjD,OAAO,KAAK,CAAC;IACf,CAAC"}

package/dist/src/core/shaders/templates/shaderUtils.d.ts

@@ -1,5 +0,0 @@
-import type { Vec4 } from '../../renderers/webgl/internal/ShaderUtils.js';
-export declare const validateArrayLength4: (value: number | number[]) => Vec4;
-export type PrefixedType<T, P extends string | undefined = undefined> = {
-    [Key in keyof T as P extends string ? `${P}-${string & Key}` : Key]: T[Key];
-};

package/dist/src/core/shaders/templates/shaderUtils.js

@@ -1,41 +0,0 @@
-/*
- * 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-import { assertTruthy } from '../../../utils.js';
-export const validateArrayLength4 = (value) => {
-    if (!Array.isArray(value)) {
-        return [value, value, value, value];
-    }
-    assertTruthy(value);
-    if (value.length === 4) {
-        return value;
-    }
-    if (value.length === 3) {
-        value[3] = value[0];
-        return value;
-    }
-    if (value.length === 2) {
-        value[2] = value[0];
-        value[3] = value[1];
-        return value;
-    }
-    value[0] = value[0] || 0;
-    value[1] = value[0];
-    value[2] = value[0];
-    value[3] = value[0];
-    return value;
-};
-//# sourceMappingURL=shaderUtils.js.map

package/dist/src/core/shaders/templates/shaderUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shaderUtils.js","sourceRoot":"","sources":["../../../../../src/core/shaders/templates/shaderUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAwB,EAAQ,EAAE;IACrE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IACD,YAAY,CAAC,KAAK,CAAC,CAAC;IACpB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAa,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,OAAO,KAAa,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,OAAO,KAAa,CAAC;IACvB,CAAC;IACD,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACzB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,KAAa,CAAC;AACvB,CAAC,CAAC"}

package/dist/src/core/shaders/webgl/Spinner.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/core/shaders/webgl/Spinner.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Spinner.js.map

package/dist/src/core/shaders/webgl/Spinner.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Spinner.js","sourceRoot":"","sources":["../../../../../src/core/shaders/webgl/Spinner.ts"],"names":[],"mappings":""}

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

@@ -1,12 +0,0 @@
-import type { NormalizedFontMetrics } from './font-face-types/TrFontFace.js';
-/**
- * Calculate the default line height given normalized font metrics
- *
- * @remarks
- * This method may be used for both the WebTrFontFace and SdfTrFontFace font types.
- *
- * @param metrics
- * @param fontSize
- * @returns
- */
-export declare function calcDefaultLineHeight(metrics: NormalizedFontMetrics, fontSize: number): number;

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

@@ -1,14 +0,0 @@
-/**
- * Calculate the default line height given normalized font metrics
- *
- * @remarks
- * This method may be used for both the WebTrFontFace and SdfTrFontFace font types.
- *
- * @param metrics
- * @param fontSize
- * @returns
- */
-export function calcDefaultLineHeight(metrics, fontSize) {
-    return fontSize * (metrics.ascender - metrics.descender + metrics.lineGap);
-}
-//# sourceMappingURL=TextRenderingUtils.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"TextRenderingUtils.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/TextRenderingUtils.ts"],"names":[],"mappings":"AAoBA;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAA8B,EAC9B,QAAgB;IAEhB,OAAO,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAC7E,CAAC"}

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

@@ -1,72 +0,0 @@
-import type { NormalizedFontMetrics } from './font-face-types/TrFontFace.js';
-import type { WebTrFontFace } from './font-face-types/WebTrFontFace.js';
-/**
- * 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;
-/**
- * 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 declare function getWebFontMetrics(context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D, fontFace: WebTrFontFace, fontSize: number): NormalizedFontMetrics;
-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

@@ -1,217 +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.
- */
-/**
- * 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 getWebFontMetrics(context, fontFace, fontSize) {
-    if (fontFace.metrics) {
-        return fontFace.metrics;
-    }
-    // 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 ${fontFace.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,
-        };
-    }
-    // Save the calculated metrics to the font face for future use.
-    fontFace.metrics = metrics;
-    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=TextTextureRendererUtils.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"TextTextureRendererUtils.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/TextTextureRendererUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAKH;;;;;;;;;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,GAAG,EAAE,CAAC;IACf,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,iBAAiB,CAC/B,OAAqE,EACrE,QAAuB,EACvB,QAAgB;IAEhB,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC1B,CAAC;IACD,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,QAAQ,CAAC,UAAU,IAAI;QACtE,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,+DAA+D;IAC9D,QAAQ,CAAC,OAAwC,GAAG,OAAO,CAAC;IAC7D,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"}