@lightningjs/renderer 2.16.0 → 3.0.0-beta10

package/src/core/text-rendering/canvas/draw.ts

@@ -0,0 +1,165 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2025 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 { calcHeight, measureText } from './Utils.js';
+import type { RenderInfo } from './calculateRenderInfo.js';
+import type { LineType } from './calculateRenderInfo.js';
+import { normalizeCanvasColor } from '../../lib/colorCache.js';
+
+const MAX_TEXTURE_DIMENSION = 4096;
+
+export const draw = (
+  canvas: OffscreenCanvas | HTMLCanvasElement,
+  context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D,
+  renderInfo: RenderInfo,
+  linesOverride?: { lines: string[]; lineWidths: number[] },
+) => {
+  const fontSize = renderInfo.fontSize;
+  const lineHeight = renderInfo.lineHeight as number;
+  const precision = renderInfo.precision;
+  const lines = linesOverride?.lines || renderInfo.lines;
+  const lineWidths = linesOverride?.lineWidths || renderInfo.lineWidths;
+  const height =
+    linesOverride !== undefined
+      ? calcHeight(
+          renderInfo.textBaseline,
+          fontSize,
+          lineHeight,
+          linesOverride.lines.length,
+          0,
+        )
+      : renderInfo.height;
+
+  // Add extra margin to prevent issue with clipped text when scaling.
+  canvas.width = Math.min(
+    Math.ceil(renderInfo.width + renderInfo.textRenderIssueMargin),
+    MAX_TEXTURE_DIMENSION,
+  );
+  canvas.height = Math.min(Math.ceil(height), MAX_TEXTURE_DIMENSION);
+
+  // Canvas context has been reset.
+  context.font = `${renderInfo.fontStyle} ${fontSize}px ${renderInfo.fontFamily}`;
+  context.textBaseline = renderInfo.textBaseline;
+
+  if (fontSize >= 128) {
+    context.globalAlpha = 0.01;
+    context.fillRect(0, 0, 0.01, 0.01);
+    context.globalAlpha = 1.0;
+  }
+
+  if (renderInfo.cutSx || renderInfo.cutSy) {
+    context.translate(-renderInfo.cutSx, -renderInfo.cutSy);
+  }
+
+  let linePositionX: number;
+  let linePositionY: number;
+  const drawLines: LineType[] = [];
+  const metrics = renderInfo.metrics;
+  const ascenderPx = metrics ? metrics.ascender * fontSize : fontSize;
+  const bareLineHeightPx = metrics
+    ? (metrics.ascender - metrics.descender) * fontSize
+    : fontSize;
+
+  for (let i = 0, n = lines.length; i < n; i++) {
+    linePositionX = i === 0 ? renderInfo.textIndent : 0;
+    linePositionY = i * lineHeight + ascenderPx;
+    if (renderInfo.verticalAlign == 'middle') {
+      linePositionY += (lineHeight - bareLineHeightPx) / 2;
+    } else if (renderInfo.verticalAlign == 'bottom') {
+      linePositionY += lineHeight - bareLineHeightPx;
+    }
+    if (renderInfo.textAlign === 'right') {
+      linePositionX += renderInfo.innerWidth - lineWidths[i]!;
+    } else if (renderInfo.textAlign === 'center') {
+      linePositionX += (renderInfo.innerWidth - lineWidths[i]!) / 2;
+    }
+    linePositionX += renderInfo.paddingLeft;
+    drawLines.push({
+      text: lines[i]!,
+      x: linePositionX,
+      y: linePositionY,
+      w: lineWidths[i]!,
+    });
+  }
+
+  // Highlight
+  if (renderInfo.highlight) {
+    const color = renderInfo.highlightColor;
+    const hlHeight = renderInfo.highlightHeight * precision || fontSize * 1.5;
+    const offset = renderInfo.highlightOffset * precision;
+    const hlPaddingLeft =
+      renderInfo.highlightPaddingLeft !== null
+        ? renderInfo.highlightPaddingLeft * precision
+        : renderInfo.paddingLeft;
+    const hlPaddingRight =
+      renderInfo.highlightPaddingRight !== null
+        ? renderInfo.highlightPaddingRight * precision
+        : renderInfo.paddingRight;
+    context.fillStyle = normalizeCanvasColor(color);
+    for (let i = 0; i < drawLines.length; i++) {
+      const drawLine = drawLines[i]!;
+      context.fillRect(
+        drawLine.x - hlPaddingLeft,
+        drawLine.y - renderInfo.offsetY + offset,
+        drawLine.w + hlPaddingRight + hlPaddingLeft,
+        hlHeight,
+      );
+    }
+  }
+
+  // Text shadow
+  let prevShadowSettings: null | [string, number, number, number] = null;
+  if (renderInfo.shadow) {
+    prevShadowSettings = [
+      context.shadowColor,
+      context.shadowOffsetX,
+      context.shadowOffsetY,
+      context.shadowBlur,
+    ];
+    context.shadowColor = normalizeCanvasColor(renderInfo.shadowColor);
+    context.shadowOffsetX = renderInfo.shadowOffsetX * precision;
+    context.shadowOffsetY = renderInfo.shadowOffsetY * precision;
+    context.shadowBlur = renderInfo.shadowBlur * precision;
+  }
+
+  context.fillStyle = normalizeCanvasColor(renderInfo.textColor);
+  for (let i = 0, n = drawLines.length; i < n; i++) {
+    const drawLine = drawLines[i]!;
+    if (renderInfo.letterSpacing === 0) {
+      context.fillText(drawLine.text, drawLine.x, drawLine.y);
+    } else {
+      const textSplit = drawLine.text.split('');
+      let x = drawLine.x;
+      for (let i = 0, j = textSplit.length; i < j; i++) {
+        context.fillText(textSplit[i]!, x, drawLine.y);
+        x += measureText(context, textSplit[i]!, renderInfo.letterSpacing);
+      }
+    }
+  }
+
+  if (prevShadowSettings) {
+    context.shadowColor = prevShadowSettings[0];
+    context.shadowOffsetX = prevShadowSettings[1];
+    context.shadowOffsetY = prevShadowSettings[2];
+    context.shadowBlur = prevShadowSettings[3];
+  }
+
+  if (renderInfo.cutSx || renderInfo.cutSy) {
+    context.translate(renderInfo.cutSx, renderInfo.cutSy);
+  }
+};

package/src/core/text-rendering/sdf/Utils.test.ts

@@ -0,0 +1,402 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2025 Comcast Cable 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, it, expect, beforeAll, vi } from 'vitest';
+import {
+  wrapText,
+  wrapLine,
+  measureText,
+  truncateLineWithSuffix,
+  breakWord,
+} from './Utils.js';
+import * as SdfFontHandler from '../SdfFontHandler.js';
+
+// Mock font data for testing
+const mockFontData: SdfFontHandler.SdfFontData = {
+  info: {
+    face: 'Arial',
+    size: 16,
+    bold: 0,
+    italic: 0,
+    charset: [],
+    unicode: 1,
+    stretchH: 100,
+    smooth: 1,
+    aa: 1,
+    padding: [0, 0, 0, 0],
+    spacing: [0, 0],
+    outline: 0,
+  },
+  common: {
+    lineHeight: 20,
+    base: 16,
+    scaleW: 512,
+    scaleH: 512,
+    pages: 1,
+    packed: 0,
+    alphaChnl: 0,
+    redChnl: 0,
+    greenChnl: 0,
+    blueChnl: 0,
+  },
+  distanceField: {
+    fieldType: 'msdf',
+    distanceRange: 4,
+  },
+  pages: ['font.png'],
+  chars: [],
+  kernings: [],
+};
+
+// Mock SdfFontHandler functions
+const mockGetGlyph = (_fontFamily: string, codepoint: number) => {
+  // Mock glyph data - each character is 10 units wide for easy testing
+  return {
+    id: codepoint,
+    char: String.fromCharCode(codepoint),
+    x: 0,
+    y: 0,
+    width: 10,
+    height: 16,
+    xoffset: 0,
+    yoffset: 0,
+    xadvance: 10,
+    page: 0,
+    chnl: 0,
+  };
+};
+
+const mockGetKerning = () => {
+  // No kerning for simplicity
+  return 0;
+};
+
+describe('SDF Text Utils', () => {
+  beforeAll(() => {
+    // Mock the SdfFontHandler functions
+    vi.spyOn(SdfFontHandler, 'getGlyph').mockImplementation(mockGetGlyph);
+    vi.spyOn(SdfFontHandler, 'getKerning').mockImplementation(mockGetKerning);
+  });
+
+  describe('measureText', () => {
+    it('should measure text width correctly', () => {
+      const width = measureText('hello', 'Arial', 0);
+      expect(width).toBe(50); // 5 characters * 10 units each
+    });
+
+    it('should handle empty text', () => {
+      const width = measureText('', 'Arial', 0);
+      expect(width).toBe(0);
+    });
+
+    it('should account for letter spacing', () => {
+      const width = measureText('hello', 'Arial', 2);
+      expect(width).toBe(60); // 5 characters * 10 units + 5 * 2 letter spacing
+    });
+
+    it('should skip zero-width spaces', () => {
+      const width = measureText('hel\u200Blo', 'Arial', 0);
+      expect(width).toBe(50); // ZWSP should not contribute to width
+    });
+  });
+
+  describe('wrapLine', () => {
+    it('should wrap text that exceeds max width', () => {
+      const result = wrapLine(
+        'hello world test',
+        'Arial',
+        100, // maxWidth (10 characters at 10 units each)
+        0, // designLetterSpacing
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+
+      const [lines] = result;
+      const [line1] = lines![0]!;
+      const [line2] = lines![1]!;
+
+      expect(line1).toEqual('hello'); // Break at space, not ZWSP
+      expect(line2).toEqual('world test');
+    });
+
+    it('should handle single word that fits', () => {
+      const result = wrapLine(
+        'hello',
+        'Arial',
+        100,
+        0,
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result[0][0]).toEqual(['hello', 50]);
+    });
+
+    it('should break long words', () => {
+      const result = wrapLine(
+        'verylongwordthatdoesnotfit',
+        'Arial',
+        100, // Only 10 characters fit (each char = 10 units)
+        0,
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result.length).toBeGreaterThan(1);
+      // The first line should exist and be appropriately sized
+      expect(result[0]).toBeDefined();
+      if (result[0][0]) {
+        expect(result[0][0].length).toBeLessThanOrEqual(10);
+      }
+    });
+
+    it('should handle ZWSP as word break opportunity', () => {
+      // Test 1: ZWSP should provide break opportunity when needed
+      const result1 = wrapLine(
+        'hello\u200Bworld test',
+        'Arial',
+        100, // 10 characters max - 'helloworld' = 100 units (fits), ' test' = 50 units (exceeds)
+        0,
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+
+      const [lines] = result1;
+      const [line1] = lines![0]!;
+      const [line2] = lines![1]!;
+
+      expect(line1).toEqual('helloworld'); // Break at space, not ZWSP
+      expect(line2).toEqual('test');
+
+      // Test 2: ZWSP should NOT break when text fits on one line
+      const result2 = wrapLine(
+        'hi\u200Bthere',
+        'Arial',
+        200, // Wide enough for all text (7 characters = 70 units)
+        0,
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result2[0][0]).toEqual(['hithere', 70]); // ZWSP is invisible, no space added
+
+      // Test 3: ZWSP should break when it's the only break opportunity
+      const result3 = wrapLine(
+        'verylongword\u200Bmore',
+        'Arial',
+        100, // 10 characters max - forces break at ZWSP
+        0,
+        10, // spaceWidth
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result3.length).toBeGreaterThan(1); // Should break at ZWSP position
+      expect(result3[0][0]).toEqual(['verylongword', 120]);
+    });
+
+    it('should truncate with suffix when max lines reached', () => {
+      const result = wrapLine(
+        'hello world test more',
+        'Arial',
+        100,
+        0,
+        10, // spaceWidth
+        '...',
+        'normal',
+        1, // remainingLines = 1
+        false,
+      );
+      expect(result[0]).toHaveLength(1);
+      expect(result[0][0]?.[0]).toContain('...');
+    });
+  });
+
+  describe('wrapText', () => {
+    it('should wrap multiple lines', () => {
+      const result = wrapText(
+        'line one\nline two that is longer',
+        'Arial',
+        1.0,
+        100,
+        0,
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result[0].length).toBeGreaterThan(2);
+      expect(result[0][0]).toStrictEqual(['line one', 80]);
+    });
+
+    it('should handle empty lines', () => {
+      const result = wrapText(
+        'line one\n\nline three',
+        'Arial',
+        1.0,
+        100,
+        0,
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result[0][1]?.[0]).toBe('');
+    });
+
+    it('should respect max lines limit', () => {
+      const result = wrapText(
+        'line one\\nline two\\nline three\\nline four',
+        'Arial',
+        1.0,
+        100,
+        0,
+        '',
+        'normal',
+        2, // maxLines = 2
+        true,
+      );
+      const [lines] = result;
+      expect(lines).toHaveLength(2);
+    });
+  });
+
+  describe('truncateLineWithSuffix', () => {
+    it('should truncate line and add suffix', () => {
+      const result = truncateLineWithSuffix(
+        'this is a very long line',
+        'Arial',
+        100, // Max width for 10 characters
+        0,
+        '...',
+      );
+      expect(result).toContain('...');
+      expect(result.length).toBeLessThanOrEqual(10);
+    });
+
+    it('should return suffix if suffix is too long', () => {
+      const result = truncateLineWithSuffix(
+        'hello',
+        'Arial',
+        30, // Only 3 characters fit
+        0,
+        'verylongsuffix',
+      );
+      expect(result).toMatch(/verylongsuffi/); // Truncated suffix
+    });
+
+    it('should return original line with suffix (current behavior)', () => {
+      // Note: The current implementation always adds the suffix, even if the line fits.
+      // This is the expected behavior when used in overflow contexts where the suffix
+      // indicates that content was truncated at the line limit.
+      const result = truncateLineWithSuffix('short', 'Arial', 100, 0, '...');
+      expect(result).toBe('short...');
+    });
+  });
+
+  describe('breakLongWord', () => {
+    it('should break word into multiple lines', () => {
+      const result = breakWord(
+        'verylongword',
+        'Arial',
+        50, // 5 characters max per line
+        0,
+        0,
+        false,
+      );
+      expect(result[0].length).toBeGreaterThan(1);
+      expect(result[0][0]?.[0]).toHaveLength(5);
+    });
+
+    it('should handle single character word', () => {
+      const result = breakWord('a', 'Arial', 50, 0, 0, false);
+      expect(result[0][0]).toStrictEqual(['a', 10]);
+    });
+
+    it('should truncate with suffix when max lines reached', () => {
+      const result = breakWord(
+        'verylongword',
+        'Arial',
+        50,
+        0,
+        1, // remainingLines = 1
+        true,
+      );
+      expect(result[0]).toHaveLength(1);
+    });
+
+    it('should handle empty word', () => {
+      const result = breakWord('', 'Arial', 50, 0, 0, true);
+      expect(result[0]).toEqual([]);
+    });
+  });
+
+  describe('Integration tests', () => {
+    it('should handle complex text with ZWSP and wrapping', () => {
+      const text =
+        'This is a test\u200Bwith zero-width\u200Bspaces that should wrap properly';
+      const result = wrapText(
+        text,
+        'Arial',
+        1.0,
+        200, // 20 characters max per line
+        0,
+        '...',
+        'normal',
+        0,
+        false,
+      );
+      expect(result.length).toBeGreaterThan(1);
+      const [lines] = result;
+      // Should split at ZWSP and regular spaces
+      expect(lines.some((line) => line[0].includes('zero-width'))).toBe(true);
+    });
+
+    it('should handle mixed content with long words and ZWSP', () => {
+      const text = 'Short\u200Bverylongwordthatmustbebroken\u200Bshort';
+      const result = wrapText(
+        text,
+        'Arial',
+        1.0,
+        100, // 10 characters max per line
+        0,
+        '',
+        'normal',
+        0,
+        false,
+      );
+      expect(result.length).toBeGreaterThan(2);
+      expect(result[0][0]?.[0]).toBe('Short');
+      expect(result[0][result.length - 1]?.[0]).toBe('short');
+    });
+  });
+});