@lightningjs/renderer 0.7.2 → 0.7.4

package/exports/core-api.ts

@@ -1,102 +1,102 @@
-/*
- * 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';
-
-// Stage (type only for Core Extensions)
-export type * from '../src/core/Stage.js';
+/*
+ * 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';
+
+// Stage (type only for Core Extensions)
+export type * from '../src/core/Stage.js';

package/exports/main-api.ts

@@ -1,60 +1,60 @@
-/*
- * 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';
-
-// Selected types exported from the Core Renderer that can be used in the
-// context of the main API.
-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';
+/*
+ * 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';
+
+// Selected types exported from the Core Renderer that can be used in the
+// context of the main API.
+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/exports/utils.ts

@@ -1,41 +1,41 @@
-/*
- * 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.
- */
-/**
- * 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, deg2Rad } from '../src/utils.js';
-export { EventEmitter } from '../src/common/EventEmitter.js';
+/*
+ * 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.
+ */
+/**
+ * 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, deg2Rad } from '../src/utils.js';
+export { EventEmitter } from '../src/common/EventEmitter.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/renderer",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "Lightning 3 Renderer",
   "type": "module",
   "main": "./dist/exports/index.js",
@@ -60,15 +60,17 @@
     "exports",
     "LICENSE",
     "NOTICE",
-    "README.md"
+    "README.md",
+    "scripts"
   ],
   "packageManager": "pnpm@8.9.2",
   "engines": {
-    "npm": "please-use-pnpm",
+    "npm": ">= 10.0.0",
     "pnpm": ">= 8.9.2",
     "node": ">= 20.9.0"
   },
   "scripts": {
+    "preinstall": "node scripts/please-use-pnpm.js",
     "start": "cd examples && pnpm start",
     "start:prod": "cd examples && pnpm start:prod",
     "build": "tsc --build",

package/scripts/please-use-pnpm.js

@@ -0,0 +1,13 @@
+if (
+  process.cwd() === process.env.INIT_CWD &&
+  !process.env.npm_execpath.includes('pnpm')
+) {
+  console.log('\x1b[31m');
+  console.log('=============================================\n');
+  console.log('     Please use PNPM as a package manager');
+  console.log('     See: https://pnpm.io/ for more info');
+  console.log('\n=============================================');
+  console.log('\x1b[0m');
+
+  process.exit(1);
+}

package/src/common/CommonTypes.ts

@@ -1,105 +1,113 @@
-/*
- * 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.
- */
-
-/**
- * Types shared between Main Space and Core Space
- *
- * @remarks
- *
- * @module
- */
-
-/**
- * Represents a width and height.
- */
-export interface Dimensions {
-  width: number;
-  height: number;
-}
-
-/**
- * Payload for when text is loaded
- */
-export type NodeTextLoadedPayload = {
-  type: 'text';
-  dimensions: Dimensions;
-};
-
-/**
- * Payload for when texture is loaded
- */
-export type NodeTextureLoadedPayload = {
-  type: 'texture';
-  dimensions: Dimensions;
-};
-
-/**
- * Combined type for all loaded payloads
- */
-export type NodeLoadedPayload =
-  | NodeTextLoadedPayload
-  | NodeTextureLoadedPayload;
-
-/**
- * Payload for when text failed to load
- */
-export type NodeTextFailedPayload = {
-  type: 'text';
-  error: Error;
-};
-
-/**
- * Payload for when texture failed to load
- */
-export type NodeTextureFailedPayload = {
-  type: 'texture';
-  error: Error;
-};
-
-/**
- * Combined type for all failed payloads
- */
-export type NodeFailedPayload =
-  | NodeTextFailedPayload
-  | NodeTextureFailedPayload;
-
-/**
- * Event handler for when the texture/text of a node has loaded
- */
-export type NodeLoadedEventHandler = (
-  target: any,
-  payload: NodeLoadedPayload,
-) => void;
-
-/**
- * Event handler for when the texture/text of a node has failed to load
- */
-export type NodeFailedEventHandler = (
-  target: any,
-  payload: NodeFailedPayload,
-) => void;
-
-/**
- * Event payload for when an FpsUpdate event is emitted by either the Stage or
- * MainRenderer
- */
-export interface FpsUpdatePayload {
-  fps: number;
-  contextSpyData: Record<string, number> | null;
-}
+/*
+ * 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.
+ */
+
+/**
+ * Types shared between Main Space and Core Space
+ *
+ * @remarks
+ *
+ * @module
+ */
+
+/**
+ * Represents a width and height.
+ */
+export interface Dimensions {
+  width: number;
+  height: number;
+}
+
+/**
+ * Payload for when text is loaded
+ */
+export type NodeTextLoadedPayload = {
+  type: 'text';
+  dimensions: Dimensions;
+};
+
+/**
+ * Payload for when texture is loaded
+ */
+export type NodeTextureLoadedPayload = {
+  type: 'texture';
+  dimensions: Dimensions;
+};
+
+/**
+ * Combined type for all loaded payloads
+ */
+export type NodeLoadedPayload =
+  | NodeTextLoadedPayload
+  | NodeTextureLoadedPayload;
+
+/**
+ * Payload for when text failed to load
+ */
+export type NodeTextFailedPayload = {
+  type: 'text';
+  error: Error;
+};
+
+/**
+ * Payload for when texture failed to load
+ */
+export type NodeTextureFailedPayload = {
+  type: 'texture';
+  error: Error;
+};
+
+/**
+ * Combined type for all failed payloads
+ */
+export type NodeFailedPayload =
+  | NodeTextFailedPayload
+  | NodeTextureFailedPayload;
+
+/**
+ * Event handler for when the texture/text of a node has loaded
+ */
+export type NodeLoadedEventHandler = (
+  target: any,
+  payload: NodeLoadedPayload,
+) => void;
+
+/**
+ * Event handler for when the texture/text of a node has failed to load
+ */
+export type NodeFailedEventHandler = (
+  target: any,
+  payload: NodeFailedPayload,
+) => void;
+
+/**
+ * Event payload for when an FpsUpdate event is emitted by either the Stage or
+ * MainRenderer
+ */
+export interface FpsUpdatePayload {
+  fps: number;
+  contextSpyData: Record<string, number> | null;
+}
+
+/**
+ * Event payload for when a frame tick event is emitted by the Stage
+ */
+export interface FrameTickPayload {
+  time: number;
+  delta: number;
+}