@lightningjs/renderer 2.1.1 → 2.2.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 (194) hide show
  1. package/README.md +1 -4
  2. package/dist/exports/core-api.d.ts +74 -0
  3. package/dist/exports/core-api.js +96 -0
  4. package/dist/exports/core-api.js.map +1 -0
  5. package/dist/exports/index.d.ts +1 -0
  6. package/dist/exports/index.js +1 -0
  7. package/dist/exports/index.js.map +1 -1
  8. package/dist/exports/main-api.d.ts +30 -0
  9. package/dist/exports/main-api.js +45 -0
  10. package/dist/exports/main-api.js.map +1 -0
  11. package/dist/src/core/CoreExtension.d.ts +12 -0
  12. package/dist/src/core/CoreExtension.js +29 -0
  13. package/dist/src/core/CoreExtension.js.map +1 -0
  14. package/dist/src/core/CoreNode.d.ts +2 -2
  15. package/dist/src/core/CoreNode.js +57 -47
  16. package/dist/src/core/CoreNode.js.map +1 -1
  17. package/dist/src/core/CoreShaderManager.js +1 -0
  18. package/dist/src/core/CoreShaderManager.js.map +1 -1
  19. package/dist/src/core/Matrix2DContext.d.ts +15 -0
  20. package/dist/src/core/Matrix2DContext.js +45 -0
  21. package/dist/src/core/Matrix2DContext.js.map +1 -0
  22. package/dist/src/core/lib/SpatialHash.d.ts +38 -0
  23. package/dist/src/core/lib/SpatialHash.js +93 -0
  24. package/dist/src/core/lib/SpatialHash.js.map +1 -0
  25. package/dist/src/core/lib/WebGlContextWrapper.d.ts +144 -2
  26. package/dist/src/core/lib/WebGlContextWrapper.js +211 -20
  27. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  28. package/dist/src/core/lib/glm/common.d.ts +162 -0
  29. package/dist/src/core/lib/glm/common.js +81 -0
  30. package/dist/src/core/lib/glm/common.js.map +1 -0
  31. package/dist/src/core/lib/glm/index.d.ts +11 -0
  32. package/dist/src/core/lib/glm/index.js +30 -0
  33. package/dist/src/core/lib/glm/index.js.map +1 -0
  34. package/dist/src/core/lib/glm/mat2.d.ts +219 -0
  35. package/dist/src/core/lib/glm/mat2.js +396 -0
  36. package/dist/src/core/lib/glm/mat2.js.map +1 -0
  37. package/dist/src/core/lib/glm/mat2d.d.ts +237 -0
  38. package/dist/src/core/lib/glm/mat2d.js +442 -0
  39. package/dist/src/core/lib/glm/mat2d.js.map +1 -0
  40. package/dist/src/core/lib/glm/mat3.d.ts +283 -0
  41. package/dist/src/core/lib/glm/mat3.js +680 -0
  42. package/dist/src/core/lib/glm/mat3.js.map +1 -0
  43. package/dist/src/core/lib/glm/mat4.d.ts +550 -0
  44. package/dist/src/core/lib/glm/mat4.js +1802 -0
  45. package/dist/src/core/lib/glm/mat4.js.map +1 -0
  46. package/dist/src/core/lib/glm/quat.d.ts +363 -0
  47. package/dist/src/core/lib/glm/quat.js +693 -0
  48. package/dist/src/core/lib/glm/quat.js.map +1 -0
  49. package/dist/src/core/lib/glm/quat2.d.ts +356 -0
  50. package/dist/src/core/lib/glm/quat2.js +754 -0
  51. package/dist/src/core/lib/glm/quat2.js.map +1 -0
  52. package/dist/src/core/lib/glm/vec2.d.ts +365 -0
  53. package/dist/src/core/lib/glm/vec2.js +569 -0
  54. package/dist/src/core/lib/glm/vec2.js.map +1 -0
  55. package/dist/src/core/lib/glm/vec3.d.ts +406 -0
  56. package/dist/src/core/lib/glm/vec3.js +720 -0
  57. package/dist/src/core/lib/glm/vec3.js.map +1 -0
  58. package/dist/src/core/lib/glm/vec4.d.ts +330 -0
  59. package/dist/src/core/lib/glm/vec4.js +608 -0
  60. package/dist/src/core/lib/glm/vec4.js.map +1 -0
  61. package/dist/src/core/lib/renderToTexture.d.ts +1 -0
  62. package/dist/src/core/lib/renderToTexture.js +2 -0
  63. package/dist/src/core/lib/renderToTexture.js.map +1 -0
  64. package/dist/src/core/lib/textcompression-utils.d.ts +1 -0
  65. package/dist/src/core/lib/textcompression-utils.js +2 -0
  66. package/dist/src/core/lib/textcompression-utils.js.map +1 -0
  67. package/dist/src/core/lib/txcompression-utils.d.ts +1 -0
  68. package/dist/src/core/lib/txcompression-utils.js +2 -0
  69. package/dist/src/core/lib/txcompression-utils.js.map +1 -0
  70. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +3 -2
  71. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  72. package/dist/src/core/renderers/webgl/WebGlCoreShader.d.ts +1 -1
  73. package/dist/src/core/renderers/webgl/WebGlCoreShader.js +8 -9
  74. package/dist/src/core/renderers/webgl/WebGlCoreShader.js.map +1 -1
  75. package/dist/src/core/renderers/webgl/WebGlRenderTexture.d.ts +29 -0
  76. package/dist/src/core/renderers/webgl/WebGlRenderTexture.js +86 -0
  77. package/dist/src/core/renderers/webgl/WebGlRenderTexture.js.map +1 -0
  78. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +1 -1
  79. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js.map +1 -1
  80. package/dist/src/core/renderers/webgl/shaders/DistortShader.d.ts +44 -0
  81. package/dist/src/core/renderers/webgl/shaders/DistortShader.js +172 -0
  82. package/dist/src/core/renderers/webgl/shaders/DistortShader.js.map +1 -0
  83. package/dist/src/core/renderers/webgl/shaders/DynamicShader.d.ts +2 -1
  84. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +55 -2
  85. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js.map +1 -1
  86. package/dist/src/core/renderers/webgl/shaders/RefractionShader.d.ts +78 -0
  87. package/dist/src/core/renderers/webgl/shaders/RefractionShader.js +172 -0
  88. package/dist/src/core/renderers/webgl/shaders/RefractionShader.js.map +1 -0
  89. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +1 -1
  90. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js.map +1 -1
  91. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +6 -6
  92. package/dist/src/core/renderers/webgl/shaders/SdfShader.js.map +1 -1
  93. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts +2 -0
  94. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map +1 -1
  95. package/dist/src/core/scene/Scene.d.ts +59 -0
  96. package/dist/src/core/scene/Scene.js +106 -0
  97. package/dist/src/core/scene/Scene.js.map +1 -0
  98. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  99. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  100. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  101. package/dist/src/core/text-rendering/renderers/TextRenderer.js +12 -9
  102. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  103. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  104. package/dist/src/main-api/ICoreDriver.js +20 -0
  105. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  106. package/dist/src/main-api/IRenderDriver.d.ts +20 -0
  107. package/dist/src/main-api/IRenderDriver.js +20 -0
  108. package/dist/src/main-api/IRenderDriver.js.map +1 -0
  109. package/dist/src/main-api/IShaderController.d.ts +14 -0
  110. package/dist/src/main-api/IShaderController.js +30 -0
  111. package/dist/src/main-api/IShaderController.js.map +1 -0
  112. package/dist/src/main-api/RendererMain.d.ts +378 -0
  113. package/dist/src/main-api/RendererMain.js +367 -0
  114. package/dist/src/main-api/RendererMain.js.map +1 -0
  115. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  116. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  117. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  118. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  119. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  120. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  121. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  122. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  123. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  124. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  125. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  126. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  127. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  128. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  129. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  130. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +6 -0
  131. package/dist/src/render-drivers/main/MainOnlyShaderController.js +15 -0
  132. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +1 -0
  133. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  134. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  135. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  136. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +17 -0
  137. package/dist/src/render-drivers/main/MainRenderDriver.js +88 -0
  138. package/dist/src/render-drivers/main/MainRenderDriver.js.map +1 -0
  139. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  140. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  141. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  142. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  143. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  144. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  145. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  146. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  147. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  148. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  149. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  150. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  151. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +20 -0
  152. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +84 -0
  153. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  154. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  155. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  156. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  157. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +6 -0
  158. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +15 -0
  159. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +1 -0
  160. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  161. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  162. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  163. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +21 -0
  164. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +198 -0
  165. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +1 -0
  166. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  167. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  168. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  169. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  170. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +178 -0
  171. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  172. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  173. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  174. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  175. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  176. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  177. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  178. package/dist/src/render-drivers/utils.d.ts +12 -0
  179. package/dist/src/render-drivers/utils.js +69 -0
  180. package/dist/src/render-drivers/utils.js.map +1 -0
  181. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  182. package/exports/index.ts +1 -0
  183. package/package.json +1 -1
  184. package/src/core/CoreNode.ts +69 -54
  185. package/src/core/CoreShaderManager.ts +1 -0
  186. package/src/core/lib/WebGlContextWrapper.ts +288 -26
  187. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +3 -2
  188. package/src/core/renderers/webgl/WebGlCoreShader.ts +21 -17
  189. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +1 -1
  190. package/src/core/renderers/webgl/shaders/DynamicShader.ts +75 -3
  191. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +4 -1
  192. package/src/core/renderers/webgl/shaders/SdfShader.ts +21 -6
  193. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +3 -0
  194. package/src/core/text-rendering/renderers/TextRenderer.ts +18 -18
package/README.md CHANGED
@@ -1,7 +1,4 @@
1
- # Lightning 3 Renderer (Beta)
2
-
3
- **Warning: This is beta software and all of the exposed APIs are subject to
4
- breaking changes**
1
+ # Lightning 3 Renderer
5
2
 
6
3
  A powerful 2D scene renderer designed for rendering highly performant user
7
4
  interfaces on web browsers running on embedded devices using WebGL.
@@ -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"}
@@ -37,6 +37,7 @@ export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
37
37
  export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
38
38
  export type { ShaderProgramSources } from '../src/core/renderers/webgl/internal/ShaderUtils.js';
39
39
  export * from '../src/core/textures/Texture.js';
40
+ export { ImageTexture } from '../src/core/textures/ImageTexture.js';
40
41
  export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
41
42
  export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
42
43
  export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
@@ -49,6 +49,7 @@ export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
49
49
  export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
50
50
  // Textures
51
51
  export * from '../src/core/textures/Texture.js';
52
+ export { ImageTexture } from '../src/core/textures/ImageTexture.js';
52
53
  // Text Rendering & Fonts
53
54
  // export * from '../src/core/text-rendering/renderers/TextRenderer.js';
54
55
  export * from '../src/core/text-rendering/font-face-types/TrFontFace.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;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"}
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;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE,yBAAyB;AACzB,wEAAwE;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,6DAA6D,CAAC;AAC5E,cAAc,2EAA2E,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,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"}
@@ -125,7 +125,7 @@ export declare enum UpdateType {
125
125
  /**
126
126
  * All
127
127
  */
128
- All = 8191
128
+ All = 14335
129
129
  }
130
130
  /**
131
131
  * A custom data map which can be stored on an CoreNode
@@ -668,7 +668,7 @@ export declare class CoreNode extends EventEmitter {
668
668
  createPreloadBounds(strictBound: Bound): Bound;
669
669
  updateBoundingRect(): void;
670
670
  createRenderBounds(): void;
671
- updateRenderState(): void;
671
+ updateRenderState(renderState: CoreNodeRenderState): void;
672
672
  /**
673
673
  * This function updates the `isRenderable` property based on certain conditions.
674
674
  *
@@ -145,7 +145,7 @@ export var UpdateType;
145
145
  /**
146
146
  * All
147
147
  */
148
- UpdateType[UpdateType["All"] = 8191] = "All";
148
+ UpdateType[UpdateType["All"] = 14335] = "All";
149
149
  })(UpdateType || (UpdateType = {}));
150
150
  /**
151
151
  * A visual Node in the Renderer scene graph.
@@ -299,6 +299,9 @@ export class CoreNode extends EventEmitter {
299
299
  // Flag that we need to update
300
300
  if (this.parentHasRenderTexture) {
301
301
  this.setRTTUpdates(type);
302
+ if (parent !== null) {
303
+ parent.setUpdateType(UpdateType.RenderTexture);
304
+ }
302
305
  }
303
306
  }
304
307
  sortChildren() {
@@ -378,6 +381,7 @@ export class CoreNode extends EventEmitter {
378
381
  this.setUpdateType(UpdateType.Global);
379
382
  }
380
383
  const parent = this.props.parent;
384
+ let renderState = null;
381
385
  if (this.updateType & UpdateType.ParentRenderTexture) {
382
386
  let p = this.parent;
383
387
  while (p) {
@@ -390,9 +394,9 @@ export class CoreNode extends EventEmitter {
390
394
  // If we have render texture updates and not already running a full update
391
395
  if (this.updateType ^ UpdateType.All &&
392
396
  this.updateType & UpdateType.RenderTexture) {
393
- this.children.forEach((child) => {
394
- child.setUpdateType(UpdateType.All);
395
- });
397
+ for (let i = 0, length = this.children.length; i < length; i++) {
398
+ this.children[i]?.setUpdateType(UpdateType.All);
399
+ }
396
400
  }
397
401
  if (this.updateType & UpdateType.Global) {
398
402
  assertTruthy(this.localTransform);
@@ -417,20 +421,14 @@ export class CoreNode extends EventEmitter {
417
421
  this.setUpdateType(UpdateType.Children);
418
422
  }
419
423
  if (this.updateType & UpdateType.RenderState) {
420
- this.updateRenderState();
424
+ renderState = this.checkRenderBounds();
421
425
  this.setUpdateType(UpdateType.IsRenderable);
422
- }
423
- if (this.updateType & UpdateType.IsRenderable) {
424
- this.updateIsRenderable();
425
- }
426
- if (this.renderState === CoreNodeRenderState.OutOfBounds) {
427
- return;
428
- }
429
- if (this.updateType & UpdateType.Clipping) {
430
- this.calculateClippingRect(parentClippingRect);
431
- this.setUpdateType(UpdateType.Children);
432
- this.childUpdateType |= UpdateType.Clipping;
433
- this.childUpdateType |= UpdateType.RenderBounds;
426
+ // if we're not going out of bounds, update the render state
427
+ // this is done so the update loop can finish before we mark a node
428
+ // as out of bounds
429
+ if (renderState !== CoreNodeRenderState.OutOfBounds) {
430
+ this.updateRenderState(renderState);
431
+ }
434
432
  }
435
433
  if (this.updateType & UpdateType.WorldAlpha) {
436
434
  if (parent) {
@@ -444,6 +442,18 @@ export class CoreNode extends EventEmitter {
444
442
  UpdateType.IsRenderable);
445
443
  this.childUpdateType |= UpdateType.WorldAlpha;
446
444
  }
445
+ if (this.updateType & UpdateType.IsRenderable) {
446
+ this.updateIsRenderable();
447
+ }
448
+ if (this.renderState === CoreNodeRenderState.OutOfBounds) {
449
+ return;
450
+ }
451
+ if (this.updateType & UpdateType.Clipping) {
452
+ this.calculateClippingRect(parentClippingRect);
453
+ this.setUpdateType(UpdateType.Children);
454
+ this.childUpdateType |= UpdateType.Clipping;
455
+ this.childUpdateType |= UpdateType.RenderBounds;
456
+ }
447
457
  if (this.updateType & UpdateType.PremultipliedColors) {
448
458
  this.premultipliedColorTl = mergeColorAlphaPremultiplied(this.props.colorTl, this.worldAlpha, true);
449
459
  // If all the colors are the same just sent them all to the same value
@@ -470,11 +480,8 @@ export class CoreNode extends EventEmitter {
470
480
  if (this.updateType & UpdateType.Children &&
471
481
  this.children.length > 0 &&
472
482
  this.rtt === false) {
473
- for (let i = 0; i < this.children.length; i++) {
483
+ for (let i = 0, length = this.children.length; i < length; i++) {
474
484
  const child = this.children[i];
475
- if (child === undefined) {
476
- continue;
477
- }
478
485
  child.setUpdateType(this.childUpdateType);
479
486
  if (child.updateType === 0) {
480
487
  continue;
@@ -488,6 +495,12 @@ export class CoreNode extends EventEmitter {
488
495
  // reorder z-index
489
496
  this.sortChildren();
490
497
  }
498
+ // If we're out of bounds, apply the render state now
499
+ // this is done so nodes can finish their entire update loop before
500
+ // being marked as out of bounds
501
+ if (renderState === CoreNodeRenderState.OutOfBounds) {
502
+ this.updateRenderState(renderState);
503
+ }
491
504
  // reset update type
492
505
  this.updateType = 0;
493
506
  this.childUpdateType = 0;
@@ -560,7 +573,7 @@ export class CoreNode extends EventEmitter {
560
573
  }
561
574
  createPreloadBounds(strictBound) {
562
575
  const renderM = this.stage.boundsMargin;
563
- return createBound(strictBound.x1 - renderM[3], strictBound.y1 - renderM[0], strictBound.x2 + renderM[1], strictBound.y2 + renderM[2], this.preloadBound);
576
+ return createBound(strictBound.x1 - renderM[3], strictBound.y1 - renderM[0], strictBound.x2 + renderM[1], strictBound.y2 + renderM[2]);
564
577
  }
565
578
  updateBoundingRect() {
566
579
  const { renderCoords, globalTransform: transform } = this;
@@ -580,16 +593,14 @@ export class CoreNode extends EventEmitter {
580
593
  assertTruthy(this.stage);
581
594
  // no clipping, use parent's bounds
582
595
  if (this.clipping === false) {
583
- if (this.parent !== null) {
584
- this.strictBound =
585
- this.parent.strictBound ??
586
- createBound(0, 0, this.stage.root.width, this.stage.root.height);
587
- this.preloadBound =
588
- this.parent.preloadBound ??
589
- this.createPreloadBounds(this.strictBound);
596
+ if (this.parent !== null && this.parent.strictBound !== undefined) {
597
+ // we have a parent with a valid bound, copy it
598
+ this.strictBound = createBound(this.parent.strictBound.x1, this.parent.strictBound.y1, this.parent.strictBound.x2, this.parent.strictBound.y2);
599
+ this.preloadBound = this.createPreloadBounds(this.strictBound);
590
600
  return;
591
601
  }
592
602
  else {
603
+ // no parent or parent does not have a bound, take the stage dimensions
593
604
  this.strictBound = createBound(0, 0, this.stage.root.width, this.stage.root.height);
594
605
  this.preloadBound = this.createPreloadBounds(this.strictBound);
595
606
  return;
@@ -603,8 +614,7 @@ export class CoreNode extends EventEmitter {
603
614
  this.strictBound = createBound(_x, _y, _x + width, _y + height, this.strictBound);
604
615
  this.preloadBound = this.createPreloadBounds(this.strictBound);
605
616
  }
606
- updateRenderState() {
607
- const renderState = this.checkRenderBounds();
617
+ updateRenderState(renderState) {
608
618
  if (renderState === this.renderState) {
609
619
  return;
610
620
  }
@@ -729,8 +739,7 @@ export class CoreNode extends EventEmitter {
729
739
  this.props.texture = null;
730
740
  this.props.shader = this.stage.defShaderCtr;
731
741
  const children = [...this.children];
732
- for (let i = 0; i < children.length; i++) {
733
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
742
+ for (let i = 0, length = children.length; i < length; i++) {
734
743
  children[i].destroy();
735
744
  }
736
745
  // This very action will also remove the node from the parent's children array
@@ -959,8 +968,9 @@ export class CoreNode extends EventEmitter {
959
968
  this.props.alpha = value;
960
969
  this.setUpdateType(UpdateType.PremultipliedColors |
961
970
  UpdateType.WorldAlpha |
962
- UpdateType.Children);
963
- this.childUpdateType |= UpdateType.Global;
971
+ UpdateType.Children |
972
+ UpdateType.IsRenderable);
973
+ this.childUpdateType |= UpdateType.WorldAlpha;
964
974
  }
965
975
  get autosize() {
966
976
  return this.props.autosize;
@@ -1067,9 +1077,9 @@ export class CoreNode extends EventEmitter {
1067
1077
  set zIndexLocked(value) {
1068
1078
  this.props.zIndexLocked = value;
1069
1079
  this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1070
- this.children.forEach((child) => {
1071
- child.setUpdateType(UpdateType.CalculatedZIndex);
1072
- });
1080
+ for (let i = 0, length = this.children.length; i < length; i++) {
1081
+ this.children[i].setUpdateType(UpdateType.CalculatedZIndex);
1082
+ }
1073
1083
  }
1074
1084
  get zIndex() {
1075
1085
  return this.props.zIndex;
@@ -1077,9 +1087,9 @@ export class CoreNode extends EventEmitter {
1077
1087
  set zIndex(value) {
1078
1088
  this.props.zIndex = value;
1079
1089
  this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1080
- this.children.forEach((child) => {
1081
- child.setUpdateType(UpdateType.CalculatedZIndex);
1082
- });
1090
+ for (let i = 0, length = this.children.length; i < length; i++) {
1091
+ this.children[i].setUpdateType(UpdateType.CalculatedZIndex);
1092
+ }
1083
1093
  }
1084
1094
  get parent() {
1085
1095
  return this.props.parent;
@@ -1126,9 +1136,9 @@ export class CoreNode extends EventEmitter {
1126
1136
  if (value === false && this.texture !== null) {
1127
1137
  this.unloadTexture();
1128
1138
  this.setUpdateType(UpdateType.All);
1129
- this.children.forEach((child) => {
1130
- child.parentHasRenderTexture = false;
1131
- });
1139
+ for (let i = 0, length = this.children.length; i < length; i++) {
1140
+ this.children[i].parentHasRenderTexture = false;
1141
+ }
1132
1142
  this.stage.renderer?.removeRTTNode(this);
1133
1143
  return;
1134
1144
  }
@@ -1146,9 +1156,9 @@ export class CoreNode extends EventEmitter {
1146
1156
  this.props.rtt = true;
1147
1157
  this.hasRTTupdates = true;
1148
1158
  this.setUpdateType(UpdateType.All);
1149
- this.children.forEach((child) => {
1150
- child.setUpdateType(UpdateType.All);
1151
- });
1159
+ for (let i = 0, length = this.children.length; i < length; i++) {
1160
+ this.children[i].setUpdateType(UpdateType.All);
1161
+ }
1152
1162
  // Store RTT nodes in a separate list
1153
1163
  this.stage.renderer?.renderToTexture(this);
1154
1164
  }