@lightningjs/renderer 0.9.4 → 1.0.0-rc.1

package/src/utils.ts

@@ -237,3 +237,11 @@ export function getImageAspectRatio(width: number, height: number): number {
 export function isProductionEnvironment(): boolean {
   return import.meta.env && import.meta.env.PROD;
 }
+
+/**
+ * Returns a new unique ID
+ */
+let nextId = 1;
+export function getNewId(): number {
+  return nextId++;
+}

package/dist/exports/core-api.d.ts

@@ -1,74 +0,0 @@
-/**
- * Lightning 3 Renderer Core API
- *
- * @remarks
- * ```
- * import * from '@lightning/renderer/core';
- * ```
- *
- * The Core API is used by developers to extend the capabilities of the Renderer
- * by writing custom Shaders, Dynamic Shader Effects, Textures, Text Renderers,
- * etc.
- *
- * Custom capabilities as well as fonts can be loaded via Core Extensions.
- *
- * A core extension module is structured like so:
- * ```ts
- * import {
- *   CoreExtension,
- *   WebTrFontFace,
- *   SdfTrFontFace,
- *   type Stage
- * } from '@lightning/renderer/core';
- *
- * export default class MyCoreExtension extends CoreExtension {
- *   async run(stage: Stage) {
- *     stage.fontManager.addFontFace(
- *       new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
- *     );
- *
- *     stage.fontManager.addFontFace(
- *       new SdfTrFontFace(
- *         'Ubuntu',
- *         {},
- *         'msdf',
- *         stage,
- *         '/fonts/Ubuntu-Regular.msdf.png',
- *         '/fonts/Ubuntu-Regular.msdf.json',
- *       ),
- *     );
- *   }
- * }
- * ```
- *
- * And then imported and registered in the application's entry point
- * using the `@lightningjs/vite-plugin-import-chunk-url` plugin:
- * ```ts
- * import coreExtensionModuleUrl from './MyCoreExtension.js?importChunkUrl';
- *
- * // Set up driver, etc.
- *
- * // Initialize the Renderer
- * const renderer = new RendererMain(
- *   {
- *     // Other Renderer Config...
- *     coreExtensionModule: coreExtensionModuleUrl,
- *   },
- *   'app',
- *   driver,
- * );
- * ```
- *
- * @module
- */
-export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
-export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
-export * from '../src/core/textures/Texture.js';
-export * from '../src/core/text-rendering/renderers/TextRenderer.js';
-export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
-export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
-export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
-export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
-export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
-export * from '../src/core/CoreExtension.js';
-export type * from '../src/core/Stage.js';

package/dist/exports/core-api.js

@@ -1,96 +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.
- */
-/**
- * Lightning 3 Renderer Core API
- *
- * @remarks
- * ```
- * import * from '@lightning/renderer/core';
- * ```
- *
- * The Core API is used by developers to extend the capabilities of the Renderer
- * by writing custom Shaders, Dynamic Shader Effects, Textures, Text Renderers,
- * etc.
- *
- * Custom capabilities as well as fonts can be loaded via Core Extensions.
- *
- * A core extension module is structured like so:
- * ```ts
- * import {
- *   CoreExtension,
- *   WebTrFontFace,
- *   SdfTrFontFace,
- *   type Stage
- * } from '@lightning/renderer/core';
- *
- * export default class MyCoreExtension extends CoreExtension {
- *   async run(stage: Stage) {
- *     stage.fontManager.addFontFace(
- *       new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
- *     );
- *
- *     stage.fontManager.addFontFace(
- *       new SdfTrFontFace(
- *         'Ubuntu',
- *         {},
- *         'msdf',
- *         stage,
- *         '/fonts/Ubuntu-Regular.msdf.png',
- *         '/fonts/Ubuntu-Regular.msdf.json',
- *       ),
- *     );
- *   }
- * }
- * ```
- *
- * And then imported and registered in the application's entry point
- * using the `@lightningjs/vite-plugin-import-chunk-url` plugin:
- * ```ts
- * import coreExtensionModuleUrl from './MyCoreExtension.js?importChunkUrl';
- *
- * // Set up driver, etc.
- *
- * // Initialize the Renderer
- * const renderer = new RendererMain(
- *   {
- *     // Other Renderer Config...
- *     coreExtensionModule: coreExtensionModuleUrl,
- *   },
- *   'app',
- *   driver,
- * );
- * ```
- *
- * @module
- */
-// Shaders
-export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
-export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
-// Textures
-export * from '../src/core/textures/Texture.js';
-// Text Rendering & Fonts
-export * from '../src/core/text-rendering/renderers/TextRenderer.js';
-export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
-export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
-export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
-export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
-export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
-// Core Extensions
-export * from '../src/core/CoreExtension.js';
-//# sourceMappingURL=core-api.js.map

package/dist/exports/core-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-api.js","sourceRoot":"","sources":["../../exports/core-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AAEH,UAAU;AACV,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6DAA6D,CAAC;AAE5E,WAAW;AACX,cAAc,iCAAiC,CAAC;AAEhD,yBAAyB;AACzB,cAAc,sDAAsD,CAAC;AACrE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,yEAAyE,CAAC;AACxF,cAAc,0DAA0D,CAAC;AACzE,cAAc,6DAA6D,CAAC;AAC5E,cAAc,2EAA2E,CAAC;AAE1F,kBAAkB;AAClB,cAAc,8BAA8B,CAAC"}

package/dist/exports/main-api.d.ts

@@ -1,30 +0,0 @@
-/**
- * Lightning 3 Renderer Main API
- *
- * @remarks
- * This module exports the Main API for the Lightning 3 Renderer. You
- * can import the exports from this module like so:
- * ```ts
- * import { RendererMain } from '@lightning/renderer';
- * ```
- *
- * Generally developers/frameworks using the Renderer will use the Main API to
- * render applications.
- *
- * Do not confuse the Main API with the Core API which is used to extend
- * capabilities of the Renderer. The Main API code always runs from the main
- * thread.
- *
- * @module
- */
-export * from '../src/main-api/INode.js';
-export * from '../src/main-api/ICoreDriver.js';
-export * from '../src/main-api/RendererMain.js';
-export * from '../src/render-drivers/main/MainCoreDriver.js';
-export * from '../src/render-drivers/threadx/ThreadXCoreDriver.js';
-export * from '../src/common/IAnimationController.js';
-export * from '../src/common/CommonTypes.js';
-export type { TextRendererMap } from '../src/core/text-rendering/renderers/TextRenderer.js';
-export type { TrFontFaceMap } from '../src/core/text-rendering/font-face-types/TrFontFace.js';
-export type { AnimationSettings } from '../src/core/animations/CoreAnimation.js';
-export type { EffectMap, EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, HolePunchEffectProps, } from '../src/core/CoreShaderManager.js';

package/dist/exports/main-api.js

@@ -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.
- */
-/**
- * Lightning 3 Renderer Main API
- *
- * @remarks
- * This module exports the Main API for the Lightning 3 Renderer. You
- * can import the exports from this module like so:
- * ```ts
- * import { RendererMain } from '@lightning/renderer';
- * ```
- *
- * Generally developers/frameworks using the Renderer will use the Main API to
- * render applications.
- *
- * Do not confuse the Main API with the Core API which is used to extend
- * capabilities of the Renderer. The Main API code always runs from the main
- * thread.
- *
- * @module
- */
-export * from '../src/main-api/INode.js';
-export * from '../src/main-api/ICoreDriver.js';
-export * from '../src/main-api/RendererMain.js';
-export * from '../src/render-drivers/main/MainCoreDriver.js';
-export * from '../src/render-drivers/threadx/ThreadXCoreDriver.js';
-export * from '../src/common/IAnimationController.js';
-export * from '../src/common/CommonTypes.js';
-//# sourceMappingURL=main-api.js.map

package/dist/exports/main-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"main-api.js","sourceRoot":"","sources":["../../exports/main-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,oDAAoD,CAAC;AACnE,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC"}

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

@@ -1,12 +0,0 @@
-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

@@ -1,29 +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.
- */
-/**
- * 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

@@ -1 +0,0 @@
-{"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/renderers/SpecificNode.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/core/renderers/SpecificNode.js

@@ -1,19 +0,0 @@
-export {};
-// // @ts-expect-error Allow the "incorrect" overriding of the shader properties
-// export interface INode<S extends keyof ShaderMap = 'DefaultShader'>
-//   extends CoreNode {
-//   shaderProps: ExtractProps<ShaderMap[S]>;
-//   shader: SpecificShaderRef<S>;
-//   animate(props: Partial<INodeAnimatableProps<S>>, settings: Partial<AnimationSettings>): IAnimationController;
-// }
-// // @ts-expect-error Allow the "incorrect" overriding of the shader properties
-// export interface INodeWritableProps<
-//   S extends keyof ShaderMap = 'DefaultShader',
-// > extends CoreNodeWritableProps {
-//   shader: SpecificShaderRef<S>;
-// }
-// // @ts-expect-error Allow the "incorrect" overriding of the shader properties
-// export interface INodeAnimatableProps<S extends keyof ShaderMap = 'DefaultShader'> extends CoreNodeAnimatableProps {
-//   shaderProps: ExtractProps<ShaderMap[S]>;
-// };
-//# sourceMappingURL=SpecificNode.js.map

package/dist/src/core/renderers/SpecificNode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SpecificNode.js","sourceRoot":"","sources":["../../../../src/core/renderers/SpecificNode.ts"],"names":[],"mappings":";AAOA,gFAAgF;AAChF,sEAAsE;AACtE,uBAAuB;AACvB,6CAA6C;AAC7C,kCAAkC;AAClC,kHAAkH;AAClH,IAAI;AAEJ,gFAAgF;AAChF,uCAAuC;AACvC,iDAAiD;AACjD,oCAAoC;AACpC,kCAAkC;AAClC,IAAI;AAEJ,gFAAgF;AAChF,uHAAuH;AACvH,6CAA6C;AAC7C,KAAK"}

package/dist/src/core/renderers/webgl/newShader/effectsMock.d.ts

@@ -1,13 +0,0 @@
-import type { ShaderMap } from "../../../CoreShaderManager.js";
-/**
- * Shader Controller Base Interface
- *
- * @remarks
- * Used directly this interface is like an `any` type for Shader Controllers.
- * But it is also used as a base for more specific Shader Controller interfaces.
- */
-export interface AnyShaderController {
-    type: keyof ShaderMap;
-    shader: any;
-    props: any;
-}

package/dist/src/core/renderers/webgl/newShader/effectsMock.js

@@ -1,62 +0,0 @@
-function createEffect(name, type, props) {
-    return {
-        name,
-        type,
-        props
-    };
-}
-const renderer = {};
-// RoundedRectangle Shader
-const node2 = renderer.createNode({
-    shader: renderer.createShader('RoundedRectangle', {
-        radius: 100
-    })
-});
-node2.shader.props.radius = 200;
-node2.animate({
-    shaderProps: {
-        radius: 200
-    }
-});
-// Dynamic Shader
-class Effect {
-    props;
-    constructor(props) {
-        this.props = props;
-    }
-}
-class SomeEffect extends Effect {
-    constructor(props) {
-        super(props);
-    }
-}
-class SomeEffect2 extends Effect {
-    constructor(props) {
-        super(props);
-    }
-}
-const node = renderer.createNode({
-    shader: renderer.createDynamicShader([
-        createEffect('e1', 'SomeEffect', { color: 0xff0000 }),
-        createEffect('e2', 'SomeEffect2', { color2: 0xff0000 }),
-    ])
-});
-node.animate({
-    x: 12,
-    shaderProps: {
-        e1: {
-            color: 0x00ff00
-        },
-        e2: {
-            color2: 0x00ff00
-        },
-    }
-});
-node.shader.props.e1.color = 0x00ff00;
-// Default Shader
-const node3 = renderer.createNode({
-    x: 0,
-    y: 0
-});
-export {};
-//# sourceMappingURL=effectsMock.js.map

package/dist/src/core/renderers/webgl/newShader/effectsMock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"effectsMock.js","sourceRoot":"","sources":["../../../../../../src/core/renderers/webgl/newShader/effectsMock.ts"],"names":[],"mappings":"AAaA,SAAS,YAAY,CAAoD,IAAU,EAAE,IAAU,EAAE,KAA8D;IAC7J,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,KAAK;KACN,CAAC;AACJ,CAAC;AA6JD,MAAM,QAAQ,GAAa,EAAc,CAAC;AAuB1C,0BAA0B;AAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;IAChC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE;QAChD,MAAM,EAAE,GAAG;KACZ,CAAC;CACH,CAAC,CAAC;AAEH,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;AAEhC,KAAK,CAAC,OAAO,CAAC;IACZ,WAAW,EAAE;QACX,MAAM,EAAE,GAAG;KACZ;CACF,CAAC,CAAC;AAiBH,iBAAiB;AACjB,MAAM,MAAM;IACV,KAAK,CAAU;IAEf,YAAY,KAA8B;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,MAAM;IAK7B,YAAY,KAA0B;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF;AAED,MAAM,WAAY,SAAQ,MAAM;IAK9B,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF;AAgBD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC/B,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QACnC,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QACrD,YAAY,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;KACxD,CAAC;CACH,CAAC,CAAA;AAGF,IAAI,CAAC,OAAO,CAAC;IACX,CAAC,EAAE,EAAE;IACL,WAAW,EAAE;QACX,EAAE,EAAE;YACF,KAAK,EAAE,QAAQ;SAChB;QACD,EAAE,EAAE;YACF,MAAM,EAAE,QAAQ;SACjB;KACF;CACF,CAAC,CAAC;AAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC;AAuBtC,iBAAiB;AACjB,MAAM,KAAK,GAAU,QAAQ,CAAC,UAAU,CAAC;IACvC,CAAC,EAAE,CAAC;IACJ,CAAC,EAAE,CAAC;CACL,CAAC,CAAC"}

package/dist/src/main-api/ICoreDriver.d.ts

@@ -1,24 +0,0 @@
-import type { FpsUpdatePayload, FrameTickPayload } from '../common/CommonTypes.js';
-import type { INode, INodeWritableProps, ITextNode, ITextNodeWritableProps } from './INode.js';
-import type { RendererMain, RendererMainSettings } from './RendererMain.js';
-/**
- * This interface is to be implemented by Core Drivers
- *
- * @remarks
- * Both the {@link MainCoreDriver} and the {@link ThreadXCoreDriver} exist
- * that implement this interface to support both the single-threaded and
- * multi-threaded Core modes.
- */
-export interface ICoreDriver {
-    init(rendererMain: RendererMain, rendererSettings: Required<RendererMainSettings>, canvas: HTMLCanvasElement): Promise<void>;
-    createNode(props: INodeWritableProps): INode;
-    createTextNode(props: ITextNodeWritableProps): ITextNode;
-    destroyNode(node: INode): void;
-    getRootNode(): INode;
-    releaseTexture(textureDescId: number): void;
-    onCreateNode(node: INode): void;
-    onBeforeDestroyNode(node: INode): void;
-    onFpsUpdate(fpsData: FpsUpdatePayload): void;
-    onFrameTick(frameTickData: FrameTickPayload): void;
-    onIdle?(): void;
-}

package/dist/src/main-api/ICoreDriver.js

@@ -1,20 +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.
- */
-export {};
-//# sourceMappingURL=ICoreDriver.js.map

package/dist/src/main-api/ICoreDriver.js.map

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