@lightningjs/renderer 0.7.1 → 0.7.3

package/src/render-drivers/threadx/ThreadXMainTextNode.ts

@@ -1,85 +1,85 @@
-/*
- * 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 { ITextNode } from '../../main-api/INode.js';
-import type { RendererMain } from '../../main-api/RendererMain.js';
-import type { NodeStructWritableProps } from './NodeStruct.js';
-import type {
-  TextNodeStruct,
-  TextNodeStructWritableProps,
-} from './TextNodeStruct.js';
-import { ThreadXMainNode } from './ThreadXMainNode.js';
-
-export class ThreadXMainTextNode extends ThreadXMainNode implements ITextNode {
-  protected _debug: ITextNode['debug'] = {};
-
-  constructor(rendererMain: RendererMain, sharedNodeStruct: TextNodeStruct) {
-    super(rendererMain, sharedNodeStruct, {
-      text: sharedNodeStruct.text,
-      textRendererOverride: sharedNodeStruct.textRendererOverride,
-      fontSize: sharedNodeStruct.fontSize,
-      fontFamily: sharedNodeStruct.fontFamily,
-      fontStretch: sharedNodeStruct.fontStretch,
-      fontStyle: sharedNodeStruct.fontStyle,
-      fontWeight: sharedNodeStruct.fontWeight,
-      lineHeight: sharedNodeStruct.lineHeight,
-      maxLines: sharedNodeStruct.maxLines,
-      textBaseline: sharedNodeStruct.textBaseline,
-      verticalAlign: sharedNodeStruct.verticalAlign,
-      contain: sharedNodeStruct.contain,
-      letterSpacing: sharedNodeStruct.letterSpacing,
-      offsetY: sharedNodeStruct.offsetY,
-      scrollable: sharedNodeStruct.scrollable,
-      scrollY: sharedNodeStruct.scrollY,
-      textAlign: sharedNodeStruct.textAlign,
-      overflowSuffix: sharedNodeStruct.overflowSuffix,
-    } satisfies Omit<TextNodeStructWritableProps, keyof NodeStructWritableProps>);
-  }
-
-  declare text: ITextNode['text'];
-  declare textRendererOverride: ITextNode['textRendererOverride'];
-  declare fontSize: ITextNode['fontSize'];
-  declare fontFamily: ITextNode['fontFamily'];
-  declare fontStretch: ITextNode['fontStretch'];
-  declare fontStyle: ITextNode['fontStyle'];
-  declare fontWeight: ITextNode['fontWeight'];
-  declare lineHeight: ITextNode['lineHeight'];
-  declare maxLines: ITextNode['maxLines'];
-  declare textBaseline: ITextNode['textBaseline'];
-  declare verticalAlign: ITextNode['verticalAlign'];
-  declare textAlign: ITextNode['textAlign'];
-  declare contain: ITextNode['contain'];
-  declare scrollable: ITextNode['scrollable'];
-  declare scrollY: ITextNode['scrollY'];
-  declare offsetY: ITextNode['offsetY'];
-  declare letterSpacing: ITextNode['letterSpacing'];
-  declare overflowSuffix: ITextNode['overflowSuffix'];
-
-  get debug(): ITextNode['debug'] {
-    return this._debug;
-  }
-
-  set debug(debug: ITextNode['debug']) {
-    if (this._debug === debug) {
-      return;
-    }
-    this._debug = debug;
-    this.emit('debug', debug);
-  }
-}
+/*
+ * 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 { ITextNode } from '../../main-api/INode.js';
+import type { RendererMain } from '../../main-api/RendererMain.js';
+import type { NodeStructWritableProps } from './NodeStruct.js';
+import type {
+  TextNodeStruct,
+  TextNodeStructWritableProps,
+} from './TextNodeStruct.js';
+import { ThreadXMainNode } from './ThreadXMainNode.js';
+
+export class ThreadXMainTextNode extends ThreadXMainNode implements ITextNode {
+  protected _debug: ITextNode['debug'] = {};
+
+  constructor(rendererMain: RendererMain, sharedNodeStruct: TextNodeStruct) {
+    super(rendererMain, sharedNodeStruct, {
+      text: sharedNodeStruct.text,
+      textRendererOverride: sharedNodeStruct.textRendererOverride,
+      fontSize: sharedNodeStruct.fontSize,
+      fontFamily: sharedNodeStruct.fontFamily,
+      fontStretch: sharedNodeStruct.fontStretch,
+      fontStyle: sharedNodeStruct.fontStyle,
+      fontWeight: sharedNodeStruct.fontWeight,
+      lineHeight: sharedNodeStruct.lineHeight,
+      maxLines: sharedNodeStruct.maxLines,
+      textBaseline: sharedNodeStruct.textBaseline,
+      verticalAlign: sharedNodeStruct.verticalAlign,
+      contain: sharedNodeStruct.contain,
+      letterSpacing: sharedNodeStruct.letterSpacing,
+      offsetY: sharedNodeStruct.offsetY,
+      scrollable: sharedNodeStruct.scrollable,
+      scrollY: sharedNodeStruct.scrollY,
+      textAlign: sharedNodeStruct.textAlign,
+      overflowSuffix: sharedNodeStruct.overflowSuffix,
+    } satisfies Omit<TextNodeStructWritableProps, keyof NodeStructWritableProps>);
+  }
+
+  declare text: ITextNode['text'];
+  declare textRendererOverride: ITextNode['textRendererOverride'];
+  declare fontSize: ITextNode['fontSize'];
+  declare fontFamily: ITextNode['fontFamily'];
+  declare fontStretch: ITextNode['fontStretch'];
+  declare fontStyle: ITextNode['fontStyle'];
+  declare fontWeight: ITextNode['fontWeight'];
+  declare lineHeight: ITextNode['lineHeight'];
+  declare maxLines: ITextNode['maxLines'];
+  declare textBaseline: ITextNode['textBaseline'];
+  declare verticalAlign: ITextNode['verticalAlign'];
+  declare textAlign: ITextNode['textAlign'];
+  declare contain: ITextNode['contain'];
+  declare scrollable: ITextNode['scrollable'];
+  declare scrollY: ITextNode['scrollY'];
+  declare offsetY: ITextNode['offsetY'];
+  declare letterSpacing: ITextNode['letterSpacing'];
+  declare overflowSuffix: ITextNode['overflowSuffix'];
+
+  get debug(): ITextNode['debug'] {
+    return this._debug;
+  }
+
+  set debug(debug: ITextNode['debug']) {
+    if (this._debug === debug) {
+      return;
+    }
+    this._debug = debug;
+    this.emit('debug', debug);
+  }
+}

package/src/render-drivers/threadx/ThreadXRendererMessage.ts

@@ -1,97 +1,110 @@
-/*
- * 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 { FpsUpdatePayload } from '../../common/CommonTypes.js';
-
-/**
- * @module
- * @description
- * Message types / utils for communication between the main worker and the
- * worker worker.
- */
-
-/**
- * Defines the shape of a message sent from the main worker to the worker
- */
-export interface ThreadXRendererMessage {
-  type: string;
-}
-
-/**
- * An initialization message sent from the main worker to the renderer worker
- */
-export interface ThreadXRendererInitMessage extends ThreadXRendererMessage {
-  type: 'init';
-  canvas: OffscreenCanvas;
-  appWidth: number;
-  appHeight: number;
-  deviceLogicalPixelRatio: number;
-  devicePhysicalPixelRatio: number;
-  clearColor: number;
-  fpsUpdateInterval: number;
-  enableContextSpy: boolean;
-  numImageWorkers: number;
-  coreExtensionModule: string | null;
-}
-
-/**
- * A message sent from the main worker to the renderer worker to release a
- * texture
- */
-export interface ThreadXRendererReleaseTextureMessage
-  extends ThreadXRendererMessage {
-  type: 'releaseTexture';
-  textureDescId: number;
-}
-
-/**
- * A message sent from the renderer worker to the main worker to update the FPS
- */
-export interface ThreadXRendererFpsUpdateMessage
-  extends ThreadXRendererMessage {
-  type: 'fpsUpdate';
-  fpsData: FpsUpdatePayload;
-}
-
-/**
- * A map of message types to message shapes
- */
-export interface ThreadXRendererMessageMap {
-  init: ThreadXRendererInitMessage;
-  releaseTexture: ThreadXRendererReleaseTextureMessage;
-  fpsUpdate: ThreadXRendererFpsUpdateMessage;
-}
-
-/**
- * Type guard util for a message sent from the main worker to the renderer worker
- *
- * @param type
- * @param message
- * @returns
- */
-export function isThreadXRendererMessage<
-  Type extends keyof ThreadXRendererMessageMap,
->(type: Type, message: unknown): message is ThreadXRendererMessageMap[Type] {
-  return (
-    typeof message === 'object' &&
-    message !== null &&
-    'type' in message &&
-    message.type === type
-  );
-}
+/*
+ * 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 {
+  FpsUpdatePayload,
+  FrameTickPayload,
+} from '../../common/CommonTypes.js';
+
+/**
+ * @module
+ * @description
+ * Message types / utils for communication between the main worker and the
+ * worker worker.
+ */
+
+/**
+ * Defines the shape of a message sent from the main worker to the worker
+ */
+export interface ThreadXRendererMessage {
+  type: string;
+}
+
+/**
+ * An initialization message sent from the main worker to the renderer worker
+ */
+export interface ThreadXRendererInitMessage extends ThreadXRendererMessage {
+  type: 'init';
+  canvas: OffscreenCanvas;
+  appWidth: number;
+  appHeight: number;
+  deviceLogicalPixelRatio: number;
+  devicePhysicalPixelRatio: number;
+  clearColor: number;
+  fpsUpdateInterval: number;
+  enableContextSpy: boolean;
+  numImageWorkers: number;
+  coreExtensionModule: string | null;
+}
+
+/**
+ * A message sent from the main worker to the renderer worker to release a
+ * texture
+ */
+export interface ThreadXRendererReleaseTextureMessage
+  extends ThreadXRendererMessage {
+  type: 'releaseTexture';
+  textureDescId: number;
+}
+
+/**
+ * A message sent from the renderer worker to the main worker to update the FPS
+ */
+export interface ThreadXRendererFpsUpdateMessage
+  extends ThreadXRendererMessage {
+  type: 'fpsUpdate';
+  fpsData: FpsUpdatePayload;
+}
+
+/**
+ * A message sent from the renderer worker to the main worker to update the FPS
+ */
+export interface ThreadXRendererFrameTickMessage
+  extends ThreadXRendererMessage {
+  type: 'frameTick';
+  frameTickData: FrameTickPayload;
+}
+
+/**
+ * A map of message types to message shapes
+ */
+export interface ThreadXRendererMessageMap {
+  init: ThreadXRendererInitMessage;
+  releaseTexture: ThreadXRendererReleaseTextureMessage;
+  fpsUpdate: ThreadXRendererFpsUpdateMessage;
+  frameTick: ThreadXRendererFrameTickMessage;
+}
+
+/**
+ * Type guard util for a message sent from the main worker to the renderer worker
+ *
+ * @param type
+ * @param message
+ * @returns
+ */
+export function isThreadXRendererMessage<
+  Type extends keyof ThreadXRendererMessageMap,
+>(type: Type, message: unknown): message is ThreadXRendererMessageMap[Type] {
+  return (
+    typeof message === 'object' &&
+    message !== null &&
+    'type' in message &&
+    message.type === type
+  );
+}