@lightningjs/renderer 3.0.0-beta9 → 3.0.0

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/platform.ts

@@ -0,0 +1,31 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2026 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 {
+  Platform,
+  type PlatformSettings,
+} from '../src/core/platforms/Platform.js';
+export { WebPlatform } from '../src/core/platforms/web/WebPlatform.js';
+export { WebPlatformNext } from '../src/core/platforms/web/WebPlatformNext.js';
+export { WebPlatformChrome50 } from '../src/core/platforms/web/WebPlatformChrome50.js';
+export { WebPlatformLegacy } from '../src/core/platforms/web/WebPlatformLegacy.js';
+
+// GL Context Wrappers
+export { GlContextWrapper } from '../src/core/platforms/GlContextWrapper.js';
+export { WebGlContextWrapper } from '../src/core/platforms/web/WebGlContextWrapper.js';

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,50 +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 { SdfTextRenderer } from '../src/core/text-rendering/renderers/SdfTextRenderer/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';
+/*
+ * 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-beta9",
+  "version": "3.0.0",
   "description": "Lightning 3 Renderer",
   "type": "module",
   "main": "./dist/exports/index.js",
@@ -11,7 +11,8 @@
     "./canvas/shaders": "./dist/exports/canvas-shaders.js",
     "./webgl": "./dist/exports/webgl.js",
     "./webgl/shaders": "./dist/exports/webgl-shaders.js",
-    "./inspector": "./dist/exports/inspector.js"
+    "./inspector": "./dist/exports/inspector.js",
+    "./platforms": "./dist/exports/platform.js"
   },
   "repository": {
     "type": "git",
@@ -32,19 +33,19 @@
   },
   "homepage": "https://github.com/lightning-js/renderer#readme",
   "devDependencies": {
-    "@types/node": "^20.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "@typescript-eslint/parser": "^8.16.0",
-    "@vitest/coverage-v8": "^2.1.5",
-    "concurrently": "^8.0.1",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^8.7.0",
+    "@types/node": "^20.19.17",
+    "@typescript-eslint/eslint-plugin": "^8.44.0",
+    "@typescript-eslint/parser": "^8.44.0",
+    "@vitest/coverage-v8": "^2.1.9",
+    "concurrently": "^8.2.2",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^8.10.2",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.0",
-    "prettier": "^2.8.4",
-    "typedoc": "^0.26.11",
-    "typescript": "~5.6.3",
-    "vitest": "^2.0.0",
+    "lint-staged": "^13.3.0",
+    "prettier": "^2.8.8",
+    "typedoc": "^0.28.13",
+    "typescript": "~5.9.2",
+    "vitest": "^2.1.9",
     "vitest-mock-extended": "^2.0.2"
   },
   "lint-staged": {
@@ -65,7 +66,7 @@
   ],
   "engines": {
     "npm": ">= 10.0.0",
-    "pnpm": ">= 8.9.2",
+    "pnpm": ">= 10.17.0",
     "node": ">= 18.0.0"
   },
   "scripts": {