@lightningjs/renderer 0.7.1 → 0.7.3

package/src/render-drivers/main/MainCoreDriver.ts

@@ -1,133 +1,148 @@
-/*
- * 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 { assertTruthy } from '../../utils.js';
-import type { ICoreDriver } from '../../main-api/ICoreDriver.js';
-import type {
-  INode,
-  INodeWritableProps,
-  ITextNodeWritableProps,
-} from '../../main-api/INode.js';
-import { MainOnlyNode, getNewId } from './MainOnlyNode.js';
-import { Stage, type StageFpsUpdateHandler } from '../../core/Stage.js';
-import type {
-  RendererMain,
-  RendererMainSettings,
-} from '../../main-api/RendererMain.js';
-import { MainOnlyTextNode } from './MainOnlyTextNode.js';
-import { loadCoreExtension } from '../utils.js';
-import type { FpsUpdatePayload } from '../../common/CommonTypes.js';
-
-export class MainCoreDriver implements ICoreDriver {
-  private root: MainOnlyNode | null = null;
-  private stage: Stage | null = null;
-  private rendererMain: RendererMain | null = null;
-
-  async init(
-    rendererMain: RendererMain,
-    rendererSettings: Required<RendererMainSettings>,
-    canvas: HTMLCanvasElement,
-  ): Promise<void> {
-    this.stage = new Stage({
-      rootId: getNewId(),
-      appWidth: rendererSettings.appWidth,
-      appHeight: rendererSettings.appHeight,
-      deviceLogicalPixelRatio: rendererSettings.deviceLogicalPixelRatio,
-      devicePhysicalPixelRatio: rendererSettings.devicePhysicalPixelRatio,
-      clearColor: rendererSettings.clearColor,
-      canvas,
-      fpsUpdateInterval: rendererSettings.fpsUpdateInterval,
-      enableContextSpy: rendererSettings.enableContextSpy,
-      numImageWorkers: rendererSettings.numImageWorkers,
-      debug: {
-        monitorTextureCache: false,
-      },
-    });
-    this.rendererMain = rendererMain;
-    assertTruthy(this.stage.root);
-    const node = new MainOnlyNode(
-      rendererMain.resolveNodeDefaults({}),
-      this.rendererMain,
-      this.stage,
-      this.stage.root,
-    );
-    this.root = node;
-    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
-    this.onCreateNode(node);
-
-    // Load the Core Extension Module if one was specified.
-    if (rendererSettings.coreExtensionModule) {
-      await loadCoreExtension(rendererSettings.coreExtensionModule, this.stage);
-    }
-
-    // Forward fpsUpdate events from the stage to RendererMain
-    this.stage.on('fpsUpdate', ((stage, fpsData) => {
-      this.onFpsUpdate(fpsData);
-    }) satisfies StageFpsUpdateHandler);
-  }
-
-  createNode(props: INodeWritableProps): INode {
-    assertTruthy(this.rendererMain);
-    assertTruthy(this.stage);
-    const node = new MainOnlyNode(props, this.rendererMain, this.stage);
-    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
-    this.onCreateNode(node);
-    return node;
-  }
-
-  createTextNode(props: ITextNodeWritableProps) {
-    assertTruthy(this.rendererMain);
-    assertTruthy(this.stage);
-    const node = new MainOnlyTextNode(props, this.rendererMain, this.stage);
-    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
-    this.onCreateNode(node);
-    return node;
-  }
-
-  // TODO: Remove?
-  destroyNode(node: INode): void {
-    node.destroy();
-  }
-
-  releaseTexture(id: number): void {
-    const { stage } = this;
-    assertTruthy(stage);
-    stage.txManager.removeTextureIdFromCache(id);
-  }
-
-  getRootNode(): INode {
-    assertTruthy(this.root);
-    return this.root;
-  }
-
-  //#region Event Methods
-  // The implementations for these event methods are provided by RendererMain
-  onCreateNode(node: INode): void {
-    throw new Error('Method not implemented.');
-  }
-
-  onBeforeDestroyNode(node: INode): void {
-    throw new Error('Method not implemented.');
-  }
-
-  onFpsUpdate(fpsData: FpsUpdatePayload) {
-    throw new Error('Method not implemented.');
-  }
-  //#endregion
-}
+/*
+ * 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 { assertTruthy } from '../../utils.js';
+import type { ICoreDriver } from '../../main-api/ICoreDriver.js';
+import type {
+  INode,
+  INodeWritableProps,
+  ITextNodeWritableProps,
+} from '../../main-api/INode.js';
+import { MainOnlyNode, getNewId } from './MainOnlyNode.js';
+import {
+  Stage,
+  type StageFpsUpdateHandler,
+  type StageFrameTickHandler,
+} from '../../core/Stage.js';
+import type {
+  RendererMain,
+  RendererMainSettings,
+} from '../../main-api/RendererMain.js';
+import { MainOnlyTextNode } from './MainOnlyTextNode.js';
+import { loadCoreExtension } from '../utils.js';
+import type {
+  FpsUpdatePayload,
+  FrameTickPayload,
+} from '../../common/CommonTypes.js';
+
+export class MainCoreDriver implements ICoreDriver {
+  private root: MainOnlyNode | null = null;
+  private stage: Stage | null = null;
+  private rendererMain: RendererMain | null = null;
+
+  async init(
+    rendererMain: RendererMain,
+    rendererSettings: Required<RendererMainSettings>,
+    canvas: HTMLCanvasElement,
+  ): Promise<void> {
+    this.stage = new Stage({
+      rootId: getNewId(),
+      appWidth: rendererSettings.appWidth,
+      appHeight: rendererSettings.appHeight,
+      deviceLogicalPixelRatio: rendererSettings.deviceLogicalPixelRatio,
+      devicePhysicalPixelRatio: rendererSettings.devicePhysicalPixelRatio,
+      clearColor: rendererSettings.clearColor,
+      canvas,
+      fpsUpdateInterval: rendererSettings.fpsUpdateInterval,
+      enableContextSpy: rendererSettings.enableContextSpy,
+      numImageWorkers: rendererSettings.numImageWorkers,
+      debug: {
+        monitorTextureCache: false,
+      },
+    });
+    this.rendererMain = rendererMain;
+    assertTruthy(this.stage.root);
+    const node = new MainOnlyNode(
+      rendererMain.resolveNodeDefaults({}),
+      this.rendererMain,
+      this.stage,
+      this.stage.root,
+    );
+    this.root = node;
+    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
+    this.onCreateNode(node);
+
+    // Load the Core Extension Module if one was specified.
+    if (rendererSettings.coreExtensionModule) {
+      await loadCoreExtension(rendererSettings.coreExtensionModule, this.stage);
+    }
+
+    // Forward fpsUpdate events from the stage to RendererMain
+    this.stage.on('fpsUpdate', ((stage, fpsData) => {
+      this.onFpsUpdate(fpsData);
+    }) satisfies StageFpsUpdateHandler);
+
+    this.stage.on('frameTick', ((stage, frameTickData) => {
+      this.onFrameTick(frameTickData);
+    }) satisfies StageFrameTickHandler);
+  }
+
+  createNode(props: INodeWritableProps): INode {
+    assertTruthy(this.rendererMain);
+    assertTruthy(this.stage);
+    const node = new MainOnlyNode(props, this.rendererMain, this.stage);
+    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
+    this.onCreateNode(node);
+    return node;
+  }
+
+  createTextNode(props: ITextNodeWritableProps) {
+    assertTruthy(this.rendererMain);
+    assertTruthy(this.stage);
+    const node = new MainOnlyTextNode(props, this.rendererMain, this.stage);
+    node.once('beforeDestroy', this.onBeforeDestroyNode.bind(this, node));
+    this.onCreateNode(node);
+    return node;
+  }
+
+  // TODO: Remove?
+  destroyNode(node: INode): void {
+    node.destroy();
+  }
+
+  releaseTexture(id: number): void {
+    const { stage } = this;
+    assertTruthy(stage);
+    stage.txManager.removeTextureIdFromCache(id);
+  }
+
+  getRootNode(): INode {
+    assertTruthy(this.root);
+    return this.root;
+  }
+
+  //#region Event Methods
+  // The implementations for these event methods are provided by RendererMain
+  onCreateNode(node: INode): void {
+    throw new Error('Method not implemented.');
+  }
+
+  onBeforeDestroyNode(node: INode): void {
+    throw new Error('Method not implemented.');
+  }
+
+  onFpsUpdate(fpsData: FpsUpdatePayload) {
+    throw new Error('Method not implemented.');
+  }
+
+  onFrameTick(frameTickData: FrameTickPayload) {
+    throw new Error('Method not implemented.');
+  }
+  //#endregion
+}