@lightningjs/renderer 0.7.5 → 0.8.0

package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts

@@ -1,48 +1,48 @@
-/*
- * 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 './PeekableGenerator.js';
-
-describe('PeekableIterator', () => {
-  it('should be able to peek at the next value.', () => {
-    const iterator = new PeekableIterator([1, 2, 3].values());
-    expect(iterator.peek()).toEqual({ done: false, value: 1 });
-    expect(iterator.next()).toEqual({ done: false, value: 1 });
-    expect(iterator.peek()).toEqual({ done: false, value: 2 });
-    expect(iterator.next()).toEqual({ done: false, value: 2 });
-    expect(iterator.peek()).toEqual({ done: false, value: 3 });
-    expect(iterator.next()).toEqual({ done: false, value: 3 });
-    expect(iterator.peek()).toEqual({ done: true, value: undefined });
-    expect(iterator.next()).toEqual({ done: true, value: undefined });
-  });
-
-  it('should be able to return the last index of the iterator.', () => {
-    const iterator = new PeekableIterator([1, 2, 3].values());
-    expect(iterator.lastIndex).toBe(-1);
-    iterator.next();
-    expect(iterator.lastIndex).toBe(0);
-    iterator.next();
-    expect(iterator.lastIndex).toBe(1);
-    iterator.next();
-    expect(iterator.lastIndex).toBe(2);
-    iterator.next();
-    expect(iterator.lastIndex).toBe(-1);
-  });
-});
+/*
+ * 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 './PeekableGenerator.js';
+
+describe('PeekableIterator', () => {
+  it('should be able to peek at the next value.', () => {
+    const iterator = new PeekableIterator([1, 2, 3].values());
+    expect(iterator.peek()).toEqual({ done: false, value: 1 });
+    expect(iterator.next()).toEqual({ done: false, value: 1 });
+    expect(iterator.peek()).toEqual({ done: false, value: 2 });
+    expect(iterator.next()).toEqual({ done: false, value: 2 });
+    expect(iterator.peek()).toEqual({ done: false, value: 3 });
+    expect(iterator.next()).toEqual({ done: false, value: 3 });
+    expect(iterator.peek()).toEqual({ done: true, value: undefined });
+    expect(iterator.next()).toEqual({ done: true, value: undefined });
+  });
+
+  it('should be able to return the last index of the iterator.', () => {
+    const iterator = new PeekableIterator([1, 2, 3].values());
+    expect(iterator.lastIndex).toBe(-1);
+    iterator.next();
+    expect(iterator.lastIndex).toBe(0);
+    iterator.next();
+    expect(iterator.lastIndex).toBe(1);
+    iterator.next();
+    expect(iterator.lastIndex).toBe(2);
+    iterator.next();
+    expect(iterator.lastIndex).toBe(-1);
+  });
+});

package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts

@@ -1,66 +1,66 @@
-/*
- * 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.
- */
-
-/**
- * A wrapper Generator class that makes a generator peekable.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class PeekableIterator<T = unknown, TReturn = any, TNext = unknown>
-  implements Iterator<T, TReturn, TNext>
-{
-  private peekBuffer: IteratorResult<T, TReturn>[] = [];
-  private _lastIndex;
-
-  constructor(private iterator: Iterator<T, TReturn, TNext>, indexBase = 0) {
-    this.iterator = iterator;
-    this._lastIndex = indexBase - 1;
-    this.peekBuffer = [];
-  }
-
-  next(): IteratorResult<T, TReturn> {
-    const nextResult =
-      this.peekBuffer.length > 0
-        ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          this.peekBuffer.pop()!
-        : this.iterator.next();
-
-    if (nextResult.done) {
-      this._lastIndex = -1;
-    } else {
-      this._lastIndex++;
-    }
-    return nextResult;
-  }
-
-  peek(): IteratorResult<T, TReturn> {
-    if (this.peekBuffer.length > 0) {
-      // We know that the buffer is not empty, so we can safely use the
-      // non-null assertion operator
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      return this.peekBuffer[0]!;
-    }
-    const result = this.iterator.next();
-    this.peekBuffer.push(result);
-    return result;
-  }
-
-  get lastIndex(): number {
-    return this._lastIndex;
-  }
-}
+/*
+ * 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.
+ */
+
+/**
+ * A wrapper Generator class that makes a generator peekable.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class PeekableIterator<T = unknown, TReturn = any, TNext = unknown>
+  implements Iterator<T, TReturn, TNext>
+{
+  private peekBuffer: IteratorResult<T, TReturn>[] = [];
+  private _lastIndex;
+
+  constructor(private iterator: Iterator<T, TReturn, TNext>, indexBase = 0) {
+    this.iterator = iterator;
+    this._lastIndex = indexBase - 1;
+    this.peekBuffer = [];
+  }
+
+  next(): IteratorResult<T, TReturn> {
+    const nextResult =
+      this.peekBuffer.length > 0
+        ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          this.peekBuffer.pop()!
+        : this.iterator.next();
+
+    if (nextResult.done) {
+      this._lastIndex = -1;
+    } else {
+      this._lastIndex++;
+    }
+    return nextResult;
+  }
+
+  peek(): IteratorResult<T, TReturn> {
+    if (this.peekBuffer.length > 0) {
+      // We know that the buffer is not empty, so we can safely use the
+      // non-null assertion operator
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      return this.peekBuffer[0]!;
+    }
+    const result = this.iterator.next();
+    this.peekBuffer.push(result);
+    return result;
+  }
+
+  get lastIndex(): number {
+    return this._lastIndex;
+  }
+}

package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts

@@ -1,52 +1,52 @@
-/*
- * 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.
- */
-
-export const SpecialCodepoints = {
-  LINE_FEED: 0x0a,
-  CARRIAGE_RETURN: 0x0d,
-  SPACE: 0x20,
-  TAB: 0x09,
-  ZERO_WIDTH_SPACE: 0x200b,
-  ZERO_WIDTH_NON_JOINER: 0x200c,
-  ZERO_WIDTH_JOINER: 0x200d,
-  LEFT_TO_RIGHT_MARK: 0x200e,
-  RIGHT_TO_LEFT_MARK: 0x200f,
-  LEFT_TO_RIGHT_EMBEDDING: 0x202a,
-  RIGHT_TO_LEFT_EMBEDDING: 0x202b,
-  POP_DIRECTIONAL_FORMATTING: 0x202c,
-  LEFT_TO_RIGHT_OVERRIDE: 0x202d,
-  RIGHT_TO_LEFT_OVERRIDE: 0x202e,
-  LINE_SEPARATOR: 0x2028,
-  PARAGRAPH_SEPARATOR: 0x2029,
-  OBJECT_REPLACEMENT_CHARACTER: 0xfffc,
-  REPLACEMENT_CHARACTER: 0xfffd,
-  ZERO_WIDTH_NO_BREAK_SPACE: 0xfeff,
-  LEFT_TO_RIGHT_ISOLATE: 0x2066,
-  RIGHT_TO_LEFT_ISOLATE: 0x2067,
-  FIRST_STRONG_ISOLATE: 0x2068,
-  POP_DIRECTIONAL_ISOLATE: 0x2069,
-  INHIBIT_SYMMETRIC_SWAPPING: 0x206a,
-  ACTIVATE_SYMMETRIC_SWAPPING: 0x206b,
-  INHIBIT_ARABIC_FORM_SHAPING: 0x206c,
-  ACTIVATE_ARABIC_FORM_SHAPING: 0x206d,
-  NATIONAL_DIGIT_SHAPES: 0x206e,
-  NOMINAL_DIGIT_SHAPES: 0x206f,
-  LEFT_TO_RIGHT_BOUNDARY: 0x200e,
-  RIGHT_TO_LEFT_BOUNDARY: 0x200f,
-};
+/*
+ * 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.
+ */
+
+export const SpecialCodepoints = {
+  LINE_FEED: 0x0a,
+  CARRIAGE_RETURN: 0x0d,
+  SPACE: 0x20,
+  TAB: 0x09,
+  ZERO_WIDTH_SPACE: 0x200b,
+  ZERO_WIDTH_NON_JOINER: 0x200c,
+  ZERO_WIDTH_JOINER: 0x200d,
+  LEFT_TO_RIGHT_MARK: 0x200e,
+  RIGHT_TO_LEFT_MARK: 0x200f,
+  LEFT_TO_RIGHT_EMBEDDING: 0x202a,
+  RIGHT_TO_LEFT_EMBEDDING: 0x202b,
+  POP_DIRECTIONAL_FORMATTING: 0x202c,
+  LEFT_TO_RIGHT_OVERRIDE: 0x202d,
+  RIGHT_TO_LEFT_OVERRIDE: 0x202e,
+  LINE_SEPARATOR: 0x2028,
+  PARAGRAPH_SEPARATOR: 0x2029,
+  OBJECT_REPLACEMENT_CHARACTER: 0xfffc,
+  REPLACEMENT_CHARACTER: 0xfffd,
+  ZERO_WIDTH_NO_BREAK_SPACE: 0xfeff,
+  LEFT_TO_RIGHT_ISOLATE: 0x2066,
+  RIGHT_TO_LEFT_ISOLATE: 0x2067,
+  FIRST_STRONG_ISOLATE: 0x2068,
+  POP_DIRECTIONAL_ISOLATE: 0x2069,
+  INHIBIT_SYMMETRIC_SWAPPING: 0x206a,
+  ACTIVATE_SYMMETRIC_SWAPPING: 0x206b,
+  INHIBIT_ARABIC_FORM_SHAPING: 0x206c,
+  ACTIVATE_ARABIC_FORM_SHAPING: 0x206d,
+  NATIONAL_DIGIT_SHAPES: 0x206e,
+  NOMINAL_DIGIT_SHAPES: 0x206f,
+  LEFT_TO_RIGHT_BOUNDARY: 0x200e,
+  RIGHT_TO_LEFT_BOUNDARY: 0x200f,
+};

package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts

@@ -1,32 +1,32 @@
-/*
- * 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.
- */
-
-/**
- * Number of floating point numbers that represent a single glyph in the SDF vertex buffer.
- *
- * @remarks
- * The vertex buffer contains:
- *  - 6 vertex positions
- *  - 6 texture coordinates
- *  - = 12 positions/coordinates per glyph
- *
- * Each vertex position and texture coordinate consist of 2 floating point numbers (x/y).
- * So there are 12 * 2 = 24 floating point numbers that make up a single glyph.
- */
-export const FLOATS_PER_GLYPH = 24;
+/*
+ * 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.
+ */
+
+/**
+ * Number of floating point numbers that represent a single glyph in the SDF vertex buffer.
+ *
+ * @remarks
+ * The vertex buffer contains:
+ *  - 6 vertex positions
+ *  - 6 texture coordinates
+ *  - = 12 positions/coordinates per glyph
+ *
+ * Each vertex position and texture coordinate consist of 2 floating point numbers (x/y).
+ * So there are 12 * 2 = 24 floating point numbers that make up a single glyph.
+ */
+export const FLOATS_PER_GLYPH = 24;

package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts

@@ -1,84 +1,84 @@
-/*
- * 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 { Bound } from '../../../../lib/utils.js';
-import type { TrProps, TextRendererState } from '../../TextRenderer.js';
-import type { SdfTextRendererState } from '../SdfTextRenderer.js';
-import type { SdfRenderWindow } from './setRenderWindow.js';
-
-/**
- * Gets the start conditions for the layout loop.
- *
- * @remarks
- * Returns `undefined` if the layout loop should not be run.
- *
- * @param fontSize
- * @param fontSizeRatio
- * @param sdfLineHeight
- * @param renderWindow
- * @param lineCache
- * @param textH
- * @returns
- */
-export function getStartConditions(
-  sdfFontSize: number,
-  sdfLineHeight: number,
-  lineHeight: number,
-  verticalAlign: TrProps['verticalAlign'],
-  offsetY: TrProps['offsetY'],
-  fontSizeRatio: number,
-  renderWindow: SdfRenderWindow,
-  lineCache: SdfTextRendererState['lineCache'],
-  textH: TextRendererState['textH'],
-):
-  | {
-      sdfX: number;
-      sdfY: number;
-      lineIndex: number;
-    }
-  | undefined {
-  // State variables
-  const startLineIndex = Math.min(
-    Math.max(renderWindow.firstLineIdx, 0),
-    lineCache.length,
-  );
-
-  // TODO: (fontSize / 6.4286 / fontSizeRatio) Adding this to the startY helps the text line up better with Canvas rendered text
-  const sdfStartX = 0;
-  let sdfVerticalAlignYOffset = 0;
-  if (verticalAlign === 'middle') {
-    sdfVerticalAlignYOffset = (sdfLineHeight - sdfFontSize) / 2;
-  } else if (verticalAlign === 'bottom') {
-    sdfVerticalAlignYOffset = sdfLineHeight - sdfFontSize;
-  }
-  const sdfOffsetY = offsetY / fontSizeRatio;
-  const sdfStartY =
-    sdfOffsetY + startLineIndex * sdfLineHeight + sdfVerticalAlignYOffset; // TODO: Figure out what determines the initial y offset of text.
-
-  // Don't attempt to render anything if we know we're starting past the established end of the text
-  if (textH && sdfStartY >= textH / fontSizeRatio) {
-    return;
-  }
-
-  return {
-    sdfX: sdfStartX,
-    sdfY: sdfStartY,
-    lineIndex: startLineIndex,
-  };
-}
+/*
+ * 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 { Bound } from '../../../../lib/utils.js';
+import type { TrProps, TextRendererState } from '../../TextRenderer.js';
+import type { SdfTextRendererState } from '../SdfTextRenderer.js';
+import type { SdfRenderWindow } from './setRenderWindow.js';
+
+/**
+ * Gets the start conditions for the layout loop.
+ *
+ * @remarks
+ * Returns `undefined` if the layout loop should not be run.
+ *
+ * @param fontSize
+ * @param fontSizeRatio
+ * @param sdfLineHeight
+ * @param renderWindow
+ * @param lineCache
+ * @param textH
+ * @returns
+ */
+export function getStartConditions(
+  sdfFontSize: number,
+  sdfLineHeight: number,
+  lineHeight: number,
+  verticalAlign: TrProps['verticalAlign'],
+  offsetY: TrProps['offsetY'],
+  fontSizeRatio: number,
+  renderWindow: SdfRenderWindow,
+  lineCache: SdfTextRendererState['lineCache'],
+  textH: TextRendererState['textH'],
+):
+  | {
+      sdfX: number;
+      sdfY: number;
+      lineIndex: number;
+    }
+  | undefined {
+  // State variables
+  const startLineIndex = Math.min(
+    Math.max(renderWindow.firstLineIdx, 0),
+    lineCache.length,
+  );
+
+  // TODO: (fontSize / 6.4286 / fontSizeRatio) Adding this to the startY helps the text line up better with Canvas rendered text
+  const sdfStartX = 0;
+  let sdfVerticalAlignYOffset = 0;
+  if (verticalAlign === 'middle') {
+    sdfVerticalAlignYOffset = (sdfLineHeight - sdfFontSize) / 2;
+  } else if (verticalAlign === 'bottom') {
+    sdfVerticalAlignYOffset = sdfLineHeight - sdfFontSize;
+  }
+  const sdfOffsetY = offsetY / fontSizeRatio;
+  const sdfStartY =
+    sdfOffsetY + startLineIndex * sdfLineHeight + sdfVerticalAlignYOffset; // TODO: Figure out what determines the initial y offset of text.
+
+  // Don't attempt to render anything if we know we're starting past the established end of the text
+  if (textH && sdfStartY >= textH / fontSizeRatio) {
+    return;
+  }
+
+  return {
+    sdfX: sdfStartX,
+    sdfY: sdfStartY,
+    lineIndex: startLineIndex,
+  };
+}