@lightningjs/renderer 3.0.0-beta10 → 3.0.0-beta11

package/exports/utils.ts

@@ -1,50 +1,50 @@
-/*
- * 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
- *
- * @module Utils
- */
-export {
-  assertTruthy,
-  mergeColorAlpha,
-  deg2Rad,
-  mergeColorProgress,
-} from '../src/utils.js';
-export { getNormalizedRgbaComponents } from '../src/core/lib/utils.js';
-export { getTimingFunction } from '../src/core/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
+ *
+ * @module Utils
+ */
+export {
+  assertTruthy,
+  mergeColorAlpha,
+  deg2Rad,
+  mergeColorProgress,
+} from '../src/utils.js';
+export { getNormalizedRgbaComponents } from '../src/core/lib/utils.js';
+export { getTimingFunction } from '../src/core/utils.js';
+export { EventEmitter } from '../src/common/EventEmitter.js';

package/exports/webgl-shaders.ts

@@ -1,28 +1,28 @@
-/*
- * 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-export * from '../src/core/renderers/webgl/WebGlShaderNode.js';
-
-export { Rounded } from '../src/core/shaders/webgl/Rounded.js';
-export { RoundedWithBorder } from '../src/core/shaders/webgl/RoundedWithBorder.js';
-export { RoundedWithBorderAndShadow } from '../src/core/shaders/webgl/RoundedWithBorderAndShadow.js';
-export { RoundedWithShadow } from '../src/core/shaders/webgl/RoundedWithShadow.js';
-export { Border } from '../src/core/shaders/webgl/Border.js';
-export { Shadow } from '../src/core/shaders/webgl/Shadow.js';
-export { HolePunch } from '../src/core/shaders/webgl/HolePunch.js';
-export { LinearGradient } from '../src/core/shaders/webgl/LinearGradient.js';
-export { RadialGradient } from '../src/core/shaders/webgl/RadialGradient.js';
-export { Default } from '../src/core/shaders/webgl/Default.js';
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from '../src/core/renderers/webgl/WebGlShaderNode.js';
+
+export { Rounded } from '../src/core/shaders/webgl/Rounded.js';
+export { RoundedWithBorder } from '../src/core/shaders/webgl/RoundedWithBorder.js';
+export { RoundedWithBorderAndShadow } from '../src/core/shaders/webgl/RoundedWithBorderAndShadow.js';
+export { RoundedWithShadow } from '../src/core/shaders/webgl/RoundedWithShadow.js';
+export { Border } from '../src/core/shaders/webgl/Border.js';
+export { Shadow } from '../src/core/shaders/webgl/Shadow.js';
+export { HolePunch } from '../src/core/shaders/webgl/HolePunch.js';
+export { LinearGradient } from '../src/core/shaders/webgl/LinearGradient.js';
+export { RadialGradient } from '../src/core/shaders/webgl/RadialGradient.js';
+export { Default } from '../src/core/shaders/webgl/Default.js';

package/exports/webgl.ts

@@ -1,52 +1,52 @@
-/*
- * 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.
- */
-
-/**
- * SDF Font renderer
- *
- * @remarks
- * This module exports the SDF Font renderer for the Lightning 3 Renderer.
- * The SDF Font renderer is used to render text using Single-Channel Signed
- * Distance Field (SSDF) fonts or Multi-Channel Signed Distance Field (MSDF)
- * fonts. The SDF font renderer is used to render text in a way that is
- * optimized for GPU rendering.
- *
- * You can import the exports from this module like so:
- * ```ts
- * import { SdfTextRenderer } from '@lightning/renderer';
- * ```
- *
- * @packageDocumentation
- */
-
-export * from '../src/core/text-rendering/SdfTextRenderer.js';
-export { WebGlRenderer } from '../src/core/renderers/webgl/WebGlRenderer.js';
-export { WebGlCtxTexture } from '../src/core/renderers/webgl/WebGlCtxTexture.js';
-
-export * from '../src/core/renderers/webgl/WebGlShaderNode.js';
-
-/**
- * @deprecated Use WebGlRenderer.
- */
-export { WebGlRenderer as WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlRenderer.js';
-export { WebGlRenderer as WebGlCoreCtxTexture } from '../src/core/renderers/webgl/WebGlRenderer.js';
-
-export * as shaders from './webgl-shaders.js';
-
-export { default as SdfTextRenderer } from '../src/core/text-rendering/SdfTextRenderer.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.
+ */
+
+/**
+ * SDF Font renderer
+ *
+ * @remarks
+ * This module exports the SDF Font renderer for the Lightning 3 Renderer.
+ * The SDF Font renderer is used to render text using Single-Channel Signed
+ * Distance Field (SSDF) fonts or Multi-Channel Signed Distance Field (MSDF)
+ * fonts. The SDF font renderer is used to render text in a way that is
+ * optimized for GPU rendering.
+ *
+ * You can import the exports from this module like so:
+ * ```ts
+ * import { SdfTextRenderer } from '@lightning/renderer';
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+export * from '../src/core/text-rendering/SdfTextRenderer.js';
+export { WebGlRenderer } from '../src/core/renderers/webgl/WebGlRenderer.js';
+export { WebGlCtxTexture } from '../src/core/renderers/webgl/WebGlCtxTexture.js';
+
+export * from '../src/core/renderers/webgl/WebGlShaderNode.js';
+
+/**
+ * @deprecated Use WebGlRenderer.
+ */
+export { WebGlRenderer as WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlRenderer.js';
+export { WebGlRenderer as WebGlCoreCtxTexture } from '../src/core/renderers/webgl/WebGlRenderer.js';
+
+export * as shaders from './webgl-shaders.js';
+
+export { default as SdfTextRenderer } from '../src/core/text-rendering/SdfTextRenderer.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/renderer",
-  "version": "3.0.0-beta10",
+  "version": "3.0.0-beta11",
   "description": "Lightning 3 Renderer",
   "type": "module",
   "main": "./dist/exports/index.js",
@@ -63,6 +63,7 @@
     "README.md",
     "scripts"
   ],
+  "packageManager": "pnpm@8.9.2",
   "engines": {
     "npm": ">= 10.0.0",
     "pnpm": ">= 8.9.2",

package/src/common/CommonTypes.ts

@@ -1,146 +1,146 @@
-/*
- * 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 { CoreNodeRenderState } from '../core/CoreNode.js';
-
-/**
- * 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;
-};
-
-/**
- * Payload for when texture failed to load
- */
-export type NodeTextureFreedPayload = {
-  type: 'texture';
-};
-
-/**
- * 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;
-
-export type NodeRenderStatePayload = {
-  type: 'renderState';
-  payload: CoreNodeRenderState;
-};
-
-export type NodeRenderStateEventHandler = (
-  target: any,
-  payload: NodeRenderStatePayload,
-) => 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;
-}
-
-/**
- * Event payload for when a an animtion tick event is emitted
- */
-export interface AnimationTickPayload {
-  progress: number;
-}
-
-/**
- * Event payload for when an QuadsUpdate event is emitted by the Stage
- */
-export interface QuadsUpdatePayload {
-  quads: number;
-}
+/*
+ * 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 { CoreNodeRenderState } from '../core/CoreNode.js';
+
+/**
+ * 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;
+};
+
+/**
+ * Payload for when texture failed to load
+ */
+export type NodeTextureFreedPayload = {
+  type: 'texture';
+};
+
+/**
+ * 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;
+
+export type NodeRenderStatePayload = {
+  type: 'renderState';
+  payload: CoreNodeRenderState;
+};
+
+export type NodeRenderStateEventHandler = (
+  target: any,
+  payload: NodeRenderStatePayload,
+) => 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;
+}
+
+/**
+ * Event payload for when a an animtion tick event is emitted
+ */
+export interface AnimationTickPayload {
+  progress: number;
+}
+
+/**
+ * Event payload for when an QuadsUpdate event is emitted by the Stage
+ */
+export interface QuadsUpdatePayload {
+  quads: number;
+}