@lightningjs/renderer 0.9.4 → 1.0.0-rc.1

package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts

@@ -1,151 +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 { CoreTextNode } from '../../../core/CoreTextNode.js';
-import type { Stage } from '../../../core/Stage.js';
-import type { TrProps } from '../../../core/text-rendering/renderers/TextRenderer.js';
-import type { NodeStructWritableProps } from '../NodeStruct.js';
-import type {
-  TextNodeStruct,
-  TextNodeStructWritableProps,
-} from '../TextNodeStruct.js';
-import { ThreadXRendererNode } from './ThreadXRendererNode.js';
-
-export class ThreadXRendererTextNode extends ThreadXRendererNode {
-  declare coreNode: CoreTextNode;
-  declare z$__type__Props: TextNodeStructWritableProps &
-    ThreadXRendererNode['z$__type__Props'];
-
-  constructor(stage: Stage, sharedNodeStruct: TextNodeStruct) {
-    super(
-      stage,
-      sharedNodeStruct,
-      new CoreTextNode(stage, {
-        id: sharedNodeStruct.id,
-        // It doesn't matter what these are initially. They will be reset
-        // appropriately via the onPropertyChange() calls below and in the
-        // ThreadXRendererNode constructor.
-        x: sharedNodeStruct.x,
-        y: sharedNodeStruct.y,
-        width: sharedNodeStruct.width,
-        height: sharedNodeStruct.height,
-        alpha: sharedNodeStruct.alpha,
-        autosize: sharedNodeStruct.autosize,
-        clipping: sharedNodeStruct.clipping,
-        color: sharedNodeStruct.color,
-        colorTop: sharedNodeStruct.colorTop,
-        colorBottom: sharedNodeStruct.colorBottom,
-        colorLeft: sharedNodeStruct.colorLeft,
-        colorRight: sharedNodeStruct.colorRight,
-        colorTl: sharedNodeStruct.colorTl,
-        colorTr: sharedNodeStruct.colorTr,
-        colorBl: sharedNodeStruct.colorBl,
-        colorBr: sharedNodeStruct.colorBr,
-        zIndex: sharedNodeStruct.zIndex,
-        zIndexLocked: sharedNodeStruct.zIndexLocked,
-        mount: sharedNodeStruct.mount,
-        mountX: sharedNodeStruct.mountX,
-        mountY: sharedNodeStruct.mountY,
-        pivot: sharedNodeStruct.pivot,
-        pivotX: sharedNodeStruct.pivotX,
-        pivotY: sharedNodeStruct.pivotY,
-        scaleX: sharedNodeStruct.scaleX,
-        scaleY: sharedNodeStruct.scaleY,
-        rotation: sharedNodeStruct.rotation,
-        rtt: sharedNodeStruct.rtt,
-
-        // These are passed in via message handlers
-        shader: null,
-        shaderProps: null,
-        texture: null,
-        textureOptions: null,
-
-        // Setup the parent after
-        parent: null,
-
-        // Text properties
-        text: sharedNodeStruct.text,
-        textRendererOverride: sharedNodeStruct.textRendererOverride,
-        fontSize: sharedNodeStruct.fontSize,
-        fontFamily: sharedNodeStruct.fontFamily,
-        fontWeight: sharedNodeStruct.fontWeight,
-        fontStretch: sharedNodeStruct.fontStretch,
-        fontStyle: sharedNodeStruct.fontStyle,
-        lineHeight: sharedNodeStruct.lineHeight,
-        maxLines: sharedNodeStruct.maxLines,
-        textBaseline: sharedNodeStruct.textBaseline,
-        verticalAlign: sharedNodeStruct.verticalAlign,
-        overflowSuffix: sharedNodeStruct.overflowSuffix,
-        contain: sharedNodeStruct.contain,
-        letterSpacing: sharedNodeStruct.letterSpacing,
-        offsetY: sharedNodeStruct.offsetY,
-        textAlign: sharedNodeStruct.textAlign,
-        scrollable: sharedNodeStruct.scrollable,
-        scrollY: sharedNodeStruct.scrollY,
-        debug: {},
-      }),
-      {
-        text: sharedNodeStruct.text,
-        textRendererOverride: sharedNodeStruct.textRendererOverride,
-        fontSize: sharedNodeStruct.fontSize,
-        fontFamily: sharedNodeStruct.fontFamily,
-        fontWeight: sharedNodeStruct.fontWeight,
-        fontStretch: sharedNodeStruct.fontStretch,
-        fontStyle: sharedNodeStruct.fontStyle,
-        lineHeight: sharedNodeStruct.lineHeight,
-        maxLines: sharedNodeStruct.maxLines,
-        textBaseline: sharedNodeStruct.textBaseline,
-        verticalAlign: sharedNodeStruct.verticalAlign,
-        overflowSuffix: sharedNodeStruct.overflowSuffix,
-        contain: sharedNodeStruct.contain,
-        letterSpacing: sharedNodeStruct.letterSpacing,
-        offsetY: sharedNodeStruct.offsetY,
-        textAlign: sharedNodeStruct.textAlign,
-        scrollable: sharedNodeStruct.scrollable,
-        scrollY: sharedNodeStruct.scrollY,
-      } satisfies Omit<
-        TextNodeStructWritableProps,
-        keyof NodeStructWritableProps | 'debug'
-      >,
-    );
-    // Forward on CoreNode events
-    this.on('debug', (target: ThreadXRendererNode, debug: TrProps['debug']) => {
-      this.coreNode.debug = debug;
-    });
-  }
-
-  declare text: TextNodeStructWritableProps['text'];
-  declare textRendererOverride: TextNodeStructWritableProps['textRendererOverride'];
-  declare fontSize: TextNodeStructWritableProps['fontSize'];
-  declare fontFamily: TextNodeStructWritableProps['fontFamily'];
-  declare fontWeight: TextNodeStructWritableProps['fontWeight'];
-  declare fontStretch: TextNodeStructWritableProps['fontStretch'];
-  declare fontStyle: TextNodeStructWritableProps['fontStyle'];
-  declare lineHeight: TextNodeStructWritableProps['lineHeight'];
-  declare maxLines: TextNodeStructWritableProps['maxLines'];
-  declare textBaseline: TextNodeStructWritableProps['textBaseline'];
-  declare verticalAlign: TextNodeStructWritableProps['verticalAlign'];
-  declare overflowSuffix: TextNodeStructWritableProps['overflowSuffix'];
-  declare contain: TextNodeStructWritableProps['contain'];
-  declare letterSpacing: TextNodeStructWritableProps['letterSpacing'];
-  declare offsetY: TextNodeStructWritableProps['offsetY'];
-  declare textAlign: TextNodeStructWritableProps['textAlign'];
-  declare scrollable: TextNodeStructWritableProps['scrollable'];
-  declare scrollY: TextNodeStructWritableProps['scrollY'];
-}

package/src/render-drivers/threadx/worker/renderer.ts

@@ -1,156 +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 { ThreadX, BufferStruct } from '@lightningjs/threadx';
-import { NodeStruct, type NodeStructWritableProps } from '../NodeStruct.js';
-import { ThreadXRendererNode } from './ThreadXRendererNode.js';
-import { Stage, type StageFpsUpdateHandler } from '../../../core/Stage.js';
-import { assertTruthy } from '../../../utils.js';
-import {
-  isThreadXRendererMessage,
-  type ThreadXRendererFpsUpdateMessage,
-  type ThreadXRendererMessage,
-} from '../ThreadXRendererMessage.js';
-import { TextNodeStruct } from '../TextNodeStruct.js';
-import { ThreadXRendererTextNode } from './ThreadXRendererTextNode.js';
-import { loadCoreExtension } from '../../utils.js';
-
-let canvas: OffscreenCanvas | null = null;
-let stage: Stage | null = null;
-let rootNode: ThreadXRendererNode | null = null;
-const threadx = ThreadX.init({
-  workerId: 2,
-  workerName: 'renderer',
-  sharedObjectFactory(buffer) {
-    const typeId = BufferStruct.extractTypeId(buffer);
-    if (typeId === NodeStruct.typeId) {
-      const nodeStruct = new NodeStruct(buffer);
-      nodeStruct.parentId = nodeStruct.parentId || 0;
-      const node = nodeStruct.lock(() => {
-        assertTruthy(stage);
-        return new ThreadXRendererNode(stage, nodeStruct);
-      });
-      return node;
-    } else if (typeId === TextNodeStruct.typeId) {
-      const nodeStruct = new TextNodeStruct(buffer);
-      nodeStruct.parentId = nodeStruct.parentId || 0;
-      const node = nodeStruct.lock(() => {
-        assertTruthy(stage);
-        return new ThreadXRendererTextNode(stage, nodeStruct);
-      });
-      return node;
-    }
-    return null;
-  },
-  async onMessage(message: ThreadXRendererMessage) {
-    if (isThreadXRendererMessage('init', message)) {
-      canvas = message.canvas;
-      const nodeStruct = new NodeStruct();
-      stage = new Stage({
-        rootId: nodeStruct.id,
-        appWidth: message.appWidth,
-        appHeight: message.appHeight,
-        txMemByteThreshold: message.txMemByteThreshold,
-        boundsMargin: message.boundsMargin,
-        deviceLogicalPixelRatio: message.deviceLogicalPixelRatio,
-        devicePhysicalPixelRatio: message.devicePhysicalPixelRatio,
-        clearColor: message.clearColor,
-        canvas,
-        fpsUpdateInterval: message.fpsUpdateInterval,
-        enableContextSpy: message.enableContextSpy,
-        numImageWorkers: message.numImageWorkers,
-        renderMode: 'webgl',
-        debug: {
-          monitorTextureCache: false,
-        },
-      });
-
-      const coreRootNode = stage.root;
-
-      // We must initialize the root NodeStruct with the same properties from
-      // the CoreNode that the Stage created.
-      Object.assign(nodeStruct, {
-        x: coreRootNode.x,
-        y: coreRootNode.y,
-        width: coreRootNode.width,
-        height: coreRootNode.height,
-        alpha: coreRootNode.alpha,
-        autosize: coreRootNode.autosize,
-        clipping: coreRootNode.clipping,
-        color: coreRootNode.color,
-        colorTop: coreRootNode.colorTop,
-        colorRight: coreRootNode.colorRight,
-        colorBottom: coreRootNode.colorBottom,
-        colorLeft: coreRootNode.colorLeft,
-        colorTl: coreRootNode.colorTl,
-        colorTr: coreRootNode.colorTr,
-        colorBr: coreRootNode.colorBr,
-        colorBl: coreRootNode.colorBl,
-        parentId: coreRootNode.parent?.id ?? 0,
-        zIndex: coreRootNode.zIndex,
-        zIndexLocked: coreRootNode.zIndexLocked,
-        scaleX: coreRootNode.scaleX,
-        scaleY: coreRootNode.scaleY,
-        mount: coreRootNode.mount,
-        mountX: coreRootNode.mountX,
-        mountY: coreRootNode.mountY,
-        pivot: coreRootNode.pivot,
-        pivotX: coreRootNode.pivotX,
-        pivotY: coreRootNode.pivotY,
-        rotation: coreRootNode.rotation,
-        rtt: coreRootNode.rtt,
-      } satisfies NodeStructWritableProps);
-
-      // Share the root node that was created by the Stage with the main worker.
-      rootNode = new ThreadXRendererNode(stage, nodeStruct, coreRootNode);
-      await threadx.shareObjects('parent', [rootNode]);
-
-      // Load the Core Extension Module if one was specified.
-      if (message.coreExtensionModule) {
-        await loadCoreExtension(message.coreExtensionModule, stage);
-      }
-
-      // Forward FPS updates to the main worker.
-      stage.on('fpsUpdate', ((stage, fpsData) => {
-        threadx.sendMessage('parent', {
-          type: 'fpsUpdate',
-          fpsData: fpsData,
-        } satisfies ThreadXRendererFpsUpdateMessage);
-      }) satisfies StageFpsUpdateHandler);
-
-      // Return its ID so the main worker can retrieve it from the shared object
-      // store.
-      return rootNode.id;
-    } else if (isThreadXRendererMessage('releaseTexture', message)) {
-      assertTruthy(stage);
-      const txManager = stage.txManager;
-      assertTruthy(txManager);
-      txManager.removeTextureIdFromCache(message.textureDescId);
-    }
-  },
-  onObjectShared(object) {
-    // TBD
-  },
-  onBeforeObjectForgotten(object) {
-    if (object instanceof ThreadXRendererNode) {
-      object.parent = null;
-      object.destroy();
-    }
-  },
-});

package/src/render-drivers/utils.ts

@@ -1,102 +0,0 @@
-import { CoreExtension } from '../../exports/core-api.js';
-import type { Stage } from '../core/Stage.js';
-import type { CustomDataMap } from '../main-api/INode.js';
-
-/**
- * Type guard that checks if a Class extends CoreExtension.
- *
- * @param Class
- * @returns
- */
-export function classExtendsCoreExtension(
-  Class: unknown,
-): Class is new () => CoreExtension {
-  return (Class as typeof CoreExtension).prototype instanceof CoreExtension;
-}
-
-export async function loadCoreExtension(
-  coreExtensionModule: string,
-  stage: Stage,
-) {
-  let module: {
-    default?: unknown;
-  };
-  try {
-    console.log('Loading core extension', coreExtensionModule);
-    module = (await import(
-      coreExtensionModule /* @vite-ignore */
-    )) as typeof module;
-  } catch (e: unknown) {
-    console.error(
-      `The core extension module at '${coreExtensionModule}' could not be loaded.`,
-    );
-    console.error(e);
-    return;
-  }
-  if (!module.default) {
-    console.error(
-      `The core extension module at '${coreExtensionModule}' does not have a default export.`,
-    );
-    return;
-  }
-  const ExtensionClass = module.default;
-  if (classExtendsCoreExtension(ExtensionClass)) {
-    const coreExtension = new ExtensionClass();
-    try {
-      await coreExtension.run(stage);
-    } catch (e: unknown) {
-      console.error(
-        `The core extension at '${coreExtensionModule}' threw an error.`,
-      );
-      console.error(e);
-    }
-  } else {
-    console.error(
-      `The core extension at '${coreExtensionModule}' does not extend CoreExtension.`,
-    );
-  }
-}
-
-export function santizeCustomDataMap(d: CustomDataMap): CustomDataMap {
-  const validTypes = {
-    boolean: true,
-    string: true,
-    number: true,
-    undefined: true,
-  };
-
-  const keys = Object.keys(d);
-  for (let i = 0; i < keys.length; i++) {
-    const key = keys[i];
-    if (!key) {
-      continue;
-    }
-
-    const value = d[key];
-    const valueType = typeof value;
-
-    // Typescript doesn't understand the above const valueType ¯\_(ツ)_/¯
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore-next-line
-    if (valueType === 'string' && value.length > 2048) {
-      console.warn(
-        `Custom Data value for ${key} is too long, it will be truncated to 2048 characters`,
-      );
-
-      // same here, see above comment, this can only be a string at this point
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore-next-line
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
-      d[key] = value.substring(0, 2048);
-    }
-
-    if (!validTypes[valueType as keyof typeof validTypes]) {
-      console.warn(
-        `Custom Data value for ${key} is not a boolean, string, or number, it will be ignored`,
-      );
-      delete d[key];
-    }
-  }
-
-  return d;
-}