@lightningjs/renderer 2.10.0 → 2.11.0

package/exports/canvas.ts

@@ -1,39 +1,39 @@
-/*
- * 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.
- */
-/**
- * Canvas Text Renderer
- *
- * @remarks
- * This module exports the Canvas Text Renderer for the Lightning 3 Renderer.
- * The Canvas Text Renderer is used to render text using the Canvas API,
- * this is slightly less performant than the SDF Text Renderer. However
- * the Canvas Text Renderer is more widely supported on older devices.
- *
- * You can import the exports from this module like so:
- * ```ts
- * import { CanvasTextRenderer } from '@lightning/renderer';
- * ```
- *
- * @module Canvas
- *
- * @packageDocumentation
- */
-
-export { CanvasTextRenderer } from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
-export { CanvasCoreRenderer } from '../src/core/renderers/canvas/CanvasCoreRenderer.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.
+ */
+/**
+ * Canvas Text Renderer
+ *
+ * @remarks
+ * This module exports the Canvas Text Renderer for the Lightning 3 Renderer.
+ * The Canvas Text Renderer is used to render text using the Canvas API,
+ * this is slightly less performant than the SDF Text Renderer. However
+ * the Canvas Text Renderer is more widely supported on older devices.
+ *
+ * You can import the exports from this module like so:
+ * ```ts
+ * import { CanvasTextRenderer } from '@lightning/renderer';
+ * ```
+ *
+ * @module Canvas
+ *
+ * @packageDocumentation
+ */
+
+export { CanvasTextRenderer } from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
+export { CanvasCoreRenderer } from '../src/core/renderers/canvas/CanvasCoreRenderer.js';

package/exports/index.ts

@@ -1,89 +1,89 @@
-/*
- * 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 API
- *
- * @remarks
- * This module exports the API for the Lightning 3 Renderer. You
- * can import the exports from this module like so:
- * ```ts
- * import { Renderer } 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 Renderer
- */
-
-export * from '../src/main-api/INode.js';
-export * from '../src/main-api/Renderer.js';
-export * from '../src/main-api/ShaderController.js';
-export * from '../src/main-api/DynamicShaderController.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 {
-  CoreTextureManager,
-  type TextureMap,
-} from '../src/core/CoreTextureManager.js';
-export type { MemoryInfo } from '../src/core/TextureMemoryManager.js';
-export type { ShaderMap, EffectMap } from '../src/core/CoreShaderManager.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,
-  HolePunchEffectProps,
-} from '../src/core/CoreShaderManager.js';
-export type { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';
-export type { WebGlCoreCtxTexture } from '../src/core/renderers/webgl/WebGlCoreCtxTexture.js';
-export type { Inspector } from '../src/main-api/Inspector.js';
-export type { CoreNodeRenderState } from '../src/core/CoreNode.js';
-
-// Shaders
-export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
-export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
-export type { ShaderProgramSources } from '../src/core/renderers/webgl/internal/ShaderUtils.js';
-
-// Textures
-export * from '../src/core/textures/Texture.js';
-export { ImageTexture } from '../src/core/textures/ImageTexture.js';
-
-// Text Rendering & Fonts
-// export * from '../src/core/text-rendering/renderers/TextRenderer.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';
-
-// 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 API
+ *
+ * @remarks
+ * This module exports the API for the Lightning 3 Renderer. You
+ * can import the exports from this module like so:
+ * ```ts
+ * import { Renderer } 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 Renderer
+ */
+
+export * from '../src/main-api/INode.js';
+export * from '../src/main-api/Renderer.js';
+export * from '../src/main-api/ShaderController.js';
+export * from '../src/main-api/DynamicShaderController.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 {
+  CoreTextureManager,
+  type TextureMap,
+} from '../src/core/CoreTextureManager.js';
+export type { MemoryInfo } from '../src/core/TextureMemoryManager.js';
+export type { ShaderMap, EffectMap } from '../src/core/CoreShaderManager.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,
+  HolePunchEffectProps,
+} from '../src/core/CoreShaderManager.js';
+export type { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';
+export type { WebGlCoreCtxTexture } from '../src/core/renderers/webgl/WebGlCoreCtxTexture.js';
+export type { Inspector } from '../src/main-api/Inspector.js';
+export type { CoreNodeRenderState } from '../src/core/CoreNode.js';
+
+// Shaders
+export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
+export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
+export type { ShaderProgramSources } from '../src/core/renderers/webgl/internal/ShaderUtils.js';
+
+// Textures
+export * from '../src/core/textures/Texture.js';
+export { ImageTexture } from '../src/core/textures/ImageTexture.js';
+
+// Text Rendering & Fonts
+// export * from '../src/core/text-rendering/renderers/TextRenderer.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';
+
+// Stage (type only for Core Extensions)
+export type * from '../src/core/Stage.js';

package/exports/inspector.ts

@@ -1,24 +1,24 @@
-/*
- * 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.
- */
-
-/**
- * @module Inspector
- */
-
-export { Inspector } from '../src/main-api/Inspector.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.
+ */
+
+/**
+ * @module Inspector
+ */
+
+export { Inspector } from '../src/main-api/Inspector.js';

package/exports/utils.ts

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

package/exports/webgl.ts

@@ -1,38 +1,38 @@
-/*
- * 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 { SdfTextRenderer } from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
-export { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.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 { SdfTextRenderer } from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
+export { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';

package/package.json

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

package/scripts/please-use-pnpm.js

@@ -1,13 +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);
-}
+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);
+}