@lightningjs/renderer 2.16.0 → 3.0.0-beta10

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 (443) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +133 -147
  5. package/dist/exports/canvas.d.ts +8 -2
  6. package/dist/exports/canvas.js +8 -2
  7. package/dist/exports/canvas.js.map +1 -1
  8. package/dist/exports/index.d.ts +16 -13
  9. package/dist/exports/index.js +8 -9
  10. package/dist/exports/index.js.map +1 -1
  11. package/dist/exports/utils.d.ts +2 -1
  12. package/dist/exports/utils.js +2 -1
  13. package/dist/exports/utils.js.map +1 -1
  14. package/dist/exports/webgl.d.ts +11 -2
  15. package/dist/exports/webgl.js +11 -2
  16. package/dist/exports/webgl.js.map +1 -1
  17. package/dist/src/core/CoreNode.d.ts +47 -76
  18. package/dist/src/core/CoreNode.js +322 -309
  19. package/dist/src/core/CoreNode.js.map +1 -1
  20. package/dist/src/core/CoreShaderManager.d.ts +29 -73
  21. package/dist/src/core/CoreShaderManager.js +110 -97
  22. package/dist/src/core/CoreShaderManager.js.map +1 -1
  23. package/dist/src/core/CoreTextNode.d.ts +58 -87
  24. package/dist/src/core/CoreTextNode.js +243 -237
  25. package/dist/src/core/CoreTextNode.js.map +1 -1
  26. package/dist/src/core/CoreTextureManager.d.ts +2 -0
  27. package/dist/src/core/CoreTextureManager.js +12 -10
  28. package/dist/src/core/CoreTextureManager.js.map +1 -1
  29. package/dist/src/core/Stage.d.ts +58 -53
  30. package/dist/src/core/Stage.js +260 -196
  31. package/dist/src/core/Stage.js.map +1 -1
  32. package/dist/src/core/TextureMemoryManager.d.ts +3 -0
  33. package/dist/src/core/TextureMemoryManager.js +78 -74
  34. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  35. package/dist/src/core/animations/CoreAnimation.d.ts +0 -1
  36. package/dist/src/core/animations/CoreAnimation.js +6 -52
  37. package/dist/src/core/animations/CoreAnimation.js.map +1 -1
  38. package/dist/src/core/lib/ImageWorker.js +1 -1
  39. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  40. package/dist/src/core/lib/RenderCoords.d.ts +9 -10
  41. package/dist/src/core/lib/RenderCoords.js +43 -55
  42. package/dist/src/core/lib/RenderCoords.js.map +1 -1
  43. package/dist/src/core/lib/WebGlContextWrapper.d.ts +117 -55
  44. package/dist/src/core/lib/WebGlContextWrapper.js +196 -157
  45. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  46. package/dist/src/core/lib/colorCache.d.ts +1 -0
  47. package/dist/src/core/lib/colorCache.js +19 -0
  48. package/dist/src/core/lib/colorCache.js.map +1 -0
  49. package/dist/src/core/lib/colorParser.d.ts +21 -0
  50. package/dist/src/core/lib/colorParser.js +72 -0
  51. package/dist/src/core/lib/colorParser.js.map +1 -0
  52. package/dist/src/core/lib/textureCompression.js +0 -1
  53. package/dist/src/core/lib/textureCompression.js.map +1 -1
  54. package/dist/src/core/lib/utils.d.ts +3 -1
  55. package/dist/src/core/lib/utils.js +19 -0
  56. package/dist/src/core/lib/utils.js.map +1 -1
  57. package/dist/src/core/lib/validateImageBitmap.d.ts +2 -1
  58. package/dist/src/core/lib/validateImageBitmap.js +4 -4
  59. package/dist/src/core/lib/validateImageBitmap.js.map +1 -1
  60. package/dist/src/core/platforms/web/WebPlatform.js +29 -3
  61. package/dist/src/core/platforms/web/WebPlatform.js.map +1 -1
  62. package/dist/src/core/renderers/CoreRenderer.d.ts +15 -22
  63. package/dist/src/core/renderers/CoreRenderer.js +0 -6
  64. package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
  65. package/dist/src/core/renderers/canvas/CanvasRenderer.d.ts +0 -2
  66. package/dist/src/core/renderers/canvas/CanvasRenderer.js +7 -21
  67. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -1
  68. package/dist/src/core/renderers/canvas/CanvasShaderNode.js +2 -1
  69. package/dist/src/core/renderers/canvas/CanvasShaderNode.js.map +1 -1
  70. package/dist/src/core/renderers/canvas/CanvasTexture.d.ts +2 -2
  71. package/dist/src/core/renderers/canvas/CanvasTexture.js +8 -7
  72. package/dist/src/core/renderers/canvas/CanvasTexture.js.map +1 -1
  73. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.d.ts +0 -13
  74. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.js +192 -113
  75. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.js.map +1 -1
  76. package/dist/src/core/renderers/canvas/internal/ColorUtils.d.ts +2 -0
  77. package/dist/src/core/renderers/canvas/internal/ColorUtils.js +14 -0
  78. package/dist/src/core/renderers/canvas/internal/ColorUtils.js.map +1 -1
  79. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js +3 -0
  80. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js.map +1 -1
  81. package/dist/src/core/renderers/webgl/WebGlCtxTexture.d.ts +5 -6
  82. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js +30 -18
  83. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js.map +1 -1
  84. package/dist/src/core/renderers/webgl/WebGlShaderProgram.d.ts +4 -2
  85. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js +31 -13
  86. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js.map +1 -1
  87. package/dist/src/core/renderers/webgl/internal/ShaderUtils.d.ts +32 -5
  88. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +50 -0
  89. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js.map +1 -1
  90. package/dist/src/core/shaders/canvas/Border.js +1 -1
  91. package/dist/src/core/shaders/canvas/Border.js.map +1 -1
  92. package/dist/src/core/shaders/webgl/Border.js +82 -82
  93. package/dist/src/core/shaders/webgl/Default.js +47 -47
  94. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  95. package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
  96. package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
  97. package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
  98. package/dist/src/core/shaders/webgl/Rounded.js +71 -71
  99. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +111 -111
  100. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +130 -130
  101. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
  102. package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
  103. package/dist/src/core/shaders/webgl/Shadow.js +83 -83
  104. package/dist/src/core/text-rendering/CanvasFontHandler.d.ts +4 -4
  105. package/dist/src/core/text-rendering/CanvasFontHandler.js +19 -6
  106. package/dist/src/core/text-rendering/CanvasFontHandler.js.map +1 -1
  107. package/dist/src/core/text-rendering/CanvasTextRenderer.d.ts +18 -2
  108. package/dist/src/core/text-rendering/CanvasTextRenderer.js +296 -69
  109. package/dist/src/core/text-rendering/CanvasTextRenderer.js.map +1 -1
  110. package/dist/src/core/text-rendering/SdfFontHandler.d.ts +4 -4
  111. package/dist/src/core/text-rendering/SdfFontHandler.js +6 -6
  112. package/dist/src/core/text-rendering/SdfFontHandler.js.map +1 -1
  113. package/dist/src/core/text-rendering/SdfTextRenderer.d.ts +4 -8
  114. package/dist/src/core/text-rendering/SdfTextRenderer.js +68 -37
  115. package/dist/src/core/text-rendering/SdfTextRenderer.js.map +1 -1
  116. package/dist/src/core/text-rendering/TextRenderer.d.ts +37 -113
  117. package/dist/src/core/text-rendering/TextRenderer.js +1 -51
  118. package/dist/src/core/text-rendering/TextRenderer.js.map +1 -1
  119. package/dist/src/core/text-rendering/TextTextureRendererUtils.js.map +1 -1
  120. package/dist/src/core/text-rendering/canvas/Settings.d.ts +14 -3
  121. package/dist/src/core/text-rendering/canvas/Utils.d.ts +3 -2
  122. package/dist/src/core/text-rendering/canvas/Utils.js +9 -4
  123. package/dist/src/core/text-rendering/canvas/Utils.js.map +1 -1
  124. package/dist/src/core/text-rendering/canvas/calculateRenderInfo.d.ts +32 -9
  125. package/dist/src/core/text-rendering/canvas/calculateRenderInfo.js +52 -57
  126. package/dist/src/core/text-rendering/canvas/calculateRenderInfo.js.map +1 -1
  127. package/dist/src/core/text-rendering/canvas/draw.d.ts +3 -10
  128. package/dist/src/core/text-rendering/canvas/draw.js +26 -27
  129. package/dist/src/core/text-rendering/canvas/draw.js.map +1 -1
  130. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +2 -2
  131. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  132. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +5 -0
  133. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  134. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.d.ts +7 -1
  135. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +50 -2
  136. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
  137. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +2 -3
  138. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +42 -83
  139. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  140. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.d.ts +1 -1
  141. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +66 -8
  142. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  143. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +14 -4
  144. package/dist/src/core/text-rendering/renderers/TextRenderer.js +3 -0
  145. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  146. package/dist/src/core/text-rendering/sdf/Utils.d.ts +26 -0
  147. package/dist/src/core/text-rendering/sdf/Utils.js +304 -0
  148. package/dist/src/core/text-rendering/sdf/Utils.js.map +1 -0
  149. package/dist/src/core/text-rendering/sdf/index.d.ts +1 -0
  150. package/{src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts → dist/src/core/text-rendering/sdf/index.js} +3 -21
  151. package/dist/src/core/text-rendering/sdf/index.js.map +1 -0
  152. package/dist/src/core/textures/ImageTexture.d.ts +1 -0
  153. package/dist/src/core/textures/ImageTexture.js +11 -4
  154. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  155. package/dist/src/core/textures/Texture.d.ts +6 -1
  156. package/dist/src/core/textures/Texture.js.map +1 -1
  157. package/dist/src/main-api/INode.d.ts +9 -9
  158. package/dist/src/main-api/Inspector.d.ts +6 -1
  159. package/dist/src/main-api/Inspector.js +43 -7
  160. package/dist/src/main-api/Inspector.js.map +1 -1
  161. package/dist/src/main-api/Renderer.d.ts +83 -136
  162. package/dist/src/main-api/Renderer.js +139 -91
  163. package/dist/src/main-api/Renderer.js.map +1 -1
  164. package/dist/src/utils.d.ts +5 -4
  165. package/dist/src/utils.js +20 -9
  166. package/dist/src/utils.js.map +1 -1
  167. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  168. package/exports/canvas-shaders.ts +28 -0
  169. package/exports/canvas.ts +45 -39
  170. package/exports/index.ts +82 -89
  171. package/exports/inspector.ts +24 -24
  172. package/exports/utils.ts +50 -44
  173. package/exports/webgl-shaders.ts +28 -0
  174. package/exports/webgl.ts +52 -38
  175. package/package.json +4 -4
  176. package/src/common/CommonTypes.ts +146 -146
  177. package/src/common/EventEmitter.ts +77 -77
  178. package/src/common/IAnimationController.ts +92 -92
  179. package/src/common/IEventEmitter.ts +28 -28
  180. package/src/core/CoreNode.test.ts +202 -202
  181. package/src/core/CoreNode.ts +2491 -2487
  182. package/src/core/CoreShaderManager.ts +188 -292
  183. package/src/core/CoreTextNode.ts +443 -455
  184. package/src/core/CoreTextureManager.ts +565 -561
  185. package/src/core/Stage.ts +906 -826
  186. package/src/core/TextureMemoryManager.ts +445 -431
  187. package/src/core/animations/AnimationManager.ts +38 -38
  188. package/src/core/animations/CoreAnimation.ts +291 -347
  189. package/src/core/animations/CoreAnimationController.ts +166 -166
  190. package/src/core/lib/ContextSpy.ts +41 -41
  191. package/src/core/lib/ImageWorker.ts +286 -280
  192. package/src/core/lib/Matrix3d.ts +244 -244
  193. package/src/core/lib/RenderCoords.ts +71 -86
  194. package/src/core/lib/WebGlContextWrapper.ts +1381 -1332
  195. package/src/core/lib/colorCache.ts +20 -0
  196. package/src/core/{renderers/canvas/internal/ColorUtils.ts → lib/colorParser.ts} +85 -69
  197. package/src/core/lib/textureCompression.ts +152 -152
  198. package/src/core/lib/textureSvg.ts +78 -78
  199. package/src/core/lib/utils.ts +412 -388
  200. package/src/core/lib/validateImageBitmap.ts +87 -76
  201. package/src/core/platforms/Platform.ts +77 -0
  202. package/src/core/platforms/web/WebPlatform.ts +121 -0
  203. package/src/core/renderers/CoreContextTexture.ts +43 -43
  204. package/src/core/renderers/CoreRenderOp.ts +22 -22
  205. package/src/core/renderers/CoreRenderer.ts +110 -115
  206. package/src/core/renderers/CoreShaderNode.ts +175 -0
  207. package/{dist/src/core/renderers/CoreShader.js → src/core/renderers/CoreShaderProgram.ts} +23 -28
  208. package/src/core/renderers/canvas/CanvasRenderer.ts +283 -0
  209. package/src/core/renderers/canvas/CanvasShaderNode.ts +96 -0
  210. package/src/core/renderers/canvas/{CanvasCoreTexture.ts → CanvasTexture.ts} +156 -153
  211. package/src/core/renderers/webgl/{WebGlCoreCtxRenderTexture.ts → WebGlCtxRenderTexture.ts} +91 -91
  212. package/src/core/renderers/webgl/{WebGlCoreCtxSubTexture.ts → WebGlCtxSubTexture.ts} +50 -50
  213. package/src/core/renderers/webgl/{WebGlCoreCtxTexture.ts → WebGlCtxTexture.ts} +310 -313
  214. package/src/core/renderers/webgl/WebGlRenderOp.ts +167 -0
  215. package/src/core/renderers/webgl/{WebGlCoreRenderer.ts → WebGlRenderer.ts} +747 -821
  216. package/src/core/renderers/webgl/WebGlShaderNode.ts +435 -0
  217. package/src/core/renderers/webgl/WebGlShaderProgram.ts +341 -0
  218. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  219. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  220. package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -143
  221. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  222. package/src/core/shaders/canvas/Border.ts +75 -0
  223. package/src/core/shaders/canvas/HolePunch.ts +62 -0
  224. package/src/core/shaders/canvas/LinearGradient.ts +71 -0
  225. package/src/core/shaders/canvas/RadialGradient.ts +99 -0
  226. package/src/core/shaders/canvas/Rounded.ts +55 -0
  227. package/src/core/shaders/canvas/RoundedWithBorder.ts +74 -0
  228. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +90 -0
  229. package/src/core/shaders/canvas/RoundedWithShadow.ts +70 -0
  230. package/src/core/shaders/canvas/Shadow.ts +52 -0
  231. package/src/core/shaders/canvas/utils/render.ts +151 -0
  232. package/src/core/shaders/templates/BorderTemplate.ts +115 -0
  233. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -0
  234. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -0
  235. package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -0
  236. package/src/core/shaders/templates/RoundedTemplate.ts +98 -0
  237. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -0
  238. package/{dist/src/core/shaders/templates/shaderUtils.js → src/core/shaders/templates/RoundedWithBorderTemplate.ts} +35 -41
  239. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -0
  240. package/src/core/shaders/templates/ShadowTemplate.ts +106 -0
  241. package/src/core/shaders/utils.ts +46 -0
  242. package/src/core/shaders/webgl/Border.ts +116 -0
  243. package/src/core/shaders/webgl/Default.ts +89 -0
  244. package/src/core/shaders/webgl/DefaultBatched.ts +129 -0
  245. package/src/core/shaders/webgl/HolePunch.ts +75 -0
  246. package/src/core/shaders/webgl/LinearGradient.ts +82 -0
  247. package/src/core/shaders/webgl/RadialGradient.ts +85 -0
  248. package/src/core/shaders/webgl/Rounded.ts +117 -0
  249. package/src/core/shaders/webgl/RoundedWithBorder.ts +155 -0
  250. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +175 -0
  251. package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -0
  252. package/src/core/shaders/webgl/SdfShader.ts +134 -0
  253. package/src/core/shaders/webgl/Shadow.ts +115 -0
  254. package/src/core/text-rendering/CanvasFontHandler.ts +176 -0
  255. package/src/core/text-rendering/CanvasTextRenderer.ts +622 -0
  256. package/src/core/text-rendering/SdfFontHandler.ts +517 -0
  257. package/src/core/text-rendering/SdfTextRenderer.ts +466 -0
  258. package/src/core/text-rendering/TextRenderer.ts +404 -0
  259. package/src/core/text-rendering/{TextTextureRendererUtils.ts → Utils.ts} +257 -263
  260. package/src/core/text-rendering/canvas/Settings.ts +99 -0
  261. package/src/core/text-rendering/canvas/Utils.test.ts +206 -0
  262. package/src/core/text-rendering/canvas/Utils.ts +178 -0
  263. package/src/core/text-rendering/canvas/calculateRenderInfo.ts +299 -0
  264. package/src/core/text-rendering/canvas/draw.ts +165 -0
  265. package/src/core/text-rendering/sdf/Utils.test.ts +402 -0
  266. package/src/core/text-rendering/sdf/Utils.ts +436 -0
  267. package/src/core/text-rendering/{renderers/SdfTextRenderer/internal/constants.ts → sdf/index.ts} +20 -32
  268. package/src/core/textures/ColorTexture.ts +102 -102
  269. package/src/core/textures/ImageTexture.ts +418 -400
  270. package/src/core/textures/NoiseTexture.ts +104 -104
  271. package/src/core/textures/RenderTexture.ts +85 -85
  272. package/src/core/textures/SubTexture.ts +205 -205
  273. package/src/core/textures/Texture.ts +381 -376
  274. package/src/core/utils.ts +227 -227
  275. package/src/env.d.ts +7 -7
  276. package/src/main-api/INode.ts +100 -101
  277. package/src/main-api/Inspector.ts +567 -522
  278. package/src/main-api/Renderer.ts +873 -807
  279. package/src/main-api/utils.ts +45 -45
  280. package/src/utils.ts +267 -248
  281. package/dist/src/core/platform.d.ts +0 -10
  282. package/dist/src/core/platform.js +0 -81
  283. package/dist/src/core/platform.js.map +0 -1
  284. package/dist/src/core/renderers/CoreShader.d.ts +0 -9
  285. package/dist/src/core/renderers/CoreShader.js.map +0 -1
  286. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.d.ts +0 -33
  287. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +0 -250
  288. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +0 -1
  289. package/dist/src/core/renderers/canvas/CanvasCoreTexture.d.ts +0 -16
  290. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +0 -124
  291. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +0 -1
  292. package/dist/src/core/renderers/canvas/shaders/UnsupportedShader.d.ts +0 -10
  293. package/dist/src/core/renderers/canvas/shaders/UnsupportedShader.js +0 -43
  294. package/dist/src/core/renderers/canvas/shaders/UnsupportedShader.js.map +0 -1
  295. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.d.ts +0 -12
  296. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js +0 -58
  297. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js.map +0 -1
  298. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.d.ts +0 -9
  299. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +0 -38
  300. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +0 -1
  301. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +0 -56
  302. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +0 -239
  303. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +0 -1
  304. package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.d.ts +0 -34
  305. package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.js +0 -114
  306. package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.js.map +0 -1
  307. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +0 -133
  308. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +0 -616
  309. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +0 -1
  310. package/dist/src/core/renderers/webgl/WebGlCoreShader.d.ts +0 -83
  311. package/dist/src/core/renderers/webgl/WebGlCoreShader.js +0 -233
  312. package/dist/src/core/renderers/webgl/WebGlCoreShader.js.map +0 -1
  313. package/dist/src/core/renderers/webgl/shaders/DefaultShader.d.ts +0 -9
  314. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +0 -87
  315. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js.map +0 -1
  316. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.d.ts +0 -10
  317. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +0 -119
  318. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js.map +0 -1
  319. package/dist/src/core/renderers/webgl/shaders/DynamicShader.d.ts +0 -29
  320. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +0 -413
  321. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js.map +0 -1
  322. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.d.ts +0 -28
  323. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +0 -131
  324. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js.map +0 -1
  325. package/dist/src/core/renderers/webgl/shaders/SdfShader.d.ts +0 -47
  326. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +0 -160
  327. package/dist/src/core/renderers/webgl/shaders/SdfShader.js.map +0 -1
  328. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.d.ts +0 -31
  329. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +0 -71
  330. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js.map +0 -1
  331. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.d.ts +0 -30
  332. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +0 -58
  333. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js.map +0 -1
  334. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.d.ts +0 -31
  335. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +0 -71
  336. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js.map +0 -1
  337. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.d.ts +0 -31
  338. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +0 -71
  339. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js.map +0 -1
  340. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.d.ts +0 -31
  341. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +0 -71
  342. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js.map +0 -1
  343. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.d.ts +0 -9
  344. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js +0 -136
  345. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js.map +0 -1
  346. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.d.ts +0 -36
  347. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +0 -85
  348. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js.map +0 -1
  349. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.d.ts +0 -45
  350. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +0 -104
  351. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js.map +0 -1
  352. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.d.ts +0 -22
  353. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +0 -45
  354. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js.map +0 -1
  355. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.d.ts +0 -58
  356. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +0 -80
  357. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js.map +0 -1
  358. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.d.ts +0 -35
  359. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +0 -129
  360. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +0 -1
  361. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.d.ts +0 -39
  362. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +0 -116
  363. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +0 -1
  364. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.d.ts +0 -61
  365. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +0 -127
  366. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js.map +0 -1
  367. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.d.ts +0 -40
  368. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +0 -71
  369. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js.map +0 -1
  370. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts +0 -115
  371. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js +0 -61
  372. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map +0 -1
  373. package/dist/src/core/shaders/templates/shaderUtils.d.ts +0 -5
  374. package/dist/src/core/shaders/templates/shaderUtils.js.map +0 -1
  375. package/dist/src/core/shaders/webgl/Spinner.d.ts +0 -1
  376. package/dist/src/core/shaders/webgl/Spinner.js +0 -2
  377. package/dist/src/core/shaders/webgl/Spinner.js.map +0 -1
  378. package/dist/src/core/text-rendering/sdf/PeekableGenerator.d.ts +0 -12
  379. package/dist/src/core/text-rendering/sdf/PeekableGenerator.js +0 -61
  380. package/dist/src/core/text-rendering/sdf/PeekableGenerator.js.map +0 -1
  381. package/dist/src/core/text-rendering/sdf/SimpleFontShaper.d.ts +0 -45
  382. package/dist/src/core/text-rendering/sdf/SimpleFontShaper.js +0 -69
  383. package/dist/src/core/text-rendering/sdf/SimpleFontShaper.js.map +0 -1
  384. package/dist/src/main-api/DynamicShaderController.d.ts +0 -29
  385. package/dist/src/main-api/DynamicShaderController.js +0 -58
  386. package/dist/src/main-api/DynamicShaderController.js.map +0 -1
  387. package/dist/src/main-api/ShaderController.d.ts +0 -31
  388. package/dist/src/main-api/ShaderController.js +0 -37
  389. package/dist/src/main-api/ShaderController.js.map +0 -1
  390. package/scripts/please-use-pnpm.js +0 -13
  391. package/src/core/platform.ts +0 -100
  392. package/src/core/renderers/CoreShader.ts +0 -41
  393. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +0 -375
  394. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +0 -231
  395. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +0 -48
  396. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +0 -125
  397. package/src/core/renderers/webgl/WebGlCoreShader.ts +0 -365
  398. package/src/core/renderers/webgl/shaders/DefaultShader.ts +0 -93
  399. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +0 -132
  400. package/src/core/renderers/webgl/shaders/DynamicShader.ts +0 -580
  401. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +0 -167
  402. package/src/core/renderers/webgl/shaders/SdfShader.ts +0 -204
  403. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +0 -101
  404. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +0 -87
  405. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +0 -101
  406. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +0 -101
  407. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +0 -101
  408. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +0 -159
  409. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +0 -127
  410. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +0 -148
  411. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +0 -67
  412. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +0 -157
  413. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +0 -171
  414. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +0 -168
  415. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +0 -187
  416. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +0 -110
  417. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +0 -196
  418. package/src/core/text-rendering/TextRenderingUtils.ts +0 -36
  419. package/src/core/text-rendering/TrFontManager.ts +0 -183
  420. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +0 -176
  421. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +0 -139
  422. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +0 -173
  423. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +0 -171
  424. package/src/core/text-rendering/font-face-types/TrFontFace.ts +0 -187
  425. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +0 -94
  426. package/src/core/text-rendering/font-face-types/utils.ts +0 -39
  427. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +0 -509
  428. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +0 -808
  429. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +0 -853
  430. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +0 -48
  431. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +0 -66
  432. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +0 -52
  433. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +0 -117
  434. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +0 -133
  435. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +0 -408
  436. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +0 -49
  437. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +0 -52
  438. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +0 -205
  439. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +0 -93
  440. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +0 -40
  441. package/src/core/text-rendering/renderers/TextRenderer.ts +0 -557
  442. package/src/main-api/DynamicShaderController.ts +0 -104
  443. package/src/main-api/ShaderController.ts +0 -80
@@ -1,561 +1,565 @@
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 { ImageWorkerManager } from './lib/ImageWorker.js';
21
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
22
- import { ColorTexture } from './textures/ColorTexture.js';
23
- import { ImageTexture } from './textures/ImageTexture.js';
24
- import { NoiseTexture } from './textures/NoiseTexture.js';
25
- import { SubTexture } from './textures/SubTexture.js';
26
- import { RenderTexture } from './textures/RenderTexture.js';
27
- import { Texture, TextureType } from './textures/Texture.js';
28
- import { EventEmitter } from '../common/EventEmitter.js';
29
- import { getTimeStamp } from './platform.js';
30
- import type { Stage } from './Stage.js';
31
- import {
32
- validateCreateImageBitmap,
33
- type CreateImageBitmapSupport,
34
- } from './lib/validateImageBitmap.js';
35
-
36
- /**
37
- * Augmentable map of texture class types
38
- *
39
- * @remarks
40
- * This interface can be augmented by other modules/apps to add additional
41
- * texture types. The ones included directly here are the ones that are
42
- * included in the core library.
43
- */
44
- export interface TextureMap {
45
- ColorTexture: typeof ColorTexture;
46
- ImageTexture: typeof ImageTexture;
47
- NoiseTexture: typeof NoiseTexture;
48
- SubTexture: typeof SubTexture;
49
- RenderTexture: typeof RenderTexture;
50
- }
51
-
52
- export type ExtractProps<Type> = Type extends { z$__type__Props: infer Props }
53
- ? Props
54
- : never;
55
-
56
- /**
57
- * Contains information about the texture manager's internal state
58
- * for debugging purposes.
59
- */
60
- export interface TextureManagerDebugInfo {
61
- keyCacheSize: number;
62
- }
63
-
64
- export interface TextureManagerSettings {
65
- numImageWorkers: number;
66
- createImageBitmapSupport: 'auto' | 'basic' | 'options' | 'full';
67
- }
68
-
69
- export type ResizeModeOptions =
70
- | {
71
- /**
72
- * Specifies that the image should be resized to cover the specified dimensions.
73
- */
74
- type: 'cover';
75
- /**
76
- * The horizontal clipping position
77
- * To clip the left, set clipX to 0. To clip the right, set clipX to 1.
78
- * clipX 0.5 will clip a equal amount from left and right
79
- *
80
- * @defaultValue 0.5
81
- */
82
- clipX?: number;
83
- /**
84
- * The vertical clipping position
85
- * To clip the top, set clipY to 0. To clip the bottom, set clipY to 1.
86
- * clipY 0.5 will clip a equal amount from top and bottom
87
- *
88
- * @defaultValue 0.5
89
- */
90
- clipY?: number;
91
- }
92
- | {
93
- /**
94
- * Specifies that the image should be resized to fit within the specified dimensions.
95
- */
96
- type: 'contain';
97
- };
98
-
99
- /**
100
- * Universal options for all texture types
101
- *
102
- * @remarks
103
- * Texture Options provide a way to specify options that are relevant to the
104
- * texture loading process (including caching) and specifically for how a
105
- * texture is rendered within a specific Node (or set of Nodes).
106
- *
107
- * They are not used in determining the cache key for a texture (except if
108
- * the `cacheKey` option is provided explicitly to oveerride the default
109
- * cache key for the texture instance) nor are they stored/referenced within
110
- * the texture instance itself. Instead, the options are stored/referenced
111
- * within individual Nodes. So a single texture instance can be used in
112
- * multiple Nodes each using a different set of options.
113
- */
114
- export interface TextureOptions {
115
- /**
116
- * Preload the texture immediately even if it's not being rendered to the
117
- * screen.
118
- *
119
- * @remarks
120
- * This allows the texture to be used immediately without any delay when it
121
- * is first needed for rendering. Otherwise the loading process will start
122
- * when the texture is first rendered, which may cause a delay in that texture
123
- * being shown properly.
124
- *
125
- * @defaultValue `false`
126
- */
127
- preload?: boolean;
128
-
129
- /**
130
- * Prevent clean up of the texture when it is no longer being used.
131
- *
132
- * @remarks
133
- * This is useful when you want to keep the texture in memory for later use.
134
- * Regardless of whether the texture is being used or not, it will not be
135
- * cleaned up.
136
- *
137
- * @defaultValue `false`
138
- */
139
- preventCleanup?: boolean;
140
-
141
- /**
142
- * Flip the texture horizontally when rendering
143
- *
144
- * @defaultValue `false`
145
- */
146
- flipX?: boolean;
147
-
148
- /**
149
- * Flip the texture vertically when rendering
150
- *
151
- * @defaultValue `false`
152
- */
153
- flipY?: boolean;
154
-
155
- /**
156
- * You can use resizeMode to determine the clipping automatically from the width
157
- * and height of the source texture. This can be convenient if you are unsure about
158
- * the exact image sizes but want the image to cover a specific area.
159
- *
160
- * The resize modes cover and contain are supported
161
- */
162
- resizeMode?: ResizeModeOptions;
163
- }
164
-
165
- export class CoreTextureManager extends EventEmitter {
166
- /**
167
- * Map of textures by cache key
168
- */
169
- keyCache: Map<string, Texture> = new Map();
170
-
171
- /**
172
- * Map of cache keys by texture
173
- */
174
- inverseKeyCache: WeakMap<Texture, string> = new WeakMap();
175
-
176
- /**
177
- * Map of texture constructors by their type name
178
- */
179
- txConstructors: Partial<TextureMap> = {};
180
-
181
- private priorityQueue: Array<Texture> = [];
182
- private uploadTextureQueue: Array<Texture> = [];
183
- private initialized = false;
184
- private stage: Stage;
185
- private numImageWorkers: number;
186
-
187
- imageWorkerManager: ImageWorkerManager | null = null;
188
- hasCreateImageBitmap = !!self.createImageBitmap;
189
- imageBitmapSupported = {
190
- basic: false,
191
- options: false,
192
- full: false,
193
- };
194
-
195
- hasWorker = !!self.Worker;
196
- /**
197
- * Renderer that this texture manager is associated with
198
- *
199
- * @remarks
200
- * This MUST be set before the texture manager is used. Otherwise errors
201
- * will occur when using the texture manager.
202
- */
203
- renderer!: CoreRenderer;
204
-
205
- /**
206
- * The current frame time in milliseconds
207
- *
208
- * @remarks
209
- * This is used to populate the `lastRenderableChangeTime` property of
210
- * {@link Texture} instances when their renderable state changes.
211
- *
212
- * Set by stage via `updateFrameTime` method.
213
- */
214
- frameTime = 0;
215
-
216
- constructor(stage: Stage, settings: TextureManagerSettings) {
217
- super();
218
-
219
- const { numImageWorkers, createImageBitmapSupport } = settings;
220
- this.stage = stage;
221
- this.numImageWorkers = numImageWorkers;
222
-
223
- if (createImageBitmapSupport === 'auto') {
224
- validateCreateImageBitmap()
225
- .then((result) => {
226
- this.initialize(result);
227
- })
228
- .catch(() => {
229
- console.warn(
230
- '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
231
- );
232
-
233
- // initialized without image worker manager and createImageBitmap
234
- this.initialized = true;
235
- this.emit('initialized');
236
- });
237
- } else {
238
- this.initialize({
239
- basic: createImageBitmapSupport === 'basic',
240
- options: createImageBitmapSupport === 'options',
241
- full: createImageBitmapSupport === 'full',
242
- });
243
- }
244
-
245
- this.registerTextureType('ImageTexture', ImageTexture);
246
- this.registerTextureType('ColorTexture', ColorTexture);
247
- this.registerTextureType('NoiseTexture', NoiseTexture);
248
- this.registerTextureType('SubTexture', SubTexture);
249
- this.registerTextureType('RenderTexture', RenderTexture);
250
- }
251
-
252
- registerTextureType<Type extends keyof TextureMap>(
253
- textureType: Type,
254
- textureClass: TextureMap[Type],
255
- ): void {
256
- this.txConstructors[textureType] = textureClass;
257
- }
258
-
259
- private initialize(support: CreateImageBitmapSupport) {
260
- this.hasCreateImageBitmap =
261
- support.basic || support.options || support.full;
262
- this.imageBitmapSupported = support;
263
-
264
- if (!this.hasCreateImageBitmap) {
265
- console.warn(
266
- '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
267
- );
268
- }
269
-
270
- if (
271
- this.hasCreateImageBitmap &&
272
- this.hasWorker &&
273
- this.numImageWorkers > 0
274
- ) {
275
- this.imageWorkerManager = new ImageWorkerManager(
276
- this.numImageWorkers,
277
- support,
278
- );
279
- } else {
280
- console.warn(
281
- '[Lightning] Imageworker is 0 or not supported on this browser. Image loading will be slower.',
282
- );
283
- }
284
-
285
- this.initialized = true;
286
- this.emit('initialized');
287
- }
288
-
289
- /**
290
- * Enqueue a texture for uploading to the GPU.
291
- *
292
- * @param texture - The texture to upload
293
- */
294
- enqueueUploadTexture(texture: Texture): void {
295
- if (this.uploadTextureQueue.includes(texture) === false) {
296
- this.uploadTextureQueue.push(texture);
297
- }
298
- }
299
-
300
- /**
301
- * Create a texture
302
- *
303
- * @param textureType - The type of texture to create
304
- * @param props - The properties to use for the texture
305
- */
306
- createTexture<Type extends keyof TextureMap>(
307
- textureType: Type,
308
- props: ExtractProps<TextureMap[Type]>,
309
- ): InstanceType<TextureMap[Type]> {
310
- let texture: Texture | undefined;
311
- const TextureClass = this.txConstructors[textureType];
312
- if (!TextureClass) {
313
- throw new Error(`Texture type "${textureType}" is not registered`);
314
- }
315
-
316
- const cacheKey = TextureClass.makeCacheKey(props as any);
317
- if (cacheKey && this.keyCache.has(cacheKey)) {
318
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
319
- texture = this.keyCache.get(cacheKey)!;
320
- } else {
321
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
322
- texture = new TextureClass(this, props as any);
323
-
324
- if (cacheKey) {
325
- this.initTextureToCache(texture, cacheKey);
326
- }
327
- }
328
-
329
- return texture as InstanceType<TextureMap[Type]>;
330
- }
331
-
332
- orphanTexture(texture: Texture): void {
333
- // if it is part of the download or upload queue, remove it
334
- this.removeTextureFromQueue(texture);
335
-
336
- if (texture.type === TextureType.subTexture) {
337
- // ignore subtextures
338
- return;
339
- }
340
-
341
- this.stage.txMemManager.addToOrphanedTextures(texture);
342
- }
343
-
344
- /**
345
- * Override loadTexture to use the batched approach.
346
- *
347
- * @param texture - The texture to load
348
- * @param immediate - Whether to prioritize the texture for immediate loading
349
- */
350
- loadTexture(texture: Texture, priority?: boolean): void {
351
- this.stage.txMemManager.removeFromOrphanedTextures(texture);
352
-
353
- if (texture.type === TextureType.subTexture) {
354
- // ignore subtextures - they get loaded through their parent
355
- return;
356
- }
357
-
358
- if (texture.state === 'loaded') {
359
- // if the texture is already loaded, just return
360
- return;
361
- }
362
-
363
- if (Texture.TRANSITIONAL_TEXTURE_STATES.includes(texture.state)) {
364
- return;
365
- }
366
-
367
- // if we're not initialized, just queue the texture into the priority queue
368
- if (this.initialized === false) {
369
- this.priorityQueue.push(texture);
370
- return;
371
- }
372
-
373
- // If the texture failed to load, we need to re-download it.
374
- if (texture.state === 'failed') {
375
- texture.free();
376
- texture.freeTextureData();
377
- }
378
-
379
- texture.setState('loading');
380
-
381
- // Get the texture data
382
- texture
383
- .getTextureData()
384
- .then(() => {
385
- if (texture.state !== 'fetched') {
386
- texture.setState('failed');
387
- return;
388
- }
389
-
390
- // For non-image textures, upload immediately
391
- if (texture.type !== TextureType.image) {
392
- this.uploadTexture(texture).catch((err) => {
393
- console.error('Failed to upload non-image texture:', err);
394
- texture.setState('failed');
395
- });
396
- } else {
397
- // For image textures, queue for throttled upload
398
- // If it's a priority texture, upload it immediately
399
- if (priority === true) {
400
- this.uploadTexture(texture).catch((err) => {
401
- console.error('Failed to upload priority texture:', err);
402
- texture.setState('failed');
403
- });
404
- } else {
405
- this.enqueueUploadTexture(texture);
406
- }
407
- }
408
- })
409
- .catch((err) => {
410
- console.error(err);
411
- texture.setState('failed');
412
- });
413
- }
414
-
415
- /**
416
- * Upload a texture to the GPU
417
- *
418
- * @param texture Texture to upload
419
- * @returns Promise that resolves when the texture is fully loaded
420
- */
421
- async uploadTexture(texture: Texture): Promise<void> {
422
- if (
423
- this.stage.txMemManager.doNotExceedCriticalThreshold === true &&
424
- this.stage.txMemManager.criticalCleanupRequested === true
425
- ) {
426
- // we're at a critical memory threshold, don't upload textures
427
- this.enqueueUploadTexture(texture);
428
- return;
429
- }
430
-
431
- const coreContext = texture.loadCtxTexture();
432
- if (coreContext !== null && coreContext.state === 'loaded') {
433
- texture.setState('loaded');
434
- return;
435
- }
436
-
437
- await coreContext.load();
438
- }
439
-
440
- /**
441
- * Check if a texture is being processed
442
- */
443
- isProcessingTexture(texture: Texture): boolean {
444
- return this.uploadTextureQueue.includes(texture) === true;
445
- }
446
-
447
- /**
448
- * Process a limited number of uploads.
449
- *
450
- * @param maxProcessingTime - The maximum processing time in milliseconds
451
- */
452
- async processSome(maxProcessingTime: number): Promise<void> {
453
- if (this.initialized === false) {
454
- return;
455
- }
456
-
457
- const startTime = getTimeStamp();
458
-
459
- // Process priority queue
460
- while (
461
- this.priorityQueue.length > 0 &&
462
- getTimeStamp() - startTime < maxProcessingTime
463
- ) {
464
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
465
- const texture = this.priorityQueue.pop()!;
466
- try {
467
- await texture.getTextureData();
468
- await this.uploadTexture(texture);
469
- } catch (error) {
470
- console.error('Failed to process priority texture:', error);
471
- // Continue with next texture instead of stopping entire queue
472
- }
473
- }
474
-
475
- // Process uploads - await each upload to prevent GPU overload
476
- while (
477
- this.uploadTextureQueue.length > 0 &&
478
- getTimeStamp() - startTime < maxProcessingTime
479
- ) {
480
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
481
- const texture = this.uploadTextureQueue.shift()!;
482
- try {
483
- await this.uploadTexture(texture);
484
- } catch (error) {
485
- console.error('Failed to upload texture:', error);
486
- // Continue with next texture instead of stopping entire queue
487
- }
488
- }
489
- }
490
-
491
- public hasUpdates(): boolean {
492
- return this.uploadTextureQueue.length > 0;
493
- }
494
-
495
- /**
496
- * Initialize a texture to the cache
497
- *
498
- * @param texture Texture to cache
499
- * @param cacheKey Cache key for the texture
500
- */
501
- initTextureToCache(texture: Texture, cacheKey: string) {
502
- const { keyCache, inverseKeyCache } = this;
503
- keyCache.set(cacheKey, texture);
504
- inverseKeyCache.set(texture, cacheKey);
505
- }
506
-
507
- /**
508
- * Get a texture from the cache
509
- *
510
- * @param cacheKey
511
- */
512
- getTextureFromCache(cacheKey: string): Texture | undefined {
513
- return this.keyCache.get(cacheKey);
514
- }
515
-
516
- /**
517
- * Remove a texture from the cache
518
- *
519
- * @remarks
520
- * Called by Texture Cleanup when a texture is freed.
521
- *
522
- * @param texture
523
- */
524
- removeTextureFromCache(texture: Texture) {
525
- const { inverseKeyCache, keyCache } = this;
526
- const cacheKey = inverseKeyCache.get(texture);
527
- if (cacheKey) {
528
- keyCache.delete(cacheKey);
529
- }
530
- }
531
-
532
- /**
533
- * Remove texture from the upload queue
534
- *
535
- * @param texture - The texture to remove
536
- */
537
- removeTextureFromQueue(texture: Texture): void {
538
- const uploadIndex = this.uploadTextureQueue.indexOf(texture);
539
- if (uploadIndex !== -1) {
540
- this.uploadTextureQueue.splice(uploadIndex, 1);
541
- }
542
- }
543
-
544
- /**
545
- * Resolve a parent texture from the cache or fallback to the provided texture.
546
- *
547
- * @param texture - The provided texture to resolve.
548
- * @returns The cached or provided texture.
549
- */
550
- resolveParentTexture(texture: ImageTexture): Texture {
551
- if (!texture?.props) {
552
- return texture;
553
- }
554
-
555
- const cacheKey = ImageTexture.makeCacheKey(texture.props);
556
- const cachedTexture = cacheKey
557
- ? this.getTextureFromCache(cacheKey)
558
- : undefined;
559
- return cachedTexture ?? texture;
560
- }
561
- }
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 { ImageWorkerManager } from './lib/ImageWorker.js';
21
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
22
+ import { ColorTexture } from './textures/ColorTexture.js';
23
+ import { ImageTexture } from './textures/ImageTexture.js';
24
+ import { NoiseTexture } from './textures/NoiseTexture.js';
25
+ import { SubTexture } from './textures/SubTexture.js';
26
+ import { RenderTexture } from './textures/RenderTexture.js';
27
+ import { Texture, TextureType } from './textures/Texture.js';
28
+ import { EventEmitter } from '../common/EventEmitter.js';
29
+ import type { Stage } from './Stage.js';
30
+ import {
31
+ validateCreateImageBitmap,
32
+ type CreateImageBitmapSupport,
33
+ } from './lib/validateImageBitmap.js';
34
+ import type { Platform } from './platforms/Platform.js';
35
+
36
+ /**
37
+ * Augmentable map of texture class types
38
+ *
39
+ * @remarks
40
+ * This interface can be augmented by other modules/apps to add additional
41
+ * texture types. The ones included directly here are the ones that are
42
+ * included in the core library.
43
+ */
44
+ export interface TextureMap {
45
+ ColorTexture: typeof ColorTexture;
46
+ ImageTexture: typeof ImageTexture;
47
+ NoiseTexture: typeof NoiseTexture;
48
+ SubTexture: typeof SubTexture;
49
+ RenderTexture: typeof RenderTexture;
50
+ }
51
+
52
+ export type ExtractProps<Type> = Type extends { z$__type__Props: infer Props }
53
+ ? Props
54
+ : never;
55
+
56
+ /**
57
+ * Contains information about the texture manager's internal state
58
+ * for debugging purposes.
59
+ */
60
+ export interface TextureManagerDebugInfo {
61
+ keyCacheSize: number;
62
+ }
63
+
64
+ export interface TextureManagerSettings {
65
+ numImageWorkers: number;
66
+ createImageBitmapSupport: 'auto' | 'basic' | 'options' | 'full';
67
+ }
68
+
69
+ export type ResizeModeOptions =
70
+ | {
71
+ /**
72
+ * Specifies that the image should be resized to cover the specified dimensions.
73
+ */
74
+ type: 'cover';
75
+ /**
76
+ * The horizontal clipping position
77
+ * To clip the left, set clipX to 0. To clip the right, set clipX to 1.
78
+ * clipX 0.5 will clip a equal amount from left and right
79
+ *
80
+ * @defaultValue 0.5
81
+ */
82
+ clipX?: number;
83
+ /**
84
+ * The vertical clipping position
85
+ * To clip the top, set clipY to 0. To clip the bottom, set clipY to 1.
86
+ * clipY 0.5 will clip a equal amount from top and bottom
87
+ *
88
+ * @defaultValue 0.5
89
+ */
90
+ clipY?: number;
91
+ }
92
+ | {
93
+ /**
94
+ * Specifies that the image should be resized to fit within the specified dimensions.
95
+ */
96
+ type: 'contain';
97
+ };
98
+
99
+ /**
100
+ * Universal options for all texture types
101
+ *
102
+ * @remarks
103
+ * Texture Options provide a way to specify options that are relevant to the
104
+ * texture loading process (including caching) and specifically for how a
105
+ * texture is rendered within a specific Node (or set of Nodes).
106
+ *
107
+ * They are not used in determining the cache key for a texture (except if
108
+ * the `cacheKey` option is provided explicitly to oveerride the default
109
+ * cache key for the texture instance) nor are they stored/referenced within
110
+ * the texture instance itself. Instead, the options are stored/referenced
111
+ * within individual Nodes. So a single texture instance can be used in
112
+ * multiple Nodes each using a different set of options.
113
+ */
114
+ export interface TextureOptions {
115
+ /**
116
+ * Preload the texture immediately even if it's not being rendered to the
117
+ * screen.
118
+ *
119
+ * @remarks
120
+ * This allows the texture to be used immediately without any delay when it
121
+ * is first needed for rendering. Otherwise the loading process will start
122
+ * when the texture is first rendered, which may cause a delay in that texture
123
+ * being shown properly.
124
+ *
125
+ * @defaultValue `false`
126
+ */
127
+ preload?: boolean;
128
+
129
+ /**
130
+ * Prevent clean up of the texture when it is no longer being used.
131
+ *
132
+ * @remarks
133
+ * This is useful when you want to keep the texture in memory for later use.
134
+ * Regardless of whether the texture is being used or not, it will not be
135
+ * cleaned up.
136
+ *
137
+ * @defaultValue `false`
138
+ */
139
+ preventCleanup?: boolean;
140
+
141
+ /**
142
+ * Flip the texture horizontally when rendering
143
+ *
144
+ * @defaultValue `false`
145
+ */
146
+ flipX?: boolean;
147
+
148
+ /**
149
+ * Flip the texture vertically when rendering
150
+ *
151
+ * @defaultValue `false`
152
+ */
153
+ flipY?: boolean;
154
+
155
+ /**
156
+ * You can use resizeMode to determine the clipping automatically from the width
157
+ * and height of the source texture. This can be convenient if you are unsure about
158
+ * the exact image sizes but want the image to cover a specific area.
159
+ *
160
+ * The resize modes cover and contain are supported
161
+ */
162
+ resizeMode?: ResizeModeOptions;
163
+ }
164
+
165
+ export class CoreTextureManager extends EventEmitter {
166
+ /**
167
+ * Map of textures by cache key
168
+ */
169
+ keyCache: Map<string, Texture> = new Map();
170
+
171
+ /**
172
+ * Map of cache keys by texture
173
+ */
174
+ inverseKeyCache: WeakMap<Texture, string> = new WeakMap();
175
+
176
+ /**
177
+ * Map of texture constructors by their type name
178
+ */
179
+ txConstructors: Partial<TextureMap> = {};
180
+
181
+ private priorityQueue: Array<Texture> = [];
182
+ private uploadTextureQueue: Array<Texture> = [];
183
+ private initialized = false;
184
+ private stage: Stage;
185
+ private numImageWorkers: number;
186
+
187
+ public platform: Platform;
188
+
189
+ imageWorkerManager: ImageWorkerManager | null = null;
190
+ hasCreateImageBitmap = false;
191
+ imageBitmapSupported = {
192
+ basic: false,
193
+ options: false,
194
+ full: false,
195
+ };
196
+
197
+ hasWorker = !!self.Worker;
198
+ /**
199
+ * Renderer that this texture manager is associated with
200
+ *
201
+ * @remarks
202
+ * This MUST be set before the texture manager is used. Otherwise errors
203
+ * will occur when using the texture manager.
204
+ */
205
+ renderer!: CoreRenderer;
206
+
207
+ /**
208
+ * The current frame time in milliseconds
209
+ *
210
+ * @remarks
211
+ * This is used to populate the `lastRenderableChangeTime` property of
212
+ * {@link Texture} instances when their renderable state changes.
213
+ *
214
+ * Set by stage via `updateFrameTime` method.
215
+ */
216
+ frameTime = 0;
217
+
218
+ constructor(stage: Stage, settings: TextureManagerSettings) {
219
+ super();
220
+
221
+ const { numImageWorkers, createImageBitmapSupport } = settings;
222
+ this.stage = stage;
223
+ this.platform = stage.platform;
224
+ this.numImageWorkers = numImageWorkers;
225
+
226
+ if (createImageBitmapSupport === 'auto') {
227
+ validateCreateImageBitmap(this.platform)
228
+ .then((result) => {
229
+ this.initialize(result);
230
+ })
231
+ .catch(() => {
232
+ console.warn(
233
+ '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
234
+ );
235
+
236
+ // initialized without image worker manager and createImageBitmap
237
+ this.initialized = true;
238
+ this.emit('initialized');
239
+ });
240
+ } else {
241
+ this.initialize({
242
+ basic: createImageBitmapSupport === 'basic',
243
+ options: createImageBitmapSupport === 'options',
244
+ full: createImageBitmapSupport === 'full',
245
+ });
246
+ }
247
+
248
+ this.registerTextureType('ImageTexture', ImageTexture);
249
+ this.registerTextureType('ColorTexture', ColorTexture);
250
+ this.registerTextureType('NoiseTexture', NoiseTexture);
251
+ this.registerTextureType('SubTexture', SubTexture);
252
+ this.registerTextureType('RenderTexture', RenderTexture);
253
+ }
254
+
255
+ registerTextureType<Type extends keyof TextureMap>(
256
+ textureType: Type,
257
+ textureClass: TextureMap[Type],
258
+ ): void {
259
+ this.txConstructors[textureType] = textureClass;
260
+ }
261
+
262
+ private initialize(support: CreateImageBitmapSupport) {
263
+ this.hasCreateImageBitmap =
264
+ support.basic || support.options || support.full;
265
+ this.imageBitmapSupported = support;
266
+
267
+ if (this.hasCreateImageBitmap === false) {
268
+ console.warn(
269
+ '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
270
+ );
271
+ }
272
+
273
+ if (
274
+ this.hasCreateImageBitmap === true &&
275
+ this.hasWorker === true &&
276
+ this.numImageWorkers > 0
277
+ ) {
278
+ this.imageWorkerManager = new ImageWorkerManager(
279
+ this.numImageWorkers,
280
+ support,
281
+ );
282
+ } else {
283
+ console.warn(
284
+ '[Lightning] Imageworker is 0 or not supported on this browser. Image loading will be slower.',
285
+ );
286
+ }
287
+
288
+ this.initialized = true;
289
+ this.emit('initialized');
290
+ }
291
+
292
+ /**
293
+ * Enqueue a texture for uploading to the GPU.
294
+ *
295
+ * @param texture - The texture to upload
296
+ */
297
+ enqueueUploadTexture(texture: Texture): void {
298
+ if (this.uploadTextureQueue.includes(texture) === false) {
299
+ this.uploadTextureQueue.push(texture);
300
+ }
301
+ }
302
+
303
+ /**
304
+ * Create a texture
305
+ *
306
+ * @param textureType - The type of texture to create
307
+ * @param props - The properties to use for the texture
308
+ */
309
+ createTexture<Type extends keyof TextureMap>(
310
+ textureType: Type,
311
+ props: ExtractProps<TextureMap[Type]>,
312
+ ): InstanceType<TextureMap[Type]> {
313
+ let texture: Texture | undefined;
314
+ const TextureClass = this.txConstructors[textureType];
315
+ if (!TextureClass) {
316
+ throw new Error(`Texture type "${textureType}" is not registered`);
317
+ }
318
+
319
+ const cacheKey = TextureClass.makeCacheKey(props as any);
320
+ if (cacheKey && this.keyCache.has(cacheKey)) {
321
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
322
+ texture = this.keyCache.get(cacheKey)!;
323
+ } else {
324
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
325
+ texture = new TextureClass(this, props as any);
326
+
327
+ if (cacheKey) {
328
+ this.initTextureToCache(texture, cacheKey);
329
+ }
330
+ }
331
+
332
+ return texture as InstanceType<TextureMap[Type]>;
333
+ }
334
+
335
+ orphanTexture(texture: Texture): void {
336
+ // if it is part of the download or upload queue, remove it
337
+ this.removeTextureFromQueue(texture);
338
+
339
+ if (texture.type === TextureType.subTexture) {
340
+ // ignore subtextures
341
+ return;
342
+ }
343
+
344
+ this.stage.txMemManager.addToOrphanedTextures(texture);
345
+ }
346
+
347
+ /**
348
+ * Override loadTexture to use the batched approach.
349
+ *
350
+ * @param texture - The texture to load
351
+ * @param immediate - Whether to prioritize the texture for immediate loading
352
+ */
353
+ loadTexture(texture: Texture, priority?: boolean): void {
354
+ this.stage.txMemManager.removeFromOrphanedTextures(texture);
355
+
356
+ if (texture.type === TextureType.subTexture) {
357
+ // ignore subtextures - they get loaded through their parent
358
+ return;
359
+ }
360
+
361
+ if (texture.state === 'loaded') {
362
+ // if the texture is already loaded, just return
363
+ return;
364
+ }
365
+
366
+ if (Texture.TRANSITIONAL_TEXTURE_STATES.includes(texture.state)) {
367
+ return;
368
+ }
369
+
370
+ // if we're not initialized, just queue the texture into the priority queue
371
+ if (this.initialized === false) {
372
+ this.priorityQueue.push(texture);
373
+ return;
374
+ }
375
+
376
+ // If the texture failed to load, we need to re-download it.
377
+ if (texture.state === 'failed') {
378
+ texture.free();
379
+ texture.freeTextureData();
380
+ }
381
+
382
+ texture.setState('loading');
383
+
384
+ // Get the texture data
385
+ texture
386
+ .getTextureData()
387
+ .then(() => {
388
+ if (texture.state !== 'fetched') {
389
+ texture.setState('failed');
390
+ return;
391
+ }
392
+
393
+ // For non-image textures, upload immediately
394
+ if (texture.type !== TextureType.image) {
395
+ this.uploadTexture(texture).catch((err) => {
396
+ console.error('Failed to upload non-image texture:', err);
397
+ texture.setState('failed');
398
+ });
399
+ } else {
400
+ // For image textures, queue for throttled upload
401
+ // If it's a priority texture, upload it immediately
402
+ if (priority === true) {
403
+ this.uploadTexture(texture).catch((err) => {
404
+ console.error('Failed to upload priority texture:', err);
405
+ texture.setState('failed');
406
+ });
407
+ } else {
408
+ this.enqueueUploadTexture(texture);
409
+ }
410
+ }
411
+ })
412
+ .catch((err) => {
413
+ console.error(err);
414
+ texture.setState('failed');
415
+ });
416
+ }
417
+
418
+ /**
419
+ * Upload a texture to the GPU
420
+ *
421
+ * @param texture Texture to upload
422
+ * @returns Promise that resolves when the texture is fully loaded
423
+ */
424
+ async uploadTexture(texture: Texture): Promise<void> {
425
+ if (
426
+ this.stage.txMemManager.doNotExceedCriticalThreshold === true &&
427
+ this.stage.txMemManager.criticalCleanupRequested === true
428
+ ) {
429
+ // we're at a critical memory threshold, don't upload textures
430
+ texture.setState('failed');
431
+ return;
432
+ }
433
+
434
+ const coreContext = texture.loadCtxTexture();
435
+ if (coreContext !== null && coreContext.state === 'loaded') {
436
+ texture.setState('loaded');
437
+ return;
438
+ }
439
+
440
+ await coreContext.load();
441
+ }
442
+
443
+ /**
444
+ * Check if a texture is being processed
445
+ */
446
+ isProcessingTexture(texture: Texture): boolean {
447
+ return this.uploadTextureQueue.includes(texture) === true;
448
+ }
449
+
450
+ /**
451
+ * Process a limited number of uploads.
452
+ *
453
+ * @param maxProcessingTime - The maximum processing time in milliseconds
454
+ */
455
+ async processSome(maxProcessingTime: number): Promise<void> {
456
+ if (this.initialized === false) {
457
+ return;
458
+ }
459
+
460
+ const platform = this.platform;
461
+ const startTime = platform.getTimeStamp();
462
+
463
+ // Process priority queue
464
+ while (
465
+ this.priorityQueue.length > 0 &&
466
+ platform.getTimeStamp() - startTime < maxProcessingTime
467
+ ) {
468
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
469
+ const texture = this.priorityQueue.pop()!;
470
+ try {
471
+ await texture.getTextureData();
472
+ await this.uploadTexture(texture);
473
+ } catch (error) {
474
+ console.error('Failed to process priority texture:', error);
475
+ // Continue with next texture instead of stopping entire queue
476
+ }
477
+ }
478
+
479
+ // Process uploads - await each upload to prevent GPU overload
480
+ while (
481
+ this.uploadTextureQueue.length > 0 &&
482
+ platform.getTimeStamp() - startTime < maxProcessingTime
483
+ ) {
484
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
485
+ const texture = this.uploadTextureQueue.shift()!;
486
+ try {
487
+ await this.uploadTexture(texture);
488
+ } catch (error) {
489
+ console.error('Failed to upload texture:', error);
490
+ // Continue with next texture instead of stopping entire queue
491
+ }
492
+ }
493
+ }
494
+
495
+ public hasUpdates(): boolean {
496
+ return this.uploadTextureQueue.length > 0;
497
+ }
498
+
499
+ /**
500
+ * Initialize a texture to the cache
501
+ *
502
+ * @param texture Texture to cache
503
+ * @param cacheKey Cache key for the texture
504
+ */
505
+ initTextureToCache(texture: Texture, cacheKey: string) {
506
+ const { keyCache, inverseKeyCache } = this;
507
+ keyCache.set(cacheKey, texture);
508
+ inverseKeyCache.set(texture, cacheKey);
509
+ }
510
+
511
+ /**
512
+ * Get a texture from the cache
513
+ *
514
+ * @param cacheKey
515
+ */
516
+ getTextureFromCache(cacheKey: string): Texture | undefined {
517
+ return this.keyCache.get(cacheKey);
518
+ }
519
+
520
+ /**
521
+ * Remove a texture from the cache
522
+ *
523
+ * @remarks
524
+ * Called by Texture Cleanup when a texture is freed.
525
+ *
526
+ * @param texture
527
+ */
528
+ removeTextureFromCache(texture: Texture) {
529
+ const { inverseKeyCache, keyCache } = this;
530
+ const cacheKey = inverseKeyCache.get(texture);
531
+ if (cacheKey) {
532
+ keyCache.delete(cacheKey);
533
+ }
534
+ }
535
+
536
+ /**
537
+ * Remove texture from the upload queue
538
+ *
539
+ * @param texture - The texture to remove
540
+ */
541
+ removeTextureFromQueue(texture: Texture): void {
542
+ const uploadIndex = this.uploadTextureQueue.indexOf(texture);
543
+ if (uploadIndex !== -1) {
544
+ this.uploadTextureQueue.splice(uploadIndex, 1);
545
+ }
546
+ }
547
+
548
+ /**
549
+ * Resolve a parent texture from the cache or fallback to the provided texture.
550
+ *
551
+ * @param texture - The provided texture to resolve.
552
+ * @returns The cached or provided texture.
553
+ */
554
+ resolveParentTexture(texture: ImageTexture): Texture {
555
+ if (!texture?.props) {
556
+ return texture;
557
+ }
558
+
559
+ const cacheKey = ImageTexture.makeCacheKey(texture.props);
560
+ const cachedTexture = cacheKey
561
+ ? this.getTextureFromCache(cacheKey)
562
+ : undefined;
563
+ return cachedTexture ?? texture;
564
+ }
565
+ }