@lightningjs/renderer 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/README.md +17 -0
  2. package/dist/exports/canvas.d.ts +18 -0
  3. package/dist/exports/canvas.js +37 -0
  4. package/dist/exports/canvas.js.map +1 -0
  5. package/dist/exports/core-api.d.ts +74 -0
  6. package/dist/exports/core-api.js +96 -0
  7. package/dist/exports/core-api.js.map +1 -0
  8. package/dist/exports/index.d.ts +2 -4
  9. package/dist/exports/index.js +1 -3
  10. package/dist/exports/index.js.map +1 -1
  11. package/dist/exports/inspector.d.ts +1 -0
  12. package/dist/exports/inspector.js +20 -0
  13. package/dist/exports/inspector.js.map +1 -0
  14. package/dist/exports/main-api.d.ts +30 -0
  15. package/dist/exports/main-api.js +45 -0
  16. package/dist/exports/main-api.js.map +1 -0
  17. package/dist/exports/webgl.d.ts +19 -0
  18. package/dist/exports/webgl.js +38 -0
  19. package/dist/exports/webgl.js.map +1 -0
  20. package/dist/src/common/EventEmitter.d.ts +1 -1
  21. package/dist/src/common/IAnimationController.d.ts +1 -1
  22. package/dist/src/common/IEventEmitter.d.ts +8 -0
  23. package/dist/src/common/IEventEmitter.js +18 -0
  24. package/dist/src/common/IEventEmitter.js.map +1 -0
  25. package/dist/src/core/CoreExtension.d.ts +12 -0
  26. package/dist/src/core/CoreExtension.js +29 -0
  27. package/dist/src/core/CoreExtension.js.map +1 -0
  28. package/dist/src/core/CoreNode.d.ts +58 -0
  29. package/dist/src/core/CoreNode.js +57 -1
  30. package/dist/src/core/CoreNode.js.map +1 -1
  31. package/dist/src/core/CoreTextNode.d.ts +2 -2
  32. package/dist/src/core/CoreTextNode.js +20 -30
  33. package/dist/src/core/CoreTextNode.js.map +1 -1
  34. package/dist/src/core/Stage.d.ts +11 -5
  35. package/dist/src/core/Stage.js +54 -26
  36. package/dist/src/core/Stage.js.map +1 -1
  37. package/dist/src/core/TextureMemoryManager.js +4 -2
  38. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  39. package/dist/src/core/animations/CoreAnimation.js +1 -1
  40. package/dist/src/core/animations/CoreAnimation.js.map +1 -1
  41. package/dist/src/core/animations/CoreAnimationController.js +1 -0
  42. package/dist/src/core/animations/CoreAnimationController.js.map +1 -1
  43. package/dist/src/core/lib/ImageWorker.d.ts +1 -1
  44. package/dist/src/core/lib/ImageWorker.js +25 -3
  45. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  46. package/dist/src/core/lib/textureSvg.d.ts +16 -0
  47. package/dist/src/core/lib/textureSvg.js +63 -0
  48. package/dist/src/core/lib/textureSvg.js.map +1 -0
  49. package/dist/src/core/renderers/webgl/WebGlCoreShader.js +0 -1
  50. package/dist/src/core/renderers/webgl/WebGlCoreShader.js.map +1 -1
  51. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +2 -2
  52. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +2 -2
  53. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +2 -2
  54. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +2 -2
  55. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +9 -1
  56. package/dist/src/core/renderers/webgl/shaders/SdfShader.js.map +1 -1
  57. package/dist/src/core/text-rendering/TrFontManager.js +11 -4
  58. package/dist/src/core/text-rendering/TrFontManager.js.map +1 -1
  59. package/dist/src/core/text-rendering/font-face-types/WebTrFontFace.js +13 -5
  60. package/dist/src/core/text-rendering/font-face-types/WebTrFontFace.js.map +1 -1
  61. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts +1 -0
  62. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +1 -0
  63. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  64. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +1 -0
  65. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +1 -0
  66. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  67. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +1 -0
  68. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  69. package/dist/src/core/textures/ImageTexture.d.ts +52 -0
  70. package/dist/src/core/textures/ImageTexture.js +78 -31
  71. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  72. package/dist/src/core/textures/Texture.d.ts +1 -0
  73. package/dist/src/core/textures/Texture.js +1 -0
  74. package/dist/src/core/textures/Texture.js.map +1 -1
  75. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  76. package/dist/src/main-api/ICoreDriver.js +20 -0
  77. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  78. package/dist/src/main-api/Inspector.js +2 -2
  79. package/dist/src/main-api/Inspector.js.map +1 -1
  80. package/dist/src/main-api/Renderer.d.ts +50 -8
  81. package/dist/src/main-api/Renderer.js +8 -7
  82. package/dist/src/main-api/Renderer.js.map +1 -1
  83. package/dist/src/main-api/RendererMain.d.ts +378 -0
  84. package/dist/src/main-api/RendererMain.js +367 -0
  85. package/dist/src/main-api/RendererMain.js.map +1 -0
  86. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  87. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  88. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  89. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  90. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  91. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  92. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  93. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  94. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  95. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  96. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  97. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  98. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  99. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  100. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  101. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  102. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  103. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  104. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  105. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  106. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  107. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  108. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  109. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  110. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  111. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  112. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  113. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  114. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  115. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  116. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  117. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  118. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  119. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  120. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  121. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  122. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  123. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  124. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  125. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  126. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  127. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  128. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  129. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  130. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  131. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  132. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  133. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  134. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  135. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  136. package/dist/src/render-drivers/utils.d.ts +12 -0
  137. package/dist/src/render-drivers/utils.js +74 -0
  138. package/dist/src/render-drivers/utils.js.map +1 -0
  139. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  140. package/dist/tsconfig.tsbuildinfo +1 -0
  141. package/exports/canvas.ts +37 -0
  142. package/exports/index.ts +3 -3
  143. package/exports/inspector.ts +20 -0
  144. package/exports/webgl.ts +38 -0
  145. package/package.json +5 -7
  146. package/src/common/EventEmitter.ts +1 -1
  147. package/src/common/IAnimationController.ts +1 -1
  148. package/src/common/IEventEmitter.ts +28 -0
  149. package/src/core/CoreNode.test.ts +1 -0
  150. package/src/core/CoreNode.ts +120 -1
  151. package/src/core/CoreTextNode.ts +58 -65
  152. package/src/core/Stage.ts +88 -36
  153. package/src/core/TextureMemoryManager.ts +4 -2
  154. package/src/core/animations/CoreAnimation.ts +2 -1
  155. package/src/core/animations/CoreAnimationController.ts +1 -0
  156. package/src/core/lib/ImageWorker.ts +44 -7
  157. package/src/core/lib/textureSvg.ts +78 -0
  158. package/src/core/renderers/webgl/WebGlCoreShader.ts +0 -1
  159. package/src/core/renderers/webgl/shaders/DefaultShader.ts +2 -2
  160. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +2 -2
  161. package/src/core/renderers/webgl/shaders/DynamicShader.ts +2 -2
  162. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +2 -2
  163. package/src/core/renderers/webgl/shaders/SdfShader.ts +9 -1
  164. package/src/core/text-rendering/TrFontManager.ts +15 -4
  165. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +15 -8
  166. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +2 -0
  167. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +2 -0
  168. package/src/core/text-rendering/renderers/TextRenderer.ts +1 -0
  169. package/src/core/textures/ImageTexture.ts +159 -35
  170. package/src/core/textures/Texture.ts +2 -0
  171. package/src/main-api/Inspector.ts +2 -2
  172. package/src/main-api/Renderer.ts +59 -15
  173. package/dist/src/core/TextureList.js +0 -34
  174. package/dist/src/core/TextureList.js.map +0 -1
  175. package/dist/src/core/renderers/webgl/newShader/abcMock.d.ts +0 -1
  176. package/dist/src/core/renderers/webgl/newShader/abcMock.js +0 -2
  177. package/dist/src/core/renderers/webgl/newShader/abcMock.js.map +0 -1
  178. package/dist/src/effectsMock.d.ts +0 -13
  179. package/dist/src/effectsMock.js +0 -62
  180. package/dist/src/effectsMock.js.map +0 -1
  181. package/dist/src/test.d.ts +0 -1
  182. package/dist/src/test.js +0 -4
  183. package/dist/src/test.js.map +0 -1
  184. /package/dist/src/{core/TextureList.d.ts → render-drivers/threadx/worker/renderer.d.ts} +0 -0
package/README.md CHANGED
@@ -103,10 +103,18 @@ import {
103
103
  SdfTrFontFace,
104
104
  } from '@lightningjs/renderer';
105
105
 
106
+ import {
107
+ WebGlCoreRenderer,
108
+ SdfTextRenderer,
109
+ } from '@lightningjs/renderer/webgl';
110
+ import { CanvasTextRenderer } from '@lightningjs/renderer/canvas';
111
+
106
112
  const renderer = new RendererMain(
107
113
  {
108
114
  appWidth: 1920,
109
115
  appHeight: 1080,
116
+ renderEngine: WebGlCoreRenderer,
117
+ fontEngines: [SdfTextRenderer, CanvasTextRenderer],
110
118
  // ...Other Renderer Config
111
119
  },
112
120
  'app', // id of div to insert Canvas.
@@ -128,3 +136,12 @@ renderer.stage.fontManager.addFontFace(
128
136
  ),
129
137
  );
130
138
  ```
139
+
140
+ Please note that the WebGL renderer supports both SDF Fonts and Web Fonts, however the
141
+ Canvas renderer only supports Web Fonts:
142
+
143
+ | Font Type Renderer | SDF Font | Web Font |
144
+ | ------------------ | -------- | -------- |
145
+ | WebGL | Y | Y |
146
+ | Canvas | N | Y |
147
+ | | | |
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Canvas Text Renderer
3
+ *
4
+ * @remarks
5
+ * This module exports the Canvas Text Renderer for the Lightning 3 Renderer.
6
+ * The Canvas Text Renderer is used to render text using the Canvas API,
7
+ * this is slightly less performant than the SDF Text Renderer. However
8
+ * the Canvas Text Renderer is more widely supported on older devices.
9
+ *
10
+ * You can import the exports from this module like so:
11
+ * ```ts
12
+ * import { CanvasTextRenderer } from '@lightning/renderer';
13
+ * ```
14
+ *
15
+ * @packageDocumentation
16
+ */
17
+ export { CanvasTextRenderer } from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
18
+ export { CanvasCoreRenderer } from '../src/core/renderers/canvas/CanvasCoreRenderer.js';
@@ -0,0 +1,37 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /**
20
+ * Canvas Text Renderer
21
+ *
22
+ * @remarks
23
+ * This module exports the Canvas Text Renderer for the Lightning 3 Renderer.
24
+ * The Canvas Text Renderer is used to render text using the Canvas API,
25
+ * this is slightly less performant than the SDF Text Renderer. However
26
+ * the Canvas Text Renderer is more widely supported on older devices.
27
+ *
28
+ * You can import the exports from this module like so:
29
+ * ```ts
30
+ * import { CanvasTextRenderer } from '@lightning/renderer';
31
+ * ```
32
+ *
33
+ * @packageDocumentation
34
+ */
35
+ export { CanvasTextRenderer } from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
36
+ export { CanvasCoreRenderer } from '../src/core/renderers/canvas/CanvasCoreRenderer.js';
37
+ //# sourceMappingURL=canvas.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"canvas.js","sourceRoot":"","sources":["../../exports/canvas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,4DAA4D,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC"}
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Lightning 3 Renderer Core API
3
+ *
4
+ * @remarks
5
+ * ```
6
+ * import * from '@lightning/renderer/core';
7
+ * ```
8
+ *
9
+ * The Core API is used by developers to extend the capabilities of the Renderer
10
+ * by writing custom Shaders, Dynamic Shader Effects, Textures, Text Renderers,
11
+ * etc.
12
+ *
13
+ * Custom capabilities as well as fonts can be loaded via Core Extensions.
14
+ *
15
+ * A core extension module is structured like so:
16
+ * ```ts
17
+ * import {
18
+ * CoreExtension,
19
+ * WebTrFontFace,
20
+ * SdfTrFontFace,
21
+ * type Stage
22
+ * } from '@lightning/renderer/core';
23
+ *
24
+ * export default class MyCoreExtension extends CoreExtension {
25
+ * async run(stage: Stage) {
26
+ * stage.fontManager.addFontFace(
27
+ * new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
28
+ * );
29
+ *
30
+ * stage.fontManager.addFontFace(
31
+ * new SdfTrFontFace(
32
+ * 'Ubuntu',
33
+ * {},
34
+ * 'msdf',
35
+ * stage,
36
+ * '/fonts/Ubuntu-Regular.msdf.png',
37
+ * '/fonts/Ubuntu-Regular.msdf.json',
38
+ * ),
39
+ * );
40
+ * }
41
+ * }
42
+ * ```
43
+ *
44
+ * And then imported and registered in the application's entry point
45
+ * using the `@lightningjs/vite-plugin-import-chunk-url` plugin:
46
+ * ```ts
47
+ * import coreExtensionModuleUrl from './MyCoreExtension.js?importChunkUrl';
48
+ *
49
+ * // Set up driver, etc.
50
+ *
51
+ * // Initialize the Renderer
52
+ * const renderer = new RendererMain(
53
+ * {
54
+ * // Other Renderer Config...
55
+ * coreExtensionModule: coreExtensionModuleUrl,
56
+ * },
57
+ * 'app',
58
+ * driver,
59
+ * );
60
+ * ```
61
+ *
62
+ * @module
63
+ */
64
+ export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
65
+ export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
66
+ export * from '../src/core/textures/Texture.js';
67
+ export * from '../src/core/text-rendering/renderers/TextRenderer.js';
68
+ export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
69
+ export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
70
+ export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
71
+ export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
72
+ export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
73
+ export * from '../src/core/CoreExtension.js';
74
+ export type * from '../src/core/Stage.js';
@@ -0,0 +1,96 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /**
20
+ * Lightning 3 Renderer Core API
21
+ *
22
+ * @remarks
23
+ * ```
24
+ * import * from '@lightning/renderer/core';
25
+ * ```
26
+ *
27
+ * The Core API is used by developers to extend the capabilities of the Renderer
28
+ * by writing custom Shaders, Dynamic Shader Effects, Textures, Text Renderers,
29
+ * etc.
30
+ *
31
+ * Custom capabilities as well as fonts can be loaded via Core Extensions.
32
+ *
33
+ * A core extension module is structured like so:
34
+ * ```ts
35
+ * import {
36
+ * CoreExtension,
37
+ * WebTrFontFace,
38
+ * SdfTrFontFace,
39
+ * type Stage
40
+ * } from '@lightning/renderer/core';
41
+ *
42
+ * export default class MyCoreExtension extends CoreExtension {
43
+ * async run(stage: Stage) {
44
+ * stage.fontManager.addFontFace(
45
+ * new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
46
+ * );
47
+ *
48
+ * stage.fontManager.addFontFace(
49
+ * new SdfTrFontFace(
50
+ * 'Ubuntu',
51
+ * {},
52
+ * 'msdf',
53
+ * stage,
54
+ * '/fonts/Ubuntu-Regular.msdf.png',
55
+ * '/fonts/Ubuntu-Regular.msdf.json',
56
+ * ),
57
+ * );
58
+ * }
59
+ * }
60
+ * ```
61
+ *
62
+ * And then imported and registered in the application's entry point
63
+ * using the `@lightningjs/vite-plugin-import-chunk-url` plugin:
64
+ * ```ts
65
+ * import coreExtensionModuleUrl from './MyCoreExtension.js?importChunkUrl';
66
+ *
67
+ * // Set up driver, etc.
68
+ *
69
+ * // Initialize the Renderer
70
+ * const renderer = new RendererMain(
71
+ * {
72
+ * // Other Renderer Config...
73
+ * coreExtensionModule: coreExtensionModuleUrl,
74
+ * },
75
+ * 'app',
76
+ * driver,
77
+ * );
78
+ * ```
79
+ *
80
+ * @module
81
+ */
82
+ // Shaders
83
+ export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
84
+ export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
85
+ // Textures
86
+ export * from '../src/core/textures/Texture.js';
87
+ // Text Rendering & Fonts
88
+ export * from '../src/core/text-rendering/renderers/TextRenderer.js';
89
+ export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
90
+ export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
91
+ export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
92
+ export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
93
+ export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
94
+ // Core Extensions
95
+ export * from '../src/core/CoreExtension.js';
96
+ //# sourceMappingURL=core-api.js.map
@@ -0,0 +1 @@
1
+ {"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"}
@@ -29,16 +29,14 @@ export type { ShaderMap, EffectMap } from '../src/core/CoreShaderManager.js';
29
29
  export type { TextRendererMap } from '../src/core/text-rendering/renderers/TextRenderer.js';
30
30
  export type { TrFontFaceMap } from '../src/core/text-rendering/font-face-types/TrFontFace.js';
31
31
  export type { AnimationSettings } from '../src/core/animations/CoreAnimation.js';
32
- export type { EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, } from '../src/core/CoreShaderManager.js';
32
+ export type { EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, HolePunchEffectProps, } from '../src/core/CoreShaderManager.js';
33
33
  export type { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';
34
34
  export type { WebGlCoreCtxTexture } from '../src/core/renderers/webgl/WebGlCoreCtxTexture.js';
35
+ export type { Inspector } from '../src/main-api/Inspector.js';
35
36
  export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
36
37
  export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
37
38
  export type { ShaderProgramSources } from '../src/core/renderers/webgl/internal/ShaderUtils.js';
38
39
  export * from '../src/core/textures/Texture.js';
39
- export * from '../src/core/text-rendering/renderers/TextRenderer.js';
40
- export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
41
- export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
42
40
  export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
43
41
  export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
44
42
  export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
@@ -50,9 +50,7 @@ export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
50
50
  // Textures
51
51
  export * from '../src/core/textures/Texture.js';
52
52
  // Text Rendering & Fonts
53
- export * from '../src/core/text-rendering/renderers/TextRenderer.js';
54
- export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
55
- export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
53
+ // export * from '../src/core/text-rendering/renderers/TextRenderer.js';
56
54
  export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
57
55
  export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
58
56
  export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../exports/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAE7C,yEAAyE;AACzE,2BAA2B;AAC3B,OAAO,EACL,kBAAkB,GAEnB,MAAM,mCAAmC,CAAC;AAkB3C,UAAU;AACV,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6DAA6D,CAAC;AAG5E,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"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../exports/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAE7C,yEAAyE;AACzE,2BAA2B;AAC3B,OAAO,EACL,kBAAkB,GAEnB,MAAM,mCAAmC,CAAC;AAoB3C,UAAU;AACV,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6DAA6D,CAAC;AAG5E,WAAW;AACX,cAAc,iCAAiC,CAAC;AAEhD,yBAAyB;AACzB,wEAAwE;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,6DAA6D,CAAC;AAC5E,cAAc,2EAA2E,CAAC"}
@@ -0,0 +1 @@
1
+ export { Inspector } from '../src/main-api/Inspector.js';
@@ -0,0 +1,20 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ export { Inspector } from '../src/main-api/Inspector.js';
20
+ //# sourceMappingURL=inspector.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inspector.js","sourceRoot":"","sources":["../../exports/inspector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC"}
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Lightning 3 Renderer Main API
3
+ *
4
+ * @remarks
5
+ * This module exports the Main API for the Lightning 3 Renderer. You
6
+ * can import the exports from this module like so:
7
+ * ```ts
8
+ * import { RendererMain } from '@lightning/renderer';
9
+ * ```
10
+ *
11
+ * Generally developers/frameworks using the Renderer will use the Main API to
12
+ * render applications.
13
+ *
14
+ * Do not confuse the Main API with the Core API which is used to extend
15
+ * capabilities of the Renderer. The Main API code always runs from the main
16
+ * thread.
17
+ *
18
+ * @module
19
+ */
20
+ export * from '../src/main-api/INode.js';
21
+ export * from '../src/main-api/ICoreDriver.js';
22
+ export * from '../src/main-api/RendererMain.js';
23
+ export * from '../src/render-drivers/main/MainCoreDriver.js';
24
+ export * from '../src/render-drivers/threadx/ThreadXCoreDriver.js';
25
+ export * from '../src/common/IAnimationController.js';
26
+ export * from '../src/common/CommonTypes.js';
27
+ export type { TextRendererMap } from '../src/core/text-rendering/renderers/TextRenderer.js';
28
+ export type { TrFontFaceMap } from '../src/core/text-rendering/font-face-types/TrFontFace.js';
29
+ export type { AnimationSettings } from '../src/core/animations/CoreAnimation.js';
30
+ export type { EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, } from '../src/core/CoreShaderManager.js';
@@ -0,0 +1,45 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /**
20
+ * Lightning 3 Renderer Main API
21
+ *
22
+ * @remarks
23
+ * This module exports the Main API for the Lightning 3 Renderer. You
24
+ * can import the exports from this module like so:
25
+ * ```ts
26
+ * import { RendererMain } from '@lightning/renderer';
27
+ * ```
28
+ *
29
+ * Generally developers/frameworks using the Renderer will use the Main API to
30
+ * render applications.
31
+ *
32
+ * Do not confuse the Main API with the Core API which is used to extend
33
+ * capabilities of the Renderer. The Main API code always runs from the main
34
+ * thread.
35
+ *
36
+ * @module
37
+ */
38
+ export * from '../src/main-api/INode.js';
39
+ export * from '../src/main-api/ICoreDriver.js';
40
+ export * from '../src/main-api/RendererMain.js';
41
+ export * from '../src/render-drivers/main/MainCoreDriver.js';
42
+ export * from '../src/render-drivers/threadx/ThreadXCoreDriver.js';
43
+ export * from '../src/common/IAnimationController.js';
44
+ export * from '../src/common/CommonTypes.js';
45
+ //# sourceMappingURL=main-api.js.map
@@ -0,0 +1 @@
1
+ {"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"}
@@ -0,0 +1,19 @@
1
+ /**
2
+ * SDF Font renderer
3
+ *
4
+ * @remarks
5
+ * This module exports the SDF Font renderer for the Lightning 3 Renderer.
6
+ * The SDF Font renderer is used to render text using Single-Channel Signed
7
+ * Distance Field (SSDF) fonts or Multi-Channel Signed Distance Field (MSDF)
8
+ * fonts. The SDF font renderer is used to render text in a way that is
9
+ * optimized for GPU rendering.
10
+ *
11
+ * You can import the exports from this module like so:
12
+ * ```ts
13
+ * import { SdfTextRenderer } from '@lightning/renderer';
14
+ * ```
15
+ *
16
+ * @packageDocumentation
17
+ */
18
+ export { SdfTextRenderer } from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
19
+ export { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';
@@ -0,0 +1,38 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /**
20
+ * SDF Font renderer
21
+ *
22
+ * @remarks
23
+ * This module exports the SDF Font renderer for the Lightning 3 Renderer.
24
+ * The SDF Font renderer is used to render text using Single-Channel Signed
25
+ * Distance Field (SSDF) fonts or Multi-Channel Signed Distance Field (MSDF)
26
+ * fonts. The SDF font renderer is used to render text in a way that is
27
+ * optimized for GPU rendering.
28
+ *
29
+ * You can import the exports from this module like so:
30
+ * ```ts
31
+ * import { SdfTextRenderer } from '@lightning/renderer';
32
+ * ```
33
+ *
34
+ * @packageDocumentation
35
+ */
36
+ export { SdfTextRenderer } from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
37
+ export { WebGlCoreRenderer } from '../src/core/renderers/webgl/WebGlCoreRenderer.js';
38
+ //# sourceMappingURL=webgl.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webgl.js","sourceRoot":"","sources":["../../exports/webgl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,yEAAyE,CAAC;AAC1G,OAAO,EAAE,iBAAiB,EAAE,MAAM,kDAAkD,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { IEventEmitter } from '@lightningjs/threadx';
1
+ import type { IEventEmitter } from './IEventEmitter.js';
2
2
  /**
3
3
  * EventEmitter base class
4
4
  */
@@ -1,4 +1,4 @@
1
- import type { IEventEmitter } from '@lightningjs/threadx';
1
+ import type { IEventEmitter } from './IEventEmitter.js';
2
2
  export type AnimationControllerState = 'running' | 'paused' | 'stopped';
3
3
  /**
4
4
  * Animation Controller interface
@@ -0,0 +1,8 @@
1
+ export interface IEventEmitter<T extends object = {
2
+ [s: string]: (target: any, data: any) => void;
3
+ }> {
4
+ on<K extends keyof T>(event: Extract<K, string>, listener: T[K]): void;
5
+ once<K extends keyof T>(event: Extract<K, string>, listener: T[K]): void;
6
+ off<K extends keyof T>(event: Extract<K, string>, listener: T[K]): void;
7
+ emit<K extends keyof T>(event: Extract<K, string>, data: Parameters<any>[1]): void;
8
+ }
@@ -0,0 +1,18 @@
1
+ /*
2
+ * Copyright 2023 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+ export {};
18
+ //# sourceMappingURL=IEventEmitter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEventEmitter.js","sourceRoot":"","sources":["../../../src/common/IEventEmitter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}
@@ -0,0 +1,12 @@
1
+ import type { Stage } from './Stage.js';
2
+ /**
3
+ * Base class for Core extensions.
4
+ *
5
+ * @remarks
6
+ * Core extensions are used to extend the Core Renderer with custom code such as
7
+ * custom fonts, custom shaders, custom textures, custom animation functions,
8
+ * and more.
9
+ */
10
+ export declare abstract class CoreExtension {
11
+ abstract run(stage: Stage): Promise<void>;
12
+ }
@@ -0,0 +1,29 @@
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /**
20
+ * Base class for Core extensions.
21
+ *
22
+ * @remarks
23
+ * Core extensions are used to extend the Core Renderer with custom code such as
24
+ * custom fonts, custom shaders, custom textures, custom animation functions,
25
+ * and more.
26
+ */
27
+ export class CoreExtension {
28
+ }
29
+ //# sourceMappingURL=CoreExtension.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CoreExtension.js","sourceRoot":"","sources":["../../../src/core/CoreExtension.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH;;;;;;;GAOG;AACH,MAAM,OAAgB,aAAa;CAElC"}