@lightningjs/renderer 3.0.0-beta4 → 3.0.0-beta6

package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts

@@ -1,171 +1,171 @@
-/*
- * 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 type { PeekableIterator } from '../../../renderers/SdfTextRenderer/internal/PeekableGenerator.js';
-import { SpecialCodepoints } from '../../../renderers/SdfTextRenderer/internal/SpecialCodepoints.js';
-import type { FontMetrics } from '../../TrFontFace.js';
-import {
-  FontShaper,
-  type FontShaperProps,
-  type MappedGlyphInfo,
-  type UnmappedCharacterInfo,
-} from './FontShaper.js';
-
-/**
- * Fast look up table for kernings
- */
-type KerningTable = Record<
-  number,
-  Record<number, number | undefined> | undefined
->;
-
-export class SdfFontShaper extends FontShaper {
-  private readonly data: SdfFontData;
-  private readonly glyphMap: Map<number, SdfFontData['chars'][0]>;
-  private readonly kernings: KerningTable;
-
-  constructor(
-    data: SdfFontData,
-    glyphMap: Map<number, SdfFontData['chars'][0]>,
-  ) {
-    super();
-    this.data = data;
-    this.glyphMap = glyphMap;
-
-    const kernings: KerningTable = (this.kernings = {});
-    data.kernings.forEach((kerning) => {
-      const second = kerning.second;
-      const firsts = (kernings[second] = kernings[second] || {});
-      firsts[kerning.first] = kerning.amount;
-    });
-    this.kernings = kernings;
-  }
-
-  *shapeText(
-    props: FontShaperProps,
-    codepoints: PeekableIterator<number>,
-  ): Generator<MappedGlyphInfo | UnmappedCharacterInfo, void> {
-    let codepointResult: IteratorResult<number>;
-    let lastGlyphId: number | undefined = undefined;
-    while ((codepointResult = codepoints.peek()) && !codepointResult.done) {
-      const codepoint = codepointResult.value;
-      const glyph = this.glyphMap.get(codepoint);
-      codepoints.next();
-      if (glyph !== undefined) {
-        // We found a glyph for this codepoint
-        // Yield the mapped glyph info
-
-        /**
-         * Kerning includes any possible additional letter spacing
-         */
-        const kerning =
-          lastGlyphId !== undefined
-            ? (this.kernings[glyph.id]?.[lastGlyphId] || 0) +
-              props.letterSpacing
-            : 0;
-
-        lastGlyphId = glyph.id;
-        yield {
-          mapped: true,
-          glyphId: glyph.id,
-          codepoint,
-          cluster: codepoints.lastIndex,
-          xAdvance: glyph.xadvance + kerning,
-          yAdvance: 0,
-          xOffset: glyph.xoffset + kerning,
-          yOffset: glyph.yoffset,
-          xBearing: 0,
-          yBearing: 0,
-          width: glyph.width,
-          height: glyph.height,
-        };
-      } else {
-        // We didn't find a glyph for this codepoint
-        // Yield the unmapped codepoint info
-
-        // If this codepoint is a linebreak, we should reset the last glyph id
-        // so that the next glyph will not be kerned with the last glyph of the
-        // previous line.
-        if (codepoint === SpecialCodepoints.LINE_FEED) {
-          lastGlyphId = undefined;
-        }
-        yield {
-          mapped: false,
-          codepoint,
-          cluster: codepoints.lastIndex,
-        };
-      }
-    }
-  }
-}
-
-export interface SdfFontData {
-  pages: string[];
-  chars: Array<{
-    id: number;
-    char: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    xoffset: number;
-    yoffset: number;
-    xadvance: number;
-    page: number;
-    chnl: number;
-  }>;
-
-  kernings: Array<{
-    first: number;
-    second: number;
-    amount: number;
-  }>;
-  info: {
-    face: string;
-    size: number;
-    bold: number;
-    italic: number;
-    charset: string[];
-    unicode: number;
-    stretchH: number;
-    smooth: number;
-    aa: number;
-    padding: [number, number, number, number]; // [up, right, down, left]
-    spacing: [number, number]; // [horizontal, vertical]
-    outline: number;
-  };
-  common: {
-    lineHeight: number;
-    base: number;
-    scaleW: number;
-    scaleH: number;
-    pages: number;
-    packed: number;
-    alphaChnl: number;
-    redChnl: number;
-    greenChnl: number;
-    blueChnl: number;
-  };
-  distanceField: {
-    // msdf-bmfont-xml uses the string 'sdf' for single-channel SDF.
-    fieldType: 'sdf' | 'msdf';
-    distanceRange: number;
-  };
-  lightningMetrics?: FontMetrics;
-}
+/*
+ * 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 type { PeekableIterator } from '../../../renderers/SdfTextRenderer/internal/PeekableGenerator.js';
+import { SpecialCodepoints } from '../../../renderers/SdfTextRenderer/internal/SpecialCodepoints.js';
+import type { FontMetrics } from '../../TrFontFace.js';
+import {
+  FontShaper,
+  type FontShaperProps,
+  type MappedGlyphInfo,
+  type UnmappedCharacterInfo,
+} from './FontShaper.js';
+
+/**
+ * Fast look up table for kernings
+ */
+type KerningTable = Record<
+  number,
+  Record<number, number | undefined> | undefined
+>;
+
+export class SdfFontShaper extends FontShaper {
+  private readonly data: SdfFontData;
+  private readonly glyphMap: Map<number, SdfFontData['chars'][0]>;
+  private readonly kernings: KerningTable;
+
+  constructor(
+    data: SdfFontData,
+    glyphMap: Map<number, SdfFontData['chars'][0]>,
+  ) {
+    super();
+    this.data = data;
+    this.glyphMap = glyphMap;
+
+    const kernings: KerningTable = (this.kernings = {});
+    data.kernings.forEach((kerning) => {
+      const second = kerning.second;
+      const firsts = (kernings[second] = kernings[second] || {});
+      firsts[kerning.first] = kerning.amount;
+    });
+    this.kernings = kernings;
+  }
+
+  *shapeText(
+    props: FontShaperProps,
+    codepoints: PeekableIterator<number>,
+  ): Generator<MappedGlyphInfo | UnmappedCharacterInfo, void> {
+    let codepointResult: IteratorResult<number>;
+    let lastGlyphId: number | undefined = undefined;
+    while ((codepointResult = codepoints.peek()) && !codepointResult.done) {
+      const codepoint = codepointResult.value;
+      const glyph = this.glyphMap.get(codepoint);
+      codepoints.next();
+      if (glyph !== undefined) {
+        // We found a glyph for this codepoint
+        // Yield the mapped glyph info
+
+        /**
+         * Kerning includes any possible additional letter spacing
+         */
+        const kerning =
+          lastGlyphId !== undefined
+            ? (this.kernings[glyph.id]?.[lastGlyphId] || 0) +
+              props.letterSpacing
+            : 0;
+
+        lastGlyphId = glyph.id;
+        yield {
+          mapped: true,
+          glyphId: glyph.id,
+          codepoint,
+          cluster: codepoints.lastIndex,
+          xAdvance: glyph.xadvance + kerning,
+          yAdvance: 0,
+          xOffset: glyph.xoffset + kerning,
+          yOffset: glyph.yoffset,
+          xBearing: 0,
+          yBearing: 0,
+          width: glyph.width,
+          height: glyph.height,
+        };
+      } else {
+        // We didn't find a glyph for this codepoint
+        // Yield the unmapped codepoint info
+
+        // If this codepoint is a linebreak, we should reset the last glyph id
+        // so that the next glyph will not be kerned with the last glyph of the
+        // previous line.
+        if (codepoint === SpecialCodepoints.LINE_FEED) {
+          lastGlyphId = undefined;
+        }
+        yield {
+          mapped: false,
+          codepoint,
+          cluster: codepoints.lastIndex,
+        };
+      }
+    }
+  }
+}
+
+export interface SdfFontData {
+  pages: string[];
+  chars: Array<{
+    id: number;
+    char: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    xoffset: number;
+    yoffset: number;
+    xadvance: number;
+    page: number;
+    chnl: number;
+  }>;
+
+  kernings: Array<{
+    first: number;
+    second: number;
+    amount: number;
+  }>;
+  info: {
+    face: string;
+    size: number;
+    bold: number;
+    italic: number;
+    charset: string[];
+    unicode: number;
+    stretchH: number;
+    smooth: number;
+    aa: number;
+    padding: [number, number, number, number]; // [up, right, down, left]
+    spacing: [number, number]; // [horizontal, vertical]
+    outline: number;
+  };
+  common: {
+    lineHeight: number;
+    base: number;
+    scaleW: number;
+    scaleH: number;
+    pages: number;
+    packed: number;
+    alphaChnl: number;
+    redChnl: number;
+    greenChnl: number;
+    blueChnl: number;
+  };
+  distanceField: {
+    // msdf-bmfont-xml uses the string 'sdf' for single-channel SDF.
+    fieldType: 'sdf' | 'msdf';
+    distanceRange: number;
+  };
+  lightningMetrics?: FontMetrics;
+}