@lightningjs/renderer 2.9.0-beta3 → 2.9.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 (217) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/CoreNode.d.ts +33 -7
  14. package/dist/src/core/CoreNode.js +113 -75
  15. package/dist/src/core/CoreNode.js.map +1 -1
  16. package/dist/src/core/CoreTextNode.d.ts +2 -2
  17. package/dist/src/core/CoreTextNode.js +7 -4
  18. package/dist/src/core/CoreTextNode.js.map +1 -1
  19. package/dist/src/core/CoreTextureManager.d.ts +24 -0
  20. package/dist/src/core/CoreTextureManager.js.map +1 -1
  21. package/dist/src/core/Stage.js +1 -0
  22. package/dist/src/core/Stage.js.map +1 -1
  23. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  24. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  25. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  26. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  27. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  28. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  29. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  30. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  31. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  32. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  33. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  34. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  35. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  36. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  37. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  38. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +12 -12
  39. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  40. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  41. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +6 -0
  42. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  43. package/dist/src/core/textures/Texture.d.ts +1 -1
  44. package/dist/src/core/textures/Texture.js +13 -5
  45. package/dist/src/core/textures/Texture.js.map +1 -1
  46. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  47. package/dist/src/main-api/ICoreDriver.js +20 -0
  48. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  49. package/dist/src/main-api/RendererMain.d.ts +378 -0
  50. package/dist/src/main-api/RendererMain.js +367 -0
  51. package/dist/src/main-api/RendererMain.js.map +1 -0
  52. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  53. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  54. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  55. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  56. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  57. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  58. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  59. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  60. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  61. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  62. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  63. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  64. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  65. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  66. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  67. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  68. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  69. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  70. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  71. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  72. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  73. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  74. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  75. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  76. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  77. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  78. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  79. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  80. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  81. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  82. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  83. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  84. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  85. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  86. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  87. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  88. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  89. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  90. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  91. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  92. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  93. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  94. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  95. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  96. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  97. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  98. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  99. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  100. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  101. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  102. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  103. package/dist/src/render-drivers/utils.d.ts +12 -0
  104. package/dist/src/render-drivers/utils.js +74 -0
  105. package/dist/src/render-drivers/utils.js.map +1 -0
  106. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  107. package/dist/tsconfig.tsbuildinfo +1 -0
  108. package/exports/canvas.ts +39 -39
  109. package/exports/index.ts +89 -89
  110. package/exports/inspector.ts +24 -24
  111. package/exports/utils.ts +44 -44
  112. package/exports/webgl.ts +38 -38
  113. package/package.json +1 -1
  114. package/scripts/please-use-pnpm.js +13 -13
  115. package/src/common/CommonTypes.ts +139 -139
  116. package/src/common/EventEmitter.ts +77 -77
  117. package/src/common/IAnimationController.ts +92 -92
  118. package/src/common/IEventEmitter.ts +28 -28
  119. package/src/core/CoreNode.test.ts +199 -95
  120. package/src/core/CoreNode.ts +2335 -2282
  121. package/src/core/CoreShaderManager.ts +292 -292
  122. package/src/core/CoreTextNode.ts +455 -450
  123. package/src/core/CoreTextureManager.ts +548 -522
  124. package/src/core/Stage.ts +700 -699
  125. package/src/core/TextureMemoryManager.ts +277 -277
  126. package/src/core/animations/AnimationManager.ts +38 -38
  127. package/src/core/animations/CoreAnimation.ts +340 -340
  128. package/src/core/animations/CoreAnimationController.ts +157 -157
  129. package/src/core/lib/ContextSpy.ts +41 -41
  130. package/src/core/lib/ImageWorker.ts +270 -270
  131. package/src/core/lib/Matrix3d.ts +244 -244
  132. package/src/core/lib/RenderCoords.ts +86 -86
  133. package/src/core/lib/WebGlContextWrapper.ts +1322 -1322
  134. package/src/core/lib/textureCompression.ts +152 -152
  135. package/src/core/lib/textureSvg.ts +78 -78
  136. package/src/core/lib/utils.ts +306 -306
  137. package/src/core/platform.ts +61 -61
  138. package/src/core/renderers/CoreContextTexture.ts +43 -43
  139. package/src/core/renderers/CoreRenderOp.ts +22 -22
  140. package/src/core/renderers/CoreRenderer.ts +114 -114
  141. package/src/core/renderers/CoreShader.ts +41 -41
  142. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -364
  143. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -150
  144. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  145. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  146. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  147. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  148. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  149. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -298
  150. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  151. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -805
  152. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  153. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  154. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  155. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  156. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  157. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  158. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  159. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  160. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  161. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  162. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  163. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  164. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  165. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  166. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  167. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  168. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  169. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  170. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  171. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  172. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  173. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  174. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  175. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  176. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  177. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  178. package/src/core/text-rendering/TrFontManager.ts +183 -183
  179. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -169
  180. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  181. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  182. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  183. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  184. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  185. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  186. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  192. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  193. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  194. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  195. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  197. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  198. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  199. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  200. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  201. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  202. package/src/core/textures/ColorTexture.ts +102 -102
  203. package/src/core/textures/ImageTexture.ts +378 -378
  204. package/src/core/textures/NoiseTexture.ts +104 -104
  205. package/src/core/textures/RenderTexture.ts +85 -85
  206. package/src/core/textures/SubTexture.ts +171 -171
  207. package/src/core/textures/Texture.ts +423 -407
  208. package/src/core/utils.ts +227 -227
  209. package/src/env.d.ts +7 -7
  210. package/src/main-api/DynamicShaderController.ts +104 -104
  211. package/src/main-api/INode.ts +101 -101
  212. package/src/main-api/Inspector.ts +505 -505
  213. package/src/main-api/Renderer.ts +693 -693
  214. package/src/main-api/ShaderController.ts +80 -80
  215. package/src/main-api/utils.ts +45 -45
  216. package/src/utils.ts +248 -248
  217. package/COPYING +0 -1
package/README.md CHANGED
@@ -1,147 +1,147 @@
1
- # Lightning 3 Renderer
2
-
3
- A powerful 2D scene renderer designed for rendering highly performant user
4
- interfaces on web browsers running on embedded devices using WebGL.
5
-
6
- The Renderer is part of the [LightningJS](https://lightningjs.io) project. While it is possible to use the renderer directly, it is not recommended. Instead, Lightning 3 works best when combined with [Blits](https://lightningjs.io/v3-docs/blits/getting_started/intro.html).
7
-
8
- ## Setup & Commands
9
-
10
- ```
11
- # Install renderer + example dependencies
12
- pnpm install
13
-
14
- # Build Renderer
15
- pnpm build
16
-
17
- # Build Renderer (watch mode)
18
- pnpm watch
19
-
20
- # Run unit tests
21
- pnpm test
22
-
23
- # Run Visual Regression Tests
24
- pnpm test:visual
25
-
26
- # Build API Documentation (builds into ./typedocs folder)
27
- pnpm typedoc
28
-
29
- # Launch Example Tests in dev mode (includes Build Renderer (watch mode))
30
- pnpm start
31
-
32
- # Launch Example Tests in production mode
33
- # IMPORTANT: To run test examples on embedded devices that use older browser versions
34
- # you MUST run the examples in this mode.
35
- pnpm start:prod
36
- ```
37
-
38
- ## Browser Targets
39
-
40
- The Lightning 3 Renderer's goal is to work with the following browser versions and above:
41
-
42
- - Chrome v38 (Released October 7, 2014)
43
-
44
- Any JavaScript language features or browser APIs that cannot be automatically transpiled or polyfilled by industry standard transpilers (such as Babel) to target these versions must be carefully considered before use.
45
-
46
- For a more detailed and comprehensive list of browsers and their features please see [browsers](./BROWSERS.md).
47
-
48
- ## Example Tests
49
-
50
- The Example Tests sub-project define a set of tests for various Renderer
51
- features. This is NOT an automated test. The command below will launch a
52
- web server which can be accessed by a web browser for manual testing. However,
53
- many of the Example Tests define Snapshots for the Visual Regression Test Runner
54
- (see below).
55
-
56
- The Example Tests can be launched with:
57
-
58
- ```
59
- pnpm start
60
- ```
61
-
62
- A hosted version can be found [here](https://lightning-js.github.io/renderer/).
63
-
64
- This supports modern browsers as well as Chrome 38 and above through a legacy build.
65
-
66
- See [examples/README.md](./examples/README.md) for more info.
67
-
68
- ## Visual Regression Tests
69
-
70
- In order to prevent bugs on existing Renderer features when new features or bug
71
- fixes are added, the Renderer includes a Visual Regression Test Runner along
72
- with a set of certified snapshot files that are checked into the repository.
73
-
74
- These tests can be launched with:
75
-
76
- ```
77
- pnpm test:visual
78
- ```
79
-
80
- The captured Snapshots of these tests are optionally defined in the individual
81
- Example Tests.
82
-
83
- See [visual-regression/README.md](./visual-regression/README.md) for more info.
84
-
85
- ## Manual Regression Tests
86
-
87
- See [docs/ManualRegressionTests.md].
88
-
89
- ## Release Procedure
90
-
91
- See [RELEASE.md](./RELEASE.md)
92
-
93
- ## Installing Fonts
94
-
95
- Fonts can be installed into the Font Manager exposed by the Renderer's Stage.
96
- There are two types of fonts that you can install, Web/Canvas2D fonts (WebTrFontFace)
97
- and SDF fonts (SdfTrFontFace). Install that fonts that your applications needs
98
- at start up so they are ready when your application is rendered.
99
-
100
- ```ts
101
- import {
102
- RendererMain,
103
- WebTrFontFace,
104
- SdfTrFontFace,
105
- } from '@lightningjs/renderer';
106
-
107
- import {
108
- WebGlCoreRenderer,
109
- SdfTextRenderer,
110
- } from '@lightningjs/renderer/webgl';
111
- import { CanvasTextRenderer } from '@lightningjs/renderer/canvas';
112
-
113
- const renderer = new RendererMain(
114
- {
115
- appWidth: 1920,
116
- appHeight: 1080,
117
- renderEngine: WebGlCoreRenderer,
118
- fontEngines: [SdfTextRenderer, CanvasTextRenderer],
119
- // ...Other Renderer Config
120
- },
121
- 'app', // id of div to insert Canvas.
122
- );
123
-
124
- // Load fonts into renderer
125
- renderer.stage.fontManager.addFontFace(
126
- new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
127
- );
128
-
129
- renderer.stage.fontManager.addFontFace(
130
- new SdfTrFontFace(
131
- 'Ubuntu',
132
- {},
133
- 'msdf',
134
- stage,
135
- '/fonts/Ubuntu-Regular.msdf.png',
136
- '/fonts/Ubuntu-Regular.msdf.json',
137
- ),
138
- );
139
- ```
140
-
141
- Please note that the WebGL renderer supports both SDF Fonts and Web Fonts, however the
142
- Canvas renderer only supports Web Fonts:
143
-
144
- | Font Type Renderer | SDF Font | Web Font |
145
- | ------------------ | -------- | -------- |
146
- | WebGL | Y | Y |
147
- | Canvas | N | Y |
1
+ # Lightning 3 Renderer
2
+
3
+ A powerful 2D scene renderer designed for rendering highly performant user
4
+ interfaces on web browsers running on embedded devices using WebGL.
5
+
6
+ The Renderer is part of the [LightningJS](https://lightningjs.io) project. While it is possible to use the renderer directly, it is not recommended. Instead, Lightning 3 works best when combined with [Blits](https://lightningjs.io/v3-docs/blits/getting_started/intro.html).
7
+
8
+ ## Setup & Commands
9
+
10
+ ```
11
+ # Install renderer + example dependencies
12
+ pnpm install
13
+
14
+ # Build Renderer
15
+ pnpm build
16
+
17
+ # Build Renderer (watch mode)
18
+ pnpm watch
19
+
20
+ # Run unit tests
21
+ pnpm test
22
+
23
+ # Run Visual Regression Tests
24
+ pnpm test:visual
25
+
26
+ # Build API Documentation (builds into ./typedocs folder)
27
+ pnpm typedoc
28
+
29
+ # Launch Example Tests in dev mode (includes Build Renderer (watch mode))
30
+ pnpm start
31
+
32
+ # Launch Example Tests in production mode
33
+ # IMPORTANT: To run test examples on embedded devices that use older browser versions
34
+ # you MUST run the examples in this mode.
35
+ pnpm start:prod
36
+ ```
37
+
38
+ ## Browser Targets
39
+
40
+ The Lightning 3 Renderer's goal is to work with the following browser versions and above:
41
+
42
+ - Chrome v38 (Released October 7, 2014)
43
+
44
+ Any JavaScript language features or browser APIs that cannot be automatically transpiled or polyfilled by industry standard transpilers (such as Babel) to target these versions must be carefully considered before use.
45
+
46
+ For a more detailed and comprehensive list of browsers and their features please see [browsers](./BROWSERS.md).
47
+
48
+ ## Example Tests
49
+
50
+ The Example Tests sub-project define a set of tests for various Renderer
51
+ features. This is NOT an automated test. The command below will launch a
52
+ web server which can be accessed by a web browser for manual testing. However,
53
+ many of the Example Tests define Snapshots for the Visual Regression Test Runner
54
+ (see below).
55
+
56
+ The Example Tests can be launched with:
57
+
58
+ ```
59
+ pnpm start
60
+ ```
61
+
62
+ A hosted version can be found [here](https://lightning-js.github.io/renderer/).
63
+
64
+ This supports modern browsers as well as Chrome 38 and above through a legacy build.
65
+
66
+ See [examples/README.md](./examples/README.md) for more info.
67
+
68
+ ## Visual Regression Tests
69
+
70
+ In order to prevent bugs on existing Renderer features when new features or bug
71
+ fixes are added, the Renderer includes a Visual Regression Test Runner along
72
+ with a set of certified snapshot files that are checked into the repository.
73
+
74
+ These tests can be launched with:
75
+
76
+ ```
77
+ pnpm test:visual
78
+ ```
79
+
80
+ The captured Snapshots of these tests are optionally defined in the individual
81
+ Example Tests.
82
+
83
+ See [visual-regression/README.md](./visual-regression/README.md) for more info.
84
+
85
+ ## Manual Regression Tests
86
+
87
+ See [docs/ManualRegressionTests.md].
88
+
89
+ ## Release Procedure
90
+
91
+ See [RELEASE.md](./RELEASE.md)
92
+
93
+ ## Installing Fonts
94
+
95
+ Fonts can be installed into the Font Manager exposed by the Renderer's Stage.
96
+ There are two types of fonts that you can install, Web/Canvas2D fonts (WebTrFontFace)
97
+ and SDF fonts (SdfTrFontFace). Install that fonts that your applications needs
98
+ at start up so they are ready when your application is rendered.
99
+
100
+ ```ts
101
+ import {
102
+ RendererMain,
103
+ WebTrFontFace,
104
+ SdfTrFontFace,
105
+ } from '@lightningjs/renderer';
106
+
107
+ import {
108
+ WebGlCoreRenderer,
109
+ SdfTextRenderer,
110
+ } from '@lightningjs/renderer/webgl';
111
+ import { CanvasTextRenderer } from '@lightningjs/renderer/canvas';
112
+
113
+ const renderer = new RendererMain(
114
+ {
115
+ appWidth: 1920,
116
+ appHeight: 1080,
117
+ renderEngine: WebGlCoreRenderer,
118
+ fontEngines: [SdfTextRenderer, CanvasTextRenderer],
119
+ // ...Other Renderer Config
120
+ },
121
+ 'app', // id of div to insert Canvas.
122
+ );
123
+
124
+ // Load fonts into renderer
125
+ renderer.stage.fontManager.addFontFace(
126
+ new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
127
+ );
128
+
129
+ renderer.stage.fontManager.addFontFace(
130
+ new SdfTrFontFace(
131
+ 'Ubuntu',
132
+ {},
133
+ 'msdf',
134
+ stage,
135
+ '/fonts/Ubuntu-Regular.msdf.png',
136
+ '/fonts/Ubuntu-Regular.msdf.json',
137
+ ),
138
+ );
139
+ ```
140
+
141
+ Please note that the WebGL renderer supports both SDF Fonts and Web Fonts, however the
142
+ Canvas renderer only supports Web Fonts:
143
+
144
+ | Font Type Renderer | SDF Font | Web Font |
145
+ | ------------------ | -------- | -------- |
146
+ | WebGL | Y | Y |
147
+ | Canvas | N | Y |
@@ -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"}
@@ -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"}
@@ -342,7 +342,11 @@ export interface CoreNodeProps {
342
342
  */
343
343
  texture: Texture | null;
344
344
  /**
345
- * Whether to prevent the node from being cleaned up
345
+ * [Deprecated]: Prevents the texture from being cleaned up when the Node is removed
346
+ *
347
+ * @remarks
348
+ * Please use the `preventCleanup` property on {@link TextureOptions} instead.
349
+ *
346
350
  * @default false
347
351
  */
348
352
  preventCleanup: boolean;
@@ -657,7 +661,6 @@ export declare class CoreNode extends EventEmitter {
657
661
  rttParent: CoreNode | null;
658
662
  constructor(stage: Stage, props: CoreNodeProps);
659
663
  loadTexture(): void;
660
- createDefaultTexture(): void;
661
664
  unloadTexture(): void;
662
665
  autosizeNode(dimensions: Dimensions): void;
663
666
  private onTextureLoaded;
@@ -682,18 +685,40 @@ export declare class CoreNode extends EventEmitter {
682
685
  update(delta: number, parentClippingRect: RectWithValid): void;
683
686
  private findParentRTTNode;
684
687
  private notifyParentRTTOfUpdate;
685
- hasRenderableProperties(): boolean;
686
688
  checkRenderBounds(): CoreNodeRenderState;
687
689
  updateBoundingRect(): void;
688
690
  createRenderBounds(): void;
689
691
  updateRenderState(renderState: CoreNodeRenderState): void;
690
692
  /**
691
- * This function updates the `isRenderable` property based on certain conditions.
692
- *
693
- * @returns
693
+ * Updates the `isRenderable` property based on various conditions.
694
694
  */
695
695
  updateIsRenderable(): void;
696
- onChangeIsRenderable(isRenderable: boolean): void;
696
+ /**
697
+ * Checks if the node is renderable based on world alpha, dimensions and out of bounds status.
698
+ */
699
+ checkBasicRenderability(): boolean;
700
+ /**
701
+ * Sets the renderable state and triggers changes if necessary.
702
+ * @param isRenderable - The new renderable state
703
+ */
704
+ setRenderable(isRenderable: boolean): void;
705
+ /**
706
+ * Changes the renderable state of the node.
707
+ */
708
+ updateTextureOwnership(isRenderable: boolean): void;
709
+ /**
710
+ * Checks if the node is out of the viewport bounds.
711
+ */
712
+ isOutOfBounds(): boolean;
713
+ /**
714
+ * Checks if the node has dimensions (width/height)
715
+ */
716
+ hasDimensions(): boolean;
717
+ /**
718
+ * Checks if the node has any color properties set.
719
+ */
720
+ hasColorProperties(): boolean;
721
+ hasShader(): boolean;
697
722
  calculateRenderCoords(): void;
698
723
  /**
699
724
  * This function calculates the clipping rectangle for a node.
@@ -778,6 +803,7 @@ export declare class CoreNode extends EventEmitter {
778
803
  get rtt(): boolean;
779
804
  set rtt(value: boolean);
780
805
  private initRenderTexture;
806
+ private loadRenderTexture;
781
807
  private cleanupRenderTexture;
782
808
  private markChildrenWithRTT;
783
809
  private applyRTTInheritance;