@lightningjs/renderer 0.3.0 → 0.3.2

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

@@ -0,0 +1,117 @@
+/*
+ * 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 { IRenderDriver } from '../../main-api/IRenderDriver.js';
+import type {
+  INode,
+  INodeWritableProps,
+  ITextNodeWritableProps,
+} from '../../main-api/INode.js';
+import { MainOnlyNode } from './MainOnlyNode.js';
+import { Stage } from '../../core/Stage.js';
+import type {
+  RendererMain,
+  RendererMainSettings,
+} from '../../main-api/RendererMain.js';
+import { MainOnlyTextNode } from './MainOnlyTextNode.js';
+import { loadCoreExtension } from '../utils.js';
+
+export class MainRenderDriver implements IRenderDriver {
+  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: 1,
+      appWidth: rendererSettings.appWidth,
+      appHeight: rendererSettings.appHeight,
+      deviceLogicalPixelRatio: rendererSettings.deviceLogicalPixelRatio,
+      devicePhysicalPixelRatio: rendererSettings.devicePhysicalPixelRatio,
+      clearColor: rendererSettings.clearColor,
+      canvas,
+      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);
+    }
+  }
+
+  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;
+  }
+
+  onCreateNode(node: INode): void {
+    throw new Error('Method not implemented.');
+  }
+
+  onBeforeDestroyNode(node: INode): void {
+    throw new Error('Method not implemented.');
+  }
+}

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

@@ -0,0 +1,290 @@
+/*
+ * 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 { BufferStruct, structProp, genTypeId } from '@lightningjs/threadx';
+
+export interface NodeStructWritableProps {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  alpha: number;
+  clipping: boolean;
+  color: number;
+  colorTop: number;
+  colorBottom: number;
+  colorLeft: number;
+  colorRight: number;
+  colorTl: number;
+  colorTr: number;
+  colorBr: number;
+  colorBl: number;
+  parentId: number;
+  zIndex: number;
+  zIndexLocked: number;
+  scale: number;
+  mount: number;
+  mountX: number;
+  mountY: number;
+  pivot: number;
+  pivotX: number;
+  pivotY: number;
+  rotation: number;
+}
+
+export class NodeStruct
+  extends BufferStruct
+  implements NodeStructWritableProps
+{
+  static override readonly typeId = genTypeId('NODE');
+
+  @structProp('number')
+  get x(): number {
+    return 0;
+  }
+
+  set x(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get y(): number {
+    return 0;
+  }
+
+  set y(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get width(): number {
+    return 0;
+  }
+
+  set width(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get height(): number {
+    return 0;
+  }
+
+  set height(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get alpha(): number {
+    return 1;
+  }
+
+  set alpha(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('boolean')
+  get clipping(): boolean {
+    return false;
+  }
+
+  set clipping(value: boolean) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get color(): number {
+    return 0;
+  }
+
+  set color(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorTop(): number {
+    return 0;
+  }
+
+  set colorTop(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorBottom(): number {
+    return 0;
+  }
+
+  set colorBottom(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorLeft(): number {
+    return 0;
+  }
+
+  set colorLeft(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorRight(): number {
+    return 0;
+  }
+
+  set colorRight(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorTl(): number {
+    return 0;
+  }
+
+  set colorTl(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorTr(): number {
+    return 0;
+  }
+
+  set colorTr(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorBl(): number {
+    return 0;
+  }
+
+  set colorBl(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get colorBr(): number {
+    return 0;
+  }
+
+  set colorBr(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get scale(): number {
+    return 1;
+  }
+
+  set scale(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get mount(): number {
+    return 0;
+  }
+
+  set mount(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get mountX(): number {
+    return 0;
+  }
+
+  set mountX(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get mountY(): number {
+    return 0;
+  }
+
+  set mountY(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get pivot(): number {
+    return 0.5;
+  }
+
+  set pivot(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get pivotX(): number {
+    return 0.5;
+  }
+
+  set pivotX(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get pivotY(): number {
+    return 0.5;
+  }
+
+  set pivotY(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get rotation(): number {
+    return 0;
+  }
+
+  set rotation(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get parentId(): number {
+    return 0;
+  }
+
+  set parentId(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get zIndex(): number {
+    return 0;
+  }
+
+  set zIndex(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get zIndexLocked(): number {
+    return 0;
+  }
+
+  set zIndexLocked(value: number) {
+    // Decorator will handle this
+  }
+}

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

@@ -0,0 +1,95 @@
+/*
+ * 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 { NodeStruct, NodeStructWritableProps } from './NodeStruct.js';
+import { SharedObject } from '@lightningjs/threadx';
+
+export class SharedNode extends SharedObject {
+  declare z$__type__Props: NodeStructWritableProps &
+    SharedObject['z$__type__Props'];
+
+  /**
+   * Must have lock on sharedNode before calling constructor!
+   *
+   * @param sharedNodeStruct
+   */
+  constructor(
+    sharedNodeStruct: NodeStruct,
+    extendedCurProps?: Record<string, unknown>,
+  ) {
+    super(sharedNodeStruct, {
+      ...extendedCurProps,
+      x: sharedNodeStruct.x,
+      y: sharedNodeStruct.y,
+      width: sharedNodeStruct.width,
+      height: sharedNodeStruct.height,
+      alpha: sharedNodeStruct.alpha,
+      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,
+      parentId: sharedNodeStruct.parentId,
+      zIndex: sharedNodeStruct.zIndex,
+      zIndexLocked: sharedNodeStruct.zIndexLocked,
+      scale: sharedNodeStruct.scale,
+      mount: sharedNodeStruct.mount,
+      mountX: sharedNodeStruct.mountX,
+      mountY: sharedNodeStruct.mountY,
+      pivot: sharedNodeStruct.pivot,
+      pivotX: sharedNodeStruct.pivotX,
+      pivotY: sharedNodeStruct.pivotY,
+      rotation: sharedNodeStruct.rotation,
+    } satisfies NodeStructWritableProps);
+  }
+
+  // Declare getters and setters for all properties that are automatically
+  // generated on this class.
+  declare x: number;
+  declare y: number;
+  declare width: number;
+  declare height: number;
+  declare alpha: number;
+  declare clipping: boolean;
+  declare color: number;
+  declare colorTop: number;
+  declare colorBottom: number;
+  declare colorLeft: number;
+  declare colorRight: number;
+  declare colorTl: number;
+  declare colorTr: number;
+  declare colorBl: number;
+  declare colorBr: number;
+  declare scale: number;
+  declare mountX: number;
+  declare mountY: number;
+  declare mount: number;
+  declare pivot: number;
+  declare pivotX: number;
+  declare pivotY: number;
+  declare rotation: number;
+  protected declare parentId: number;
+  declare zIndex: number;
+  declare zIndexLocked: number;
+}

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

@@ -0,0 +1,166 @@
+/*
+ * 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 { structProp, genTypeId } from '@lightningjs/threadx';
+import { NodeStruct, type NodeStructWritableProps } from './NodeStruct.js';
+import type {
+  TextRendererMap,
+  TrProps,
+} from '../../core/text-rendering/renderers/TextRenderer.js';
+
+export interface TextNodeStructWritableProps
+  extends NodeStructWritableProps,
+    Omit<TrProps, 'debug'> {
+  textRendererOverride: keyof TextRendererMap | null;
+}
+
+export class TextNodeStruct
+  extends NodeStruct
+  implements TextNodeStructWritableProps
+{
+  static override readonly typeId = genTypeId('TEXT');
+
+  @structProp('string')
+  get text(): string {
+    return '';
+  }
+
+  set text(value: string) {
+    // Decorator will handle this
+  }
+
+  @structProp('string', {
+    propToBuffer(value: TextNodeStructWritableProps['textRendererOverride']) {
+      // Property accepts `null` but the buffer only accepts a string.
+      // Encode `null` as a special string
+      return value ?? '$$null';
+    },
+    bufferToProp(value: string) {
+      return value === '$$null' ? null : (value as keyof TextRendererMap);
+    },
+  })
+  get textRendererOverride(): TextNodeStructWritableProps['textRendererOverride'] {
+    return null;
+  }
+
+  set textRendererOverride(
+    value: TextNodeStructWritableProps['textRendererOverride'],
+  ) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get fontSize(): number {
+    return 0;
+  }
+
+  set fontSize(value: number) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get fontFamily(): TextNodeStructWritableProps['fontFamily'] {
+    return '';
+  }
+
+  set fontFamily(value: TextNodeStructWritableProps['fontFamily']) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get fontStretch(): TextNodeStructWritableProps['fontStretch'] {
+    return 'normal';
+  }
+
+  set fontStretch(value: TextNodeStructWritableProps['fontStretch']) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get fontStyle(): TextNodeStructWritableProps['fontStyle'] {
+    return 'normal';
+  }
+
+  set fontStyle(value: TextNodeStructWritableProps['fontStyle']) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get fontWeight(): TextNodeStructWritableProps['fontWeight'] {
+    return 'normal';
+  }
+
+  set fontWeight(value: TextNodeStructWritableProps['fontWeight']) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get textAlign(): TextNodeStructWritableProps['textAlign'] {
+    return 'left';
+  }
+
+  set textAlign(value: TextNodeStructWritableProps['textAlign']) {
+    // Decorator will handle this
+  }
+
+  @structProp('string')
+  get contain(): TextNodeStructWritableProps['contain'] {
+    return 'none';
+  }
+
+  set contain(value: TextNodeStructWritableProps['contain']) {
+    // Decorator will handle this
+  }
+
+  @structProp('boolean')
+  get scrollable(): TextNodeStructWritableProps['scrollable'] {
+    return false;
+  }
+
+  set scrollable(value: TextNodeStructWritableProps['scrollable']) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get scrollY(): TextNodeStructWritableProps['scrollY'] {
+    return 0;
+  }
+
+  set scrollY(value: TextNodeStructWritableProps['scrollY']) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get offsetY(): TextNodeStructWritableProps['offsetY'] {
+    return 0;
+  }
+
+  set offsetY(value: TextNodeStructWritableProps['offsetY']) {
+    // Decorator will handle this
+  }
+
+  @structProp('number')
+  get letterSpacing(): TextNodeStructWritableProps['letterSpacing'] {
+    return 0;
+  }
+
+  set letterSpacing(value: TextNodeStructWritableProps['letterSpacing']) {
+    // Decorator will handle this
+  }
+}