@lightningjs/renderer 3.0.0-beta2 → 3.0.0-beta20

package/src/utils.ts

@@ -64,6 +64,15 @@ export function createWebGLContext(
   return gl;
 }
 
+/**
+ * Checks if we're in a development environment or not.
+ *
+ * @returns
+ */
+declare const __DEV__: boolean;
+export const isProductionEnvironment =
+  typeof __DEV__ !== 'undefined' ? !__DEV__ : true;
+
 /**
  * Asserts a condition is truthy, otherwise throws an error
  *
@@ -80,7 +89,7 @@ export function assertTruthy(
   condition: unknown,
   message?: string,
 ): asserts condition {
-  if (isProductionEnvironment() === true) return;
+  if (isProductionEnvironment === true) return;
   if (!condition) {
     throw new Error(message || 'Assertion failed');
   }
@@ -230,15 +239,6 @@ export function getImageAspectRatio(width: number, height: number): number {
   return width / height;
 }
 
-/**
- * Checks import.meta if env is production
- *
- * @returns
- */
-export function isProductionEnvironment(): boolean {
-  return import.meta.env && import.meta.env.PROD;
-}
-
 /**
  * Returns a new unique ID
  */

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 { EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, } 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/CoreStuff.d.ts

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

package/dist/src/core/CoreStuff.js

@@ -1,138 +0,0 @@
-export {};
-/*interface InstanceMap {
-  renderer: CoreRenderer;
-  effect: CoreEffect;
-  program: new () => void;
-}
-
-type WebGlInstanceMap = InstanceMap & {
-  renderer: WebGlCoreRenderer;
-  effect: WebGlEffect;
-};
-
-interface AdvEffectProp {
-  default: any;
-  isColor?: boolean;
-  validator?: (value: any) => any;
-}
-
-interface EffectProps {
-  [key: string]: any | AdvEffectProp;
-}
-
-type EffectDescriptor<Effect, Props> = Effect & {
-  props?: Props;
-};
-
-type InferEffectProps<T> = {
-  [K in keyof T]: T[K] extends AdvEffectProp ? T[K]['default'] : T[K];
-};
-
-interface CoreEffect {
-  props?: EffectProps;
-  update?: (ctx: unknown) => void;
-}
-
-type WebGlEffect = CoreEffect & {
-  fragment: string;
-  update?: (glw: WebGLRenderingContext) => void;
-};
-
-type StageOptions<Renderer extends InstanceMap> = {
-  renderEngine?: new () => Renderer['renderer'];
-};
-
-class Stage<RendererMap extends InstanceMap> {
-  fxManager: CoreFxManager<RendererMap>;
-  constructor(options: StageOptions<RendererMap>) {
-    this.fxManager = new CoreFxManager();
-    const renderer = new options.renderEngine();
-  }
-
-  createShader<Effect extends RendererMap['effect'], Props>(
-    effect: EffectDescriptor<Effect, Props>,
-    props?: InferEffectProps<Props>
-  ): EffectNode<Effect, Props> {
-    return this.fxManager.createShader(effect, props);
-  }
-}
-
-class CoreRenderer {
-  mode = 'core';
-}
-
-class WebGlCoreRenderer extends CoreRenderer {
-  override mode = 'webgl';
-}
-
-class CanvasCoreRenderer extends CoreRenderer {
-  override mode = 'canvas';
-}
-
-class CoreFxManager<RendererMap extends InstanceMap> {
-  fxCache: Map<string, RendererMap['effect']> = new Map();
-
-  resolveProps(defaultProps?: EffectProps, props?: EffectProps) {
-    if(defaultProps !== undefined) {
-      props = props ?? {}
-      const keys = Object.keys(defaultProps);
-      const l = keys.length;
-      for(let i = 0; i < l; i++) {
-        if(props[keys[i]] === undefined) {
-          props[keys[i]] = defaultProps[keys[i]].default || defaultProps[keys[i]]
-        }
-      }
-    }
-  }
-
-  createShader<Effect extends RendererMap['effect'], Props>(
-    effect: EffectDescriptor<Effect, Props>,
-    props?: InferEffectProps<Props>
-  ): EffectNode<Effect, Props> {
-
-    // const f = JSON.stringify(effect);
-    // if (this.fxCache.has(f)) {
-    //   console.log('already has this effect');
-    // } else {
-    //   console.log('create new effect program');
-    //   this.fxCache.set(f, effect);
-    // }
-
-    return new EffectNode<Effect, Props>(effect, WebGlCoreRenderer, props);
-  }
-}
-
-class EffectNode<Effect extends CoreEffect, Props extends EffectProps> {
-  #data: Record<string, any> | undefined = undefined;
-  constructor(
-    readonly type: Effect,
-    readonly program: new () => void,
-    props?: InferEffectProps<Props>
-  ) {
-    this.#data = props;
-  }
-}
-
-const stage = new Stage<WebGlInstanceMap>({
-  renderEngine: CanvasCoreRenderer,
-});
-
-stage.createShader(
-  {
-    props: {
-      radius: 10,
-    },
-    fragment: '',
-  },
-  {
-    radius: 30,
-  }
-);
-
-stage.createShader({
-  props: {
-    radius: 10,
-  },
-  fragment: '',
-});*/
-//# sourceMappingURL=CoreStuff.js.map

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

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

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

@@ -1,14 +0,0 @@
-import { type CoreNode } from "./CoreNode.js";
-import type { Texture } from "./textures/Texture.js";
-export declare class CoreTexturizer {
-    readonly node: CoreNode;
-    enabled: boolean;
-    renderTexture: Texture | null;
-    rttRequested: boolean;
-    constructor(node: CoreNode);
-    enableRenderTexture(): void;
-    createRenderTexture(): void;
-    loadRenderTexture(): void;
-    unloadRenderTexture(): void;
-    requestRTT(): void;
-}

package/dist/src/core/CoreTexturizer.js

@@ -1,47 +0,0 @@
-import { UpdateType } from "./CoreNode.js";
-export class CoreTexturizer {
-    node;
-    enabled = false;
-    renderTexture = null;
-    rttRequested = false;
-    constructor(node) {
-        this.node = node;
-    }
-    enableRenderTexture() {
-        this.enabled = true;
-        this.createRenderTexture();
-    }
-    createRenderTexture() {
-        this.unloadRenderTexture();
-        this.renderTexture = this.node.stage.txManager.createTexture('RenderTexture', {
-            width: this.node.width,
-            height: this.node.height,
-        });
-    }
-    loadRenderTexture() {
-        if (this.renderTexture === null) {
-            return;
-        }
-        if (this.renderTexture.state === 'loaded') {
-            this.node.stage.renderer.renderToTexture(this.node);
-            return;
-        }
-        this.node.stage.txManager.loadTexture(this.renderTexture, true);
-        this.renderTexture.once('loaded', () => {
-            this.node.stage.renderer.renderToTexture(this.node);
-            this.node.setUpdateType(UpdateType.IsRenderable);
-        });
-        this.renderTexture.setRenderableOwner(this, true);
-    }
-    unloadRenderTexture() {
-        if (this.renderTexture !== null) {
-            this.renderTexture.setRenderableOwner(this, false);
-        }
-        this.renderTexture = null;
-    }
-    requestRTT() {
-        this.rttRequested = true;
-        this.node.setUpdateType(UpdateType.RenderTexture);
-    }
-}
-//# sourceMappingURL=CoreTexturizer.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"CoreTexturizer.js","sourceRoot":"","sources":["../../../src/core/CoreTexturizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAiB,MAAM,eAAe,CAAC;AAG1D,MAAM,OAAO,cAAc;IAKJ;IAJrB,OAAO,GAAG,KAAK,CAAC;IAChB,aAAa,GAAmB,IAAI,CAAC;IACrC,YAAY,GAAG,KAAK,CAAC;IAErB,YAAqB,IAAc;QAAd,SAAI,GAAJ,IAAI,CAAU;IAEnC,CAAC;IAED,mBAAmB;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IAED,mBAAmB;QACjB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,EAAE;YAC5E,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;YACtB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,iBAAiB;QACf,IAAG,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAG,IAAI,CAAC,aAAa,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,mBAAmB;QACjB,IAAG,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED,UAAU;QACR,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACpD,CAAC;CACF"}