@lightningjs/renderer 2.13.1 → 2.13.2

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 (344) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/exports/canvas-shaders.d.ts +10 -0
  6. package/dist/exports/canvas-shaders.js +27 -0
  7. package/dist/exports/canvas-shaders.js.map +1 -0
  8. package/dist/exports/webgl-shaders.d.ts +11 -0
  9. package/dist/exports/webgl-shaders.js +28 -0
  10. package/dist/exports/webgl-shaders.js.map +1 -0
  11. package/dist/src/core/renderers/CoreShaderNode.d.ts +59 -0
  12. package/dist/src/core/renderers/CoreShaderNode.js +107 -0
  13. package/dist/src/core/renderers/CoreShaderNode.js.map +1 -0
  14. package/dist/src/core/renderers/CoreShaderProgram.d.ts +4 -0
  15. package/dist/src/{main-api/ICoreDriver.js → core/renderers/CoreShaderProgram.js} +1 -1
  16. package/dist/src/core/renderers/CoreShaderProgram.js.map +1 -0
  17. package/dist/src/core/renderers/canvas/CanvasRenderer.d.ts +36 -0
  18. package/dist/src/core/renderers/canvas/CanvasRenderer.js +212 -0
  19. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -0
  20. package/dist/src/core/renderers/canvas/CanvasShaderNode.d.ts +21 -0
  21. package/dist/src/core/renderers/canvas/CanvasShaderNode.js +60 -0
  22. package/dist/src/core/renderers/canvas/CanvasShaderNode.js.map +1 -0
  23. package/dist/src/core/renderers/canvas/CanvasTexture.d.ts +16 -0
  24. package/dist/src/core/renderers/canvas/CanvasTexture.js +123 -0
  25. package/dist/src/core/renderers/canvas/CanvasTexture.js.map +1 -0
  26. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.d.ts +12 -0
  27. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js +55 -0
  28. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js.map +1 -0
  29. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.d.ts +9 -0
  30. package/dist/src/{main-api/texture-usage-trackers/TextureUsageTracker.js → core/renderers/webgl/WebGlCtxSubTexture.js} +18 -8
  31. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js.map +1 -0
  32. package/dist/src/core/renderers/webgl/WebGlCtxTexture.d.ts +57 -0
  33. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js +227 -0
  34. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js.map +1 -0
  35. package/dist/src/core/renderers/webgl/WebGlRenderOp.d.ts +36 -0
  36. package/dist/src/core/renderers/webgl/WebGlRenderOp.js +107 -0
  37. package/dist/src/core/renderers/webgl/WebGlRenderOp.js.map +1 -0
  38. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +134 -0
  39. package/dist/src/core/renderers/webgl/WebGlRenderer.js +546 -0
  40. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -0
  41. package/dist/src/core/renderers/webgl/WebGlShaderNode.d.ts +221 -0
  42. package/dist/src/core/renderers/webgl/WebGlShaderNode.js +334 -0
  43. package/dist/src/core/renderers/webgl/WebGlShaderNode.js.map +1 -0
  44. package/dist/src/core/renderers/webgl/WebGlShaderProgram.d.ts +35 -0
  45. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js +195 -0
  46. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js.map +1 -0
  47. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  48. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  49. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  50. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  51. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  52. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  53. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  54. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  55. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  56. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  57. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  58. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  59. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  60. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  61. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  62. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  63. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  64. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  65. package/dist/src/core/shaders/canvas/Border.d.ts +9 -0
  66. package/dist/src/core/shaders/canvas/Border.js +57 -0
  67. package/dist/src/core/shaders/canvas/Border.js.map +1 -0
  68. package/dist/src/core/shaders/canvas/HolePunch.d.ts +7 -0
  69. package/dist/src/core/shaders/canvas/HolePunch.js +38 -0
  70. package/dist/src/core/shaders/canvas/HolePunch.js.map +1 -0
  71. package/dist/src/core/shaders/canvas/LinearGradient.d.ts +10 -0
  72. package/dist/src/core/shaders/canvas/LinearGradient.js +46 -0
  73. package/dist/src/core/shaders/canvas/LinearGradient.js.map +1 -0
  74. package/dist/src/core/shaders/canvas/RadialGradient.d.ts +11 -0
  75. package/dist/src/core/shaders/canvas/RadialGradient.js +68 -0
  76. package/dist/src/core/shaders/canvas/RadialGradient.js.map +1 -0
  77. package/dist/src/core/shaders/canvas/Rounded.d.ts +7 -0
  78. package/dist/src/core/shaders/canvas/Rounded.js +33 -0
  79. package/dist/src/core/shaders/canvas/Rounded.js.map +1 -0
  80. package/dist/src/core/shaders/canvas/RoundedWithBorder.d.ts +7 -0
  81. package/dist/src/core/shaders/canvas/RoundedWithBorder.js +35 -0
  82. package/dist/src/core/shaders/canvas/RoundedWithBorder.js.map +1 -0
  83. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.d.ts +8 -0
  84. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js +39 -0
  85. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js.map +1 -0
  86. package/dist/src/core/shaders/canvas/RoundedWithShadow.d.ts +7 -0
  87. package/dist/src/core/shaders/canvas/RoundedWithShadow.js +38 -0
  88. package/dist/src/core/shaders/canvas/RoundedWithShadow.js.map +1 -0
  89. package/dist/src/core/shaders/canvas/Shadow.d.ts +8 -0
  90. package/dist/src/core/shaders/canvas/Shadow.js +31 -0
  91. package/dist/src/core/shaders/canvas/Shadow.js.map +1 -0
  92. package/dist/src/core/shaders/canvas/utils/render.d.ts +5 -0
  93. package/dist/src/core/shaders/canvas/utils/render.js +84 -0
  94. package/dist/src/core/shaders/canvas/utils/render.js.map +1 -0
  95. package/dist/src/core/shaders/templates/BorderTemplate.d.ts +37 -0
  96. package/dist/src/core/shaders/templates/BorderTemplate.js +73 -0
  97. package/dist/src/core/shaders/templates/BorderTemplate.js.map +1 -0
  98. package/dist/src/core/shaders/templates/HolePunchTemplate.d.ts +46 -0
  99. package/dist/src/core/shaders/templates/HolePunchTemplate.js +35 -0
  100. package/dist/src/core/shaders/templates/HolePunchTemplate.js.map +1 -0
  101. package/dist/src/core/shaders/templates/LinearGradientTemplate.d.ts +23 -0
  102. package/dist/src/core/shaders/templates/LinearGradientTemplate.js +47 -0
  103. package/dist/src/core/shaders/templates/LinearGradientTemplate.js.map +1 -0
  104. package/dist/src/core/shaders/templates/RadialGradientTemplate.d.ts +31 -0
  105. package/dist/src/core/shaders/templates/RadialGradientTemplate.js +49 -0
  106. package/dist/src/core/shaders/templates/RadialGradientTemplate.js.map +1 -0
  107. package/dist/src/core/shaders/templates/RoundedTemplate.d.ts +29 -0
  108. package/dist/src/core/shaders/templates/RoundedTemplate.js +67 -0
  109. package/dist/src/core/shaders/templates/RoundedTemplate.js.map +1 -0
  110. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.d.ts +7 -0
  111. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js +24 -0
  112. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js.map +1 -0
  113. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.d.ts +6 -0
  114. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js +23 -0
  115. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js.map +1 -0
  116. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.d.ts +6 -0
  117. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js +23 -0
  118. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js.map +1 -0
  119. package/dist/src/core/shaders/templates/ShadowTemplate.d.ts +34 -0
  120. package/dist/src/core/shaders/templates/ShadowTemplate.js +66 -0
  121. package/dist/src/core/shaders/templates/ShadowTemplate.js.map +1 -0
  122. package/dist/src/core/shaders/templates/shaderUtils.d.ts +5 -0
  123. package/dist/src/core/shaders/templates/shaderUtils.js +41 -0
  124. package/dist/src/core/shaders/templates/shaderUtils.js.map +1 -0
  125. package/dist/src/core/shaders/webgl/Border.d.ts +3 -0
  126. package/dist/src/core/shaders/webgl/Border.js +87 -0
  127. package/dist/src/core/shaders/webgl/Border.js.map +1 -0
  128. package/dist/src/core/shaders/webgl/Default.d.ts +2 -0
  129. package/dist/src/core/shaders/webgl/Default.js +86 -0
  130. package/dist/src/core/shaders/webgl/Default.js.map +1 -0
  131. package/dist/src/core/shaders/webgl/DefaultBatched.d.ts +2 -0
  132. package/dist/src/core/shaders/webgl/DefaultBatched.js +104 -0
  133. package/dist/src/core/shaders/webgl/DefaultBatched.js.map +1 -0
  134. package/dist/src/core/shaders/webgl/HolePunch.d.ts +3 -0
  135. package/dist/src/core/shaders/webgl/HolePunch.js +64 -0
  136. package/dist/src/core/shaders/webgl/HolePunch.js.map +1 -0
  137. package/dist/src/core/shaders/webgl/LinearGradient.d.ts +3 -0
  138. package/dist/src/core/shaders/webgl/LinearGradient.js +75 -0
  139. package/dist/src/core/shaders/webgl/LinearGradient.js.map +1 -0
  140. package/dist/src/core/shaders/webgl/RadialGradient.d.ts +3 -0
  141. package/dist/src/core/shaders/webgl/RadialGradient.js +73 -0
  142. package/dist/src/core/shaders/webgl/RadialGradient.js.map +1 -0
  143. package/dist/src/core/shaders/webgl/Rounded.d.ts +7 -0
  144. package/dist/src/core/shaders/webgl/Rounded.js +86 -0
  145. package/dist/src/core/shaders/webgl/Rounded.js.map +1 -0
  146. package/dist/src/core/shaders/webgl/RoundedWithBorder.d.ts +3 -0
  147. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +97 -0
  148. package/dist/src/core/shaders/webgl/RoundedWithBorder.js.map +1 -0
  149. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.d.ts +3 -0
  150. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +112 -0
  151. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js.map +1 -0
  152. package/dist/src/core/shaders/webgl/RoundedWithShadow.d.ts +3 -0
  153. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +84 -0
  154. package/dist/src/core/shaders/webgl/RoundedWithShadow.js.map +1 -0
  155. package/dist/src/core/shaders/webgl/SdfShader.d.ts +32 -0
  156. package/dist/src/core/shaders/webgl/SdfShader.js +116 -0
  157. package/dist/src/core/shaders/webgl/SdfShader.js.map +1 -0
  158. package/dist/src/core/shaders/webgl/Shadow.d.ts +3 -0
  159. package/dist/src/core/shaders/webgl/Shadow.js +110 -0
  160. package/dist/src/core/shaders/webgl/Shadow.js.map +1 -0
  161. package/dist/src/core/textures/Texture.d.ts +4 -2
  162. package/dist/src/core/textures/Texture.js +18 -6
  163. package/dist/src/core/textures/Texture.js.map +1 -1
  164. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  165. package/exports/canvas.ts +39 -39
  166. package/exports/index.ts +89 -89
  167. package/exports/inspector.ts +24 -24
  168. package/exports/utils.ts +44 -44
  169. package/exports/webgl.ts +38 -38
  170. package/package.json +1 -2
  171. package/scripts/please-use-pnpm.js +13 -13
  172. package/src/common/CommonTypes.ts +146 -146
  173. package/src/common/EventEmitter.ts +77 -77
  174. package/src/common/IAnimationController.ts +92 -92
  175. package/src/common/IEventEmitter.ts +28 -28
  176. package/src/core/CoreNode.test.ts +202 -202
  177. package/src/core/CoreNode.ts +2455 -2455
  178. package/src/core/CoreShaderManager.ts +292 -292
  179. package/src/core/CoreTextNode.ts +455 -455
  180. package/src/core/CoreTextureManager.ts +597 -597
  181. package/src/core/Stage.ts +743 -743
  182. package/src/core/TextureMemoryManager.ts +395 -395
  183. package/src/core/animations/AnimationManager.ts +38 -38
  184. package/src/core/animations/CoreAnimation.ts +340 -340
  185. package/src/core/animations/CoreAnimationController.ts +157 -157
  186. package/src/core/lib/ContextSpy.ts +41 -41
  187. package/src/core/lib/ImageWorker.ts +280 -280
  188. package/src/core/lib/Matrix3d.ts +244 -244
  189. package/src/core/lib/RenderCoords.ts +86 -86
  190. package/src/core/lib/WebGlContextWrapper.ts +1332 -1332
  191. package/src/core/lib/textureCompression.ts +152 -152
  192. package/src/core/lib/textureSvg.ts +78 -78
  193. package/src/core/lib/utils.ts +384 -384
  194. package/src/core/lib/validateImageBitmap.ts +76 -76
  195. package/src/core/platform.ts +63 -63
  196. package/src/core/renderers/CoreContextTexture.ts +43 -43
  197. package/src/core/renderers/CoreRenderOp.ts +22 -22
  198. package/src/core/renderers/CoreRenderer.ts +115 -115
  199. package/src/core/renderers/CoreShader.ts +41 -41
  200. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +375 -375
  201. package/src/core/renderers/canvas/CanvasCoreTexture.ts +153 -153
  202. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  203. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  204. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  205. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +86 -86
  206. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  207. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +301 -301
  208. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  209. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +815 -815
  210. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  211. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  212. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  213. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  214. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  215. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  216. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  217. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  218. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  219. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  220. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  221. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  222. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  223. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  224. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  225. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  226. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  227. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  228. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  229. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  230. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  231. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  232. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  233. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  234. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  235. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  236. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  237. package/src/core/text-rendering/TrFontManager.ts +183 -183
  238. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  239. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  240. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  241. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  242. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  243. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  244. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  245. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  246. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +808 -808
  247. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  248. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  249. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  250. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  251. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  252. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  253. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  254. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  255. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +408 -408
  256. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  257. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  258. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  259. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  260. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  261. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  262. package/src/core/textures/ColorTexture.ts +102 -102
  263. package/src/core/textures/ImageTexture.ts +399 -399
  264. package/src/core/textures/NoiseTexture.ts +104 -104
  265. package/src/core/textures/RenderTexture.ts +85 -85
  266. package/src/core/textures/SubTexture.ts +205 -205
  267. package/src/core/textures/Texture.ts +353 -337
  268. package/src/core/utils.ts +227 -227
  269. package/src/env.d.ts +7 -7
  270. package/src/main-api/DynamicShaderController.ts +104 -104
  271. package/src/main-api/INode.ts +101 -101
  272. package/src/main-api/Inspector.ts +522 -522
  273. package/src/main-api/Renderer.ts +751 -751
  274. package/src/main-api/ShaderController.ts +80 -80
  275. package/src/main-api/utils.ts +45 -45
  276. package/src/utils.ts +248 -248
  277. package/dist/exports/core-api.d.ts +0 -74
  278. package/dist/exports/core-api.js +0 -96
  279. package/dist/exports/core-api.js.map +0 -1
  280. package/dist/exports/main-api.d.ts +0 -30
  281. package/dist/exports/main-api.js +0 -45
  282. package/dist/exports/main-api.js.map +0 -1
  283. package/dist/src/core/CoreExtension.d.ts +0 -12
  284. package/dist/src/core/CoreExtension.js +0 -29
  285. package/dist/src/core/CoreExtension.js.map +0 -1
  286. package/dist/src/main-api/ICoreDriver.d.ts +0 -24
  287. package/dist/src/main-api/ICoreDriver.js.map +0 -1
  288. package/dist/src/main-api/RendererMain.d.ts +0 -378
  289. package/dist/src/main-api/RendererMain.js +0 -367
  290. package/dist/src/main-api/RendererMain.js.map +0 -1
  291. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
  292. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
  293. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
  294. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
  295. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
  296. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
  297. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
  298. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
  299. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -21
  300. package/dist/src/render-drivers/main/MainCoreDriver.js +0 -115
  301. package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
  302. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -101
  303. package/dist/src/render-drivers/main/MainOnlyNode.js +0 -425
  304. package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
  305. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
  306. package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -204
  307. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
  308. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -93
  309. package/dist/src/render-drivers/threadx/NodeStruct.js +0 -290
  310. package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
  311. package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -40
  312. package/dist/src/render-drivers/threadx/SharedNode.js +0 -61
  313. package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
  314. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
  315. package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -203
  316. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
  317. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -25
  318. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -232
  319. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
  320. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -24
  321. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -113
  322. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
  323. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -46
  324. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -160
  325. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
  326. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
  327. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
  328. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
  329. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
  330. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
  331. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
  332. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
  333. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -184
  334. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
  335. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
  336. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -109
  337. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
  338. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +0 -1
  339. package/dist/src/render-drivers/threadx/worker/renderer.js +0 -147
  340. package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
  341. package/dist/src/render-drivers/utils.d.ts +0 -12
  342. package/dist/src/render-drivers/utils.js +0 -74
  343. package/dist/src/render-drivers/utils.js.map +0 -1
  344. package/dist/tsconfig.tsbuildinfo +0 -1
@@ -1,395 +1,395 @@
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 { getTimeStamp } from './platform.js';
21
- import type { Stage } from './Stage.js';
22
- import { TextureType, type Texture } from './textures/Texture.js';
23
- import { bytesToMb } from './utils.js';
24
-
25
- export interface TextureMemoryManagerSettings {
26
- /**
27
- * Critical Threshold (in bytes)
28
- *
29
- * @remarks
30
- * When the amount of memory used by textures exceeds this threshold,
31
- * the Renderer will immediately trigger a Texture Cleanup towards the
32
- * Target Threshold Level.
33
- *
34
- * When set to `0`, the Texture Memory Manager is disabled.
35
- *
36
- * @defaultValue `124e6` (118 MB)
37
- */
38
- criticalThreshold: number;
39
-
40
- /**
41
- * Target Threshold Level (as fraction of Critical Threshold)
42
- *
43
- * @remarks
44
- * This value is the fractional level of the Critical Threshold that the
45
- * Texture Memory Manager will attempt to maintain by cleaning up textures.
46
- * The Texture Memory Manager will attempt to keep the memory usage below
47
- * this level by freeing up non-renderable textures.
48
- *
49
- * Valid Range: 0.0 - 1.0
50
- *
51
- * @defaultValue `0.5`
52
- */
53
- targetThresholdLevel: number;
54
-
55
- /**
56
- * Interval between non-aggressive Texture Cleanups (in milliseconds)
57
- *
58
- * @remarks
59
- * Texture Memory Manager will perform a non aggressive Texture Cleanup no more
60
- * frequently than this interval when the scene becomes idle.
61
- *
62
- * @defaultValue `5,000` (5 seconds)
63
- */
64
- cleanupInterval: number;
65
-
66
- /**
67
- * Whether or not to log debug information
68
- *
69
- * @defaultValue `false`
70
- */
71
- debugLogging: boolean;
72
-
73
- /**
74
- * Baseline memory allocation for the Texture Memory Manager
75
- *
76
- * @remarks
77
- * Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
78
- * This will be used on top of the memory used by textures to determine when to trigger a cleanup.
79
- *
80
- * @defaultValue `25e6` (25 MB)
81
- */
82
- baselineMemoryAllocation: number;
83
-
84
- /**
85
- * Do not exceed critical threshold
86
- *
87
- * @defaultValue `false`
88
- */
89
- doNotExceedCriticalThreshold: boolean;
90
- }
91
-
92
- export interface MemoryInfo {
93
- criticalThreshold: number;
94
- targetThreshold: number;
95
- renderableMemUsed: number;
96
- memUsed: number;
97
- renderableTexturesLoaded: number;
98
- loadedTextures: number;
99
- baselineMemoryAllocation: number;
100
- }
101
-
102
- /**
103
- * LRU (Least Recently Used) style memory manager for textures
104
- *
105
- * @remarks
106
- * This class is responsible for managing the memory usage of textures
107
- * in the Renderer. It keeps track of the memory used by each texture
108
- * and triggers a cleanup when the memory usage exceeds a critical
109
- * threshold (`criticalThreshold`).
110
- *
111
- * The cleanup process will free up non-renderable textures until the
112
- * memory usage is below a target threshold (`targetThresholdLevel`).
113
- *
114
- * The memory manager's clean up process will also be triggered when the
115
- * scene is idle for a certain amount of time (`cleanupInterval`).
116
- */
117
- export class TextureMemoryManager {
118
- private memUsed = 0;
119
- private loadedTextures: Map<Texture, number> = new Map();
120
- private orphanedTextures: Texture[] = [];
121
- private criticalThreshold: number;
122
- private targetThreshold: number;
123
- private cleanupInterval: number;
124
- private debugLogging: boolean;
125
- private lastCleanupTime = 0;
126
- private baselineMemoryAllocation: number;
127
-
128
- public criticalCleanupRequested = false;
129
- public doNotExceedCriticalThreshold: boolean;
130
-
131
- /**
132
- * The current frame time in milliseconds
133
- *
134
- * @remarks
135
- * This is used to determine when to perform Idle Texture Cleanups.
136
- *
137
- * Set by stage via `updateFrameTime` method.
138
- */
139
- public frameTime = 0;
140
-
141
- constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
142
- const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
143
- this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
144
- this.criticalThreshold = Math.round(criticalThreshold);
145
- const targetFraction = Math.max(
146
- 0,
147
- Math.min(1, settings.targetThresholdLevel),
148
- );
149
- this.cleanupInterval = settings.cleanupInterval;
150
- this.debugLogging = settings.debugLogging;
151
- this.baselineMemoryAllocation = Math.round(
152
- settings.baselineMemoryAllocation,
153
- );
154
- this.targetThreshold = Math.max(
155
- Math.round(criticalThreshold * targetFraction),
156
- this.baselineMemoryAllocation,
157
- );
158
- this.memUsed = Math.round(settings.baselineMemoryAllocation);
159
-
160
- if (settings.debugLogging) {
161
- let lastMemUse = 0;
162
- setInterval(() => {
163
- if (lastMemUse !== this.memUsed) {
164
- lastMemUse = this.memUsed;
165
- console.log(
166
- `[TextureMemoryManager] Memory used: ${bytesToMb(
167
- this.memUsed,
168
- )} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
169
- (this.memUsed / this.criticalThreshold) *
170
- 100
171
- ).toFixed(1)}%)`,
172
- );
173
- }
174
- }, 1000);
175
- }
176
-
177
- // If the threshold is 0, we disable the memory manager by replacing the
178
- // setTextureMemUse method with a no-op function.
179
- if (criticalThreshold === 0) {
180
- this.setTextureMemUse = () => {};
181
- }
182
- }
183
-
184
- /**
185
- * Add a texture to the orphaned textures list
186
- *
187
- * @param texture - The texture to add to the orphaned textures list
188
- */
189
- addToOrphanedTextures(texture: Texture) {
190
- // if the texture is already in the orphaned textures list add it at the end
191
- if (this.orphanedTextures.includes(texture)) {
192
- this.removeFromOrphanedTextures(texture);
193
- }
194
-
195
- // If the texture can be cleaned up, add it to the orphaned textures list
196
- if (texture.preventCleanup === false) {
197
- this.orphanedTextures.push(texture);
198
- }
199
- }
200
-
201
- /**
202
- * Remove a texture from the orphaned textures list
203
- *
204
- * @param texture - The texture to remove from the orphaned textures list
205
- */
206
- removeFromOrphanedTextures(texture: Texture) {
207
- const index = this.orphanedTextures.indexOf(texture);
208
- if (index !== -1) {
209
- this.orphanedTextures.splice(index, 1);
210
- }
211
- }
212
-
213
- /**
214
- * Set the memory usage of a texture
215
- *
216
- * @param texture - The texture to set memory usage for
217
- * @param byteSize - The size of the texture in bytes
218
- */
219
- setTextureMemUse(texture: Texture, byteSize: number) {
220
- if (this.loadedTextures.has(texture)) {
221
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
222
- this.memUsed -= this.loadedTextures.get(texture)!;
223
- }
224
-
225
- if (byteSize === 0) {
226
- this.loadedTextures.delete(texture);
227
- return;
228
- } else {
229
- this.memUsed += byteSize;
230
- this.loadedTextures.set(texture, byteSize);
231
- }
232
-
233
- if (this.memUsed > this.criticalThreshold) {
234
- this.criticalCleanupRequested = true;
235
- }
236
- }
237
-
238
- checkCleanup() {
239
- return (
240
- this.criticalCleanupRequested ||
241
- (this.memUsed > this.targetThreshold &&
242
- this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
243
- );
244
- }
245
-
246
- checkCriticalCleanup() {
247
- return this.memUsed > this.criticalThreshold;
248
- }
249
-
250
- cleanupQuick(critical: boolean) {
251
- // Free non-renderable textures until we reach the target threshold
252
- const memTarget = this.targetThreshold;
253
- const txManager = this.stage.txManager;
254
- const timestamp = getTimeStamp();
255
-
256
- while (
257
- this.memUsed >= memTarget &&
258
- this.orphanedTextures.length > 0 &&
259
- (critical || getTimeStamp() - timestamp < 10)
260
- ) {
261
- const texture = this.orphanedTextures.shift();
262
-
263
- if (texture === undefined) {
264
- continue;
265
- }
266
-
267
- if (texture.renderable === true) {
268
- // If the texture is renderable, we can't free it up
269
- continue;
270
- }
271
-
272
- texture.free();
273
- txManager.removeTextureFromCache(texture);
274
- }
275
- }
276
-
277
- cleanupDeep(critical: boolean) {
278
- // Free non-renderable textures until we reach the target threshold
279
- const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
280
- const txManager = this.stage.txManager;
281
-
282
- // sort by renderability
283
- const filteredAndSortedTextures: Texture[] = [];
284
- const textures = [...this.loadedTextures.keys()];
285
- for (let i = 0; i < textures.length; i++) {
286
- const texture = textures[i];
287
- if (texture === undefined) {
288
- continue;
289
- }
290
-
291
- if (
292
- texture.type === TextureType.image ||
293
- texture.type === TextureType.noise ||
294
- texture.type === TextureType.renderToTexture
295
- ) {
296
- if (texture.renderable === true) {
297
- filteredAndSortedTextures.push(texture);
298
- } else {
299
- filteredAndSortedTextures.unshift(texture);
300
- }
301
- }
302
- }
303
-
304
- while (this.memUsed >= memTarget && filteredAndSortedTextures.length > 0) {
305
- const texture = filteredAndSortedTextures.shift();
306
- if (texture === undefined) {
307
- continue;
308
- }
309
-
310
- if (texture.preventCleanup === true) {
311
- continue;
312
- }
313
-
314
- if (texture.renderable === true) {
315
- break;
316
- }
317
-
318
- texture.free();
319
- this.removeFromOrphanedTextures(texture);
320
- txManager.removeTextureFromCache(texture);
321
- txManager.removeTextureFromQueue(texture);
322
- }
323
- }
324
-
325
- cleanup(aggressive: boolean = false) {
326
- const critical = this.criticalCleanupRequested;
327
- this.lastCleanupTime = this.frameTime;
328
-
329
- if (critical === true) {
330
- this.stage.queueFrameEvent('criticalCleanup', {
331
- memUsed: this.memUsed,
332
- criticalThreshold: this.criticalThreshold,
333
- });
334
- }
335
-
336
- if (this.debugLogging === true) {
337
- console.log(
338
- `[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Aggressive: ${aggressive}`,
339
- );
340
- }
341
-
342
- // try a quick cleanup first
343
- this.cleanupQuick(critical);
344
-
345
- // if we're still above the target threshold, do a deep cleanup
346
- if (aggressive === true && this.memUsed >= this.criticalThreshold) {
347
- this.cleanupDeep(critical);
348
- }
349
-
350
- if (this.memUsed >= this.criticalThreshold) {
351
- this.stage.queueFrameEvent('criticalCleanupFailed', {
352
- memUsed: this.memUsed,
353
- criticalThreshold: this.criticalThreshold,
354
- });
355
-
356
- if (this.debugLogging === true || isProductionEnvironment() === false) {
357
- console.warn(
358
- `[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${this.memUsed}`,
359
- );
360
- }
361
- } else {
362
- this.criticalCleanupRequested = false;
363
- }
364
- }
365
-
366
- /**
367
- * Get the current texture memory usage information
368
- *
369
- * @remarks
370
- * This method is for debugging purposes and returns information about the
371
- * current memory usage of the textures in the Renderer.
372
- */
373
- getMemoryInfo(): MemoryInfo {
374
- let renderableTexturesLoaded = 0;
375
- const renderableMemUsed = [...this.loadedTextures.keys()].reduce(
376
- (acc, texture) => {
377
- renderableTexturesLoaded += texture.renderable ? 1 : 0;
378
- return (
379
- acc + (texture.renderable ? this.loadedTextures.get(texture)! : 0)
380
- );
381
- },
382
- this.baselineMemoryAllocation,
383
- );
384
-
385
- return {
386
- criticalThreshold: this.criticalThreshold,
387
- targetThreshold: this.targetThreshold,
388
- renderableMemUsed,
389
- memUsed: this.memUsed,
390
- renderableTexturesLoaded,
391
- loadedTextures: this.loadedTextures.size,
392
- baselineMemoryAllocation: this.baselineMemoryAllocation,
393
- };
394
- }
395
- }
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 { getTimeStamp } from './platform.js';
21
+ import type { Stage } from './Stage.js';
22
+ import { TextureType, type Texture } from './textures/Texture.js';
23
+ import { bytesToMb } from './utils.js';
24
+
25
+ export interface TextureMemoryManagerSettings {
26
+ /**
27
+ * Critical Threshold (in bytes)
28
+ *
29
+ * @remarks
30
+ * When the amount of memory used by textures exceeds this threshold,
31
+ * the Renderer will immediately trigger a Texture Cleanup towards the
32
+ * Target Threshold Level.
33
+ *
34
+ * When set to `0`, the Texture Memory Manager is disabled.
35
+ *
36
+ * @defaultValue `124e6` (118 MB)
37
+ */
38
+ criticalThreshold: number;
39
+
40
+ /**
41
+ * Target Threshold Level (as fraction of Critical Threshold)
42
+ *
43
+ * @remarks
44
+ * This value is the fractional level of the Critical Threshold that the
45
+ * Texture Memory Manager will attempt to maintain by cleaning up textures.
46
+ * The Texture Memory Manager will attempt to keep the memory usage below
47
+ * this level by freeing up non-renderable textures.
48
+ *
49
+ * Valid Range: 0.0 - 1.0
50
+ *
51
+ * @defaultValue `0.5`
52
+ */
53
+ targetThresholdLevel: number;
54
+
55
+ /**
56
+ * Interval between non-aggressive Texture Cleanups (in milliseconds)
57
+ *
58
+ * @remarks
59
+ * Texture Memory Manager will perform a non aggressive Texture Cleanup no more
60
+ * frequently than this interval when the scene becomes idle.
61
+ *
62
+ * @defaultValue `5,000` (5 seconds)
63
+ */
64
+ cleanupInterval: number;
65
+
66
+ /**
67
+ * Whether or not to log debug information
68
+ *
69
+ * @defaultValue `false`
70
+ */
71
+ debugLogging: boolean;
72
+
73
+ /**
74
+ * Baseline memory allocation for the Texture Memory Manager
75
+ *
76
+ * @remarks
77
+ * Baseline texture memory is an allocation of memory by simply having a 1080p WebGL context.
78
+ * This will be used on top of the memory used by textures to determine when to trigger a cleanup.
79
+ *
80
+ * @defaultValue `25e6` (25 MB)
81
+ */
82
+ baselineMemoryAllocation: number;
83
+
84
+ /**
85
+ * Do not exceed critical threshold
86
+ *
87
+ * @defaultValue `false`
88
+ */
89
+ doNotExceedCriticalThreshold: boolean;
90
+ }
91
+
92
+ export interface MemoryInfo {
93
+ criticalThreshold: number;
94
+ targetThreshold: number;
95
+ renderableMemUsed: number;
96
+ memUsed: number;
97
+ renderableTexturesLoaded: number;
98
+ loadedTextures: number;
99
+ baselineMemoryAllocation: number;
100
+ }
101
+
102
+ /**
103
+ * LRU (Least Recently Used) style memory manager for textures
104
+ *
105
+ * @remarks
106
+ * This class is responsible for managing the memory usage of textures
107
+ * in the Renderer. It keeps track of the memory used by each texture
108
+ * and triggers a cleanup when the memory usage exceeds a critical
109
+ * threshold (`criticalThreshold`).
110
+ *
111
+ * The cleanup process will free up non-renderable textures until the
112
+ * memory usage is below a target threshold (`targetThresholdLevel`).
113
+ *
114
+ * The memory manager's clean up process will also be triggered when the
115
+ * scene is idle for a certain amount of time (`cleanupInterval`).
116
+ */
117
+ export class TextureMemoryManager {
118
+ private memUsed = 0;
119
+ private loadedTextures: Map<Texture, number> = new Map();
120
+ private orphanedTextures: Texture[] = [];
121
+ private criticalThreshold: number;
122
+ private targetThreshold: number;
123
+ private cleanupInterval: number;
124
+ private debugLogging: boolean;
125
+ private lastCleanupTime = 0;
126
+ private baselineMemoryAllocation: number;
127
+
128
+ public criticalCleanupRequested = false;
129
+ public doNotExceedCriticalThreshold: boolean;
130
+
131
+ /**
132
+ * The current frame time in milliseconds
133
+ *
134
+ * @remarks
135
+ * This is used to determine when to perform Idle Texture Cleanups.
136
+ *
137
+ * Set by stage via `updateFrameTime` method.
138
+ */
139
+ public frameTime = 0;
140
+
141
+ constructor(private stage: Stage, settings: TextureMemoryManagerSettings) {
142
+ const { criticalThreshold, doNotExceedCriticalThreshold } = settings;
143
+ this.doNotExceedCriticalThreshold = doNotExceedCriticalThreshold || false;
144
+ this.criticalThreshold = Math.round(criticalThreshold);
145
+ const targetFraction = Math.max(
146
+ 0,
147
+ Math.min(1, settings.targetThresholdLevel),
148
+ );
149
+ this.cleanupInterval = settings.cleanupInterval;
150
+ this.debugLogging = settings.debugLogging;
151
+ this.baselineMemoryAllocation = Math.round(
152
+ settings.baselineMemoryAllocation,
153
+ );
154
+ this.targetThreshold = Math.max(
155
+ Math.round(criticalThreshold * targetFraction),
156
+ this.baselineMemoryAllocation,
157
+ );
158
+ this.memUsed = Math.round(settings.baselineMemoryAllocation);
159
+
160
+ if (settings.debugLogging) {
161
+ let lastMemUse = 0;
162
+ setInterval(() => {
163
+ if (lastMemUse !== this.memUsed) {
164
+ lastMemUse = this.memUsed;
165
+ console.log(
166
+ `[TextureMemoryManager] Memory used: ${bytesToMb(
167
+ this.memUsed,
168
+ )} mb / ${bytesToMb(this.criticalThreshold)} mb (${(
169
+ (this.memUsed / this.criticalThreshold) *
170
+ 100
171
+ ).toFixed(1)}%)`,
172
+ );
173
+ }
174
+ }, 1000);
175
+ }
176
+
177
+ // If the threshold is 0, we disable the memory manager by replacing the
178
+ // setTextureMemUse method with a no-op function.
179
+ if (criticalThreshold === 0) {
180
+ this.setTextureMemUse = () => {};
181
+ }
182
+ }
183
+
184
+ /**
185
+ * Add a texture to the orphaned textures list
186
+ *
187
+ * @param texture - The texture to add to the orphaned textures list
188
+ */
189
+ addToOrphanedTextures(texture: Texture) {
190
+ // if the texture is already in the orphaned textures list add it at the end
191
+ if (this.orphanedTextures.includes(texture)) {
192
+ this.removeFromOrphanedTextures(texture);
193
+ }
194
+
195
+ // If the texture can be cleaned up, add it to the orphaned textures list
196
+ if (texture.preventCleanup === false) {
197
+ this.orphanedTextures.push(texture);
198
+ }
199
+ }
200
+
201
+ /**
202
+ * Remove a texture from the orphaned textures list
203
+ *
204
+ * @param texture - The texture to remove from the orphaned textures list
205
+ */
206
+ removeFromOrphanedTextures(texture: Texture) {
207
+ const index = this.orphanedTextures.indexOf(texture);
208
+ if (index !== -1) {
209
+ this.orphanedTextures.splice(index, 1);
210
+ }
211
+ }
212
+
213
+ /**
214
+ * Set the memory usage of a texture
215
+ *
216
+ * @param texture - The texture to set memory usage for
217
+ * @param byteSize - The size of the texture in bytes
218
+ */
219
+ setTextureMemUse(texture: Texture, byteSize: number) {
220
+ if (this.loadedTextures.has(texture)) {
221
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
222
+ this.memUsed -= this.loadedTextures.get(texture)!;
223
+ }
224
+
225
+ if (byteSize === 0) {
226
+ this.loadedTextures.delete(texture);
227
+ return;
228
+ } else {
229
+ this.memUsed += byteSize;
230
+ this.loadedTextures.set(texture, byteSize);
231
+ }
232
+
233
+ if (this.memUsed > this.criticalThreshold) {
234
+ this.criticalCleanupRequested = true;
235
+ }
236
+ }
237
+
238
+ checkCleanup() {
239
+ return (
240
+ this.criticalCleanupRequested ||
241
+ (this.memUsed > this.targetThreshold &&
242
+ this.frameTime - this.lastCleanupTime >= this.cleanupInterval)
243
+ );
244
+ }
245
+
246
+ checkCriticalCleanup() {
247
+ return this.memUsed > this.criticalThreshold;
248
+ }
249
+
250
+ cleanupQuick(critical: boolean) {
251
+ // Free non-renderable textures until we reach the target threshold
252
+ const memTarget = this.targetThreshold;
253
+ const txManager = this.stage.txManager;
254
+ const timestamp = getTimeStamp();
255
+
256
+ while (
257
+ this.memUsed >= memTarget &&
258
+ this.orphanedTextures.length > 0 &&
259
+ (critical || getTimeStamp() - timestamp < 10)
260
+ ) {
261
+ const texture = this.orphanedTextures.shift();
262
+
263
+ if (texture === undefined) {
264
+ continue;
265
+ }
266
+
267
+ if (texture.renderable === true) {
268
+ // If the texture is renderable, we can't free it up
269
+ continue;
270
+ }
271
+
272
+ texture.free();
273
+ txManager.removeTextureFromCache(texture);
274
+ }
275
+ }
276
+
277
+ cleanupDeep(critical: boolean) {
278
+ // Free non-renderable textures until we reach the target threshold
279
+ const memTarget = critical ? this.criticalThreshold : this.targetThreshold;
280
+ const txManager = this.stage.txManager;
281
+
282
+ // sort by renderability
283
+ const filteredAndSortedTextures: Texture[] = [];
284
+ const textures = [...this.loadedTextures.keys()];
285
+ for (let i = 0; i < textures.length; i++) {
286
+ const texture = textures[i];
287
+ if (texture === undefined) {
288
+ continue;
289
+ }
290
+
291
+ if (
292
+ texture.type === TextureType.image ||
293
+ texture.type === TextureType.noise ||
294
+ texture.type === TextureType.renderToTexture
295
+ ) {
296
+ if (texture.renderable === true) {
297
+ filteredAndSortedTextures.push(texture);
298
+ } else {
299
+ filteredAndSortedTextures.unshift(texture);
300
+ }
301
+ }
302
+ }
303
+
304
+ while (this.memUsed >= memTarget && filteredAndSortedTextures.length > 0) {
305
+ const texture = filteredAndSortedTextures.shift();
306
+ if (texture === undefined) {
307
+ continue;
308
+ }
309
+
310
+ if (texture.preventCleanup === true) {
311
+ continue;
312
+ }
313
+
314
+ if (texture.renderable === true) {
315
+ break;
316
+ }
317
+
318
+ texture.free();
319
+ this.removeFromOrphanedTextures(texture);
320
+ txManager.removeTextureFromCache(texture);
321
+ txManager.removeTextureFromQueue(texture);
322
+ }
323
+ }
324
+
325
+ cleanup(aggressive: boolean = false) {
326
+ const critical = this.criticalCleanupRequested;
327
+ this.lastCleanupTime = this.frameTime;
328
+
329
+ if (critical === true) {
330
+ this.stage.queueFrameEvent('criticalCleanup', {
331
+ memUsed: this.memUsed,
332
+ criticalThreshold: this.criticalThreshold,
333
+ });
334
+ }
335
+
336
+ if (this.debugLogging === true) {
337
+ console.log(
338
+ `[TextureMemoryManager] Cleaning up textures. Critical: ${critical}. Aggressive: ${aggressive}`,
339
+ );
340
+ }
341
+
342
+ // try a quick cleanup first
343
+ this.cleanupQuick(critical);
344
+
345
+ // if we're still above the target threshold, do a deep cleanup
346
+ if (aggressive === true && this.memUsed >= this.criticalThreshold) {
347
+ this.cleanupDeep(critical);
348
+ }
349
+
350
+ if (this.memUsed >= this.criticalThreshold) {
351
+ this.stage.queueFrameEvent('criticalCleanupFailed', {
352
+ memUsed: this.memUsed,
353
+ criticalThreshold: this.criticalThreshold,
354
+ });
355
+
356
+ if (this.debugLogging === true || isProductionEnvironment() === false) {
357
+ console.warn(
358
+ `[TextureMemoryManager] Memory usage above critical threshold after cleanup: ${this.memUsed}`,
359
+ );
360
+ }
361
+ } else {
362
+ this.criticalCleanupRequested = false;
363
+ }
364
+ }
365
+
366
+ /**
367
+ * Get the current texture memory usage information
368
+ *
369
+ * @remarks
370
+ * This method is for debugging purposes and returns information about the
371
+ * current memory usage of the textures in the Renderer.
372
+ */
373
+ getMemoryInfo(): MemoryInfo {
374
+ let renderableTexturesLoaded = 0;
375
+ const renderableMemUsed = [...this.loadedTextures.keys()].reduce(
376
+ (acc, texture) => {
377
+ renderableTexturesLoaded += texture.renderable ? 1 : 0;
378
+ return (
379
+ acc + (texture.renderable ? this.loadedTextures.get(texture)! : 0)
380
+ );
381
+ },
382
+ this.baselineMemoryAllocation,
383
+ );
384
+
385
+ return {
386
+ criticalThreshold: this.criticalThreshold,
387
+ targetThreshold: this.targetThreshold,
388
+ renderableMemUsed,
389
+ memUsed: this.memUsed,
390
+ renderableTexturesLoaded,
391
+ loadedTextures: this.loadedTextures.size,
392
+ baselineMemoryAllocation: this.baselineMemoryAllocation,
393
+ };
394
+ }
395
+ }