@lightningjs/renderer 3.0.0-beta5 → 3.0.0-beta7

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 (370) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/src/core/CoreNode.d.ts +15 -16
  6. package/dist/src/core/CoreNode.js +41 -37
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextNode.js +0 -1
  9. package/dist/src/core/CoreTextNode.js.map +1 -1
  10. package/dist/src/core/CoreTextureManager.js +10 -5
  11. package/dist/src/core/CoreTextureManager.js.map +1 -1
  12. package/dist/src/core/Stage.d.ts +16 -0
  13. package/dist/src/core/Stage.js +39 -3
  14. package/dist/src/core/Stage.js.map +1 -1
  15. package/dist/src/core/TextureMemoryManager.js +3 -4
  16. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  17. package/dist/src/core/lib/ImageWorker.js +1 -1
  18. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  19. package/dist/src/core/lib/utils.d.ts +1 -0
  20. package/dist/src/core/lib/utils.js +3 -0
  21. package/dist/src/core/lib/utils.js.map +1 -1
  22. package/dist/src/core/renderers/CoreRenderer.d.ts +1 -1
  23. package/dist/src/core/renderers/webgl/WebGlRenderOp.d.ts +1 -1
  24. package/dist/src/core/renderers/webgl/WebGlRenderOp.js.map +1 -1
  25. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +1 -2
  26. package/dist/src/core/renderers/webgl/WebGlRenderer.js +1 -3
  27. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -1
  28. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +35 -35
  29. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  30. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  31. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  32. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  33. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  34. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  35. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  36. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  37. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  38. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  39. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  40. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  41. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  42. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  43. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  44. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  45. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  46. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  47. package/dist/src/core/shaders/canvas/RoundedWithBorder.js +8 -2
  48. package/dist/src/core/shaders/canvas/RoundedWithBorder.js.map +1 -1
  49. package/dist/src/core/shaders/webgl/Border.js +86 -63
  50. package/dist/src/core/shaders/webgl/Border.js.map +1 -1
  51. package/dist/src/core/shaders/webgl/Default.js +47 -47
  52. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  53. package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
  54. package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
  55. package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
  56. package/dist/src/core/shaders/webgl/Rounded.js +71 -71
  57. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +104 -72
  58. package/dist/src/core/shaders/webgl/RoundedWithBorder.js.map +1 -1
  59. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +123 -86
  60. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js.map +1 -1
  61. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
  62. package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
  63. package/dist/src/core/shaders/webgl/Shadow.js +83 -83
  64. package/dist/src/core/temp.js +77 -0
  65. package/dist/src/core/temp.js.map +1 -0
  66. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +3 -1
  67. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  68. package/dist/src/core/textures/ImageTexture.js +5 -0
  69. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  70. package/dist/src/main-api/Inspector.js +1 -1
  71. package/dist/src/main-api/Inspector.js.map +1 -1
  72. package/dist/src/main-api/Renderer.js +3 -4
  73. package/dist/src/main-api/Renderer.js.map +1 -1
  74. package/dist/src/utils.d.ts +1 -6
  75. package/dist/src/utils.js +2 -9
  76. package/dist/src/utils.js.map +1 -1
  77. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  78. package/exports/canvas-shaders.ts +28 -28
  79. package/exports/canvas.ts +45 -45
  80. package/exports/index.ts +90 -90
  81. package/exports/inspector.ts +24 -24
  82. package/exports/utils.ts +44 -44
  83. package/exports/webgl-shaders.ts +28 -28
  84. package/exports/webgl.ts +50 -50
  85. package/package.json +1 -3
  86. package/src/common/CommonTypes.ts +146 -146
  87. package/src/common/EventEmitter.ts +77 -77
  88. package/src/common/IAnimationController.ts +92 -92
  89. package/src/common/IEventEmitter.ts +28 -28
  90. package/src/core/CoreNode.test.ts +202 -203
  91. package/src/core/CoreNode.ts +2495 -2494
  92. package/src/core/CoreShaderManager.ts +188 -188
  93. package/src/core/CoreTextNode.ts +448 -449
  94. package/src/core/CoreTextureManager.ts +607 -601
  95. package/src/core/Stage.ts +797 -754
  96. package/src/core/TextureMemoryManager.ts +394 -395
  97. package/src/core/animations/AnimationManager.ts +38 -38
  98. package/src/core/animations/CoreAnimation.ts +284 -284
  99. package/src/core/animations/CoreAnimationController.ts +157 -157
  100. package/src/core/lib/ContextSpy.ts +41 -41
  101. package/src/core/lib/ImageWorker.ts +286 -280
  102. package/src/core/lib/Matrix3d.ts +244 -244
  103. package/src/core/lib/RenderCoords.ts +71 -71
  104. package/src/core/lib/WebGlContextWrapper.ts +1374 -1374
  105. package/src/core/lib/textureCompression.ts +152 -152
  106. package/src/core/lib/textureSvg.ts +78 -78
  107. package/src/core/lib/utils.ts +390 -386
  108. package/src/core/lib/validateImageBitmap.ts +87 -87
  109. package/src/core/platforms/Platform.ts +77 -77
  110. package/src/core/platforms/web/WebPlatform.ts +84 -84
  111. package/src/core/renderers/CoreContextTexture.ts +43 -43
  112. package/src/core/renderers/CoreRenderOp.ts +22 -22
  113. package/src/core/renderers/CoreRenderer.ts +109 -109
  114. package/src/core/renderers/CoreShaderNode.ts +165 -165
  115. package/src/core/renderers/CoreShaderProgram.ts +23 -23
  116. package/src/core/renderers/canvas/CanvasRenderer.ts +298 -298
  117. package/src/core/renderers/canvas/CanvasShaderNode.ts +99 -99
  118. package/src/core/renderers/canvas/CanvasTexture.ts +156 -156
  119. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +220 -220
  120. package/src/core/renderers/canvas/internal/ColorUtils.ts +85 -85
  121. package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +86 -86
  122. package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +50 -50
  123. package/src/core/renderers/webgl/WebGlCtxTexture.ts +301 -301
  124. package/src/core/renderers/webgl/WebGlRenderOp.ts +161 -161
  125. package/src/core/renderers/webgl/WebGlRenderer.ts +748 -750
  126. package/src/core/renderers/webgl/WebGlShaderNode.ts +437 -437
  127. package/src/core/renderers/webgl/WebGlShaderProgram.ts +318 -318
  128. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  129. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  130. package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -281
  131. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  132. package/src/core/shaders/canvas/Border.ts +78 -78
  133. package/src/core/shaders/canvas/HolePunch.ts +62 -62
  134. package/src/core/shaders/canvas/LinearGradient.ts +69 -69
  135. package/src/core/shaders/canvas/RadialGradient.ts +113 -113
  136. package/src/core/shaders/canvas/Rounded.ts +55 -55
  137. package/src/core/shaders/canvas/RoundedWithBorder.ts +72 -68
  138. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +88 -88
  139. package/src/core/shaders/canvas/RoundedWithShadow.ts +69 -69
  140. package/src/core/shaders/canvas/Shadow.ts +52 -52
  141. package/src/core/shaders/canvas/utils/render.ts +151 -151
  142. package/src/core/shaders/templates/BorderTemplate.ts +115 -115
  143. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
  144. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
  145. package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -81
  146. package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
  147. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
  148. package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
  149. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
  150. package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
  151. package/src/core/shaders/templates/shaderUtils.ts +47 -47
  152. package/src/core/shaders/webgl/Border.ts +116 -96
  153. package/src/core/shaders/webgl/Default.ts +89 -89
  154. package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
  155. package/src/core/shaders/webgl/HolePunch.ts +78 -78
  156. package/src/core/shaders/webgl/LinearGradient.ts +81 -81
  157. package/src/core/shaders/webgl/RadialGradient.ts +84 -84
  158. package/src/core/shaders/webgl/Rounded.ts +117 -117
  159. package/src/core/shaders/webgl/RoundedWithBorder.ts +144 -114
  160. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +166 -133
  161. package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -98
  162. package/src/core/shaders/webgl/SdfShader.ts +134 -134
  163. package/src/core/shaders/webgl/Shadow.ts +115 -115
  164. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  165. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  166. package/src/core/text-rendering/TrFontManager.ts +183 -183
  167. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  168. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  169. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  170. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  171. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  172. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  173. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  174. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +514 -514
  175. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +863 -863
  176. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +849 -846
  177. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  178. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  179. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  180. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  181. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  182. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  183. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  184. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +497 -497
  185. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  186. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  190. package/src/core/text-rendering/renderers/TextRenderer.ts +567 -567
  191. package/src/core/textures/ColorTexture.ts +102 -102
  192. package/src/core/textures/ImageTexture.ts +417 -410
  193. package/src/core/textures/NoiseTexture.ts +104 -104
  194. package/src/core/textures/RenderTexture.ts +85 -85
  195. package/src/core/textures/SubTexture.ts +205 -205
  196. package/src/core/textures/Texture.ts +358 -358
  197. package/src/core/utils.ts +227 -227
  198. package/src/env.d.ts +7 -7
  199. package/src/main-api/INode.ts +100 -100
  200. package/src/main-api/Inspector.ts +522 -522
  201. package/src/main-api/Renderer.ts +673 -675
  202. package/src/main-api/utils.ts +45 -45
  203. package/src/utils.ts +267 -267
  204. package/dist/exports/core-api.d.ts +0 -74
  205. package/dist/exports/core-api.js +0 -96
  206. package/dist/exports/core-api.js.map +0 -1
  207. package/dist/exports/main-api.d.ts +0 -30
  208. package/dist/exports/main-api.js +0 -45
  209. package/dist/exports/main-api.js.map +0 -1
  210. package/dist/src/core/CoreExtension.d.ts +0 -12
  211. package/dist/src/core/CoreExtension.js +0 -29
  212. package/dist/src/core/CoreExtension.js.map +0 -1
  213. package/dist/src/core/CoreStuff.js +0 -138
  214. package/dist/src/core/CoreStuff.js.map +0 -1
  215. package/dist/src/core/CoreTexturizer.d.ts +0 -14
  216. package/dist/src/core/CoreTexturizer.js +0 -47
  217. package/dist/src/core/CoreTexturizer.js.map +0 -1
  218. package/dist/src/core/LngNode.d.ts +0 -736
  219. package/dist/src/core/LngNode.js +0 -1174
  220. package/dist/src/core/LngNode.js.map +0 -1
  221. package/dist/src/core/Matrix2DContext.d.ts +0 -15
  222. package/dist/src/core/Matrix2DContext.js +0 -45
  223. package/dist/src/core/Matrix2DContext.js.map +0 -1
  224. package/dist/src/core/ShaderNode.d.ts +0 -10
  225. package/dist/src/core/ShaderNode.js +0 -30
  226. package/dist/src/core/ShaderNode.js.map +0 -1
  227. package/dist/src/core/TextNode.d.ts +0 -103
  228. package/dist/src/core/TextNode.js +0 -331
  229. package/dist/src/core/TextNode.js.map +0 -1
  230. package/dist/src/core/lib/Coords.d.ts +0 -14
  231. package/dist/src/core/lib/Coords.js +0 -55
  232. package/dist/src/core/lib/Coords.js.map +0 -1
  233. package/dist/src/core/lib/glm/common.d.ts +0 -162
  234. package/dist/src/core/lib/glm/common.js +0 -81
  235. package/dist/src/core/lib/glm/common.js.map +0 -1
  236. package/dist/src/core/lib/glm/index.d.ts +0 -11
  237. package/dist/src/core/lib/glm/index.js +0 -30
  238. package/dist/src/core/lib/glm/index.js.map +0 -1
  239. package/dist/src/core/lib/glm/mat2.d.ts +0 -219
  240. package/dist/src/core/lib/glm/mat2.js +0 -396
  241. package/dist/src/core/lib/glm/mat2.js.map +0 -1
  242. package/dist/src/core/lib/glm/mat2d.d.ts +0 -237
  243. package/dist/src/core/lib/glm/mat2d.js +0 -442
  244. package/dist/src/core/lib/glm/mat2d.js.map +0 -1
  245. package/dist/src/core/lib/glm/mat3.d.ts +0 -283
  246. package/dist/src/core/lib/glm/mat3.js +0 -680
  247. package/dist/src/core/lib/glm/mat3.js.map +0 -1
  248. package/dist/src/core/lib/glm/mat4.d.ts +0 -550
  249. package/dist/src/core/lib/glm/mat4.js +0 -1802
  250. package/dist/src/core/lib/glm/mat4.js.map +0 -1
  251. package/dist/src/core/lib/glm/quat.d.ts +0 -363
  252. package/dist/src/core/lib/glm/quat.js +0 -693
  253. package/dist/src/core/lib/glm/quat.js.map +0 -1
  254. package/dist/src/core/lib/glm/quat2.d.ts +0 -356
  255. package/dist/src/core/lib/glm/quat2.js +0 -754
  256. package/dist/src/core/lib/glm/quat2.js.map +0 -1
  257. package/dist/src/core/lib/glm/vec2.d.ts +0 -365
  258. package/dist/src/core/lib/glm/vec2.js +0 -569
  259. package/dist/src/core/lib/glm/vec2.js.map +0 -1
  260. package/dist/src/core/lib/glm/vec3.d.ts +0 -406
  261. package/dist/src/core/lib/glm/vec3.js +0 -720
  262. package/dist/src/core/lib/glm/vec3.js.map +0 -1
  263. package/dist/src/core/lib/glm/vec4.d.ts +0 -330
  264. package/dist/src/core/lib/glm/vec4.js +0 -608
  265. package/dist/src/core/lib/glm/vec4.js.map +0 -1
  266. package/dist/src/core/renderers/CoreShaderManager.d.ts +0 -19
  267. package/dist/src/core/renderers/CoreShaderManager.js +0 -33
  268. package/dist/src/core/renderers/CoreShaderManager.js.map +0 -1
  269. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +0 -27
  270. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +0 -82
  271. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +0 -1
  272. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +0 -11
  273. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +0 -34
  274. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +0 -1
  275. package/dist/src/core/scene/Scene.d.ts +0 -59
  276. package/dist/src/core/scene/Scene.js +0 -106
  277. package/dist/src/core/scene/Scene.js.map +0 -1
  278. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +0 -20
  279. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +0 -55
  280. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +0 -1
  281. package/dist/src/main-api/ICoreDriver.d.ts +0 -27
  282. package/dist/src/main-api/ICoreDriver.js +0 -20
  283. package/dist/src/main-api/ICoreDriver.js.map +0 -1
  284. package/dist/src/main-api/IRenderDriver.d.ts +0 -20
  285. package/dist/src/main-api/IRenderDriver.js +0 -20
  286. package/dist/src/main-api/IRenderDriver.js.map +0 -1
  287. package/dist/src/main-api/IShaderController.d.ts +0 -14
  288. package/dist/src/main-api/IShaderController.js +0 -30
  289. package/dist/src/main-api/IShaderController.js.map +0 -1
  290. package/dist/src/main-api/IShaderNode.d.ts +0 -17
  291. package/dist/src/main-api/IShaderNode.js +0 -19
  292. package/dist/src/main-api/IShaderNode.js.map +0 -1
  293. package/dist/src/main-api/RendererMain.d.ts +0 -375
  294. package/dist/src/main-api/RendererMain.js +0 -365
  295. package/dist/src/main-api/RendererMain.js.map +0 -1
  296. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
  297. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
  298. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
  299. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
  300. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
  301. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
  302. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
  303. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +0 -28
  304. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
  305. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -24
  306. package/dist/src/render-drivers/main/MainCoreDriver.js +0 -118
  307. package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
  308. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -99
  309. package/dist/src/render-drivers/main/MainOnlyNode.js +0 -396
  310. package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
  311. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +0 -6
  312. package/dist/src/render-drivers/main/MainOnlyShaderController.js +0 -15
  313. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +0 -1
  314. package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +0 -7
  315. package/dist/src/render-drivers/main/MainOnlyShaderNode.js +0 -34
  316. package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +0 -1
  317. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
  318. package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -205
  319. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
  320. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +0 -17
  321. package/dist/src/render-drivers/main/MainRenderDriver.js +0 -88
  322. package/dist/src/render-drivers/main/MainRenderDriver.js.map +0 -1
  323. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -90
  324. package/dist/src/render-drivers/threadx/NodeStruct.js +0 -281
  325. package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
  326. package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -39
  327. package/dist/src/render-drivers/threadx/SharedNode.js +0 -60
  328. package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
  329. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
  330. package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -201
  331. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
  332. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -28
  333. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -234
  334. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
  335. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -20
  336. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -84
  337. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
  338. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -44
  339. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -154
  340. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
  341. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +0 -6
  342. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +0 -16
  343. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +0 -1
  344. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +0 -7
  345. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +0 -15
  346. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +0 -1
  347. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
  348. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
  349. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
  350. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +0 -21
  351. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +0 -198
  352. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +0 -1
  353. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
  354. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
  355. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
  356. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
  357. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -177
  358. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
  359. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
  360. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -108
  361. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
  362. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +0 -1
  363. package/dist/src/render-drivers/threadx/worker/renderer.js +0 -145
  364. package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
  365. package/dist/src/render-drivers/utils.d.ts +0 -12
  366. package/dist/src/render-drivers/utils.js +0 -69
  367. package/dist/src/render-drivers/utils.js.map +0 -1
  368. package/scripts/please-use-pnpm.js +0 -13
  369. package/src/core/platform.ts +0 -64
  370. /package/dist/src/core/{CoreStuff.d.ts → temp.d.ts} +0 -0
@@ -1,750 +1,748 @@
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
- import { assertTruthy, createWebGLContext } from '../../../utils.js';
21
- import {
22
- CoreRenderer,
23
- type BufferInfo,
24
- type CoreRendererOptions,
25
- type QuadOptions,
26
- } from '../CoreRenderer.js';
27
- import { WebGlRenderOp } from './WebGlRenderOp.js';
28
- import type { CoreContextTexture } from '../CoreContextTexture.js';
29
- import {
30
- createIndexBuffer,
31
- type CoreWebGlParameters,
32
- type CoreWebGlExtensions,
33
- getWebGlParameters,
34
- getWebGlExtensions,
35
- type WebGlColor,
36
- } from './internal/RendererUtils.js';
37
- import { WebGlCtxTexture } from './WebGlCtxTexture.js';
38
- import {
39
- Texture,
40
- TextureType,
41
- type TextureCoords,
42
- } from '../../textures/Texture.js';
43
- import { SubTexture } from '../../textures/SubTexture.js';
44
- import { WebGlCtxSubTexture } from './WebGlCtxSubTexture.js';
45
- import { BufferCollection } from './internal/BufferCollection.js';
46
- import { compareRect, getNormalizedRgbaComponents } from '../../lib/utils.js';
47
- import { WebGlShaderProgram } from './WebGlShaderProgram.js';
48
- import { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
49
- import { RenderTexture } from '../../textures/RenderTexture.js';
50
- import { CoreNodeRenderState, type CoreNode } from '../../CoreNode.js';
51
- import { WebGlCtxRenderTexture } from './WebGlCtxRenderTexture.js';
52
- import { Default } from '../../shaders/webgl/Default.js';
53
- import type { WebGlShaderType } from './WebGlShaderNode.js';
54
- import { WebGlShaderNode } from './WebGlShaderNode.js';
55
-
56
- const WORDS_PER_QUAD = 32;
57
- // const BYTES_PER_QUAD = WORDS_PER_QUAD * 4;
58
-
59
- export type WebGlRendererOptions = CoreRendererOptions;
60
-
61
- interface CoreWebGlSystem {
62
- parameters: CoreWebGlParameters;
63
- extensions: CoreWebGlExtensions;
64
- }
65
-
66
- export class WebGlRenderer extends CoreRenderer {
67
- //// WebGL Native Context and Data
68
- glw: WebGlContextWrapper;
69
- system: CoreWebGlSystem;
70
-
71
- //// Persistent data
72
- quadBuffer: ArrayBuffer;
73
- fQuadBuffer: Float32Array;
74
- uiQuadBuffer: Uint32Array;
75
- renderOps: WebGlRenderOp[] = [];
76
-
77
- //// Render Op / Buffer Filling State
78
- curBufferIdx = 0;
79
- curRenderOp: WebGlRenderOp | null = null;
80
- override rttNodes: CoreNode[] = [];
81
- activeRttNode: CoreNode | null = null;
82
-
83
- defaultTextureCoords: TextureCoords = {
84
- x1: 0,
85
- y1: 0,
86
- x2: 1,
87
- y2: 1,
88
- };
89
-
90
- //// Default Shader
91
- defaultShaderNode: WebGlShaderNode | null = null;
92
- quadBufferCollection: BufferCollection;
93
-
94
- clearColor: WebGlColor = {
95
- raw: 0x00000000,
96
- normalized: [0, 0, 0, 0],
97
- };
98
-
99
- /**
100
- * White pixel texture used by default when no texture is specified.
101
- */
102
-
103
- quadBufferUsage = 0;
104
- numQuadsRendered = 0;
105
- /**
106
- * Whether the renderer is currently rendering to a texture.
107
- */
108
- public renderToTextureActive = false;
109
-
110
- constructor(options: WebGlRendererOptions) {
111
- super(options);
112
-
113
- this.quadBuffer = new ArrayBuffer(this.stage.options.quadBufferSize);
114
- this.fQuadBuffer = new Float32Array(this.quadBuffer);
115
- this.uiQuadBuffer = new Uint32Array(this.quadBuffer);
116
-
117
- this.mode = 'webgl';
118
-
119
- const gl = createWebGLContext(
120
- options.canvas,
121
- options.forceWebGL2,
122
- options.contextSpy,
123
- );
124
- const glw = (this.glw = new WebGlContextWrapper(gl));
125
- glw.viewport(0, 0, options.canvas.width, options.canvas.height);
126
-
127
- this.updateClearColor(this.stage.clearColor);
128
-
129
- glw.setBlend(true);
130
- glw.blendFunc(glw.ONE, glw.ONE_MINUS_SRC_ALPHA);
131
-
132
- createIndexBuffer(glw, this.stage.bufferMemory);
133
-
134
- this.system = {
135
- parameters: getWebGlParameters(this.glw),
136
- extensions: getWebGlExtensions(this.glw),
137
- };
138
- const quadBuffer = glw.createBuffer();
139
- assertTruthy(quadBuffer);
140
- const stride = 8 * Float32Array.BYTES_PER_ELEMENT;
141
- this.quadBufferCollection = new BufferCollection([
142
- {
143
- buffer: quadBuffer,
144
- attributes: {
145
- a_position: {
146
- name: 'a_position',
147
- size: 2, // 2 components per iteration
148
- type: glw.FLOAT, // the data is 32bit floats
149
- normalized: false, // don't normalize the data
150
- stride, // 0 = move forward size * sizeof(type) each iteration to get the next position
151
- offset: 0, // start at the beginning of the buffer
152
- },
153
- a_textureCoords: {
154
- name: 'a_textureCoords',
155
- size: 2,
156
- type: glw.FLOAT,
157
- normalized: false,
158
- stride,
159
- offset: 2 * Float32Array.BYTES_PER_ELEMENT,
160
- },
161
- a_color: {
162
- name: 'a_color',
163
- size: 4,
164
- type: glw.UNSIGNED_BYTE,
165
- normalized: true,
166
- stride,
167
- offset: 4 * Float32Array.BYTES_PER_ELEMENT,
168
- },
169
- a_textureIndex: {
170
- name: 'a_textureIndex',
171
- size: 1,
172
- type: glw.FLOAT,
173
- normalized: false,
174
- stride,
175
- offset: 5 * Float32Array.BYTES_PER_ELEMENT,
176
- },
177
- a_nodeCoords: {
178
- name: 'a_nodeCoords',
179
- size: 2,
180
- type: glw.FLOAT,
181
- normalized: false,
182
- stride,
183
- offset: 6 * Float32Array.BYTES_PER_ELEMENT,
184
- },
185
- },
186
- },
187
- ]);
188
- }
189
-
190
- reset() {
191
- const { glw } = this;
192
- this.curBufferIdx = 0;
193
- this.curRenderOp = null;
194
- this.renderOps.length = 0;
195
- glw.setScissorTest(false);
196
- glw.clear();
197
- }
198
-
199
- createShaderProgram(
200
- shaderType: WebGlShaderType,
201
- props: Record<string, unknown>,
202
- ): WebGlShaderProgram {
203
- return new WebGlShaderProgram(this, shaderType, props);
204
- }
205
-
206
- createShaderNode(
207
- shaderKey: string,
208
- shaderType: WebGlShaderType,
209
- props?: Record<string, unknown>,
210
- program?: WebGlShaderProgram,
211
- ) {
212
- return new WebGlShaderNode(
213
- shaderKey,
214
- shaderType,
215
- program!,
216
- this.stage,
217
- props,
218
- );
219
- }
220
-
221
- override supportsShaderType(shaderType: Readonly<WebGlShaderType>): boolean {
222
- //if shadertype doesnt have a fragment source we cant use it
223
- return shaderType.fragment !== undefined;
224
- }
225
-
226
- createCtxTexture(textureSource: Texture): CoreContextTexture {
227
- if (textureSource instanceof SubTexture) {
228
- return new WebGlCtxSubTexture(
229
- this.glw,
230
- this.stage.txMemManager,
231
- textureSource,
232
- );
233
- } else if (textureSource instanceof RenderTexture) {
234
- return new WebGlCtxRenderTexture(
235
- this.glw,
236
- this.stage.txMemManager,
237
- textureSource,
238
- );
239
- }
240
- return new WebGlCtxTexture(
241
- this.glw,
242
- this.stage.txMemManager,
243
- textureSource,
244
- );
245
- }
246
-
247
- /**
248
- * This function adds a quad (a rectangle composed of two triangles) to the WebGL rendering pipeline.
249
- *
250
- * It takes a set of options that define the quad's properties, such as its dimensions, colors, texture, shader, and transformation matrix.
251
- * The function first updates the shader properties with the current dimensions if necessary, then sets the default texture if none is provided.
252
- * It then checks if a new render operation is needed, based on the current shader and clipping rectangle.
253
- * If a new render operation is needed, it creates one and updates the current render operation.
254
- * The function then adjusts the texture coordinates based on the texture options and adds the texture to the texture manager.
255
- *
256
- * Finally, it calculates the vertices for the quad, taking into account any transformations, and adds them to the quad buffer.
257
- * The function updates the length and number of quads in the current render operation, and updates the current buffer index.
258
- */
259
- addQuad(params: QuadOptions) {
260
- const { fQuadBuffer, uiQuadBuffer } = this;
261
- let texture = params.texture;
262
-
263
- assertTruthy(texture !== null, 'Texture is required');
264
-
265
- let { curBufferIdx: bufferIdx } = this;
266
-
267
- if (this.reuseRenderOp(params) === false) {
268
- this.newRenderOp(params, bufferIdx);
269
- }
270
-
271
- if (texture.type === TextureType.subTexture) {
272
- texture = (texture as SubTexture).parentTexture;
273
- }
274
-
275
- assertTruthy(texture.ctxTexture instanceof WebGlCtxTexture);
276
- const textureIdx = this.addTexture(texture.ctxTexture, bufferIdx);
277
-
278
- assertTruthy(this.curRenderOp !== null);
279
- assertTruthy(params.renderCoords);
280
- assertTruthy(params.textureCoords);
281
-
282
- // Upper-Left
283
- fQuadBuffer[bufferIdx++] = params.renderCoords.x1; // vertexX
284
- fQuadBuffer[bufferIdx++] = params.renderCoords.y1; // vertexY
285
- fQuadBuffer[bufferIdx++] = params.textureCoords.x1; // texCoordX
286
- fQuadBuffer[bufferIdx++] = params.textureCoords.y1; // texCoordY
287
- uiQuadBuffer[bufferIdx++] = params.colorTl; // color
288
- fQuadBuffer[bufferIdx++] = textureIdx; // texIndex
289
- fQuadBuffer[bufferIdx++] = 0; //node X coord
290
- fQuadBuffer[bufferIdx++] = 0; //node y coord
291
-
292
- // Upper-Right
293
- fQuadBuffer[bufferIdx++] = params.renderCoords.x2;
294
- fQuadBuffer[bufferIdx++] = params.renderCoords.y2;
295
- fQuadBuffer[bufferIdx++] = params.textureCoords.x2;
296
- fQuadBuffer[bufferIdx++] = params.textureCoords.y1;
297
- uiQuadBuffer[bufferIdx++] = params.colorTr;
298
- fQuadBuffer[bufferIdx++] = textureIdx;
299
- fQuadBuffer[bufferIdx++] = 1; //node X coord
300
- fQuadBuffer[bufferIdx++] = 0; //node y coord
301
-
302
- // Lower-Left
303
- fQuadBuffer[bufferIdx++] = params.renderCoords.x4;
304
- fQuadBuffer[bufferIdx++] = params.renderCoords.y4;
305
- fQuadBuffer[bufferIdx++] = params.textureCoords.x1;
306
- fQuadBuffer[bufferIdx++] = params.textureCoords.y2;
307
- uiQuadBuffer[bufferIdx++] = params.colorBl;
308
- fQuadBuffer[bufferIdx++] = textureIdx;
309
- fQuadBuffer[bufferIdx++] = 0; //node X coord
310
- fQuadBuffer[bufferIdx++] = 1; //node y coord
311
-
312
- // Lower-Right
313
- fQuadBuffer[bufferIdx++] = params.renderCoords.x3;
314
- fQuadBuffer[bufferIdx++] = params.renderCoords.y3;
315
- fQuadBuffer[bufferIdx++] = params.textureCoords.x2;
316
- fQuadBuffer[bufferIdx++] = params.textureCoords.y2;
317
- uiQuadBuffer[bufferIdx++] = params.colorBr;
318
- fQuadBuffer[bufferIdx++] = textureIdx;
319
- fQuadBuffer[bufferIdx++] = 1; //node X coord
320
- fQuadBuffer[bufferIdx++] = 1; //node y coord
321
-
322
- // Update the length of the current render op
323
- this.curRenderOp.numQuads++;
324
- this.curBufferIdx = bufferIdx;
325
- }
326
-
327
- /**
328
- * Replace the existing RenderOp with a new one that uses the specified Shader
329
- * and starts at the specified buffer index.
330
- *
331
- * @param shader
332
- * @param bufferIdx
333
- */
334
- private newRenderOp(quad: QuadOptions | WebGlRenderOp, bufferIdx: number) {
335
- const curRenderOp = new WebGlRenderOp(this, quad, bufferIdx);
336
- this.curRenderOp = curRenderOp;
337
- this.renderOps.push(curRenderOp);
338
- }
339
-
340
- /**
341
- * Add a texture to the current RenderOp. If the texture cannot be added to the
342
- * current RenderOp, a new RenderOp will be created and the texture will be added
343
- * to that one.
344
- *
345
- * If the texture cannot be added to the new RenderOp, an error will be thrown.
346
- *
347
- * @param texture
348
- * @param bufferIdx
349
- * @param recursive
350
- * @returns Assigned Texture Index of the texture in the render op
351
- */
352
- private addTexture(
353
- texture: WebGlCtxTexture,
354
- bufferIdx: number,
355
- recursive?: boolean,
356
- ): number {
357
- assertTruthy(this.curRenderOp);
358
- const textureIdx = this.curRenderOp.addTexture(texture);
359
- // TODO: Refactor to be more DRY
360
- if (textureIdx === 0xffffffff) {
361
- if (recursive) {
362
- throw new Error('Unable to add texture to render op');
363
- }
364
- this.newRenderOp(this.curRenderOp, bufferIdx);
365
- return this.addTexture(texture, bufferIdx, true);
366
- }
367
- return textureIdx;
368
- }
369
-
370
- /**
371
- * Test if the current Render operation can be reused for the specified parameters.
372
- * @param params
373
- * @returns
374
- */
375
- reuseRenderOp(params: QuadOptions): boolean {
376
- // Switching shader program will require a new render operation
377
- if (
378
- this.curRenderOp?.shader.shaderKey !==
379
- (params.shader as WebGlShaderNode).shaderKey
380
- ) {
381
- return false;
382
- }
383
-
384
- // Switching clipping rect will require a new render operation
385
- if (
386
- compareRect(this.curRenderOp.clippingRect, params.clippingRect) === false
387
- ) {
388
- return false;
389
- }
390
-
391
- // Force new render operation if rendering to texture
392
- // @todo: This needs to be improved, render operations could also be reused
393
- // for rendering to texture
394
- if (
395
- params.parentHasRenderTexture !== undefined ||
396
- params.rtt !== undefined
397
- ) {
398
- return false;
399
- }
400
-
401
- if (
402
- this.curRenderOp.shader.shaderKey === 'default' &&
403
- params.shader?.shaderKey === 'default'
404
- ) {
405
- return true;
406
- }
407
-
408
- // Check if the shader can batch the shader properties
409
- if (
410
- this.curRenderOp.shader.program.reuseRenderOp(
411
- params,
412
- this.curRenderOp,
413
- ) === false
414
- ) {
415
- return false;
416
- }
417
-
418
- // Render operation can be reused
419
- return true;
420
- }
421
-
422
- /**
423
- * add RenderOp to the render pipeline
424
- */
425
- addRenderOp(renderable: WebGlRenderOp) {
426
- this.renderOps.push(renderable);
427
- this.curRenderOp = null;
428
- }
429
-
430
- /**
431
- * Render the current set of RenderOps to render to the specified surface.
432
- *
433
- * TODO: 'screen' is the only supported surface at the moment.
434
- *
435
- * @param surface
436
- */
437
- render(surface: 'screen' | CoreContextTexture = 'screen'): void {
438
- const { glw, quadBuffer } = this;
439
-
440
- const arr = new Float32Array(quadBuffer, 0, this.curBufferIdx);
441
-
442
- const buffer = this.quadBufferCollection.getBuffer('a_position') || null;
443
- glw.arrayBufferData(buffer, arr, glw.STATIC_DRAW);
444
-
445
- for (let i = 0, length = this.renderOps.length; i < length; i++) {
446
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
447
- this.renderOps[i]!.draw();
448
- }
449
- this.quadBufferUsage = this.curBufferIdx * arr.BYTES_PER_ELEMENT;
450
-
451
- // Calculate the size of each quad in bytes (4 vertices per quad) times the size of each vertex in bytes
452
- const QUAD_SIZE_IN_BYTES = 4 * (8 * arr.BYTES_PER_ELEMENT); // 8 attributes per vertex
453
- this.numQuadsRendered = this.quadBufferUsage / QUAD_SIZE_IN_BYTES;
454
- }
455
-
456
- getQuadCount(): number {
457
- return this.numQuadsRendered;
458
- }
459
-
460
- renderToTexture(node: CoreNode) {
461
- for (let i = 0; i < this.rttNodes.length; i++) {
462
- if (this.rttNodes[i] === node) {
463
- return;
464
- }
465
- }
466
-
467
- this.insertRTTNodeInOrder(node);
468
- }
469
-
470
- /**
471
- * Inserts an RTT node into `this.rttNodes` while maintaining the correct rendering order based on hierarchy.
472
- *
473
- * Rendering order for RTT nodes is critical when nested RTT nodes exist in a parent-child relationship.
474
- * Specifically:
475
- * - Child RTT nodes must be rendered before their RTT-enabled parents to ensure proper texture composition.
476
- * - If an RTT node is added and it has existing RTT children, it should be rendered after those children.
477
- *
478
- * This function addresses both cases by:
479
- * 1. **Checking Upwards**: It traverses the node's hierarchy upwards to identify any RTT parent
480
- * already in `rttNodes`. If an RTT parent is found, the new node is placed before this parent.
481
- * 2. **Checking Downwards**: It traverses the node’s children recursively to find any RTT-enabled
482
- * children that are already in `rttNodes`. If such children are found, the new node is inserted
483
- * after the last (highest index) RTT child node.
484
- *
485
- * The final calculated insertion index ensures the new node is positioned in `rttNodes` to respect
486
- * both parent-before-child and child-before-parent rendering rules, preserving the correct order
487
- * for the WebGL renderer.
488
- *
489
- * @param node - The RTT-enabled CoreNode to be added to `rttNodes` in the appropriate hierarchical position.
490
- */
491
- private insertRTTNodeInOrder(node: CoreNode) {
492
- let insertIndex = this.rttNodes.length; // Default to the end of the array
493
-
494
- // 1. Traverse upwards to ensure the node is placed before its RTT parent (if any).
495
- let currentNode: CoreNode = node;
496
- while (currentNode) {
497
- if (!currentNode.parent) {
498
- break;
499
- }
500
-
501
- const parentIndex = this.rttNodes.indexOf(currentNode.parent);
502
- if (parentIndex !== -1) {
503
- // Found an RTT parent in the list; set insertIndex to place node before the parent
504
- insertIndex = parentIndex;
505
- break;
506
- }
507
-
508
- currentNode = currentNode.parent;
509
- }
510
-
511
- // 2. Traverse downwards to ensure the node is placed after any RTT children.
512
- // Look through each child recursively to see if any are already in rttNodes.
513
- const maxChildIndex = this.findMaxChildRTTIndex(node);
514
- if (maxChildIndex !== -1) {
515
- // Adjust insertIndex to be after the last child RTT node
516
- insertIndex = Math.max(insertIndex, maxChildIndex + 1);
517
- }
518
-
519
- // 3. Insert the node at the calculated position
520
- this.rttNodes.splice(insertIndex, 0, node);
521
- }
522
-
523
- // Helper function to find the highest index of any RTT children of a node within rttNodes
524
- private findMaxChildRTTIndex(node: CoreNode): number {
525
- let maxIndex = -1;
526
-
527
- const traverseChildren = (currentNode: CoreNode) => {
528
- const currentIndex = this.rttNodes.indexOf(currentNode);
529
- if (currentIndex !== -1) {
530
- maxIndex = Math.max(maxIndex, currentIndex);
531
- }
532
-
533
- // Recursively check all children of the current node
534
- for (const child of currentNode.children) {
535
- traverseChildren(child);
536
- }
537
- };
538
-
539
- // Start traversal directly with the provided node
540
- traverseChildren(node);
541
-
542
- return maxIndex;
543
- }
544
-
545
- renderRTTNodes() {
546
- const { glw } = this;
547
- // Render all associated RTT nodes to their textures
548
- for (let i = 0; i < this.rttNodes.length; i++) {
549
- const node = this.rttNodes[i];
550
-
551
- // Skip nodes that don't have RTT updates
552
- if (node === undefined || node.hasRTTupdates === false) {
553
- continue;
554
- }
555
-
556
- // Skip nodes that are not visible
557
- if (
558
- node.worldAlpha === 0 ||
559
- (node.strictBounds === true &&
560
- node.renderState === CoreNodeRenderState.OutOfBounds)
561
- ) {
562
- continue;
563
- }
564
-
565
- // Skip nodes that do not have a loaded texture
566
- if (node.texture === null || node.texture.state !== 'loaded') {
567
- continue;
568
- }
569
-
570
- // Set the active RTT node to the current node
571
- // So we can prevent rendering children of nested RTT nodes
572
- this.activeRttNode = node;
573
-
574
- assertTruthy(node.texture !== null, 'RTT node missing texture');
575
- const ctxTexture = node.texture.ctxTexture;
576
- assertTruthy(ctxTexture instanceof WebGlCtxRenderTexture);
577
- this.renderToTextureActive = true;
578
-
579
- // Bind the the texture's framebuffer
580
- glw.bindFramebuffer(ctxTexture.framebuffer);
581
-
582
- glw.viewport(0, 0, ctxTexture.w, ctxTexture.h);
583
- // Set the clear color to transparent
584
- glw.clearColor(0, 0, 0, 0);
585
- glw.clear();
586
-
587
- // Render all associated quads to the texture
588
- for (let i = 0; i < node.children.length; i++) {
589
- const child = node.children[i];
590
-
591
- if (child === undefined) {
592
- continue;
593
- }
594
-
595
- this.stage.addQuads(child);
596
- child.hasRTTupdates = false;
597
- }
598
-
599
- // Render all associated quads to the texture
600
- this.render();
601
-
602
- // Reset render operations
603
- this.renderOps.length = 0;
604
- node.hasRTTupdates = false;
605
- }
606
-
607
- const clearColor = this.clearColor.normalized;
608
- // Restore the default clear color
609
- glw.clearColor(clearColor[0], clearColor[1], clearColor[2], clearColor[3]);
610
-
611
- // Bind the default framebuffer
612
- glw.bindFramebuffer(null);
613
-
614
- glw.viewport(0, 0, this.glw.canvas.width, this.glw.canvas.height);
615
- this.renderToTextureActive = false;
616
- }
617
-
618
- removeRTTNode(node: CoreNode) {
619
- const index = this.rttNodes.indexOf(node);
620
- if (index === -1) {
621
- return;
622
- }
623
- this.rttNodes.splice(index, 1);
624
- }
625
-
626
- getBufferInfo(): BufferInfo | null {
627
- const bufferInfo: BufferInfo = {
628
- totalAvailable: this.stage.options.quadBufferSize,
629
- totalUsed: this.quadBufferUsage,
630
- };
631
- return bufferInfo;
632
- }
633
-
634
- getDefaultShaderNode(): WebGlShaderNode {
635
- if (this.defaultShaderNode !== null) {
636
- return this.defaultShaderNode as WebGlShaderNode;
637
- }
638
- this.stage.shManager.registerShaderType('default', Default);
639
- this.defaultShaderNode = this.stage.shManager.createShader(
640
- 'default',
641
- ) as WebGlShaderNode;
642
- return this.defaultShaderNode;
643
- }
644
-
645
- override getTextureCoords(node: CoreNode): TextureCoords {
646
- const texture = node.texture;
647
- if (texture === null) {
648
- return this.defaultTextureCoords;
649
- }
650
-
651
- const textureOptions = node.textureOptions;
652
- if (
653
- texture.type === TextureType.subTexture ||
654
- texture.type === TextureType.image ||
655
- texture.type === TextureType.renderToTexture ||
656
- textureOptions !== null
657
- ) {
658
- const result = {
659
- x1: 0,
660
- y1: 0,
661
- x2: 1,
662
- y2: 1,
663
- };
664
-
665
- if (texture.type === TextureType.subTexture) {
666
- const props = (texture as SubTexture).props;
667
- const { width: parentW = 0, height: parentH = 0 } = (
668
- texture as SubTexture
669
- ).parentTexture.dimensions || { width: 0, height: 0 };
670
- result.x1 = props.x / parentW;
671
- result.x2 = result.x1 + props.width / parentW;
672
- result.y1 = props.y / parentH;
673
- result.y2 = result.y1 + props.height / parentH;
674
- }
675
-
676
- if (
677
- texture.type === TextureType.image &&
678
- textureOptions !== null &&
679
- textureOptions.resizeMode !== undefined &&
680
- texture.dimensions !== null
681
- ) {
682
- const resizeMode = textureOptions.resizeMode;
683
- const dimensions = texture.dimensions;
684
- if (resizeMode.type === 'cover') {
685
- const scaleX = node.props.width / dimensions.width;
686
- const scaleY = node.props.height / dimensions.height;
687
- const scale = Math.max(scaleX, scaleY);
688
- const precision = 1 / scale;
689
- // Determine based on width
690
- if (scaleX < scale) {
691
- const desiredSize = precision * node.props.width;
692
- result.x1 =
693
- (1 - desiredSize / dimensions.width) * (resizeMode.clipX ?? 0.5);
694
- result.x2 = result.x1 + desiredSize / dimensions.width;
695
- }
696
- // Determine based on height
697
- if (scaleY < scale) {
698
- const desiredSize = precision * node.props.height;
699
- result.y1 =
700
- (1 - desiredSize / dimensions.height) * (resizeMode.clipY ?? 0.5);
701
- result.y2 = result.y1 + desiredSize / dimensions.height;
702
- }
703
- }
704
- }
705
-
706
- // Flip texture coordinates if dictated by texture options
707
- let flipY = 0;
708
- if (textureOptions !== null) {
709
- if (textureOptions.flipX === true) {
710
- [result.x1, result.x2] = [result.x2, result.x1];
711
- }
712
-
713
- // convert to integer for bitwise operation below
714
- flipY = +(textureOptions.flipY || false);
715
- }
716
-
717
- // Eitherone should be true
718
- if (flipY ^ +(texture.type === TextureType.renderToTexture)) {
719
- [result.y1, result.y2] = [result.y2, result.y1];
720
- }
721
- return result as TextureCoords;
722
- }
723
-
724
- return this.defaultTextureCoords;
725
- }
726
-
727
- /**
728
- * Updates the WebGL context's clear color and clears the color buffer.
729
- *
730
- * @param color - The color to set as the clear color, represented as a 32-bit integer.
731
- */
732
- updateClearColor(color: number) {
733
- if (this.clearColor.raw === color) {
734
- return;
735
- }
736
- const glw = this.glw;
737
- const normalizedColor = getNormalizedRgbaComponents(color);
738
- glw.clearColor(
739
- normalizedColor[0],
740
- normalizedColor[1],
741
- normalizedColor[2],
742
- normalizedColor[3],
743
- );
744
- this.clearColor = {
745
- raw: color,
746
- normalized: normalizedColor,
747
- };
748
- glw.clear();
749
- }
750
- }
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
+ import { assertTruthy, createWebGLContext } from '../../../utils.js';
21
+ import {
22
+ CoreRenderer,
23
+ type BufferInfo,
24
+ type CoreRendererOptions,
25
+ type QuadOptions,
26
+ } from '../CoreRenderer.js';
27
+ import { WebGlRenderOp } from './WebGlRenderOp.js';
28
+ import type { CoreContextTexture } from '../CoreContextTexture.js';
29
+ import {
30
+ createIndexBuffer,
31
+ type CoreWebGlParameters,
32
+ type CoreWebGlExtensions,
33
+ getWebGlParameters,
34
+ getWebGlExtensions,
35
+ type WebGlColor,
36
+ } from './internal/RendererUtils.js';
37
+ import { WebGlCtxTexture } from './WebGlCtxTexture.js';
38
+ import {
39
+ Texture,
40
+ TextureType,
41
+ type TextureCoords,
42
+ } from '../../textures/Texture.js';
43
+ import { SubTexture } from '../../textures/SubTexture.js';
44
+ import { WebGlCtxSubTexture } from './WebGlCtxSubTexture.js';
45
+ import { BufferCollection } from './internal/BufferCollection.js';
46
+ import { compareRect, getNormalizedRgbaComponents } from '../../lib/utils.js';
47
+ import { WebGlShaderProgram } from './WebGlShaderProgram.js';
48
+ import { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
49
+ import { RenderTexture } from '../../textures/RenderTexture.js';
50
+ import { CoreNodeRenderState, type CoreNode } from '../../CoreNode.js';
51
+ import { WebGlCtxRenderTexture } from './WebGlCtxRenderTexture.js';
52
+ import { Default } from '../../shaders/webgl/Default.js';
53
+ import type { WebGlShaderType } from './WebGlShaderNode.js';
54
+ import { WebGlShaderNode } from './WebGlShaderNode.js';
55
+
56
+ const WORDS_PER_QUAD = 32;
57
+ // const BYTES_PER_QUAD = WORDS_PER_QUAD * 4;
58
+
59
+ export type WebGlRendererOptions = CoreRendererOptions;
60
+
61
+ interface CoreWebGlSystem {
62
+ parameters: CoreWebGlParameters;
63
+ extensions: CoreWebGlExtensions;
64
+ }
65
+
66
+ export class WebGlRenderer extends CoreRenderer {
67
+ //// WebGL Native Context and Data
68
+ glw: WebGlContextWrapper;
69
+ system: CoreWebGlSystem;
70
+
71
+ //// Persistent data
72
+ quadBuffer: ArrayBuffer;
73
+ fQuadBuffer: Float32Array;
74
+ uiQuadBuffer: Uint32Array;
75
+ renderOps: WebGlRenderOp[] = [];
76
+
77
+ //// Render Op / Buffer Filling State
78
+ curBufferIdx = 0;
79
+ curRenderOp: WebGlRenderOp | null = null;
80
+ override rttNodes: CoreNode[] = [];
81
+ activeRttNode: CoreNode | null = null;
82
+
83
+ defaultTextureCoords: TextureCoords = {
84
+ x1: 0,
85
+ y1: 0,
86
+ x2: 1,
87
+ y2: 1,
88
+ };
89
+
90
+ //// Default Shader
91
+ defaultShaderNode: WebGlShaderNode | null = null;
92
+ quadBufferCollection: BufferCollection;
93
+
94
+ clearColor: WebGlColor = {
95
+ raw: 0x00000000,
96
+ normalized: [0, 0, 0, 0],
97
+ };
98
+
99
+ /**
100
+ * White pixel texture used by default when no texture is specified.
101
+ */
102
+
103
+ quadBufferUsage = 0;
104
+ numQuadsRendered = 0;
105
+ /**
106
+ * Whether the renderer is currently rendering to a texture.
107
+ */
108
+ public renderToTextureActive = false;
109
+
110
+ constructor(options: WebGlRendererOptions) {
111
+ super(options);
112
+
113
+ this.quadBuffer = new ArrayBuffer(this.stage.options.quadBufferSize);
114
+ this.fQuadBuffer = new Float32Array(this.quadBuffer);
115
+ this.uiQuadBuffer = new Uint32Array(this.quadBuffer);
116
+
117
+ this.mode = 'webgl';
118
+
119
+ const gl = createWebGLContext(
120
+ options.canvas,
121
+ options.forceWebGL2,
122
+ options.contextSpy,
123
+ );
124
+ const glw = (this.glw = new WebGlContextWrapper(gl));
125
+ glw.viewport(0, 0, options.canvas.width, options.canvas.height);
126
+
127
+ this.updateClearColor(this.stage.clearColor);
128
+
129
+ glw.setBlend(true);
130
+ glw.blendFunc(glw.ONE, glw.ONE_MINUS_SRC_ALPHA);
131
+
132
+ createIndexBuffer(glw, this.stage.bufferMemory);
133
+
134
+ this.system = {
135
+ parameters: getWebGlParameters(this.glw),
136
+ extensions: getWebGlExtensions(this.glw),
137
+ };
138
+ const quadBuffer = glw.createBuffer();
139
+ assertTruthy(quadBuffer);
140
+ const stride = 8 * Float32Array.BYTES_PER_ELEMENT;
141
+ this.quadBufferCollection = new BufferCollection([
142
+ {
143
+ buffer: quadBuffer,
144
+ attributes: {
145
+ a_position: {
146
+ name: 'a_position',
147
+ size: 2, // 2 components per iteration
148
+ type: glw.FLOAT, // the data is 32bit floats
149
+ normalized: false, // don't normalize the data
150
+ stride, // 0 = move forward size * sizeof(type) each iteration to get the next position
151
+ offset: 0, // start at the beginning of the buffer
152
+ },
153
+ a_textureCoords: {
154
+ name: 'a_textureCoords',
155
+ size: 2,
156
+ type: glw.FLOAT,
157
+ normalized: false,
158
+ stride,
159
+ offset: 2 * Float32Array.BYTES_PER_ELEMENT,
160
+ },
161
+ a_color: {
162
+ name: 'a_color',
163
+ size: 4,
164
+ type: glw.UNSIGNED_BYTE,
165
+ normalized: true,
166
+ stride,
167
+ offset: 4 * Float32Array.BYTES_PER_ELEMENT,
168
+ },
169
+ a_textureIndex: {
170
+ name: 'a_textureIndex',
171
+ size: 1,
172
+ type: glw.FLOAT,
173
+ normalized: false,
174
+ stride,
175
+ offset: 5 * Float32Array.BYTES_PER_ELEMENT,
176
+ },
177
+ a_nodeCoords: {
178
+ name: 'a_nodeCoords',
179
+ size: 2,
180
+ type: glw.FLOAT,
181
+ normalized: false,
182
+ stride,
183
+ offset: 6 * Float32Array.BYTES_PER_ELEMENT,
184
+ },
185
+ },
186
+ },
187
+ ]);
188
+ }
189
+
190
+ reset() {
191
+ const { glw } = this;
192
+ this.curBufferIdx = 0;
193
+ this.curRenderOp = null;
194
+ this.renderOps.length = 0;
195
+ glw.setScissorTest(false);
196
+ glw.clear();
197
+ }
198
+
199
+ createShaderProgram(
200
+ shaderType: WebGlShaderType,
201
+ props: Record<string, unknown>,
202
+ ): WebGlShaderProgram {
203
+ return new WebGlShaderProgram(this, shaderType, props);
204
+ }
205
+
206
+ createShaderNode(
207
+ shaderKey: string,
208
+ shaderType: WebGlShaderType,
209
+ props?: Record<string, unknown>,
210
+ program?: WebGlShaderProgram,
211
+ ) {
212
+ return new WebGlShaderNode(
213
+ shaderKey,
214
+ shaderType,
215
+ program!,
216
+ this.stage,
217
+ props,
218
+ );
219
+ }
220
+
221
+ override supportsShaderType(shaderType: Readonly<WebGlShaderType>): boolean {
222
+ //if shadertype doesnt have a fragment source we cant use it
223
+ return shaderType.fragment !== undefined;
224
+ }
225
+
226
+ createCtxTexture(textureSource: Texture): CoreContextTexture {
227
+ if (textureSource instanceof SubTexture) {
228
+ return new WebGlCtxSubTexture(
229
+ this.glw,
230
+ this.stage.txMemManager,
231
+ textureSource,
232
+ );
233
+ } else if (textureSource instanceof RenderTexture) {
234
+ return new WebGlCtxRenderTexture(
235
+ this.glw,
236
+ this.stage.txMemManager,
237
+ textureSource,
238
+ );
239
+ }
240
+ return new WebGlCtxTexture(
241
+ this.glw,
242
+ this.stage.txMemManager,
243
+ textureSource,
244
+ );
245
+ }
246
+
247
+ /**
248
+ * This function adds a quad (a rectangle composed of two triangles) to the WebGL rendering pipeline.
249
+ *
250
+ * It takes a set of options that define the quad's properties, such as its dimensions, colors, texture, shader, and transformation matrix.
251
+ * The function first updates the shader properties with the current dimensions if necessary, then sets the default texture if none is provided.
252
+ * It then checks if a new render operation is needed, based on the current shader and clipping rectangle.
253
+ * If a new render operation is needed, it creates one and updates the current render operation.
254
+ * The function then adjusts the texture coordinates based on the texture options and adds the texture to the texture manager.
255
+ *
256
+ * Finally, it calculates the vertices for the quad, taking into account any transformations, and adds them to the quad buffer.
257
+ * The function updates the length and number of quads in the current render operation, and updates the current buffer index.
258
+ */
259
+ addQuad(params: QuadOptions) {
260
+ const { fQuadBuffer, uiQuadBuffer } = this;
261
+ let texture = params.texture;
262
+
263
+ assertTruthy(texture !== null, 'Texture is required');
264
+
265
+ let { curBufferIdx: bufferIdx } = this;
266
+
267
+ if (this.reuseRenderOp(params) === false) {
268
+ this.newRenderOp(params, bufferIdx);
269
+ }
270
+
271
+ if (texture.type === TextureType.subTexture) {
272
+ texture = (texture as SubTexture).parentTexture;
273
+ }
274
+
275
+ assertTruthy(texture.ctxTexture instanceof WebGlCtxTexture);
276
+ const textureIdx = this.addTexture(texture.ctxTexture, bufferIdx);
277
+
278
+ assertTruthy(this.curRenderOp !== null);
279
+ assertTruthy(params.renderCoords);
280
+ assertTruthy(params.textureCoords);
281
+
282
+ // Upper-Left
283
+ fQuadBuffer[bufferIdx++] = params.renderCoords.x1; // vertexX
284
+ fQuadBuffer[bufferIdx++] = params.renderCoords.y1; // vertexY
285
+ fQuadBuffer[bufferIdx++] = params.textureCoords.x1; // texCoordX
286
+ fQuadBuffer[bufferIdx++] = params.textureCoords.y1; // texCoordY
287
+ uiQuadBuffer[bufferIdx++] = params.colorTl; // color
288
+ fQuadBuffer[bufferIdx++] = textureIdx; // texIndex
289
+ fQuadBuffer[bufferIdx++] = 0; //node X coord
290
+ fQuadBuffer[bufferIdx++] = 0; //node y coord
291
+
292
+ // Upper-Right
293
+ fQuadBuffer[bufferIdx++] = params.renderCoords.x2;
294
+ fQuadBuffer[bufferIdx++] = params.renderCoords.y2;
295
+ fQuadBuffer[bufferIdx++] = params.textureCoords.x2;
296
+ fQuadBuffer[bufferIdx++] = params.textureCoords.y1;
297
+ uiQuadBuffer[bufferIdx++] = params.colorTr;
298
+ fQuadBuffer[bufferIdx++] = textureIdx;
299
+ fQuadBuffer[bufferIdx++] = 1; //node X coord
300
+ fQuadBuffer[bufferIdx++] = 0; //node y coord
301
+
302
+ // Lower-Left
303
+ fQuadBuffer[bufferIdx++] = params.renderCoords.x4;
304
+ fQuadBuffer[bufferIdx++] = params.renderCoords.y4;
305
+ fQuadBuffer[bufferIdx++] = params.textureCoords.x1;
306
+ fQuadBuffer[bufferIdx++] = params.textureCoords.y2;
307
+ uiQuadBuffer[bufferIdx++] = params.colorBl;
308
+ fQuadBuffer[bufferIdx++] = textureIdx;
309
+ fQuadBuffer[bufferIdx++] = 0; //node X coord
310
+ fQuadBuffer[bufferIdx++] = 1; //node y coord
311
+
312
+ // Lower-Right
313
+ fQuadBuffer[bufferIdx++] = params.renderCoords.x3;
314
+ fQuadBuffer[bufferIdx++] = params.renderCoords.y3;
315
+ fQuadBuffer[bufferIdx++] = params.textureCoords.x2;
316
+ fQuadBuffer[bufferIdx++] = params.textureCoords.y2;
317
+ uiQuadBuffer[bufferIdx++] = params.colorBr;
318
+ fQuadBuffer[bufferIdx++] = textureIdx;
319
+ fQuadBuffer[bufferIdx++] = 1; //node X coord
320
+ fQuadBuffer[bufferIdx++] = 1; //node y coord
321
+
322
+ // Update the length of the current render op
323
+ this.curRenderOp.numQuads++;
324
+ this.curBufferIdx = bufferIdx;
325
+ }
326
+
327
+ /**
328
+ * Replace the existing RenderOp with a new one that uses the specified Shader
329
+ * and starts at the specified buffer index.
330
+ *
331
+ * @param shader
332
+ * @param bufferIdx
333
+ */
334
+ private newRenderOp(quad: QuadOptions | WebGlRenderOp, bufferIdx: number) {
335
+ const curRenderOp = new WebGlRenderOp(this, quad, bufferIdx);
336
+ this.curRenderOp = curRenderOp;
337
+ this.renderOps.push(curRenderOp);
338
+ }
339
+
340
+ /**
341
+ * Add a texture to the current RenderOp. If the texture cannot be added to the
342
+ * current RenderOp, a new RenderOp will be created and the texture will be added
343
+ * to that one.
344
+ *
345
+ * If the texture cannot be added to the new RenderOp, an error will be thrown.
346
+ *
347
+ * @param texture
348
+ * @param bufferIdx
349
+ * @param recursive
350
+ * @returns Assigned Texture Index of the texture in the render op
351
+ */
352
+ private addTexture(
353
+ texture: WebGlCtxTexture,
354
+ bufferIdx: number,
355
+ recursive?: boolean,
356
+ ): number {
357
+ assertTruthy(this.curRenderOp);
358
+ const textureIdx = this.curRenderOp.addTexture(texture);
359
+ // TODO: Refactor to be more DRY
360
+ if (textureIdx === 0xffffffff) {
361
+ if (recursive) {
362
+ throw new Error('Unable to add texture to render op');
363
+ }
364
+ this.newRenderOp(this.curRenderOp, bufferIdx);
365
+ return this.addTexture(texture, bufferIdx, true);
366
+ }
367
+ return textureIdx;
368
+ }
369
+
370
+ /**
371
+ * Test if the current Render operation can be reused for the specified parameters.
372
+ * @param params
373
+ * @returns
374
+ */
375
+ reuseRenderOp(params: QuadOptions): boolean {
376
+ // Switching shader program will require a new render operation
377
+ if (
378
+ this.curRenderOp?.shader.shaderKey !==
379
+ (params.shader as WebGlShaderNode).shaderKey
380
+ ) {
381
+ return false;
382
+ }
383
+
384
+ // Switching clipping rect will require a new render operation
385
+ if (
386
+ compareRect(this.curRenderOp.clippingRect, params.clippingRect) === false
387
+ ) {
388
+ return false;
389
+ }
390
+
391
+ // Force new render operation if rendering to texture
392
+ // @todo: This needs to be improved, render operations could also be reused
393
+ // for rendering to texture
394
+ if (
395
+ params.parentHasRenderTexture !== undefined ||
396
+ params.rtt !== undefined
397
+ ) {
398
+ return false;
399
+ }
400
+
401
+ if (
402
+ this.curRenderOp.shader.shaderKey === 'default' &&
403
+ params.shader?.shaderKey === 'default'
404
+ ) {
405
+ return true;
406
+ }
407
+
408
+ // Check if the shader can batch the shader properties
409
+ if (
410
+ this.curRenderOp.shader.program.reuseRenderOp(
411
+ params,
412
+ this.curRenderOp,
413
+ ) === false
414
+ ) {
415
+ return false;
416
+ }
417
+
418
+ // Render operation can be reused
419
+ return true;
420
+ }
421
+
422
+ /**
423
+ * add RenderOp to the render pipeline
424
+ */
425
+ addRenderOp(renderable: WebGlRenderOp) {
426
+ this.renderOps.push(renderable);
427
+ this.curRenderOp = null;
428
+ }
429
+
430
+ /**
431
+ * Render the current set of RenderOps to render to the specified surface.
432
+ *
433
+ * TODO: 'screen' is the only supported surface at the moment.
434
+ *
435
+ * @param surface
436
+ */
437
+ render(surface: 'screen' | CoreContextTexture = 'screen'): void {
438
+ const { glw, quadBuffer } = this;
439
+
440
+ const arr = new Float32Array(quadBuffer, 0, this.curBufferIdx);
441
+
442
+ const buffer = this.quadBufferCollection.getBuffer('a_position') || null;
443
+ glw.arrayBufferData(buffer, arr, glw.STATIC_DRAW);
444
+
445
+ for (let i = 0, length = this.renderOps.length; i < length; i++) {
446
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
447
+ this.renderOps[i]!.draw();
448
+ }
449
+ this.quadBufferUsage = this.curBufferIdx * arr.BYTES_PER_ELEMENT;
450
+
451
+ // Calculate the size of each quad in bytes (4 vertices per quad) times the size of each vertex in bytes
452
+ const QUAD_SIZE_IN_BYTES = 4 * (8 * arr.BYTES_PER_ELEMENT); // 8 attributes per vertex
453
+ this.numQuadsRendered = this.quadBufferUsage / QUAD_SIZE_IN_BYTES;
454
+ }
455
+
456
+ getQuadCount(): number {
457
+ return this.numQuadsRendered;
458
+ }
459
+
460
+ renderToTexture(node: CoreNode) {
461
+ for (let i = 0; i < this.rttNodes.length; i++) {
462
+ if (this.rttNodes[i] === node) {
463
+ return;
464
+ }
465
+ }
466
+
467
+ this.insertRTTNodeInOrder(node);
468
+ }
469
+
470
+ /**
471
+ * Inserts an RTT node into `this.rttNodes` while maintaining the correct rendering order based on hierarchy.
472
+ *
473
+ * Rendering order for RTT nodes is critical when nested RTT nodes exist in a parent-child relationship.
474
+ * Specifically:
475
+ * - Child RTT nodes must be rendered before their RTT-enabled parents to ensure proper texture composition.
476
+ * - If an RTT node is added and it has existing RTT children, it should be rendered after those children.
477
+ *
478
+ * This function addresses both cases by:
479
+ * 1. **Checking Upwards**: It traverses the node's hierarchy upwards to identify any RTT parent
480
+ * already in `rttNodes`. If an RTT parent is found, the new node is placed before this parent.
481
+ * 2. **Checking Downwards**: It traverses the node’s children recursively to find any RTT-enabled
482
+ * children that are already in `rttNodes`. If such children are found, the new node is inserted
483
+ * after the last (highest index) RTT child node.
484
+ *
485
+ * The final calculated insertion index ensures the new node is positioned in `rttNodes` to respect
486
+ * both parent-before-child and child-before-parent rendering rules, preserving the correct order
487
+ * for the WebGL renderer.
488
+ *
489
+ * @param node - The RTT-enabled CoreNode to be added to `rttNodes` in the appropriate hierarchical position.
490
+ */
491
+ private insertRTTNodeInOrder(node: CoreNode) {
492
+ let insertIndex = this.rttNodes.length; // Default to the end of the array
493
+
494
+ // 1. Traverse upwards to ensure the node is placed before its RTT parent (if any).
495
+ let currentNode: CoreNode = node;
496
+ while (currentNode) {
497
+ if (!currentNode.parent) {
498
+ break;
499
+ }
500
+
501
+ const parentIndex = this.rttNodes.indexOf(currentNode.parent);
502
+ if (parentIndex !== -1) {
503
+ // Found an RTT parent in the list; set insertIndex to place node before the parent
504
+ insertIndex = parentIndex;
505
+ break;
506
+ }
507
+
508
+ currentNode = currentNode.parent;
509
+ }
510
+
511
+ // 2. Traverse downwards to ensure the node is placed after any RTT children.
512
+ // Look through each child recursively to see if any are already in rttNodes.
513
+ const maxChildIndex = this.findMaxChildRTTIndex(node);
514
+ if (maxChildIndex !== -1) {
515
+ // Adjust insertIndex to be after the last child RTT node
516
+ insertIndex = Math.max(insertIndex, maxChildIndex + 1);
517
+ }
518
+
519
+ // 3. Insert the node at the calculated position
520
+ this.rttNodes.splice(insertIndex, 0, node);
521
+ }
522
+
523
+ // Helper function to find the highest index of any RTT children of a node within rttNodes
524
+ private findMaxChildRTTIndex(node: CoreNode): number {
525
+ let maxIndex = -1;
526
+
527
+ const traverseChildren = (currentNode: CoreNode) => {
528
+ const currentIndex = this.rttNodes.indexOf(currentNode);
529
+ if (currentIndex !== -1) {
530
+ maxIndex = Math.max(maxIndex, currentIndex);
531
+ }
532
+
533
+ // Recursively check all children of the current node
534
+ for (const child of currentNode.children) {
535
+ traverseChildren(child);
536
+ }
537
+ };
538
+
539
+ // Start traversal directly with the provided node
540
+ traverseChildren(node);
541
+
542
+ return maxIndex;
543
+ }
544
+
545
+ renderRTTNodes() {
546
+ const { glw } = this;
547
+ // Render all associated RTT nodes to their textures
548
+ for (let i = 0; i < this.rttNodes.length; i++) {
549
+ const node = this.rttNodes[i];
550
+
551
+ // Skip nodes that don't have RTT updates
552
+ if (node === undefined || node.hasRTTupdates === false) {
553
+ continue;
554
+ }
555
+
556
+ // Skip nodes that are not visible
557
+ if (
558
+ node.worldAlpha === 0 ||
559
+ (node.strictBounds === true &&
560
+ node.renderState === CoreNodeRenderState.OutOfBounds)
561
+ ) {
562
+ continue;
563
+ }
564
+
565
+ // Skip nodes that do not have a loaded texture
566
+ if (node.texture === null || node.texture.state !== 'loaded') {
567
+ continue;
568
+ }
569
+
570
+ // Set the active RTT node to the current node
571
+ // So we can prevent rendering children of nested RTT nodes
572
+ this.activeRttNode = node;
573
+
574
+ assertTruthy(node.texture !== null, 'RTT node missing texture');
575
+ const ctxTexture = node.texture.ctxTexture;
576
+ assertTruthy(ctxTexture instanceof WebGlCtxRenderTexture);
577
+ this.renderToTextureActive = true;
578
+
579
+ // Bind the the texture's framebuffer
580
+ glw.bindFramebuffer(ctxTexture.framebuffer);
581
+
582
+ glw.viewport(0, 0, ctxTexture.w, ctxTexture.h);
583
+ // Set the clear color to transparent
584
+ glw.clearColor(0, 0, 0, 0);
585
+ glw.clear();
586
+
587
+ // Render all associated quads to the texture
588
+ for (let i = 0; i < node.children.length; i++) {
589
+ const child = node.children[i];
590
+
591
+ if (child === undefined) {
592
+ continue;
593
+ }
594
+
595
+ this.stage.addQuads(child);
596
+ child.hasRTTupdates = false;
597
+ }
598
+
599
+ // Render all associated quads to the texture
600
+ this.render();
601
+
602
+ // Reset render operations
603
+ this.renderOps.length = 0;
604
+ node.hasRTTupdates = false;
605
+ }
606
+
607
+ const clearColor = this.clearColor.normalized;
608
+ // Restore the default clear color
609
+ glw.clearColor(clearColor[0], clearColor[1], clearColor[2], clearColor[3]);
610
+
611
+ // Bind the default framebuffer
612
+ glw.bindFramebuffer(null);
613
+
614
+ glw.viewport(0, 0, this.glw.canvas.width, this.glw.canvas.height);
615
+ this.renderToTextureActive = false;
616
+ }
617
+
618
+ removeRTTNode(node: CoreNode) {
619
+ const index = this.rttNodes.indexOf(node);
620
+ if (index === -1) {
621
+ return;
622
+ }
623
+ this.rttNodes.splice(index, 1);
624
+ }
625
+
626
+ getBufferInfo(): BufferInfo | null {
627
+ const bufferInfo: BufferInfo = {
628
+ totalAvailable: this.stage.options.quadBufferSize,
629
+ totalUsed: this.quadBufferUsage,
630
+ };
631
+ return bufferInfo;
632
+ }
633
+
634
+ getDefaultShaderNode(): WebGlShaderNode {
635
+ if (this.defaultShaderNode !== null) {
636
+ return this.defaultShaderNode as WebGlShaderNode;
637
+ }
638
+ this.stage.shManager.registerShaderType('default', Default);
639
+ this.defaultShaderNode = this.stage.shManager.createShader(
640
+ 'default',
641
+ ) as WebGlShaderNode;
642
+ return this.defaultShaderNode;
643
+ }
644
+
645
+ override getTextureCoords(node: CoreNode): TextureCoords {
646
+ const texture = node.texture;
647
+ if (texture === null) {
648
+ return this.defaultTextureCoords;
649
+ }
650
+
651
+ const textureOptions = node.textureOptions;
652
+ if (
653
+ texture.type === TextureType.subTexture ||
654
+ texture.type === TextureType.image ||
655
+ texture.type === TextureType.renderToTexture ||
656
+ textureOptions !== null
657
+ ) {
658
+ const result = {
659
+ x1: 0,
660
+ y1: 0,
661
+ x2: 1,
662
+ y2: 1,
663
+ };
664
+
665
+ if (texture.type === TextureType.subTexture) {
666
+ const props = (texture as SubTexture).props;
667
+ const { width: parentW = 0, height: parentH = 0 } = (
668
+ texture as SubTexture
669
+ ).parentTexture.dimensions || { width: 0, height: 0 };
670
+ result.x1 = props.x / parentW;
671
+ result.x2 = result.x1 + props.width / parentW;
672
+ result.y1 = props.y / parentH;
673
+ result.y2 = result.y1 + props.height / parentH;
674
+ }
675
+
676
+ if (
677
+ texture.type === TextureType.image &&
678
+ textureOptions !== null &&
679
+ textureOptions.resizeMode !== undefined &&
680
+ texture.dimensions !== null
681
+ ) {
682
+ const resizeMode = textureOptions.resizeMode;
683
+ const dimensions = texture.dimensions;
684
+ if (resizeMode.type === 'cover') {
685
+ const scaleX = node.props.width / dimensions.width;
686
+ const scaleY = node.props.height / dimensions.height;
687
+ const scale = Math.max(scaleX, scaleY);
688
+ const precision = 1 / scale;
689
+ // Determine based on width
690
+ if (scaleX < scale) {
691
+ const desiredSize = precision * node.props.width;
692
+ result.x1 =
693
+ (1 - desiredSize / dimensions.width) * (resizeMode.clipX ?? 0.5);
694
+ result.x2 = result.x1 + desiredSize / dimensions.width;
695
+ }
696
+ // Determine based on height
697
+ if (scaleY < scale) {
698
+ const desiredSize = precision * node.props.height;
699
+ result.y1 =
700
+ (1 - desiredSize / dimensions.height) * (resizeMode.clipY ?? 0.5);
701
+ result.y2 = result.y1 + desiredSize / dimensions.height;
702
+ }
703
+ }
704
+ }
705
+
706
+ // Flip texture coordinates if dictated by texture options
707
+ let flipY = 0;
708
+ if (textureOptions !== null) {
709
+ if (textureOptions.flipX === true) {
710
+ [result.x1, result.x2] = [result.x2, result.x1];
711
+ }
712
+
713
+ // convert to integer for bitwise operation below
714
+ flipY = +(textureOptions.flipY || false);
715
+ }
716
+
717
+ // Eitherone should be true
718
+ if (flipY ^ +(texture.type === TextureType.renderToTexture)) {
719
+ [result.y1, result.y2] = [result.y2, result.y1];
720
+ }
721
+ return result as TextureCoords;
722
+ }
723
+
724
+ return this.defaultTextureCoords;
725
+ }
726
+
727
+ /**
728
+ * Sets the glClearColor to the specified color. *
729
+ * @param color - The color to set as the clear color, represented as a 32-bit integer.
730
+ */
731
+ updateClearColor(color: number) {
732
+ if (this.clearColor.raw === color) {
733
+ return;
734
+ }
735
+ const glw = this.glw;
736
+ const normalizedColor = getNormalizedRgbaComponents(color);
737
+ glw.clearColor(
738
+ normalizedColor[0],
739
+ normalizedColor[1],
740
+ normalizedColor[2],
741
+ normalizedColor[3],
742
+ );
743
+ this.clearColor = {
744
+ raw: color,
745
+ normalized: normalizedColor,
746
+ };
747
+ }
748
+ }