@lightningjs/renderer 3.0.0-beta9 → 3.0.1

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 (541) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +230 -147
  4. package/dist/exports/canvas.d.ts +1 -1
  5. package/dist/exports/canvas.js +1 -1
  6. package/dist/exports/canvas.js.map +1 -1
  7. package/dist/exports/index.d.ts +5 -6
  8. package/dist/exports/index.js +3 -5
  9. package/dist/exports/index.js.map +1 -1
  10. package/dist/exports/platform.d.ts +7 -0
  11. package/dist/exports/platform.js +27 -0
  12. package/dist/exports/platform.js.map +1 -0
  13. package/dist/exports/webgl.d.ts +2 -1
  14. package/dist/exports/webgl.js +2 -1
  15. package/dist/exports/webgl.js.map +1 -1
  16. package/dist/src/common/CommonTypes.d.ts +15 -3
  17. package/dist/src/core/Autosizer.d.ts +35 -0
  18. package/dist/src/core/Autosizer.js +196 -0
  19. package/dist/src/core/Autosizer.js.map +1 -0
  20. package/dist/src/core/CoreNode.d.ts +107 -59
  21. package/dist/src/core/CoreNode.js +524 -282
  22. package/dist/src/core/CoreNode.js.map +1 -1
  23. package/dist/src/core/CoreTextNode.d.ts +73 -88
  24. package/dist/src/core/CoreTextNode.js +383 -236
  25. package/dist/src/core/CoreTextNode.js.map +1 -1
  26. package/dist/src/core/CoreTextureManager.d.ts +19 -17
  27. package/dist/src/core/CoreTextureManager.js +52 -120
  28. package/dist/src/core/CoreTextureManager.js.map +1 -1
  29. package/dist/src/core/Stage.d.ts +63 -9
  30. package/dist/src/core/Stage.js +233 -133
  31. package/dist/src/core/Stage.js.map +1 -1
  32. package/dist/src/core/TextureError.d.ts +11 -0
  33. package/dist/src/core/TextureError.js +37 -0
  34. package/dist/src/core/TextureError.js.map +1 -0
  35. package/dist/src/core/TextureMemoryManager.d.ts +2 -4
  36. package/dist/src/core/TextureMemoryManager.js +80 -113
  37. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  38. package/dist/src/core/animations/CoreAnimation.d.ts +3 -3
  39. package/dist/src/core/animations/CoreAnimation.js +3 -3
  40. package/dist/src/core/animations/CoreAnimation.js.map +1 -1
  41. package/dist/src/core/animations/CoreAnimationController.d.ts +1 -1
  42. package/dist/src/core/animations/CoreAnimationController.js +4 -2
  43. package/dist/src/core/animations/CoreAnimationController.js.map +1 -1
  44. package/dist/src/core/lib/ImageWorker.js +1 -1
  45. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  46. package/dist/src/core/lib/WebGlContextWrapper.d.ts +69 -97
  47. package/dist/src/core/lib/WebGlContextWrapper.js +192 -152
  48. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  49. package/dist/src/core/lib/collectionUtils.d.ts +4 -0
  50. package/dist/src/core/lib/collectionUtils.js +72 -0
  51. package/dist/src/core/lib/collectionUtils.js.map +1 -0
  52. package/dist/src/core/lib/colorCache.d.ts +1 -0
  53. package/dist/src/core/lib/colorCache.js +19 -0
  54. package/dist/src/core/lib/colorCache.js.map +1 -0
  55. package/dist/src/core/lib/colorParser.d.ts +21 -0
  56. package/dist/src/core/lib/colorParser.js +72 -0
  57. package/dist/src/core/lib/colorParser.js.map +1 -0
  58. package/dist/src/core/lib/textureCompression.d.ts +14 -2
  59. package/dist/src/core/lib/textureCompression.js +311 -67
  60. package/dist/src/core/lib/textureCompression.js.map +1 -1
  61. package/dist/src/core/lib/utils.d.ts +6 -6
  62. package/dist/src/core/lib/utils.js +21 -65
  63. package/dist/src/core/lib/utils.js.map +1 -1
  64. package/dist/src/core/lib/validateImageBitmap.d.ts +1 -2
  65. package/dist/src/core/lib/validateImageBitmap.js +4 -4
  66. package/dist/src/core/lib/validateImageBitmap.js.map +1 -1
  67. package/dist/src/core/platform.d.ts +10 -0
  68. package/dist/src/core/platform.js +84 -0
  69. package/dist/src/core/platform.js.map +1 -0
  70. package/dist/src/core/platforms/GlContextWrapper.d.ts +136 -0
  71. package/{src/core/text-rendering/TextRenderingUtils.ts → dist/src/core/platforms/GlContextWrapper.js} +32 -36
  72. package/dist/src/core/platforms/GlContextWrapper.js.map +1 -0
  73. package/dist/src/core/platforms/Platform.d.ts +78 -12
  74. package/dist/src/core/platforms/Platform.js +18 -0
  75. package/dist/src/core/platforms/Platform.js.map +1 -1
  76. package/dist/src/core/platforms/web/WebGlContextWrapper.d.ts +776 -0
  77. package/dist/src/core/platforms/web/WebGlContextWrapper.js +1208 -0
  78. package/dist/src/core/platforms/web/WebGlContextWrapper.js.map +1 -0
  79. package/dist/src/core/platforms/web/WebPlatform.d.ts +17 -2
  80. package/dist/src/core/platforms/web/WebPlatform.js +158 -13
  81. package/dist/src/core/platforms/web/WebPlatform.js.map +1 -1
  82. package/dist/src/core/platforms/web/WebPlatformChrome50.d.ts +19 -0
  83. package/dist/src/core/platforms/web/WebPlatformChrome50.js +54 -0
  84. package/dist/src/core/platforms/web/WebPlatformChrome50.js.map +1 -0
  85. package/dist/src/core/platforms/web/WebPlatformLegacy.d.ts +20 -0
  86. package/dist/src/core/platforms/web/WebPlatformLegacy.js +105 -0
  87. package/dist/src/core/platforms/web/WebPlatformLegacy.js.map +1 -0
  88. package/dist/src/core/platforms/web/WebPlatformNext.d.ts +21 -0
  89. package/dist/src/core/platforms/web/WebPlatformNext.js +52 -0
  90. package/dist/src/core/platforms/web/WebPlatformNext.js.map +1 -0
  91. package/dist/src/core/platforms/web/lib/ImageWorker.d.ts +21 -0
  92. package/dist/src/core/platforms/web/lib/ImageWorker.js +136 -0
  93. package/dist/src/core/platforms/web/lib/ImageWorker.js.map +1 -0
  94. package/dist/src/core/platforms/web/lib/ImageWorkerDefault.d.ts +6 -0
  95. package/dist/src/core/platforms/web/lib/ImageWorkerDefault.js +92 -0
  96. package/dist/src/core/platforms/web/lib/ImageWorkerDefault.js.map +1 -0
  97. package/dist/src/core/platforms/web/lib/ImageWorkerLegacy.d.ts +1 -0
  98. package/dist/src/core/platforms/web/lib/ImageWorkerLegacy.js +63 -0
  99. package/dist/src/core/platforms/web/lib/ImageWorkerLegacy.js.map +1 -0
  100. package/dist/src/core/platforms/web/lib/ImageWorkerNoOptions.d.ts +7 -0
  101. package/dist/src/core/platforms/web/lib/ImageWorkerNoOptions.js +75 -0
  102. package/dist/src/core/platforms/web/lib/ImageWorkerNoOptions.js.map +1 -0
  103. package/dist/src/core/platforms/web/lib/createImageBitmap.d.ts +1 -0
  104. package/dist/src/core/platforms/web/lib/createImageBitmap.js +27 -0
  105. package/dist/src/core/platforms/web/lib/createImageBitmap.js.map +1 -0
  106. package/dist/src/core/platforms/web/lib/textureCompression.d.ts +26 -0
  107. package/dist/src/core/platforms/web/lib/textureCompression.js +301 -0
  108. package/dist/src/core/platforms/web/lib/textureCompression.js.map +1 -0
  109. package/dist/src/core/platforms/web/lib/textureSvg.d.ts +7 -0
  110. package/dist/src/core/platforms/web/lib/textureSvg.js +51 -0
  111. package/dist/src/core/platforms/web/lib/textureSvg.js.map +1 -0
  112. package/dist/src/core/platforms/web/lib/utils.d.ts +5 -0
  113. package/dist/src/core/platforms/web/lib/utils.js +86 -0
  114. package/dist/src/core/platforms/web/lib/utils.js.map +1 -0
  115. package/dist/src/core/renderers/CoreContextTexture.d.ts +2 -1
  116. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  117. package/dist/src/core/renderers/CoreRenderer.d.ts +4 -40
  118. package/dist/src/core/renderers/CoreRenderer.js +3 -4
  119. package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
  120. package/dist/src/core/renderers/CoreShader.d.ts +9 -0
  121. package/{src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts → dist/src/core/renderers/CoreShader.js} +28 -32
  122. package/dist/src/core/renderers/CoreShader.js.map +1 -0
  123. package/dist/src/core/renderers/CoreShaderNode.d.ts +10 -0
  124. package/dist/src/core/renderers/CoreShaderNode.js +19 -2
  125. package/dist/src/core/renderers/CoreShaderNode.js.map +1 -1
  126. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.d.ts +33 -0
  127. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +250 -0
  128. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +1 -0
  129. package/dist/src/core/renderers/canvas/CanvasCoreTexture.d.ts +17 -0
  130. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +125 -0
  131. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +1 -0
  132. package/dist/src/core/renderers/canvas/CanvasRenderer.d.ts +5 -6
  133. package/dist/src/core/renderers/canvas/CanvasRenderer.js +67 -91
  134. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -1
  135. package/dist/src/core/renderers/canvas/CanvasShaderNode.d.ts +1 -2
  136. package/dist/src/core/renderers/canvas/CanvasShaderNode.js +5 -4
  137. package/dist/src/core/renderers/canvas/CanvasShaderNode.js.map +1 -1
  138. package/dist/src/core/renderers/canvas/CanvasTexture.d.ts +3 -2
  139. package/dist/src/core/renderers/canvas/CanvasTexture.js +17 -13
  140. package/dist/src/core/renderers/canvas/CanvasTexture.js.map +1 -1
  141. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.d.ts +13 -0
  142. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.js +113 -192
  143. package/dist/src/core/renderers/canvas/internal/C2DShaderUtils.js.map +1 -1
  144. package/dist/src/core/renderers/canvas/internal/ColorUtils.d.ts +0 -2
  145. package/dist/src/core/renderers/canvas/internal/ColorUtils.js +0 -14
  146. package/dist/src/core/renderers/canvas/internal/ColorUtils.js.map +1 -1
  147. package/dist/src/core/renderers/canvas/shaders/UnsupportedShader.d.ts +10 -0
  148. package/{src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts → dist/src/core/renderers/canvas/shaders/UnsupportedShader.js} +43 -40
  149. package/dist/src/core/renderers/canvas/shaders/UnsupportedShader.js.map +1 -0
  150. package/dist/src/core/renderers/webgl/SdfRenderOp.d.ts +33 -0
  151. package/dist/src/core/renderers/webgl/SdfRenderOp.js +98 -0
  152. package/dist/src/core/renderers/webgl/SdfRenderOp.js.map +1 -0
  153. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.d.ts +12 -0
  154. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js +58 -0
  155. package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js.map +1 -0
  156. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.d.ts +9 -0
  157. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +38 -0
  158. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -0
  159. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +69 -0
  160. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +272 -0
  161. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -0
  162. package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.d.ts +34 -0
  163. package/dist/src/core/renderers/webgl/{WebGlRenderOp.js → WebGlCoreRenderOp.js} +43 -47
  164. package/dist/src/core/renderers/webgl/WebGlCoreRenderOp.js.map +1 -0
  165. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +133 -0
  166. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +649 -0
  167. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -0
  168. package/dist/src/core/renderers/webgl/WebGlCoreShader.d.ts +78 -0
  169. package/dist/src/core/renderers/webgl/WebGlCoreShader.destroy.d.ts +1 -0
  170. package/dist/src/core/renderers/webgl/WebGlCoreShader.destroy.js +2 -0
  171. package/dist/src/core/renderers/webgl/WebGlCoreShader.destroy.js.map +1 -0
  172. package/dist/src/core/renderers/webgl/WebGlCoreShader.js +202 -0
  173. package/dist/src/core/renderers/webgl/WebGlCoreShader.js.map +1 -0
  174. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.d.ts +4 -2
  175. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js +14 -6
  176. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js.map +1 -1
  177. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.d.ts +15 -2
  178. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js +34 -5
  179. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js.map +1 -1
  180. package/dist/src/core/renderers/webgl/WebGlCtxTexture.d.ts +19 -9
  181. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js +101 -49
  182. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js.map +1 -1
  183. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +11 -23
  184. package/dist/src/core/renderers/webgl/WebGlRenderer.js +124 -133
  185. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -1
  186. package/dist/src/core/renderers/webgl/WebGlShaderNode.d.ts +4 -6
  187. package/dist/src/core/renderers/webgl/WebGlShaderNode.js +3 -3
  188. package/dist/src/core/renderers/webgl/WebGlShaderNode.js.map +1 -1
  189. package/dist/src/core/renderers/webgl/WebGlShaderProgram.d.ts +7 -7
  190. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js +60 -38
  191. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js.map +1 -1
  192. package/dist/src/core/renderers/webgl/internal/RendererUtils.d.ts +4 -4
  193. package/dist/src/core/renderers/webgl/internal/RendererUtils.js +1 -2
  194. package/dist/src/core/renderers/webgl/internal/RendererUtils.js.map +1 -1
  195. package/dist/src/core/renderers/webgl/internal/ShaderUtils.d.ts +3 -3
  196. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +38 -37
  197. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js.map +1 -1
  198. package/dist/src/core/renderers/webgl/shaders/DefaultShader.d.ts +9 -0
  199. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +84 -0
  200. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js.map +1 -0
  201. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.d.ts +10 -0
  202. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +108 -0
  203. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js.map +1 -0
  204. package/dist/src/core/renderers/webgl/shaders/DynamicShader.d.ts +29 -0
  205. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +408 -0
  206. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js.map +1 -0
  207. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.d.ts +28 -0
  208. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +126 -0
  209. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js.map +1 -0
  210. package/dist/src/core/renderers/webgl/shaders/SdfShader.d.ts +47 -0
  211. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +148 -0
  212. package/dist/src/core/renderers/webgl/shaders/SdfShader.js.map +1 -0
  213. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.d.ts +31 -0
  214. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +71 -0
  215. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js.map +1 -0
  216. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.d.ts +30 -0
  217. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +58 -0
  218. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js.map +1 -0
  219. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.d.ts +31 -0
  220. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +71 -0
  221. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js.map +1 -0
  222. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.d.ts +31 -0
  223. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +71 -0
  224. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js.map +1 -0
  225. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.d.ts +31 -0
  226. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +71 -0
  227. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js.map +1 -0
  228. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.d.ts +9 -0
  229. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js +136 -0
  230. package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js.map +1 -0
  231. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.d.ts +36 -0
  232. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +85 -0
  233. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js.map +1 -0
  234. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.d.ts +45 -0
  235. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +104 -0
  236. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js.map +1 -0
  237. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.d.ts +22 -0
  238. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +45 -0
  239. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js.map +1 -0
  240. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.d.ts +58 -0
  241. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +80 -0
  242. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js.map +1 -0
  243. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.d.ts +34 -0
  244. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +113 -0
  245. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +1 -0
  246. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.d.ts +40 -0
  247. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +126 -0
  248. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +1 -0
  249. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.d.ts +61 -0
  250. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +127 -0
  251. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js.map +1 -0
  252. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.d.ts +40 -0
  253. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +71 -0
  254. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js.map +1 -0
  255. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts +115 -0
  256. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js +61 -0
  257. package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map +1 -0
  258. package/dist/src/core/shaders/canvas/Border.d.ts +8 -2
  259. package/dist/src/core/shaders/canvas/Border.js +64 -25
  260. package/dist/src/core/shaders/canvas/Border.js.map +1 -1
  261. package/dist/src/core/shaders/canvas/HolePunch.js +4 -3
  262. package/dist/src/core/shaders/canvas/HolePunch.js.map +1 -1
  263. package/dist/src/core/shaders/canvas/LinearGradient.js +7 -5
  264. package/dist/src/core/shaders/canvas/LinearGradient.js.map +1 -1
  265. package/dist/src/core/shaders/canvas/RadialGradient.js +12 -10
  266. package/dist/src/core/shaders/canvas/RadialGradient.js.map +1 -1
  267. package/dist/src/core/shaders/canvas/Rounded.js +3 -3
  268. package/dist/src/core/shaders/canvas/Rounded.js.map +1 -1
  269. package/dist/src/core/shaders/canvas/RoundedWithBorder.d.ts +6 -3
  270. package/dist/src/core/shaders/canvas/RoundedWithBorder.js +41 -11
  271. package/dist/src/core/shaders/canvas/RoundedWithBorder.js.map +1 -1
  272. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.d.ts +2 -3
  273. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js +46 -9
  274. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js.map +1 -1
  275. package/dist/src/core/shaders/canvas/RoundedWithShadow.js +6 -5
  276. package/dist/src/core/shaders/canvas/RoundedWithShadow.js.map +1 -1
  277. package/dist/src/core/shaders/canvas/Shadow.js +4 -2
  278. package/dist/src/core/shaders/canvas/Shadow.js.map +1 -1
  279. package/dist/src/core/shaders/canvas/utils/render.d.ts +1 -1
  280. package/dist/src/core/shaders/canvas/utils/render.js +31 -18
  281. package/dist/src/core/shaders/canvas/utils/render.js.map +1 -1
  282. package/dist/src/core/shaders/templates/BorderTemplate.d.ts +11 -1
  283. package/dist/src/core/shaders/templates/BorderTemplate.js +30 -10
  284. package/dist/src/core/shaders/templates/BorderTemplate.js.map +1 -1
  285. package/dist/src/core/shaders/templates/HolePunchTemplate.d.ts +2 -2
  286. package/dist/src/core/shaders/templates/HolePunchTemplate.js +2 -2
  287. package/dist/src/core/shaders/templates/HolePunchTemplate.js.map +1 -1
  288. package/dist/src/core/shaders/templates/RadialGradientTemplate.d.ts +8 -6
  289. package/dist/src/core/shaders/templates/RadialGradientTemplate.js +2 -2
  290. package/dist/src/core/shaders/templates/RadialGradientTemplate.js.map +1 -1
  291. package/dist/src/core/shaders/webgl/Border.js +138 -84
  292. package/dist/src/core/shaders/webgl/Border.js.map +1 -1
  293. package/dist/src/core/shaders/webgl/Default.js +46 -47
  294. package/dist/src/core/shaders/webgl/Default.js.map +1 -1
  295. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  296. package/dist/src/core/shaders/webgl/HolePunch.js +34 -34
  297. package/dist/src/core/shaders/webgl/HolePunch.js.map +1 -1
  298. package/dist/src/core/shaders/webgl/LinearGradient.js +60 -36
  299. package/dist/src/core/shaders/webgl/LinearGradient.js.map +1 -1
  300. package/dist/src/core/shaders/webgl/RadialGradient.js +60 -37
  301. package/dist/src/core/shaders/webgl/RadialGradient.js.map +1 -1
  302. package/dist/src/core/shaders/webgl/Rounded.js +74 -72
  303. package/dist/src/core/shaders/webgl/Rounded.js.map +1 -1
  304. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +172 -113
  305. package/dist/src/core/shaders/webgl/RoundedWithBorder.js.map +1 -1
  306. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +191 -132
  307. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js.map +1 -1
  308. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +57 -55
  309. package/dist/src/core/shaders/webgl/RoundedWithShadow.js.map +1 -1
  310. package/dist/src/core/shaders/webgl/SdfShader.d.ts +0 -2
  311. package/dist/src/core/shaders/webgl/SdfShader.js +56 -66
  312. package/dist/src/core/shaders/webgl/SdfShader.js.map +1 -1
  313. package/dist/src/core/shaders/webgl/Shadow.js +89 -83
  314. package/dist/src/core/shaders/webgl/Shadow.js.map +1 -1
  315. package/dist/src/core/text-rendering/CanvasFontHandler.d.ts +59 -0
  316. package/dist/src/core/text-rendering/CanvasFontHandler.js +224 -0
  317. package/dist/src/core/text-rendering/CanvasFontHandler.js.map +1 -0
  318. package/dist/src/core/text-rendering/CanvasTextRenderer.d.ts +17 -0
  319. package/dist/src/core/text-rendering/CanvasTextRenderer.js +157 -0
  320. package/dist/src/core/text-rendering/CanvasTextRenderer.js.map +1 -0
  321. package/dist/src/core/text-rendering/SdfFontHandler.d.ts +182 -0
  322. package/dist/src/core/text-rendering/SdfFontHandler.js +379 -0
  323. package/dist/src/core/text-rendering/SdfFontHandler.js.map +1 -0
  324. package/dist/src/core/text-rendering/SdfTextRenderer.d.ts +17 -0
  325. package/dist/src/core/text-rendering/SdfTextRenderer.js +301 -0
  326. package/dist/src/core/text-rendering/SdfTextRenderer.js.map +1 -0
  327. package/dist/src/core/text-rendering/TextLayoutEngine.d.ts +18 -0
  328. package/dist/src/core/text-rendering/TextLayoutEngine.js +380 -0
  329. package/dist/src/core/text-rendering/TextLayoutEngine.js.map +1 -0
  330. package/dist/src/core/text-rendering/TextRenderer.d.ts +383 -0
  331. package/{src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts → dist/src/core/text-rendering/TextRenderer.js} +20 -38
  332. package/dist/src/core/text-rendering/TextRenderer.js.map +1 -0
  333. package/dist/src/core/text-rendering/TextTextureRendererUtils.js.map +1 -1
  334. package/dist/src/core/text-rendering/Utils.d.ts +30 -0
  335. package/dist/src/core/text-rendering/Utils.js +84 -0
  336. package/dist/src/core/text-rendering/Utils.js.map +1 -0
  337. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +2 -2
  338. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  339. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +0 -5
  340. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  341. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.d.ts +1 -7
  342. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +2 -50
  343. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
  344. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +3 -2
  345. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +87 -46
  346. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  347. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.d.ts +1 -1
  348. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +8 -66
  349. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  350. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +4 -14
  351. package/dist/src/core/text-rendering/renderers/TextRenderer.js +0 -3
  352. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  353. package/dist/src/core/textures/ColorTexture.d.ts +1 -1
  354. package/dist/src/core/textures/ColorTexture.js +3 -4
  355. package/dist/src/core/textures/ColorTexture.js.map +1 -1
  356. package/dist/src/core/textures/ImageTexture.d.ts +33 -14
  357. package/dist/src/core/textures/ImageTexture.js +46 -125
  358. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  359. package/dist/src/core/textures/NoiseTexture.d.ts +3 -3
  360. package/dist/src/core/textures/NoiseTexture.js +8 -8
  361. package/dist/src/core/textures/NoiseTexture.js.map +1 -1
  362. package/dist/src/core/textures/RenderTexture.d.ts +7 -7
  363. package/dist/src/core/textures/RenderTexture.js +12 -12
  364. package/dist/src/core/textures/RenderTexture.js.map +1 -1
  365. package/dist/src/core/textures/SubTexture.d.ts +6 -8
  366. package/dist/src/core/textures/SubTexture.js +22 -40
  367. package/dist/src/core/textures/SubTexture.js.map +1 -1
  368. package/dist/src/core/textures/Texture.d.ts +74 -15
  369. package/dist/src/core/textures/Texture.js +131 -19
  370. package/dist/src/core/textures/Texture.js.map +1 -1
  371. package/dist/src/core/utils.d.ts +2 -1
  372. package/dist/src/core/utils.js +1 -1
  373. package/dist/src/core/utils.js.map +1 -1
  374. package/dist/src/main-api/DynamicShaderController.d.ts +29 -0
  375. package/dist/src/main-api/DynamicShaderController.js +58 -0
  376. package/dist/src/main-api/DynamicShaderController.js.map +1 -0
  377. package/dist/src/main-api/Inspector.d.ts +129 -1
  378. package/dist/src/main-api/Inspector.js +462 -23
  379. package/dist/src/main-api/Inspector.js.map +1 -1
  380. package/dist/src/main-api/Renderer.d.ts +223 -41
  381. package/dist/src/main-api/Renderer.js +107 -62
  382. package/dist/src/main-api/Renderer.js.map +1 -1
  383. package/dist/src/main-api/ShaderController.d.ts +31 -0
  384. package/dist/src/main-api/ShaderController.js +37 -0
  385. package/dist/src/main-api/ShaderController.js.map +1 -0
  386. package/dist/src/utils.d.ts +0 -2
  387. package/dist/src/utils.js +0 -36
  388. package/dist/src/utils.js.map +1 -1
  389. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  390. package/exports/canvas-shaders.ts +28 -28
  391. package/exports/canvas.ts +45 -45
  392. package/exports/index.ts +90 -90
  393. package/exports/inspector.ts +24 -24
  394. package/exports/platform.ts +31 -0
  395. package/exports/utils.ts +50 -50
  396. package/exports/webgl-shaders.ts +28 -28
  397. package/exports/webgl.ts +52 -50
  398. package/package.json +16 -15
  399. package/src/common/CommonTypes.ts +163 -146
  400. package/src/common/EventEmitter.ts +77 -77
  401. package/src/common/IAnimationController.ts +92 -92
  402. package/src/common/IEventEmitter.ts +28 -28
  403. package/src/core/Autosizer.ts +224 -0
  404. package/src/core/CoreNode.test.ts +365 -202
  405. package/src/core/CoreNode.ts +2785 -2489
  406. package/src/core/CoreShaderManager.ts +188 -188
  407. package/src/core/CoreTextNode.test.ts +311 -0
  408. package/src/core/CoreTextNode.ts +607 -451
  409. package/src/core/CoreTextureManager.ts +484 -548
  410. package/src/core/Stage.ts +927 -800
  411. package/src/core/TextureError.ts +46 -0
  412. package/src/core/TextureMemoryManager.ts +418 -462
  413. package/src/core/animations/AnimationManager.ts +38 -38
  414. package/src/core/animations/CoreAnimation.ts +290 -291
  415. package/src/core/animations/CoreAnimationController.ts +169 -166
  416. package/src/core/lib/ContextSpy.ts +41 -41
  417. package/src/core/lib/Matrix3d.ts +244 -244
  418. package/src/core/lib/RenderCoords.ts +71 -71
  419. package/src/core/lib/collectionUtils.ts +83 -0
  420. package/src/core/lib/colorCache.ts +20 -0
  421. package/src/core/{renderers/canvas/internal/ColorUtils.ts → lib/colorParser.ts} +85 -85
  422. package/src/core/lib/utils.ts +337 -390
  423. package/src/core/platforms/GlContextWrapper.ts +291 -0
  424. package/src/core/platforms/Platform.ts +176 -77
  425. package/src/core/{lib → platforms/web}/WebGlContextWrapper.ts +1547 -1368
  426. package/src/core/platforms/web/WebPlatform.ts +306 -84
  427. package/src/core/platforms/web/WebPlatformChrome50.ts +63 -0
  428. package/src/core/platforms/web/WebPlatformLegacy.ts +150 -0
  429. package/src/core/platforms/web/WebPlatformNext.ts +57 -0
  430. package/src/core/platforms/web/lib/ImageWorker.ts +192 -0
  431. package/src/core/platforms/web/lib/ImageWorkerDefault.ts +117 -0
  432. package/src/core/platforms/web/lib/ImageWorkerLegacy.ts +87 -0
  433. package/src/core/platforms/web/lib/ImageWorkerNoOptions.ts +99 -0
  434. package/src/core/platforms/web/lib/createImageBitmap.ts +40 -0
  435. package/src/core/platforms/web/lib/textureCompression.ts +391 -0
  436. package/src/core/{lib → platforms/web/lib}/textureSvg.ts +66 -78
  437. package/src/core/platforms/web/lib/utils.ts +105 -0
  438. package/src/core/renderers/CoreContextTexture.ts +44 -43
  439. package/src/core/renderers/CoreRenderOp.ts +22 -22
  440. package/src/core/renderers/CoreRenderer.ts +71 -110
  441. package/src/core/renderers/CoreShaderNode.ts +202 -175
  442. package/src/core/renderers/CoreShaderProgram.ts +23 -23
  443. package/src/core/renderers/canvas/CanvasRenderer.ts +258 -302
  444. package/src/core/renderers/canvas/CanvasShaderNode.ts +95 -96
  445. package/src/core/renderers/canvas/CanvasTexture.ts +160 -156
  446. package/src/core/renderers/webgl/SdfRenderOp.ts +106 -0
  447. package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +89 -86
  448. package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +95 -50
  449. package/src/core/renderers/webgl/WebGlCtxTexture.test.ts +113 -0
  450. package/src/core/renderers/webgl/WebGlCtxTexture.ts +350 -298
  451. package/src/core/renderers/webgl/WebGlRenderer.ts +727 -747
  452. package/src/core/renderers/webgl/WebGlShaderNode.ts +430 -435
  453. package/src/core/renderers/webgl/WebGlShaderProgram.ts +364 -341
  454. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  455. package/src/core/renderers/webgl/internal/RendererUtils.ts +150 -155
  456. package/src/core/renderers/webgl/internal/ShaderUtils.ts +283 -281
  457. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  458. package/src/core/shaders/canvas/Border.ts +132 -78
  459. package/src/core/shaders/canvas/HolePunch.ts +56 -62
  460. package/src/core/shaders/canvas/LinearGradient.ts +73 -71
  461. package/src/core/shaders/canvas/RadialGradient.ts +96 -99
  462. package/src/core/shaders/canvas/Rounded.ts +55 -55
  463. package/src/core/shaders/canvas/RoundedWithBorder.ts +122 -74
  464. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +136 -90
  465. package/src/core/shaders/canvas/RoundedWithShadow.ts +71 -70
  466. package/src/core/shaders/canvas/Shadow.ts +54 -52
  467. package/src/core/shaders/canvas/utils/render.ts +160 -151
  468. package/src/core/shaders/templates/BorderTemplate.ts +145 -115
  469. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
  470. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
  471. package/src/core/shaders/templates/RadialGradientTemplate.ts +83 -81
  472. package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
  473. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
  474. package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
  475. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
  476. package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
  477. package/src/core/shaders/utils.ts +46 -46
  478. package/src/core/shaders/webgl/Border.ts +169 -116
  479. package/src/core/shaders/webgl/Default.ts +88 -89
  480. package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
  481. package/src/core/shaders/webgl/HolePunch.ts +75 -75
  482. package/src/core/shaders/webgl/LinearGradient.ts +106 -82
  483. package/src/core/shaders/webgl/RadialGradient.ts +108 -85
  484. package/src/core/shaders/webgl/Rounded.ts +115 -117
  485. package/src/core/shaders/webgl/RoundedWithBorder.ts +210 -155
  486. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +234 -175
  487. package/src/core/shaders/webgl/RoundedWithShadow.ts +96 -98
  488. package/src/core/shaders/webgl/SdfShader.ts +122 -134
  489. package/src/core/shaders/webgl/Shadow.ts +121 -115
  490. package/src/core/text-rendering/CanvasFontHandler.ts +304 -0
  491. package/src/core/text-rendering/CanvasTextRenderer.ts +255 -0
  492. package/src/core/text-rendering/SdfFontHandler.ts +581 -0
  493. package/src/core/text-rendering/SdfTextRenderer.ts +403 -0
  494. package/src/core/text-rendering/TextLayoutEngine.ts +672 -0
  495. package/src/core/text-rendering/TextRenderer.ts +444 -0
  496. package/src/core/text-rendering/Utils.ts +99 -0
  497. package/src/core/text-rendering/tests/TextLayoutEngine.test.ts +453 -0
  498. package/src/core/textures/ColorTexture.ts +104 -102
  499. package/src/core/textures/ImageTexture.ts +292 -418
  500. package/src/core/textures/NoiseTexture.ts +106 -104
  501. package/src/core/textures/RenderTexture.ts +87 -85
  502. package/src/core/textures/SubTexture.ts +184 -205
  503. package/src/core/textures/Texture.ts +524 -381
  504. package/src/core/utils.ts +229 -227
  505. package/src/env.d.ts +7 -7
  506. package/src/main-api/INode.ts +100 -100
  507. package/src/main-api/Inspector.ts +1278 -569
  508. package/src/main-api/Renderer.ts +1030 -818
  509. package/src/main-api/utils.ts +45 -45
  510. package/src/utils.ts +220 -267
  511. package/COPYING +0 -1
  512. package/dist/src/core/renderers/webgl/WebGlRenderOp.d.ts +0 -44
  513. package/dist/src/core/renderers/webgl/WebGlRenderOp.js.map +0 -1
  514. package/src/core/lib/ImageWorker.ts +0 -286
  515. package/src/core/lib/textureCompression.ts +0 -152
  516. package/src/core/lib/validateImageBitmap.ts +0 -87
  517. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +0 -220
  518. package/src/core/renderers/webgl/WebGlRenderOp.ts +0 -161
  519. package/src/core/text-rendering/TextTextureRendererUtils.ts +0 -263
  520. package/src/core/text-rendering/TrFontManager.ts +0 -183
  521. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +0 -176
  522. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +0 -139
  523. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +0 -173
  524. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +0 -171
  525. package/src/core/text-rendering/font-face-types/TrFontFace.ts +0 -187
  526. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +0 -94
  527. package/src/core/text-rendering/font-face-types/utils.ts +0 -39
  528. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +0 -514
  529. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +0 -863
  530. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +0 -793
  531. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +0 -48
  532. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +0 -66
  533. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +0 -52
  534. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +0 -117
  535. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +0 -133
  536. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +0 -497
  537. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +0 -49
  538. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +0 -52
  539. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +0 -205
  540. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +0 -93
  541. package/src/core/text-rendering/renderers/TextRenderer.ts +0 -567
@@ -1,462 +1,418 @@
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 2024 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
- import { isProductionEnvironment } from '../utils.js';
20
- import type { Stage } from './Stage.js';
21
- import { Texture, TextureType, type TextureState } from './textures/Texture.js';
22
- import { bytesToMb } from './utils.js';
23
-
24
- export interface TextureMemoryManagerSettings {
25
- /**
26
- * Critical Threshold (in bytes)
27
- *
28
- * @remarks
29
- * When the amount of memory used by textures exceeds this threshold,
30
- * the Renderer will immediately trigger a Texture Cleanup towards the
31
- * Target Threshold Level.
32
- *
33
- * When set to `0`, the Texture Memory Manager is disabled.
34
- *
35
- * @defaultValue `124e6` (118 MB)
36
- */
37
- criticalThreshold: number;
38
-
39
- /**
40
- * Target Threshold Level (as fraction of Critical Threshold)
41
- *
42
- * @remarks
43
- * This value is the fractional level of the Critical Threshold that the
44
- * Texture Memory Manager will attempt to maintain by cleaning up textures.
45
- * The Texture Memory Manager will attempt to keep the memory usage below
46
- * this level by freeing up non-renderable textures.
47
- *
48
- * Valid Range: 0.0 - 1.0
49
- *
50
- * @defaultValue `0.5`
51
- */
52
- targetThresholdLevel: number;
53
-
54
- /**
55
- * Interval between non-aggressive Texture Cleanups (in milliseconds)
56
- *
57
- * @remarks
58
- * Texture Memory Manager will perform a non aggressive Texture Cleanup no more
59
- * frequently than this interval when the scene becomes idle.
60
- *
61
- * @defaultValue `5,000` (5 seconds)
62
- */
63
- cleanupInterval: number;
64
-
65
- /**
66
- * Whether or not to log debug information
67
- *
68
- * @defaultValue `false`
69
- */
70
- debugLogging: boolean;
71
-
72
- /**
73
- * Baseline memory allocation for the Texture Memory Manager
74
- *
75
- * @remarks
76
- * Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
77
- * This will be used on top of the memory used by textures to determine when to trigger a cleanup.
78
- *
79
- * @defaultValue `25e6` (25 MB)
80
- */
81
- baselineMemoryAllocation: number;
82
-
83
- /**
84
- * Do not exceed critical threshold
85
- *
86
- * @defaultValue `false`
87
- */
88
- doNotExceedCriticalThreshold: boolean;
89
- }
90
-
91
- export interface MemoryInfo {
92
- criticalThreshold: number;
93
- targetThreshold: number;
94
- renderableMemUsed: number;
95
- memUsed: number;
96
- renderableTexturesLoaded: number;
97
- loadedTextures: number;
98
- baselineMemoryAllocation: number;
99
- }
100
-
101
- /**
102
- * LRU (Least Recently Used) style memory manager for textures
103
- *
104
- * @remarks
105
- * This class is responsible for managing the memory usage of textures
106
- * in the Renderer. It keeps track of the memory used by each texture
107
- * and triggers a cleanup when the memory usage exceeds a critical
108
- * threshold (`criticalThreshold`).
109
- *
110
- * The cleanup process will free up non-renderable textures until the
111
- * memory usage is below a target threshold (`targetThresholdLevel`).
112
- *
113
- * The memory manager's clean up process will also be triggered when the
114
- * scene is idle for a certain amount of time (`cleanupInterval`).
115
- */
116
- export class TextureMemoryManager {
117
- private memUsed = 0;
118
- private loadedTextures: Map<Texture, number> = new Map();
119
- private orphanedTextures: Texture[] = [];
120
- private criticalThreshold: number = 124e6;
121
- private targetThreshold: number = 0.5;
122
- private cleanupInterval: number = 5000;
123
- private debugLogging: boolean = false;
124
- private loggingID: ReturnType<typeof setInterval> =
125
- 0 as unknown as ReturnType<typeof setInterval>;
126
- private lastCleanupTime = 0;
127
- private baselineMemoryAllocation: number = 26e6;
128
-
129
- public criticalCleanupRequested = false;
130
- public doNotExceedCriticalThreshold: boolean = false;
131
- private originalSetTextureMemUse: (
132
- texture: Texture,
133
- byteSize: number,
134
- ) => void;
135
-
136
- /**
137
- * The current frame time in milliseconds
138
- *
139
- * @remarks
140
- * This is used to determine when to perform Idle Texture Cleanups.
141
- *
142
- * Set by stage via `updateFrameTime` method.
143
- */
144
- public frameTime = 0;
145
-
146
- constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
147
- this.originalSetTextureMemUse = this.setTextureMemUse;
148
-
149
- this.updateSettings(settings);
150
- }
151
-
152
- /**
153
- * Add a texture to the orphaned textures list
154
- *
155
- * @param texture - The texture to add to the orphaned textures list
156
- */
157
- addToOrphanedTextures(texture: Texture) {
158
- // if the texture is already in the orphaned textures list add it at the end
159
- if (this.orphanedTextures.includes(texture)) {
160
- this.removeFromOrphanedTextures(texture);
161
- }
162
-
163
- // If the texture can be cleaned up, add it to the orphaned textures list
164
- if (texture.preventCleanup === false) {
165
- this.orphanedTextures.push(texture);
166
- }
167
- }
168
-
169
- /**
170
- * Remove a texture from the orphaned textures list
171
- *
172
- * @param texture - The texture to remove from the orphaned textures list
173
- */
174
- removeFromOrphanedTextures(texture: Texture) {
175
- const index = this.orphanedTextures.indexOf(texture);
176
- if (index !== -1) {
177
- this.orphanedTextures.splice(index, 1);
178
- }
179
- }
180
-
181
- /**
182
- * Set the memory usage of a texture
183
- *
184
- * @param texture - The texture to set memory usage for
185
- * @param byteSize - The size of the texture in bytes
186
- */
187
- setTextureMemUse(texture: Texture, byteSize: number) {
188
- if (this.loadedTextures.has(texture)) {
189
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
190
- this.memUsed -= this.loadedTextures.get(texture)!;
191
- }
192
-
193
- if (byteSize === 0) {
194
- this.loadedTextures.delete(texture);
195
- return;
196
- } else {
197
- this.memUsed += byteSize;
198
- this.loadedTextures.set(texture, byteSize);
199
- }
200
-
201
- if (this.memUsed > this.criticalThreshold) {
202
- this.criticalCleanupRequested = true;
203
- }
204
- }
205
-
206
- checkCleanup() {
207
- return (
208
- this.criticalCleanupRequested ||
209
- (this.memUsed > this.targetThreshold &&
210
- this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
211
- );
212
- }
213
-
214
- checkCriticalCleanup() {
215
- return this.memUsed > this.criticalThreshold;
216
- }
217
-
218
- cleanupQuick(critical: boolean) {
219
- // Free non-renderable textures until we reach the target threshold
220
- const platform = this.stage.platform;
221
- const memTarget = this.targetThreshold;
222
- const timestamp = platform.getTimeStamp();
223
-
224
- while (
225
- this.memUsed >= memTarget &&
226
- this.orphanedTextures.length > 0 &&
227
- (critical || platform.getTimeStamp() - timestamp < 10)
228
- ) {
229
- const texture = this.orphanedTextures.shift();
230
-
231
- if (texture === undefined) {
232
- continue;
233
- }
234
-
235
- if (texture.renderable === true) {
236
- // If the texture is renderable, we can't free it up
237
- continue;
238
- }
239
-
240
- // Skip textures that are in transitional states - we only want to clean up
241
- // textures that are in a stable state (loaded, failed, or freed)
242
- if (Texture.TRANSITIONAL_TEXTURE_STATES.includes(texture.state)) {
243
- continue;
244
- }
245
-
246
- this.destroyTexture(texture);
247
- }
248
- }
249
-
250
- /**
251
- * Destroy a texture and remove it from the memory manager
252
- *
253
- * @param texture - The texture to destroy
254
- */
255
- destroyTexture(texture: Texture) {
256
- if (this.debugLogging === true) {
257
- console.log(
258
- `[TextureMemoryManager] Destroying texture. State: ${texture.state}`,
259
- );
260
- }
261
-
262
- const txManager = this.stage.txManager;
263
- txManager.removeTextureFromQueue(texture);
264
- txManager.removeTextureFromCache(texture);
265
-
266
- texture.destroy();
267
-
268
- this.removeFromOrphanedTextures(texture);
269
- this.loadedTextures.delete(texture);
270
- }
271
- cleanupDeep(critical: boolean) {
272
- // Free non-renderable textures until we reach the target threshold
273
- const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
274
-
275
- // sort by renderability
276
- const filteredAndSortedTextures: Texture[] = [];
277
- const textures = [...this.loadedTextures.keys()];
278
- for (let i = 0; i < textures.length; i++) {
279
- const texture = textures[i];
280
- if (texture === undefined) {
281
- continue;
282
- }
283
-
284
- if (
285
- texture.type === TextureType.image ||
286
- texture.type === TextureType.noise ||
287
- texture.type === TextureType.renderToTexture
288
- ) {
289
- if (texture.renderable === true) {
290
- filteredAndSortedTextures.push(texture);
291
- } else {
292
- filteredAndSortedTextures.unshift(texture);
293
- }
294
- }
295
- }
296
-
297
- while (this.memUsed >= memTarget && filteredAndSortedTextures.length > 0) {
298
- const texture = filteredAndSortedTextures.shift();
299
- if (texture === undefined) {
300
- continue;
301
- }
302
-
303
- if (texture.preventCleanup === true) {
304
- continue;
305
- }
306
-
307
- if (texture.renderable === true) {
308
- break;
309
- }
310
-
311
- // Skip textures that are in transitional states - we only want to clean up
312
- // textures that are in a stable state (loaded, failed, or freed)
313
- if (Texture.TRANSITIONAL_TEXTURE_STATES.includes(texture.state)) {
314
- break;
315
- }
316
-
317
- this.destroyTexture(texture);
318
- }
319
- }
320
-
321
- cleanup(aggressive: boolean = false) {
322
- const critical = this.criticalCleanupRequested;
323
- const criticalThreshold = this.criticalThreshold;
324
- const memUsed = this.memUsed;
325
- const stage = this.stage;
326
- this.lastCleanupTime = this.frameTime;
327
-
328
- if (critical === true) {
329
- stage.queueFrameEvent('criticalCleanup', {
330
- memUsed: this.memUsed,
331
- criticalThreshold: criticalThreshold,
332
- });
333
- }
334
-
335
- if (this.debugLogging === true) {
336
- console.log(
337
- `[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Aggressive: ${aggressive}`,
338
- );
339
- }
340
-
341
- // Note: We skip textures in transitional states during cleanup:
342
- // - 'initial': These textures haven't started loading yet
343
- // - 'fetching': These textures are in the process of being fetched
344
- // - 'fetched': These textures have been fetched but not yet uploaded to GPU
345
- // - 'loading': These textures are being uploaded to the GPU
346
- //
347
- // For 'failed' and 'freed' states, we only remove them from the tracking
348
- // arrays without trying to free GPU resources that don't exist.
349
-
350
- // try a quick cleanup first
351
- this.cleanupQuick(critical);
352
-
353
- // if we're still above the target threshold, do a deep cleanup
354
- if (aggressive === true && memUsed >= criticalThreshold) {
355
- this.cleanupDeep(critical);
356
- }
357
-
358
- if (memUsed >= criticalThreshold) {
359
- stage.queueFrameEvent('criticalCleanupFailed', {
360
- memUsed: memUsed,
361
- criticalThreshold: criticalThreshold,
362
- });
363
-
364
- if (this.debugLogging === true || isProductionEnvironment === false) {
365
- console.warn(
366
- `[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${memUsed}`,
367
- );
368
- }
369
- } else {
370
- this.criticalCleanupRequested = false;
371
- }
372
- }
373
-
374
- /**
375
- * Get the current texture memory usage information
376
- *
377
- * @remarks
378
- * This method is for debugging purposes and returns information about the
379
- * current memory usage of the textures in the Renderer.
380
- */
381
- getMemoryInfo(): MemoryInfo {
382
- let renderableTexturesLoaded = 0;
383
- const renderableMemUsed = [...this.loadedTextures.keys()].reduce(
384
- (acc, texture) => {
385
- renderableTexturesLoaded += texture.renderable ? 1 : 0;
386
- // Get the memory used by the texture, defaulting to 0 if not found
387
- const textureMemory = this.loadedTextures.get(texture) ?? 0;
388
- return acc + (texture.renderable ? textureMemory : 0);
389
- },
390
- this.baselineMemoryAllocation,
391
- );
392
-
393
- return {
394
- criticalThreshold: this.criticalThreshold,
395
- targetThreshold: this.targetThreshold,
396
- renderableMemUsed,
397
- memUsed: this.memUsed,
398
- renderableTexturesLoaded,
399
- loadedTextures: this.loadedTextures.size,
400
- baselineMemoryAllocation: this.baselineMemoryAllocation,
401
- };
402
- }
403
-
404
- public updateSettings(settings: TextureMemoryManagerSettings): void {
405
- const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
406
-
407
- this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
408
- this.criticalThreshold = Math.round(criticalThreshold);
409
-
410
- if (this.memUsed === 0) {
411
- this.memUsed = Math.round(settings.baselineMemoryAllocation);
412
- } else {
413
- const memUsedExBaseline = this.memUsed - this.baselineMemoryAllocation;
414
- this.memUsed = Math.round(
415
- settings.baselineMemoryAllocation + memUsedExBaseline,
416
- );
417
- }
418
- this.baselineMemoryAllocation = Math.round(
419
- settings.baselineMemoryAllocation,
420
- );
421
- const targetFraction = Math.max(
422
- 0,
423
- Math.min(1, settings.targetThresholdLevel),
424
- );
425
- this.targetThreshold = Math.max(
426
- Math.round(criticalThreshold * targetFraction),
427
- this.baselineMemoryAllocation,
428
- );
429
-
430
- this.cleanupInterval = settings.cleanupInterval;
431
- this.debugLogging = settings.debugLogging;
432
-
433
- if (this.loggingID && !settings.debugLogging) {
434
- clearInterval(this.loggingID);
435
- this.loggingID = 0 as unknown as ReturnType<typeof setInterval>;
436
- }
437
- if (settings.debugLogging && !this.loggingID) {
438
- let lastMemUse = 0;
439
- this.loggingID = setInterval(() => {
440
- if (lastMemUse !== this.memUsed) {
441
- lastMemUse = this.memUsed;
442
- console.log(
443
- `[TextureMemoryManager] Memory used: ${bytesToMb(
444
- this.memUsed,
445
- )} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
446
- (this.memUsed / this.criticalThreshold) *
447
- 100
448
- ).toFixed(1)}%)`,
449
- );
450
- }
451
- }, 1000);
452
- }
453
-
454
- // If the threshold is 0, we disable the memory manager by replacing the
455
- // setTextureMemUse method with a no-op function.
456
- if (criticalThreshold === 0) {
457
- this.setTextureMemUse = () => {};
458
- } else {
459
- this.setTextureMemUse = this.originalSetTextureMemUse;
460
- }
461
- }
462
- }
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 2024 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
+ import { isProductionEnvironment } from '../utils.js';
20
+ import type { Stage } from './Stage.js';
21
+ import { Texture, TextureType } from './textures/Texture.js';
22
+ import { bytesToMb } from './utils.js';
23
+
24
+ export interface TextureMemoryManagerSettings {
25
+ /**
26
+ * Critical Threshold (in bytes)
27
+ *
28
+ * @remarks
29
+ * When the amount of memory used by textures exceeds this threshold,
30
+ * the Renderer will immediately trigger a Texture Cleanup towards the
31
+ * Target Threshold Level.
32
+ *
33
+ * When set to `0`, the Texture Memory Manager is disabled.
34
+ *
35
+ * @defaultValue `124e6` (118 MB)
36
+ */
37
+ criticalThreshold: number;
38
+
39
+ /**
40
+ * Target Threshold Level (as fraction of Critical Threshold)
41
+ *
42
+ * @remarks
43
+ * This value is the fractional level of the Critical Threshold that the
44
+ * Texture Memory Manager will attempt to maintain by cleaning up textures.
45
+ * The Texture Memory Manager will attempt to keep the memory usage below
46
+ * this level by freeing up non-renderable textures.
47
+ *
48
+ * Valid Range: 0.0 - 1.0
49
+ *
50
+ * @defaultValue `0.5`
51
+ */
52
+ targetThresholdLevel: number;
53
+
54
+ /**
55
+ * Interval between non-aggressive Texture Cleanups (in milliseconds)
56
+ *
57
+ * @remarks
58
+ * Texture Memory Manager will perform a non aggressive Texture Cleanup no more
59
+ * frequently than this interval when the scene becomes idle.
60
+ *
61
+ * @defaultValue `5,000` (5 seconds)
62
+ */
63
+ cleanupInterval: number;
64
+
65
+ /**
66
+ * Whether or not to log debug information
67
+ *
68
+ * @defaultValue `false`
69
+ */
70
+ debugLogging: boolean;
71
+
72
+ /**
73
+ * Baseline memory allocation for the Texture Memory Manager
74
+ *
75
+ * @remarks
76
+ * Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
77
+ * This will be used on top of the memory used by textures to determine when to trigger a cleanup.
78
+ *
79
+ * @defaultValue `25e6` (25 MB)
80
+ */
81
+ baselineMemoryAllocation: number;
82
+
83
+ /**
84
+ * Do not exceed critical threshold
85
+ *
86
+ * @defaultValue `false`
87
+ */
88
+ doNotExceedCriticalThreshold: boolean;
89
+ }
90
+
91
+ export interface MemoryInfo {
92
+ criticalThreshold: number;
93
+ targetThreshold: number;
94
+ renderableMemUsed: number;
95
+ memUsed: number;
96
+ renderableTexturesLoaded: number;
97
+ loadedTextures: number;
98
+ baselineMemoryAllocation: number;
99
+ }
100
+
101
+ /**
102
+ * LRU (Least Recently Used) style memory manager for textures
103
+ *
104
+ * @remarks
105
+ * This class is responsible for managing the memory usage of textures
106
+ * in the Renderer. It keeps track of the memory used by each texture
107
+ * and triggers a cleanup when the memory usage exceeds a critical
108
+ * threshold (`criticalThreshold`).
109
+ *
110
+ * The cleanup process will free up non-renderable textures until the
111
+ * memory usage is below a target threshold (`targetThresholdLevel`).
112
+ *
113
+ * The memory manager's clean up process will also be triggered when the
114
+ * scene is idle for a certain amount of time (`cleanupInterval`).
115
+ */
116
+ export class TextureMemoryManager {
117
+ private memUsed = 0;
118
+ private loadedTextures: (Texture | null)[] = [];
119
+ private orphanedTextures: Texture[] = [];
120
+ private criticalThreshold: number = 124e6;
121
+ private targetThreshold: number = 0.5;
122
+ private cleanupInterval: number = 5000;
123
+ private debugLogging: boolean = false;
124
+ private loggingID: ReturnType<typeof setInterval> =
125
+ 0 as unknown as ReturnType<typeof setInterval>;
126
+ private lastCleanupTime = 0;
127
+ private baselineMemoryAllocation: number = 26e6;
128
+
129
+ private hasWarnedAboveCritical = false;
130
+
131
+ public criticalCleanupRequested = false;
132
+ public doNotExceedCriticalThreshold: boolean = false;
133
+
134
+ /**
135
+ * The current frame time in milliseconds
136
+ *
137
+ * @remarks
138
+ * This is used to determine when to perform Idle Texture Cleanups.
139
+ *
140
+ * Set by stage via `updateFrameTime` method.
141
+ */
142
+ public frameTime = 0;
143
+
144
+ constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
145
+ this.updateSettings(settings);
146
+ }
147
+
148
+ /**
149
+ * Add a texture to the orphaned textures list
150
+ *
151
+ * @param texture - The texture to add to the orphaned textures list
152
+ */
153
+ addToOrphanedTextures(texture: Texture) {
154
+ // if the texture is already in the orphaned textures list add it at the end
155
+ if (this.orphanedTextures.includes(texture)) {
156
+ this.removeFromOrphanedTextures(texture);
157
+ }
158
+
159
+ // If the texture can be cleaned up, add it to the orphaned textures list
160
+ if (texture.preventCleanup === false) {
161
+ this.orphanedTextures.push(texture);
162
+ }
163
+ }
164
+
165
+ /**
166
+ * Remove a texture from the orphaned textures list
167
+ *
168
+ * @param texture - The texture to remove from the orphaned textures list
169
+ */
170
+ removeFromOrphanedTextures(texture: Texture) {
171
+ const index = this.orphanedTextures.indexOf(texture);
172
+ if (index !== -1) {
173
+ this.orphanedTextures.splice(index, 1);
174
+ }
175
+ }
176
+
177
+ /**
178
+ * Set the memory usage of a texture
179
+ *
180
+ * @param texture - The texture to set memory usage for
181
+ * @param byteSize - The size of the texture in bytes
182
+ */
183
+ setTextureMemUse(texture: Texture, byteSize: number) {
184
+ // Update global memory counter by subtracting old value
185
+ this.memUsed -= texture.memUsed;
186
+
187
+ if (byteSize === 0) {
188
+ // PERFORMANCE: Mark for deletion, slot will be reused later
189
+ const index = this.loadedTextures.indexOf(texture);
190
+ if (index !== -1) {
191
+ this.loadedTextures[index] = null;
192
+ }
193
+ texture.memUsed = 0;
194
+ return;
195
+ } else {
196
+ // Update texture memory and add to tracking if not already present
197
+ texture.memUsed = byteSize;
198
+ this.memUsed += byteSize;
199
+ if (this.loadedTextures.indexOf(texture) === -1) {
200
+ // PERFORMANCE: Reuse empty slots before appending
201
+ const emptyIndex = this.loadedTextures.indexOf(null);
202
+ if (emptyIndex !== -1) {
203
+ this.loadedTextures[emptyIndex] = texture;
204
+ } else {
205
+ this.loadedTextures.push(texture);
206
+ }
207
+ }
208
+ }
209
+
210
+ if (this.memUsed > this.criticalThreshold) {
211
+ this.criticalCleanupRequested = true;
212
+ }
213
+ }
214
+
215
+ checkCleanup() {
216
+ return (
217
+ this.criticalCleanupRequested ||
218
+ (this.memUsed > this.targetThreshold &&
219
+ this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
220
+ );
221
+ }
222
+
223
+ checkCriticalCleanup() {
224
+ return this.memUsed > this.criticalThreshold;
225
+ }
226
+
227
+ /**
228
+ * Destroy a texture and remove it from the memory manager
229
+ *
230
+ * @param texture - The texture to destroy
231
+ */
232
+ destroyTexture(texture: Texture) {
233
+ if (this.debugLogging === true) {
234
+ console.log(
235
+ `[TextureMemoryManager] Destroying texture. State: ${texture.state}`,
236
+ );
237
+ }
238
+
239
+ // PERFORMANCE: Null out array position, slot will be reused later
240
+ const index = this.loadedTextures.indexOf(texture);
241
+ if (index !== -1) {
242
+ this.loadedTextures[index] = null;
243
+ }
244
+
245
+ // Destroy texture and update memory counters
246
+ const txManager = this.stage.txManager;
247
+ txManager.removeTextureFromCache(texture);
248
+
249
+ texture.destroy();
250
+
251
+ // Update memory counters
252
+ this.memUsed -= texture.memUsed;
253
+ texture.memUsed = 0;
254
+ }
255
+
256
+ cleanup(full: boolean = false) {
257
+ const critical = this.criticalCleanupRequested;
258
+ this.lastCleanupTime = this.frameTime;
259
+
260
+ if (critical === true) {
261
+ this.stage.queueFrameEvent('criticalCleanup', {
262
+ memUsed: this.memUsed,
263
+ criticalThreshold: this.criticalThreshold,
264
+ });
265
+ }
266
+
267
+ if (this.debugLogging === true) {
268
+ console.log(
269
+ `[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Full: ${full}`,
270
+ );
271
+ }
272
+
273
+ // Free non-renderable textures until we reach the target threshold
274
+ const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
275
+
276
+ // PERFORMANCE: Zero-overhead cleanup with null marking
277
+ // Skip null entries, mark cleaned textures as null for later defrag
278
+ let currentMemUsed = this.memUsed;
279
+
280
+ for (let i = 0; i < this.loadedTextures.length; i++) {
281
+ // Early exit: target memory reached
282
+ if (full === false && currentMemUsed < memTarget) {
283
+ break;
284
+ }
285
+
286
+ const texture = this.loadedTextures[i];
287
+ if (!texture) continue; // Skip null entries from previous deletions
288
+
289
+ // Fast type check for cleanable textures
290
+ const isCleanableType =
291
+ texture.type === TextureType.image ||
292
+ texture.type === TextureType.noise ||
293
+ texture.type === TextureType.renderToTexture;
294
+
295
+ // Immediate cleanup if eligible
296
+ if (isCleanableType && texture.canBeCleanedUp() === true) {
297
+ // Get memory before destroying
298
+ const textureMemory = texture.memUsed;
299
+
300
+ // Destroy texture (which will null out the array position)
301
+ this.destroyTexture(texture);
302
+ currentMemUsed -= textureMemory;
303
+ }
304
+ }
305
+
306
+ if (this.memUsed >= this.criticalThreshold) {
307
+ this.stage.queueFrameEvent('criticalCleanupFailed', {
308
+ memUsed: this.memUsed,
309
+ criticalThreshold: this.criticalThreshold,
310
+ });
311
+ // Only emit the warning once per over-threshold period
312
+ if (
313
+ !this.hasWarnedAboveCritical &&
314
+ (this.debugLogging === true || isProductionEnvironment === false)
315
+ ) {
316
+ console.warn(
317
+ `[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${this.memUsed}`,
318
+ );
319
+
320
+ this.hasWarnedAboveCritical = true;
321
+ }
322
+ } else {
323
+ this.criticalCleanupRequested = false;
324
+ this.hasWarnedAboveCritical = false;
325
+ }
326
+ }
327
+
328
+ /**
329
+ * Get the current texture memory usage information
330
+ *
331
+ * @remarks
332
+ * This method is for debugging purposes and returns information about the
333
+ * current memory usage of the textures in the Renderer.
334
+ */
335
+ getMemoryInfo(): MemoryInfo {
336
+ let renderableTexturesLoaded = 0;
337
+ let renderableMemUsed = this.baselineMemoryAllocation;
338
+
339
+ for (const texture of this.loadedTextures) {
340
+ if (texture && texture.renderable) {
341
+ renderableTexturesLoaded += 1;
342
+ renderableMemUsed += texture.memUsed;
343
+ }
344
+ }
345
+
346
+ // Count non-null entries for accurate loaded texture count
347
+ const actualLoadedTextures = this.loadedTextures.filter(
348
+ (t) => t !== null,
349
+ ).length;
350
+
351
+ return {
352
+ criticalThreshold: this.criticalThreshold,
353
+ targetThreshold: this.targetThreshold,
354
+ renderableMemUsed,
355
+ memUsed: this.memUsed,
356
+ renderableTexturesLoaded,
357
+ loadedTextures: actualLoadedTextures,
358
+ baselineMemoryAllocation: this.baselineMemoryAllocation,
359
+ };
360
+ }
361
+
362
+ public updateSettings(settings: TextureMemoryManagerSettings): void {
363
+ const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
364
+
365
+ this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
366
+ this.criticalThreshold = Math.round(criticalThreshold);
367
+
368
+ if (this.memUsed === 0) {
369
+ this.memUsed = Math.round(settings.baselineMemoryAllocation);
370
+ } else {
371
+ const memUsedExBaseline = this.memUsed - this.baselineMemoryAllocation;
372
+ this.memUsed = Math.round(
373
+ settings.baselineMemoryAllocation + memUsedExBaseline,
374
+ );
375
+ }
376
+ this.baselineMemoryAllocation = Math.round(
377
+ settings.baselineMemoryAllocation,
378
+ );
379
+ const targetFraction = Math.max(
380
+ 0,
381
+ Math.min(1, settings.targetThresholdLevel),
382
+ );
383
+ this.targetThreshold = Math.max(
384
+ Math.round(criticalThreshold * targetFraction),
385
+ this.baselineMemoryAllocation,
386
+ );
387
+
388
+ this.cleanupInterval = settings.cleanupInterval;
389
+ this.debugLogging = settings.debugLogging;
390
+
391
+ if (this.loggingID && !settings.debugLogging) {
392
+ clearInterval(this.loggingID);
393
+ this.loggingID = 0 as unknown as ReturnType<typeof setInterval>;
394
+ }
395
+ if (settings.debugLogging && !this.loggingID) {
396
+ let lastMemUse = 0;
397
+ this.loggingID = setInterval(() => {
398
+ if (lastMemUse !== this.memUsed) {
399
+ lastMemUse = this.memUsed;
400
+ console.log(
401
+ `[TextureMemoryManager] Memory used: ${bytesToMb(
402
+ this.memUsed,
403
+ )} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
404
+ (this.memUsed / this.criticalThreshold) *
405
+ 100
406
+ ).toFixed(1)}%)`,
407
+ );
408
+ }
409
+ }, 1000);
410
+ }
411
+
412
+ // If the threshold is 0, we disable the memory manager by replacing the
413
+ // setTextureMemUse method with a no-op function.
414
+ if (criticalThreshold === 0) {
415
+ this.setTextureMemUse = () => {};
416
+ }
417
+ }
418
+ }