@lightningjs/renderer 0.0.1

package/dist/exports/utils.js

@@ -0,0 +1,42 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+/**
+ * Auxiliary Utilities
+ *
+ * @remarks
+ * This module exports the a set of utilities that may be optionally used by
+ * developers using the Lightning 3 Renderer.
+ *
+ * You can import the exports from this module like so:
+ * ```ts
+ * import { assertTruthy } from '@lightning/renderer';
+ * ```
+ *
+ * @internalRemarks
+ * Exports in here should be chosen wisely, as they will be exposed to
+ * directly developers.
+ *
+ * They should be general utilities that are NOT directly coupled to the
+ * Lightning Renderer, and not specific to any particular platform.
+ *
+ * @packageDocumentation
+ */
+export { assertTruthy, mergeColorAlpha } from '../src/utils.js';
+export { EventEmitter } from '../src/common/EventEmitter.js';
+//# sourceMappingURL=utils.js.map

package/dist/exports/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../exports/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/src/common/CommonTypes.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Types shared between Main Space and Core Space
+ *
+ * @remarks
+ *
+ * @module
+ */
+/**
+ * Represents a width and height.
+ */
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+/**
+ * Event handler for when a texture is loading
+ */
+export type TextureLoadingEventHandler = (target: any) => void;
+/**
+ * Event handler for when a texture is loaded
+ */
+export type TextureLoadedEventHandler = (target: any, dimensions: Readonly<Dimensions>) => void;
+/**
+ * Event handler for when a texture fails to load
+ */
+export type TextureFailedEventHandler = (target: any, error: Error) => void;
+/**
+ * Event handler for when text is loading
+ */
+export type TextLoadingEventHandler = (target: any) => void;
+/**
+ * Event handler for when text is loaded
+ */
+export type TextLoadedEventHandler = (target: any, dimensions: Dimensions) => void;
+/**
+ * Event handler for when text fails to load
+ */
+export type TextFailedEventHandler = (target: any, error: Error) => void;

package/dist/src/common/CommonTypes.js

@@ -0,0 +1,20 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+export {};
+//# sourceMappingURL=CommonTypes.js.map

package/dist/src/common/CommonTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonTypes.js","sourceRoot":"","sources":["../../../src/common/CommonTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}

package/dist/src/common/EventEmitter.d.ts

@@ -0,0 +1,12 @@
+import type { IEventEmitter } from '@lightningjs/threadx';
+/**
+ * EventEmitter base class
+ */
+export declare class EventEmitter implements IEventEmitter {
+    private eventListeners;
+    on(event: string, listener: (target: any, data: any) => void): void;
+    off(event: string, listener?: (target: any, data: any) => void): void;
+    once(event: string, listener: (target: any, data: any) => void): void;
+    emit(event: string, data?: any): void;
+    removeAllListeners(): void;
+}

package/dist/src/common/EventEmitter.js

@@ -0,0 +1,66 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+/**
+ * EventEmitter base class
+ */
+export class EventEmitter {
+    eventListeners = {};
+    on(event, listener) {
+        let listeners = this.eventListeners[event];
+        if (!listeners) {
+            listeners = [];
+        }
+        listeners.push(listener);
+        this.eventListeners[event] = listeners;
+    }
+    off(event, listener) {
+        const listeners = this.eventListeners[event];
+        if (!listeners) {
+            return;
+        }
+        if (!listener) {
+            delete this.eventListeners[event];
+            return;
+        }
+        const index = listeners.indexOf(listener);
+        if (index >= 0) {
+            listeners.splice(index, 1);
+        }
+    }
+    once(event, listener) {
+        const onceListener = (target, data) => {
+            this.off(event, onceListener);
+            listener(target, data);
+        };
+        this.on(event, onceListener);
+    }
+    emit(event, data) {
+        const listeners = this.eventListeners[event];
+        if (!listeners) {
+            return;
+        }
+        [...listeners].forEach((listener) => {
+            listener(this, data);
+        });
+    }
+    removeAllListeners() {
+        this.eventListeners = {};
+    }
+}
+//# sourceMappingURL=EventEmitter.js.map

package/dist/src/common/EventEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventEmitter.js","sourceRoot":"","sources":["../../../src/common/EventEmitter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAQH;;GAEG;AACH,MAAM,OAAO,YAAY;IACf,cAAc,GAAiC,EAAE,CAAC;IAE1D,EAAE,CAAC,KAAa,EAAE,QAA0C;QAC1D,IAAI,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG,EAAE,CAAC;SAChB;QACD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACzC,CAAC;IAED,GAAG,CAAC,KAAa,EAAE,QAA2C;QAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAClC,OAAO;SACR;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SAC5B;IACH,CAAC;IAED,IAAI,CAAC,KAAa,EAAE,QAA0C;QAC5D,MAAM,YAAY,GAAG,CAAC,MAAW,EAAE,IAAS,EAAE,EAAE;YAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAC9B,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,CAAC,KAAa,EAAE,IAAU;QAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,CAAC,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAClC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;CACF"}

package/dist/src/common/IAnimationController.d.ts

@@ -0,0 +1,9 @@
+export type AnimationControllerState = 'running' | 'paused' | 'stopped';
+export interface IAnimationController {
+    start(): IAnimationController;
+    stop(): IAnimationController;
+    pause(): IAnimationController;
+    restore(): IAnimationController;
+    waitUntilStopped(): Promise<void>;
+    readonly state: AnimationControllerState;
+}

package/dist/src/common/IAnimationController.js

@@ -0,0 +1,20 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+export {};
+//# sourceMappingURL=IAnimationController.js.map

package/dist/src/common/IAnimationController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAnimationController.js","sourceRoot":"","sources":["../../../src/common/IAnimationController.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}

package/dist/src/core/CoreExtension.d.ts

@@ -0,0 +1,12 @@
+import type { Stage } from './Stage.js';
+/**
+ * Base class for Core extensions.
+ *
+ * @remarks
+ * Core extensions are used to extend the Core Renderer with custom code such as
+ * custom fonts, custom shaders, custom textures, custom animation functions,
+ * and more.
+ */
+export declare abstract class CoreExtension {
+    abstract run(stage: Stage): Promise<void>;
+}

package/dist/src/core/CoreExtension.js

@@ -0,0 +1,29 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+/**
+ * Base class for Core extensions.
+ *
+ * @remarks
+ * Core extensions are used to extend the Core Renderer with custom code such as
+ * custom fonts, custom shaders, custom textures, custom animation functions,
+ * and more.
+ */
+export class CoreExtension {
+}
+//# sourceMappingURL=CoreExtension.js.map

package/dist/src/core/CoreExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreExtension.js","sourceRoot":"","sources":["../../../src/core/CoreExtension.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH;;;;;;;GAOG;AACH,MAAM,OAAgB,aAAa;CAElC"}

package/dist/src/core/CoreNode.d.ts

@@ -0,0 +1,147 @@
+import type { ShaderMap } from './CoreShaderManager.js';
+import type { ExtractProps, TextureMap, TextureOptions } from './CoreTextureManager.js';
+import { Matrix2DContext } from './Matrix2DContext.js';
+import type { CoreRenderer } from './renderers/CoreRenderer.js';
+import type { CoreShader } from './renderers/CoreShader.js';
+import type { Stage } from './Stage.js';
+import type { Texture } from './textures/Texture.js';
+import { EventEmitter } from '../common/EventEmitter.js';
+export interface CoreNodeProps {
+    id: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    alpha: number;
+    color: number;
+    colorTop: number;
+    colorBottom: number;
+    colorLeft: number;
+    colorRight: number;
+    colorTl: number;
+    colorTr: number;
+    colorBl: number;
+    colorBr: number;
+    parent: CoreNode | null;
+    zIndex: number;
+    texture: Texture | null;
+    textureOptions: TextureOptions | null;
+    shader: CoreShader | null;
+    shaderProps: Record<string, unknown> | null;
+    zIndexLocked: number;
+    scale: number;
+    mount: number;
+    mountX: number;
+    mountY: number;
+    pivot: number;
+    pivotX: number;
+    pivotY: number;
+    rotation: number;
+    worldX?: number;
+    worldY?: number;
+    ta?: number;
+    tb?: number;
+    tc?: number;
+    td?: number;
+}
+type ICoreNode = Omit<CoreNodeProps, 'texture' | 'textureOptions' | 'shader' | 'shaderProps'>;
+export declare class CoreNode extends EventEmitter implements ICoreNode {
+    protected stage: Stage;
+    readonly children: CoreNode[];
+    protected props: Required<CoreNodeProps>;
+    /**
+     * Recalculation type
+     * 0 - no recalculation
+     * 1 - alpha recalculation
+     * 2 - translate recalculation
+     * 4 - transform recalculation
+     */
+    recalculationType: number;
+    hasUpdates: boolean;
+    worldContext: Matrix2DContext;
+    localPx: number;
+    localPy: number;
+    private isComplex;
+    constructor(stage: Stage, props: CoreNodeProps);
+    loadTexture<Type extends keyof TextureMap>(textureType: Type, props: ExtractProps<TextureMap[Type]>, options?: TextureOptions | null): void;
+    unloadTexture(): void;
+    private onTextureLoaded;
+    private onTextureFailed;
+    loadShader<Type extends keyof ShaderMap>(shaderType: Type, props: ExtractProps<ShaderMap[Type]>): void;
+    setHasUpdates(): void;
+    /**
+     * 1 - alpha recalculation
+     * 2 - translate recalculation
+     * 4 - transform recalculation
+     * @param type
+     */
+    setRecalculationType(type: number): void;
+    updateLocalTransform(): void;
+    setLocalTransform(a: number, b: number, c: number, d: number): void;
+    updateLocalTranslate(): void;
+    /**
+     * @todo: test for correct calculation flag
+     * @param delta
+     */
+    update(delta: number): void;
+    renderQuads(renderer: CoreRenderer): void;
+    get id(): number;
+    get x(): number;
+    set x(value: number);
+    get worldX(): number;
+    set worldX(value: number);
+    get worldY(): number;
+    set worldY(value: number);
+    get absX(): number;
+    get absY(): number;
+    get y(): number;
+    set y(value: number);
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: number);
+    get scale(): number;
+    set scale(value: number);
+    get worldScale(): number;
+    get mount(): number;
+    set mount(value: number);
+    get mountX(): number;
+    set mountX(value: number);
+    get mountY(): number;
+    set mountY(value: number);
+    get pivot(): number;
+    set pivot(value: number);
+    get pivotX(): number;
+    set pivotX(value: number);
+    get pivotY(): number;
+    set pivotY(value: number);
+    get rotation(): number;
+    set rotation(value: number);
+    get alpha(): number;
+    set alpha(value: number);
+    get color(): number;
+    set color(value: number);
+    get colorTop(): number;
+    set colorTop(value: number);
+    get colorBottom(): number;
+    set colorBottom(value: number);
+    get colorLeft(): number;
+    set colorLeft(value: number);
+    get colorRight(): number;
+    set colorRight(value: number);
+    get colorTl(): number;
+    set colorTl(value: number);
+    get colorTr(): number;
+    set colorTr(value: number);
+    get colorBl(): number;
+    set colorBl(value: number);
+    get colorBr(): number;
+    set colorBr(value: number);
+    get zIndexLocked(): number;
+    set zIndexLocked(value: number);
+    get zIndex(): number;
+    set zIndex(value: number);
+    get parent(): CoreNode | null;
+    set parent(newParent: CoreNode | null);
+}
+export {};