@lightningjs/renderer 0.7.5 → 0.8.0

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

@@ -1,139 +1,139 @@
-/*
- * 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';
-
-/**
- * HarfBuzz compatible glyph position info
- */
-export interface GlyphPosition {
-  /**
-   * how much the line advances after drawing this glyph when setting text in horizontal direction.
-   */
-  xAdvance: number;
-  /**
-   * how much the line advances after drawing this glyph when setting text in vertical direction.
-   */
-  yAdvance: number;
-  /**
-   * how much the glyph moves on the X-axis before drawing it, this should not affect how much the line advances.
-   */
-  xOffset: number;
-  /**
-   * how much the glyph moves on the Y-axis before drawing it, this should not affect how much the line advances.
-   */
-  yOffset: number;
-}
-
-/**
- * HarfBuzz compatible glyph info
- */
-export interface GlyphInfo {
-  /**
-   * Glyph ID
-   */
-  glyphId: number;
-
-  /**
-   * First codepoint in the cluster this glyph was mapped from.
-   */
-  codepoint: number;
-
-  /**
-   * the index of the character in the original text that corresponds to this hb_glyph_info_t
-   * This is useful for mapping back from glyphs to characters.
-   */
-  cluster: number;
-}
-
-/**
- * HarfBuzz compatible glyph extents
- */
-export interface GlyphExtents {
-  /**
-   * The X offset from the origin to the leftmost part of the glyph.
-   * This is negative for right-to-left scripts.
-   */
-  xBearing: number;
-
-  /**
-   * The Y offset from the origin to the topmost part of the glyph.
-   * This is negative for bottom-to-top scripts.
-   */
-  yBearing: number;
-
-  /**
-   * Distance from the top extremum of the glyph to the bottom extremum.
-   * This is always positive.
-   */
-  width: number;
-
-  /**
-   * Distance from the left extremum of the glyph to the right extremum.
-   * This is always positive.
-   */
-  height: number;
-}
-
-export interface UnmappedCharacterInfo {
-  mapped: false;
-
-  /**
-   * The Unicode code point of the character.
-   */
-  codepoint: number;
-
-  /**
-   * The index of the character in the original text that corresponds to this hb_glyph_info_t
-   * This is useful for mapping back from glyphs to characters.
-   */
-  cluster: number;
-}
-
-export type MappedGlyphInfo = { mapped: true } & GlyphInfo &
-  GlyphPosition &
-  GlyphExtents;
-
-/**
- * For performance reasons, all properties are required to reduce need for checking for undefined values.
- */
-export interface FontShaperProps {
-  /**
-   * Letter spacing
-   *
-   * @default 0
-   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing
-   **/
-  letterSpacing: number;
-}
-
-export abstract class FontShaper {
-  /**
-   * Returns the glyph IDs of the next
-   *
-   * @remarks
-   * If this returns undefined, a glyph for the next codepoint(s) could not be found.
-   *
-   * @param codepoints
-   */
-  abstract shapeText(
-    props: FontShaperProps,
-    codepoints: PeekableIterator<number>,
-  ): Generator<MappedGlyphInfo | UnmappedCharacterInfo, void>;
-}
+/*
+ * 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';
+
+/**
+ * HarfBuzz compatible glyph position info
+ */
+export interface GlyphPosition {
+  /**
+   * how much the line advances after drawing this glyph when setting text in horizontal direction.
+   */
+  xAdvance: number;
+  /**
+   * how much the line advances after drawing this glyph when setting text in vertical direction.
+   */
+  yAdvance: number;
+  /**
+   * how much the glyph moves on the X-axis before drawing it, this should not affect how much the line advances.
+   */
+  xOffset: number;
+  /**
+   * how much the glyph moves on the Y-axis before drawing it, this should not affect how much the line advances.
+   */
+  yOffset: number;
+}
+
+/**
+ * HarfBuzz compatible glyph info
+ */
+export interface GlyphInfo {
+  /**
+   * Glyph ID
+   */
+  glyphId: number;
+
+  /**
+   * First codepoint in the cluster this glyph was mapped from.
+   */
+  codepoint: number;
+
+  /**
+   * the index of the character in the original text that corresponds to this hb_glyph_info_t
+   * This is useful for mapping back from glyphs to characters.
+   */
+  cluster: number;
+}
+
+/**
+ * HarfBuzz compatible glyph extents
+ */
+export interface GlyphExtents {
+  /**
+   * The X offset from the origin to the leftmost part of the glyph.
+   * This is negative for right-to-left scripts.
+   */
+  xBearing: number;
+
+  /**
+   * The Y offset from the origin to the topmost part of the glyph.
+   * This is negative for bottom-to-top scripts.
+   */
+  yBearing: number;
+
+  /**
+   * Distance from the top extremum of the glyph to the bottom extremum.
+   * This is always positive.
+   */
+  width: number;
+
+  /**
+   * Distance from the left extremum of the glyph to the right extremum.
+   * This is always positive.
+   */
+  height: number;
+}
+
+export interface UnmappedCharacterInfo {
+  mapped: false;
+
+  /**
+   * The Unicode code point of the character.
+   */
+  codepoint: number;
+
+  /**
+   * The index of the character in the original text that corresponds to this hb_glyph_info_t
+   * This is useful for mapping back from glyphs to characters.
+   */
+  cluster: number;
+}
+
+export type MappedGlyphInfo = { mapped: true } & GlyphInfo &
+  GlyphPosition &
+  GlyphExtents;
+
+/**
+ * For performance reasons, all properties are required to reduce need for checking for undefined values.
+ */
+export interface FontShaperProps {
+  /**
+   * Letter spacing
+   *
+   * @default 0
+   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing
+   **/
+  letterSpacing: number;
+}
+
+export abstract class FontShaper {
+  /**
+   * Returns the glyph IDs of the next
+   *
+   * @remarks
+   * If this returns undefined, a glyph for the next codepoint(s) could not be found.
+   *
+   * @param codepoints
+   */
+  abstract shapeText(
+    props: FontShaperProps,
+    codepoints: PeekableIterator<number>,
+  ): Generator<MappedGlyphInfo | UnmappedCharacterInfo, void>;
+}

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

@@ -1,173 +1,173 @@
-/*
- * 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 { describe, expect, it } from 'vitest';
-
-import { PeekableIterator } from '../../../renderers/SdfTextRenderer/internal/PeekableGenerator.js';
-import { SdfFontShaper, type SdfFontData } from './SdfFontShaper.js';
-import { getUnicodeCodepoints } from '../../../renderers/SdfTextRenderer/internal/getUnicodeCodepoints.js';
-import sdfData from 'test/mockdata/Ubuntu-Bold.msdf.json';
-
-const glyphMap = new Map<number, SdfFontData['chars'][0]>();
-sdfData.chars.forEach((glyph) => {
-  glyphMap.set(glyph.id, glyph);
-});
-
-// TODO: Need tests for
-// - mapped = false
-
-describe('SdfFontShaper', () => {
-  it('should be able to shape text.', () => {
-    const shaper = new SdfFontShaper(
-      sdfData as unknown as SdfFontData,
-      glyphMap,
-    );
-    const peekableCodepoints = new PeekableIterator(
-      getUnicodeCodepoints('Hi!'),
-    );
-    const glyphs = shaper.shapeText({ letterSpacing: 0 }, peekableCodepoints);
-    // H
-    expect(glyphs.next().value).toEqual({
-      mapped: true,
-      codepoint: 72,
-      glyphId: 72,
-      cluster: 0,
-      width: 28,
-      height: 33,
-      xAdvance: 30.828,
-      yAdvance: 0,
-      xOffset: 1,
-      yOffset: 5.592,
-      xBearing: 0,
-      yBearing: 0,
-    });
-    // i
-    expect(glyphs.next().value).toEqual({
-      mapped: true,
-      codepoint: 105,
-      glyphId: 105,
-      cluster: 1,
-      width: 11,
-      height: 36,
-      xAdvance: 12.138,
-      yAdvance: 0,
-      xOffset: 0,
-      yOffset: 2.592,
-      xBearing: 0,
-      yBearing: 0,
-    });
-    // !
-    expect(glyphs.next().value).toEqual({
-      mapped: true,
-      codepoint: 33,
-      glyphId: 33,
-      cluster: 2,
-      width: 12,
-      height: 34,
-      xAdvance: 12.012,
-      yAdvance: 0,
-      xOffset: 0,
-      yOffset: 5.592,
-      xBearing: 0,
-      yBearing: 0,
-    });
-    expect(glyphs.next().done).toBe(true);
-  });
-
-  it('should be able to shape text that we know have kerning pairs.', () => {
-    const shaper = new SdfFontShaper(
-      sdfData as unknown as SdfFontData,
-      glyphMap,
-    );
-    const peekableCodepoints = new PeekableIterator(
-      getUnicodeCodepoints('WeVo'),
-    );
-    const glyphs = shaper.shapeText({ letterSpacing: 0 }, peekableCodepoints);
-    // W
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 87,
-        xAdvance: 39.816,
-        xOffset: -1,
-      }),
-    );
-    // e
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 101,
-        xAdvance: 24.528,
-        xOffset: 0,
-      }),
-    );
-    // V
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 86,
-        xAdvance: 30.324,
-        xOffset: -2,
-      }),
-    );
-    // o
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 111,
-        xAdvance: 23.184,
-        xOffset: -2.31,
-      }),
-    );
-
-    expect(glyphs.next().done).toBe(true);
-  });
-
-  it('should be able to shape text with letterSpacing.', () => {
-    const shaper = new SdfFontShaper(
-      sdfData as unknown as SdfFontData,
-      glyphMap,
-    );
-    const peekableCodepoints = new PeekableIterator(
-      getUnicodeCodepoints('We!'),
-    );
-    const glyphs = shaper.shapeText({ letterSpacing: 5 }, peekableCodepoints);
-    // W
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 87,
-        xAdvance: 39.816,
-        xOffset: -1,
-      }),
-    );
-    // e
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 101,
-        xAdvance: 29.528,
-        xOffset: 5,
-      }),
-    );
-    // !
-    expect(glyphs.next().value).toEqual(
-      expect.objectContaining({
-        codepoint: 33,
-        xAdvance: 17.012,
-        xOffset: 5,
-      }),
-    );
-    expect(glyphs.next().done).toBe(true);
-  });
-});
+/*
+ * 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 { describe, expect, it } from 'vitest';
+
+import { PeekableIterator } from '../../../renderers/SdfTextRenderer/internal/PeekableGenerator.js';
+import { SdfFontShaper, type SdfFontData } from './SdfFontShaper.js';
+import { getUnicodeCodepoints } from '../../../renderers/SdfTextRenderer/internal/getUnicodeCodepoints.js';
+import sdfData from 'test/mockdata/Ubuntu-Bold.msdf.json';
+
+const glyphMap = new Map<number, SdfFontData['chars'][0]>();
+sdfData.chars.forEach((glyph) => {
+  glyphMap.set(glyph.id, glyph);
+});
+
+// TODO: Need tests for
+// - mapped = false
+
+describe('SdfFontShaper', () => {
+  it('should be able to shape text.', () => {
+    const shaper = new SdfFontShaper(
+      sdfData as unknown as SdfFontData,
+      glyphMap,
+    );
+    const peekableCodepoints = new PeekableIterator(
+      getUnicodeCodepoints('Hi!'),
+    );
+    const glyphs = shaper.shapeText({ letterSpacing: 0 }, peekableCodepoints);
+    // H
+    expect(glyphs.next().value).toEqual({
+      mapped: true,
+      codepoint: 72,
+      glyphId: 72,
+      cluster: 0,
+      width: 28,
+      height: 33,
+      xAdvance: 30.828,
+      yAdvance: 0,
+      xOffset: 1,
+      yOffset: 5.592,
+      xBearing: 0,
+      yBearing: 0,
+    });
+    // i
+    expect(glyphs.next().value).toEqual({
+      mapped: true,
+      codepoint: 105,
+      glyphId: 105,
+      cluster: 1,
+      width: 11,
+      height: 36,
+      xAdvance: 12.138,
+      yAdvance: 0,
+      xOffset: 0,
+      yOffset: 2.592,
+      xBearing: 0,
+      yBearing: 0,
+    });
+    // !
+    expect(glyphs.next().value).toEqual({
+      mapped: true,
+      codepoint: 33,
+      glyphId: 33,
+      cluster: 2,
+      width: 12,
+      height: 34,
+      xAdvance: 12.012,
+      yAdvance: 0,
+      xOffset: 0,
+      yOffset: 5.592,
+      xBearing: 0,
+      yBearing: 0,
+    });
+    expect(glyphs.next().done).toBe(true);
+  });
+
+  it('should be able to shape text that we know have kerning pairs.', () => {
+    const shaper = new SdfFontShaper(
+      sdfData as unknown as SdfFontData,
+      glyphMap,
+    );
+    const peekableCodepoints = new PeekableIterator(
+      getUnicodeCodepoints('WeVo'),
+    );
+    const glyphs = shaper.shapeText({ letterSpacing: 0 }, peekableCodepoints);
+    // W
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 87,
+        xAdvance: 39.816,
+        xOffset: -1,
+      }),
+    );
+    // e
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 101,
+        xAdvance: 24.528,
+        xOffset: 0,
+      }),
+    );
+    // V
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 86,
+        xAdvance: 30.324,
+        xOffset: -2,
+      }),
+    );
+    // o
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 111,
+        xAdvance: 23.184,
+        xOffset: -2.31,
+      }),
+    );
+
+    expect(glyphs.next().done).toBe(true);
+  });
+
+  it('should be able to shape text with letterSpacing.', () => {
+    const shaper = new SdfFontShaper(
+      sdfData as unknown as SdfFontData,
+      glyphMap,
+    );
+    const peekableCodepoints = new PeekableIterator(
+      getUnicodeCodepoints('We!'),
+    );
+    const glyphs = shaper.shapeText({ letterSpacing: 5 }, peekableCodepoints);
+    // W
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 87,
+        xAdvance: 39.816,
+        xOffset: -1,
+      }),
+    );
+    // e
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 101,
+        xAdvance: 29.528,
+        xOffset: 5,
+      }),
+    );
+    // !
+    expect(glyphs.next().value).toEqual(
+      expect.objectContaining({
+        codepoint: 33,
+        xAdvance: 17.012,
+        xOffset: 5,
+      }),
+    );
+    expect(glyphs.next().done).toBe(true);
+  });
+});