@lightningjs/renderer 0.9.4 → 1.0.0-rc.1

package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts

@@ -1,45 +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 { assertTruthy } from '../../utils.js';
-import type { TextureRef } from '../RendererMain.js';
-import { TextureUsageTracker } from './TextureUsageTracker.js';
-
-export class FinalizationRegistryTextureUsageTracker extends TextureUsageTracker {
-  private registry: FinalizationRegistry<number>;
-
-  constructor(releaseCallback: (textureDescId: number) => void) {
-    super(releaseCallback);
-    this.registry = new FinalizationRegistry(releaseCallback);
-  }
-
-  override registerTexture(texture: TextureRef): void {
-    assertTruthy(
-      texture.options?.id,
-      'Texture must have an ID to be registered',
-    );
-    this.registry.register(texture, texture.options?.id);
-  }
-  override incrementTextureRefCount(): void {
-    // No-op for FinalizationRegistry
-  }
-  override decrementTextureRefCount(): void {
-    // No-op for FinalizationRegistry
-  }
-}

package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts

@@ -1,154 +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 { assertTruthy } from '../../utils.js';
-import type { TextureRef } from '../RendererMain.js';
-import { TextureUsageTracker } from './TextureUsageTracker.js';
-
-interface TextureRefInfo {
-  /**
-   * Texture Reference ID
-   */
-  id: number;
-  /**
-   * The number of references to this texture that are currently assigned to
-   * Nodes.
-   */
-  nodeRefCount: number;
-  /**
-   * The last time the texture reference count was updated.
-   *
-   * @remarks
-   * This is used to determine when a texture is no longer referenced by any
-   * Nodes and can be removed from the GPU.
-   */
-  lastUpdate: number;
-}
-
-export interface ManualCountTextureUsageTrackerOptions {
-  /**
-   * The interval at which to check if textures that are no longer referenced
-   * by any Nodes can be released from the Core Space Texture Usage Cache.
-   *
-   * @remarks
-   * Only valid when the {@link ManualCountTextureUsageTracker} is used.
-   *
-   * @defaultValue 10000 (10 seconds)
-   */
-  textureCleanupIntervalMs?: number;
-  /**
-   * The age at which a texture is considered to be no longer referenced by any
-   * Nodes and can be released from the Core Space Texture Usage Cache.
-   *
-   * @remarks
-   * Only valid when the {@link ManualCountTextureUsageTracker} is used.
-   *
-   * @defaultValue 60000 (1 minute)
-   */
-  textureCleanupAgeThreadholdMs?: number;
-}
-
-/**
- * Usage-based Texture Garbage Collection Registry
- */
-export class ManualCountTextureUsageTracker extends TextureUsageTracker {
-  textureMap: Map<number, TextureRefInfo> = new Map();
-  zeroReferenceTextureSet: Set<TextureRefInfo> = new Set();
-  options: Required<ManualCountTextureUsageTrackerOptions>;
-
-  constructor(
-    releaseCallback: (textureDescId: number) => void,
-    options: ManualCountTextureUsageTrackerOptions,
-  ) {
-    super(releaseCallback);
-    this.options = {
-      textureCleanupIntervalMs: options.textureCleanupIntervalMs ?? 10000,
-      textureCleanupAgeThreadholdMs:
-        options.textureCleanupAgeThreadholdMs ?? 60000,
-    };
-    // Periodically check for textures that are no longer referenced by any
-    // Nodes and notify RendererMain to release them.
-    setInterval(() => {
-      const now = Date.now();
-      const thresholdMs = this.options.textureCleanupAgeThreadholdMs;
-      for (const textureRefInfo of this.zeroReferenceTextureSet) {
-        if (now - textureRefInfo.lastUpdate > thresholdMs) {
-          this.releaseCallback(textureRefInfo.id);
-          this.textureMap.delete(textureRefInfo.id);
-          this.zeroReferenceTextureSet.delete(textureRefInfo);
-        }
-      }
-    }, this.options.textureCleanupIntervalMs);
-  }
-
-  registerTexture(texture: TextureRef) {
-    const textureId = texture.options?.id;
-    assertTruthy(textureId, 'Texture must have an id to be registered');
-    if (!this.textureMap.has(textureId)) {
-      const textureRefInfo: TextureRefInfo = {
-        id: textureId,
-        nodeRefCount: 0,
-        lastUpdate: Date.now(),
-      };
-      this.textureMap.set(textureId, textureRefInfo);
-      this.zeroReferenceTextureSet.add(textureRefInfo);
-    }
-  }
-
-  incrementTextureRefCount(texture: TextureRef) {
-    const textureId = texture.options?.id;
-    assertTruthy(textureId, 'Texture must have an id to be registered');
-    let textureRefInfo = this.textureMap.get(textureId);
-    if (!textureRefInfo) {
-      // Texture has not been registered yet, so register it now.
-      // This may happen if the TextureRef was cleaned up from the registry
-      // but was still alive in memory and eventually re-used.
-      this.registerTexture(texture);
-      textureRefInfo = this.textureMap.get(textureId);
-    }
-    assertTruthy(textureRefInfo, 'Texture must have been registered');
-    if (texture.txType === 'SubTexture') {
-      // If this is a SubTexture, then increment the reference count of the
-      // parent texture as well.
-      this.incrementTextureRefCount(texture.props.texture);
-    }
-    textureRefInfo.nodeRefCount++;
-    textureRefInfo.lastUpdate = Date.now();
-    if (this.zeroReferenceTextureSet.has(textureRefInfo)) {
-      this.zeroReferenceTextureSet.delete(textureRefInfo);
-    }
-  }
-
-  decrementTextureRefCount(texture: TextureRef) {
-    const textureId = texture.options?.id;
-    assertTruthy(textureId, 'Texture must have an id to be registered');
-    const textureRefInfo = this.textureMap.get(textureId);
-    assertTruthy(textureRefInfo, 'Texture must have been registered');
-    textureRefInfo.nodeRefCount--;
-    textureRefInfo.lastUpdate = Date.now();
-    if (textureRefInfo.nodeRefCount === 0) {
-      this.zeroReferenceTextureSet.add(textureRefInfo);
-    }
-    if (texture.txType === 'SubTexture') {
-      // If this is a SubTexture, then decrement the reference count of the
-      // parent texture as well.
-      this.decrementTextureRefCount(texture.props.texture);
-    }
-  }
-}

package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts

@@ -1,54 +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 { TextureRef } from '../RendererMain.js';
-
-/**
- * Texture Usage Tracker for Usage Based Texture Garbage Collection
- */
-export abstract class TextureUsageTracker {
-  constructor(protected releaseCallback: (textureDescId: number) => void) {}
-
-  /**
-   * Register a texture with the tracker.
-   *
-   * @param texture
-   */
-  abstract registerTexture(texture: TextureRef): void;
-
-  /**
-   * Increment the reference count for a texture.
-   *
-   * @remarks
-   * This should be called anytime a Node sets a new texture.
-   *
-   * @param texture
-   */
-  abstract incrementTextureRefCount(texture: TextureRef): void;
-
-  /**
-   * Decrement the Node reference count for a texture.
-   *
-   * @remarks
-   * This should be called anytime a Node removes a texture.
-   *
-   * @param texture
-   */
-  abstract decrementTextureRefCount(texture: TextureRef): void;
-}

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

@@ -1,159 +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 { 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,
-      txMemByteThreshold: rendererSettings.txMemByteThreshold,
-      boundsMargin: rendererSettings.boundsMargin,
-      deviceLogicalPixelRatio: rendererSettings.deviceLogicalPixelRatio,
-      devicePhysicalPixelRatio: rendererSettings.devicePhysicalPixelRatio,
-      clearColor: rendererSettings.clearColor,
-      canvas,
-      fpsUpdateInterval: rendererSettings.fpsUpdateInterval,
-      enableContextSpy: rendererSettings.enableContextSpy,
-      numImageWorkers: rendererSettings.numImageWorkers,
-      renderMode: rendererSettings.renderMode,
-      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);
-
-    this.stage.on('idle', () => {
-      this.onIdle();
-    });
-  }
-
-  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.');
-  }
-
-  onIdle() {
-    throw new Error('Method not implemented.');
-  }
-  //#endregion
-}