@lightningjs/renderer 0.7.2 → 0.7.4

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

@@ -1,114 +1,114 @@
-import type {
-  UniformInfo,
-  UniformMethodMap,
-} from '../../internal/ShaderUtils.js';
-
-export interface ShaderEffectUniform {
-  value: number | number[] | boolean | string;
-  type: string;
-  method: keyof UniformMethodMap;
-  name?: string;
-  size?: (value: Record<string, unknown>) => number;
-  validator?: (
-    value: any,
-    props: Record<string, unknown>,
-  ) => number | 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 abstract class ShaderEffect {
-  readonly priority = 1;
-  readonly name: string = '';
-
-  ref: string;
-  target: string;
-
-  passParameters = '';
-  declaredUniforms = '';
-  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 {
-    return '';
-  }
-
-  static getMethodParameters(
-    uniforms: ShaderEffectUniforms,
-    props: Record<string, unknown>,
-  ): string {
-    const res: string[] = [];
-    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: ShaderEffectOptions) {
-    const { ref, target, props = {} } = options;
-    this.ref = ref;
-    this.target = target;
-
-    const uniformInfo: Record<string, UniformInfo> = {};
-    const passParameters: string[] = [];
-    let declaredUniforms = '';
-    const uniforms = (this.constructor as typeof ShaderEffect).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: Record<string, unknown>,
-  ): Record<string, unknown> {
-    return {};
-  }
-
-  static makeEffectKey(props: Record<string, unknown>): string | false {
-    return false;
-  }
-}
+import type {
+  UniformInfo,
+  UniformMethodMap,
+} from '../../internal/ShaderUtils.js';
+
+export interface ShaderEffectUniform {
+  value: number | number[] | boolean | string;
+  type: string;
+  method: keyof UniformMethodMap;
+  name?: string;
+  size?: (value: Record<string, unknown>) => number;
+  validator?: (
+    value: any,
+    props: Record<string, unknown>,
+  ) => number | 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 abstract class ShaderEffect {
+  readonly priority = 1;
+  readonly name: string = '';
+
+  ref: string;
+  target: string;
+
+  passParameters = '';
+  declaredUniforms = '';
+  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 {
+    return '';
+  }
+
+  static getMethodParameters(
+    uniforms: ShaderEffectUniforms,
+    props: Record<string, unknown>,
+  ): string {
+    const res: string[] = [];
+    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: ShaderEffectOptions) {
+    const { ref, target, props = {} } = options;
+    this.ref = ref;
+    this.target = target;
+
+    const uniformInfo: Record<string, UniformInfo> = {};
+    const passParameters: string[] = [];
+    let declaredUniforms = '';
+    const uniforms = (this.constructor as typeof ShaderEffect).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: Record<string, unknown>,
+  ): Record<string, unknown> {
+    return {};
+  }
+
+  static makeEffectKey(props: Record<string, unknown>): string | false {
+    return false;
+  }
+}

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

@@ -1,189 +1,189 @@
-/*
- * 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: string | string[],
-  fontStyle: string,
-  fontSize: number,
-  precision: number,
-  defaultFontFace: string,
-): string {
-  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: string): boolean {
-  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: string): boolean {
-  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: RegExp, text: string): string[] {
-  const delimeters = text.match(tokenRegex) || [];
-  const words = text.split(tokenRegex) || [];
-
-  const final: string[] = [];
-  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: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D,
-  word: string,
-  space = 0,
-): number {
-  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);
-}
-
-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 function wrapText(
-  context: CanvasRenderingContext2D,
-  text: string,
-  wordWrapWidth: number,
-  letterSpacing: number,
-  indent: number,
-): WrapTextResult {
-  // 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: string[] = [];
-  const realNewlines: number[] = [];
-  for (let i = 0; i < lines.length; i++) {
-    const resultLines: string[] = [];
-    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 };
-}
+/*
+ * 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: string | string[],
+  fontStyle: string,
+  fontSize: number,
+  precision: number,
+  defaultFontFace: string,
+): string {
+  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: string): boolean {
+  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: string): boolean {
+  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: RegExp, text: string): string[] {
+  const delimeters = text.match(tokenRegex) || [];
+  const words = text.split(tokenRegex) || [];
+
+  const final: string[] = [];
+  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: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D,
+  word: string,
+  space = 0,
+): number {
+  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);
+}
+
+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 function wrapText(
+  context: CanvasRenderingContext2D,
+  text: string,
+  wordWrapWidth: number,
+  letterSpacing: number,
+  indent: number,
+): WrapTextResult {
+  // 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: string[] = [];
+  const realNewlines: number[] = [];
+  for (let i = 0; i < lines.length; i++) {
+    const resultLines: string[] = [];
+    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 };
+}