@lightningjs/renderer 3.0.0-beta2 → 3.0.0-beta21

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

@@ -1,176 +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 type { Renderer } from '../../../Renderer';
-import { assertTruthy } from '../../../../utils.js';
-import type { Stage } from '../../../Stage.js';
-import { WebGlRenderer } from '../../../renderers/webgl/WebGlRenderer.js';
-import { ImageTexture } from '../../../textures/ImageTexture.js';
-import {
-  TrFontFace,
-  type NormalizedFontMetrics,
-  type TrFontFaceOptions,
-} from '../TrFontFace.js';
-import { fetchJson } from '../utils.js';
-import type { FontShaper } from './internal/FontShaper.js';
-import { SdfFontShaper, type SdfFontData } from './internal/SdfFontShaper.js';
-
-type SdfFontType = 'ssdf' | 'msdf';
-
-declare module '../TrFontFace.js' {
-  interface TrFontFaceMap {
-    ssdf: SdfTrFontFace<'ssdf'>;
-    msdf: SdfTrFontFace<'msdf'>;
-  }
-}
-
-interface GlyphAtlasEntry {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-export interface SdfTrFontFaceOptions extends TrFontFaceOptions {
-  atlasUrl: string;
-  atlasDataUrl: string;
-  stage: Stage;
-}
-
-export class SdfTrFontFace<
-  FontTypeT extends SdfFontType = SdfFontType,
-> extends TrFontFace {
-  public readonly type: FontTypeT;
-  public readonly texture: ImageTexture;
-  /**
-   * Height of the tallest character in the font including the whitespace above it
-   * in SDF/vertex units.
-   */
-  public readonly maxCharHeight: number = 0;
-  public readonly shaper: FontShaper | undefined;
-  public readonly glyphMap: Map<number, SdfFontData['chars'][0]> = new Map();
-  public data: SdfFontData | undefined;
-
-  constructor(type: FontTypeT, options: SdfTrFontFaceOptions) {
-    super(options);
-    const { atlasUrl, atlasDataUrl, stage } = options;
-    this.type = type;
-    const renderer = stage.renderer;
-    assertTruthy(
-      renderer instanceof WebGlRenderer,
-      'SDF Font Faces can only be used with the WebGL Renderer',
-    );
-
-    // Load image
-    this.texture = stage.txManager.createTexture('ImageTexture', {
-      src: atlasUrl,
-      // IMPORTANT: The SDF shader requires the alpha channel to NOT be
-      // premultiplied on the atlas texture. If it is premultiplied, the
-      // rendering of SDF glyphs (especially single-channel SDF fonts) will
-      // be very jagged.
-      premultiplyAlpha: false,
-    });
-
-    // Load the texture
-    stage.txManager.loadTexture(this.texture, true);
-
-    // FIXME This is a stop-gap solution to avoid Font Face textures to be cleaned up
-    // Ideally we do want to clean up the textures if they're not being used to save as much memory as possible
-    // However, we need to make sure that the font face is reloaded if the texture is cleaned up and needed again
-    // and make sure the SdfFontRenderer is properly guarded against textures being reloaded
-    // for now this will do the trick and the increase on memory is not that big
-    this.texture.preventCleanup = true;
-
-    this.texture.on('loaded', () => {
-      this.checkLoaded();
-      // Make sure we mark the stage for a re-render (in case the font's texture was freed and reloaded)
-      stage.requestRender();
-    });
-
-    // Set this.data to the fetched data from dataUrl
-    fetchJson(atlasDataUrl)
-      .then((response) => {
-        this.data = JSON.parse(response as unknown as string) as SdfFontData;
-        assertTruthy(this.data);
-        // Add all the glyphs to the glyph map
-
-        let maxCharHeight = 0;
-        this.data.chars.forEach((glyph) => {
-          this.glyphMap.set(glyph.id, glyph);
-          const charHeight = glyph.yoffset + glyph.height;
-          if (charHeight > maxCharHeight) {
-            maxCharHeight = charHeight;
-          }
-        });
-
-        (this.maxCharHeight as number) = maxCharHeight;
-        // We know `data` is defined here, because we just set it
-
-        (this.shaper as FontShaper) = new SdfFontShaper(
-          this.data,
-          this.glyphMap,
-        );
-
-        // If the metrics aren't provided explicitly in the font face options,
-        // Gather them from the metrics added by the msdf-generator tool ()
-        // If they are missing then we throw an error.
-        if (!this.metrics) {
-          if (this.data?.lightningMetrics) {
-            const { ascender, descender, lineGap, unitsPerEm } =
-              this.data.lightningMetrics;
-            (this.metrics as NormalizedFontMetrics | null) = {
-              ascender: ascender / unitsPerEm,
-              descender: descender / unitsPerEm,
-              lineGap: lineGap / unitsPerEm,
-            };
-          } else {
-            throw new Error(
-              `Font metrics not found in ${this.type} font ${this.fontFamily}. ` +
-                'Make sure you are using the latest version of the Lightning ' +
-                '3 `msdf-generator` tool to generate your SDF fonts.',
-            );
-          }
-        }
-
-        this.checkLoaded();
-      })
-      .catch(console.error);
-  }
-
-  getAtlasEntry(glyphId: number): GlyphAtlasEntry {
-    const glyph = this.glyphMap.get(glyphId);
-    if (glyph === undefined) {
-      throw new Error(`Glyph ${glyphId} not found in font ${this.fontFamily}`);
-    }
-    return {
-      x: glyph.x,
-      y: glyph.y,
-      width: glyph.width,
-      height: glyph.height,
-    };
-  }
-
-  private checkLoaded(): void {
-    if (this.loaded) return;
-    if (this.texture.state === 'loaded' && this.data) {
-      (this.loaded as boolean) = true;
-      this.emit('loaded');
-    }
-  }
-}

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

@@ -1,139 +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 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 +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 { 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);
-  });
-});

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

@@ -1,171 +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 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;
-}