@lightningjs/renderer 2.1.2 → 2.3.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 (138) 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/common/IAnimationController.d.ts +1 -1
  12. package/dist/src/core/CoreExtension.d.ts +12 -0
  13. package/dist/src/core/CoreExtension.js +29 -0
  14. package/dist/src/core/CoreExtension.js.map +1 -0
  15. package/dist/src/core/CoreNode.d.ts +1 -1
  16. package/dist/src/core/CoreNode.js +45 -46
  17. package/dist/src/core/CoreNode.js.map +1 -1
  18. package/dist/src/core/CoreShaderManager.js +1 -0
  19. package/dist/src/core/CoreShaderManager.js.map +1 -1
  20. package/dist/src/core/Stage.d.ts +1 -0
  21. package/dist/src/core/Stage.js +2 -1
  22. package/dist/src/core/Stage.js.map +1 -1
  23. package/dist/src/core/animations/CoreAnimationController.js +3 -2
  24. package/dist/src/core/animations/CoreAnimationController.js.map +1 -1
  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/renderers/CoreRenderer.d.ts +1 -0
  29. package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
  30. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +4 -3
  31. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  32. package/dist/src/core/renderers/webgl/WebGlCoreShader.d.ts +1 -1
  33. package/dist/src/core/renderers/webgl/WebGlCoreShader.js +8 -18
  34. package/dist/src/core/renderers/webgl/WebGlCoreShader.js.map +1 -1
  35. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +1 -1
  36. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/shaders/DynamicShader.d.ts +2 -1
  38. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +55 -2
  39. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js.map +1 -1
  40. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +1 -1
  41. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js.map +1 -1
  42. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +6 -6
  43. package/dist/src/core/renderers/webgl/shaders/SdfShader.js.map +1 -1
  44. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts +2 -0
  45. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map +1 -1
  46. package/dist/src/core/text-rendering/renderers/TextRenderer.js +12 -9
  47. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  48. package/dist/src/core/utils.d.ts +1 -1
  49. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  50. package/dist/src/main-api/ICoreDriver.js +20 -0
  51. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  52. package/dist/src/main-api/Inspector.js +9 -0
  53. package/dist/src/main-api/Inspector.js.map +1 -1
  54. package/dist/src/main-api/Renderer.d.ts +10 -0
  55. package/dist/src/main-api/Renderer.js +2 -0
  56. package/dist/src/main-api/Renderer.js.map +1 -1
  57. package/dist/src/main-api/RendererMain.d.ts +378 -0
  58. package/dist/src/main-api/RendererMain.js +367 -0
  59. package/dist/src/main-api/RendererMain.js.map +1 -0
  60. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  61. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  62. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  63. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  64. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  65. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  66. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  67. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  68. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  69. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  70. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  71. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  72. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  73. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  74. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  75. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  76. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  77. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  78. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  79. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  80. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  81. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  82. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  83. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  84. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  85. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  86. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  87. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  88. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  89. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  90. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  91. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  92. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  93. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  94. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  95. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  96. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  97. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  98. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  99. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  100. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  101. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  102. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  103. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  104. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  105. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  106. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  107. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  108. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  109. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  110. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  111. package/dist/src/render-drivers/utils.d.ts +12 -0
  112. package/dist/src/render-drivers/utils.js +74 -0
  113. package/dist/src/render-drivers/utils.js.map +1 -0
  114. package/dist/src/utils.d.ts +1 -1
  115. package/dist/src/utils.js +2 -2
  116. package/dist/src/utils.js.map +1 -1
  117. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  118. package/dist/tsconfig.tsbuildinfo +1 -0
  119. package/exports/index.ts +1 -0
  120. package/package.json +1 -1
  121. package/src/common/IAnimationController.ts +5 -1
  122. package/src/core/CoreNode.ts +57 -55
  123. package/src/core/CoreShaderManager.ts +1 -0
  124. package/src/core/Stage.ts +3 -0
  125. package/src/core/animations/CoreAnimationController.ts +3 -2
  126. package/src/core/lib/WebGlContextWrapper.ts +288 -26
  127. package/src/core/renderers/CoreRenderer.ts +1 -0
  128. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +8 -3
  129. package/src/core/renderers/webgl/WebGlCoreShader.ts +21 -28
  130. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +1 -1
  131. package/src/core/renderers/webgl/shaders/DynamicShader.ts +75 -3
  132. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +4 -1
  133. package/src/core/renderers/webgl/shaders/SdfShader.ts +21 -6
  134. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +3 -0
  135. package/src/core/text-rendering/renderers/TextRenderer.ts +18 -18
  136. package/src/main-api/Inspector.ts +12 -0
  137. package/src/main-api/Renderer.ts +13 -0
  138. package/src/utils.ts +2 -1
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"}
@@ -1,5 +1,5 @@
1
1
  import type { IEventEmitter } from './IEventEmitter.js';
2
- export type AnimationControllerState = 'running' | 'paused' | 'stopped';
2
+ export type AnimationControllerState = 'scheduled' | 'running' | 'paused' | 'stopped';
3
3
  /**
4
4
  * Animation Controller interface
5
5
  *
@@ -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
@@ -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() {
@@ -391,9 +394,9 @@ export class CoreNode extends EventEmitter {
391
394
  // If we have render texture updates and not already running a full update
392
395
  if (this.updateType ^ UpdateType.All &&
393
396
  this.updateType & UpdateType.RenderTexture) {
394
- this.children.forEach((child) => {
395
- child.setUpdateType(UpdateType.All);
396
- });
397
+ for (let i = 0, length = this.children.length; i < length; i++) {
398
+ this.children[i]?.setUpdateType(UpdateType.All);
399
+ }
397
400
  }
398
401
  if (this.updateType & UpdateType.Global) {
399
402
  assertTruthy(this.localTransform);
@@ -407,10 +410,11 @@ export class CoreNode extends EventEmitter {
407
410
  this.calculateRenderCoords();
408
411
  this.updateBoundingRect();
409
412
  this.setUpdateType(UpdateType.RenderState | UpdateType.Children);
413
+ this.childUpdateType |= UpdateType.Global;
410
414
  if (this.clipping === true) {
411
- this.setUpdateType(UpdateType.Clipping);
415
+ this.setUpdateType(UpdateType.Clipping | UpdateType.RenderBounds);
416
+ this.childUpdateType |= UpdateType.RenderBounds;
412
417
  }
413
- this.childUpdateType |= UpdateType.Global;
414
418
  }
415
419
  if (this.updateType & UpdateType.RenderBounds) {
416
420
  this.createRenderBounds();
@@ -427,18 +431,6 @@ export class CoreNode extends EventEmitter {
427
431
  this.updateRenderState(renderState);
428
432
  }
429
433
  }
430
- if (this.updateType & UpdateType.IsRenderable) {
431
- this.updateIsRenderable();
432
- }
433
- if (this.renderState === CoreNodeRenderState.OutOfBounds) {
434
- return;
435
- }
436
- if (this.updateType & UpdateType.Clipping) {
437
- this.calculateClippingRect(parentClippingRect);
438
- this.setUpdateType(UpdateType.Children);
439
- this.childUpdateType |= UpdateType.Clipping;
440
- this.childUpdateType |= UpdateType.RenderBounds;
441
- }
442
434
  if (this.updateType & UpdateType.WorldAlpha) {
443
435
  if (parent) {
444
436
  this.worldAlpha = parent.worldAlpha * this.props.alpha;
@@ -451,6 +443,15 @@ export class CoreNode extends EventEmitter {
451
443
  UpdateType.IsRenderable);
452
444
  this.childUpdateType |= UpdateType.WorldAlpha;
453
445
  }
446
+ if (this.updateType & UpdateType.IsRenderable) {
447
+ this.updateIsRenderable();
448
+ }
449
+ if (this.updateType & UpdateType.Clipping) {
450
+ this.calculateClippingRect(parentClippingRect);
451
+ this.setUpdateType(UpdateType.Children);
452
+ this.childUpdateType |= UpdateType.Clipping;
453
+ this.childUpdateType |= UpdateType.RenderBounds;
454
+ }
454
455
  if (this.updateType & UpdateType.PremultipliedColors) {
455
456
  this.premultipliedColorTl = mergeColorAlphaPremultiplied(this.props.colorTl, this.worldAlpha, true);
456
457
  // If all the colors are the same just sent them all to the same value
@@ -474,14 +475,14 @@ export class CoreNode extends EventEmitter {
474
475
  // Tell parent to re-sort children
475
476
  parent.setUpdateType(UpdateType.ZIndexSortedChildren);
476
477
  }
478
+ if (this.renderState === CoreNodeRenderState.OutOfBounds) {
479
+ return;
480
+ }
477
481
  if (this.updateType & UpdateType.Children &&
478
482
  this.children.length > 0 &&
479
483
  this.rtt === false) {
480
- for (let i = 0; i < this.children.length; i++) {
484
+ for (let i = 0, length = this.children.length; i < length; i++) {
481
485
  const child = this.children[i];
482
- if (child === undefined) {
483
- continue;
484
- }
485
486
  child.setUpdateType(this.childUpdateType);
486
487
  if (child.updateType === 0) {
487
488
  continue;
@@ -573,7 +574,7 @@ export class CoreNode extends EventEmitter {
573
574
  }
574
575
  createPreloadBounds(strictBound) {
575
576
  const renderM = this.stage.boundsMargin;
576
- return createBound(strictBound.x1 - renderM[3], strictBound.y1 - renderM[0], strictBound.x2 + renderM[1], strictBound.y2 + renderM[2], this.preloadBound);
577
+ return createBound(strictBound.x1 - renderM[3], strictBound.y1 - renderM[0], strictBound.x2 + renderM[1], strictBound.y2 + renderM[2]);
577
578
  }
578
579
  updateBoundingRect() {
579
580
  const { renderCoords, globalTransform: transform } = this;
@@ -593,16 +594,14 @@ export class CoreNode extends EventEmitter {
593
594
  assertTruthy(this.stage);
594
595
  // no clipping, use parent's bounds
595
596
  if (this.clipping === false) {
596
- if (this.parent !== null) {
597
- this.strictBound =
598
- this.parent.strictBound ??
599
- createBound(0, 0, this.stage.root.width, this.stage.root.height);
600
- this.preloadBound =
601
- this.parent.preloadBound ??
602
- this.createPreloadBounds(this.strictBound);
597
+ if (this.parent !== null && this.parent.strictBound !== undefined) {
598
+ // we have a parent with a valid bound, copy it
599
+ this.strictBound = createBound(this.parent.strictBound.x1, this.parent.strictBound.y1, this.parent.strictBound.x2, this.parent.strictBound.y2);
600
+ this.preloadBound = this.createPreloadBounds(this.strictBound);
603
601
  return;
604
602
  }
605
603
  else {
604
+ // no parent or parent does not have a bound, take the stage dimensions
606
605
  this.strictBound = createBound(0, 0, this.stage.root.width, this.stage.root.height);
607
606
  this.preloadBound = this.createPreloadBounds(this.strictBound);
608
607
  return;
@@ -741,8 +740,7 @@ export class CoreNode extends EventEmitter {
741
740
  this.props.texture = null;
742
741
  this.props.shader = this.stage.defShaderCtr;
743
742
  const children = [...this.children];
744
- for (let i = 0; i < children.length; i++) {
745
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
743
+ for (let i = 0, length = children.length; i < length; i++) {
746
744
  children[i].destroy();
747
745
  }
748
746
  // This very action will also remove the node from the parent's children array
@@ -971,8 +969,9 @@ export class CoreNode extends EventEmitter {
971
969
  this.props.alpha = value;
972
970
  this.setUpdateType(UpdateType.PremultipliedColors |
973
971
  UpdateType.WorldAlpha |
974
- UpdateType.Children);
975
- this.childUpdateType |= UpdateType.Global;
972
+ UpdateType.Children |
973
+ UpdateType.IsRenderable);
974
+ this.childUpdateType |= UpdateType.WorldAlpha;
976
975
  }
977
976
  get autosize() {
978
977
  return this.props.autosize;
@@ -1079,9 +1078,9 @@ export class CoreNode extends EventEmitter {
1079
1078
  set zIndexLocked(value) {
1080
1079
  this.props.zIndexLocked = value;
1081
1080
  this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1082
- this.children.forEach((child) => {
1083
- child.setUpdateType(UpdateType.CalculatedZIndex);
1084
- });
1081
+ for (let i = 0, length = this.children.length; i < length; i++) {
1082
+ this.children[i].setUpdateType(UpdateType.CalculatedZIndex);
1083
+ }
1085
1084
  }
1086
1085
  get zIndex() {
1087
1086
  return this.props.zIndex;
@@ -1089,9 +1088,9 @@ export class CoreNode extends EventEmitter {
1089
1088
  set zIndex(value) {
1090
1089
  this.props.zIndex = value;
1091
1090
  this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1092
- this.children.forEach((child) => {
1093
- child.setUpdateType(UpdateType.CalculatedZIndex);
1094
- });
1091
+ for (let i = 0, length = this.children.length; i < length; i++) {
1092
+ this.children[i].setUpdateType(UpdateType.CalculatedZIndex);
1093
+ }
1095
1094
  }
1096
1095
  get parent() {
1097
1096
  return this.props.parent;
@@ -1138,9 +1137,9 @@ export class CoreNode extends EventEmitter {
1138
1137
  if (value === false && this.texture !== null) {
1139
1138
  this.unloadTexture();
1140
1139
  this.setUpdateType(UpdateType.All);
1141
- this.children.forEach((child) => {
1142
- child.parentHasRenderTexture = false;
1143
- });
1140
+ for (let i = 0, length = this.children.length; i < length; i++) {
1141
+ this.children[i].parentHasRenderTexture = false;
1142
+ }
1144
1143
  this.stage.renderer?.removeRTTNode(this);
1145
1144
  return;
1146
1145
  }
@@ -1158,9 +1157,9 @@ export class CoreNode extends EventEmitter {
1158
1157
  this.props.rtt = true;
1159
1158
  this.hasRTTupdates = true;
1160
1159
  this.setUpdateType(UpdateType.All);
1161
- this.children.forEach((child) => {
1162
- child.setUpdateType(UpdateType.All);
1163
- });
1160
+ for (let i = 0, length = this.children.length; i < length; i++) {
1161
+ this.children[i].setUpdateType(UpdateType.All);
1162
+ }
1164
1163
  // Store RTT nodes in a separate list
1165
1164
  this.stage.renderer?.renderToTexture(this);
1166
1165
  }