@lightningjs/renderer 3.0.0-beta3 → 3.0.0-beta4

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 (379) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/src/core/CoreNode.d.ts +3 -2
  6. package/dist/src/core/CoreNode.js +13 -7
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextNode.d.ts +2 -0
  9. package/dist/src/core/CoreTextNode.js +7 -0
  10. package/dist/src/core/CoreTextNode.js.map +1 -1
  11. package/dist/src/core/CoreTextureManager.d.ts +2 -0
  12. package/dist/src/core/CoreTextureManager.js +7 -5
  13. package/dist/src/core/CoreTextureManager.js.map +1 -1
  14. package/dist/src/core/Stage.d.ts +5 -0
  15. package/dist/src/core/Stage.js +10 -5
  16. package/dist/src/core/Stage.js.map +1 -1
  17. package/dist/src/core/lib/validateImageBitmap.d.ts +2 -1
  18. package/dist/src/core/lib/validateImageBitmap.js +4 -4
  19. package/dist/src/core/lib/validateImageBitmap.js.map +1 -1
  20. package/dist/src/core/platforms/Platform.d.ts +37 -0
  21. package/dist/src/{main-api/IRenderDriver.js → core/platforms/Platform.js} +4 -2
  22. package/dist/src/core/platforms/Platform.js.map +1 -0
  23. package/dist/src/core/platforms/web/WebPlatform.d.ts +9 -0
  24. package/dist/src/core/platforms/web/WebPlatform.js +58 -0
  25. package/dist/src/core/platforms/web/WebPlatform.js.map +1 -0
  26. package/dist/src/core/renderers/CoreRenderer.d.ts +3 -1
  27. package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
  28. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -1
  29. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +3 -1
  30. package/dist/src/core/renderers/webgl/WebGlRenderer.js +86 -60
  31. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -1
  32. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +35 -35
  33. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  34. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  35. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  36. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  37. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  38. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  39. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  40. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  41. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  42. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  43. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  44. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  45. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  46. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  47. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  48. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  49. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  50. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  51. package/dist/src/core/shaders/webgl/Border.js +59 -59
  52. package/dist/src/core/shaders/webgl/Default.js +47 -47
  53. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  54. package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
  55. package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
  56. package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
  57. package/dist/src/core/shaders/webgl/Rounded.js +71 -71
  58. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +66 -66
  59. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +79 -79
  60. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
  61. package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
  62. package/dist/src/core/shaders/webgl/Shadow.js +83 -83
  63. package/dist/src/core/temp.js +77 -0
  64. package/dist/src/core/temp.js.map +1 -0
  65. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +5 -0
  66. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  67. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.d.ts +1 -1
  68. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +50 -2
  69. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
  70. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +6 -2
  71. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  72. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.d.ts +1 -1
  73. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +66 -8
  74. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  75. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +13 -0
  76. package/dist/src/core/text-rendering/renderers/TextRenderer.js +3 -0
  77. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  78. package/dist/src/core/textures/ImageTexture.d.ts +1 -0
  79. package/dist/src/core/textures/ImageTexture.js +5 -3
  80. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  81. package/dist/src/core/textures/Texture.d.ts +9 -2
  82. package/dist/src/core/textures/Texture.js +18 -6
  83. package/dist/src/core/textures/Texture.js.map +1 -1
  84. package/dist/src/main-api/Renderer.d.ts +12 -0
  85. package/dist/src/main-api/Renderer.js +14 -2
  86. package/dist/src/main-api/Renderer.js.map +1 -1
  87. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  88. package/exports/canvas-shaders.ts +28 -28
  89. package/exports/canvas.ts +45 -45
  90. package/exports/index.ts +90 -90
  91. package/exports/inspector.ts +24 -24
  92. package/exports/utils.ts +44 -44
  93. package/exports/webgl-shaders.ts +28 -28
  94. package/exports/webgl.ts +50 -50
  95. package/package.json +1 -2
  96. package/scripts/please-use-pnpm.js +13 -13
  97. package/src/common/CommonTypes.ts +146 -146
  98. package/src/common/EventEmitter.ts +77 -77
  99. package/src/common/IAnimationController.ts +92 -92
  100. package/src/common/IEventEmitter.ts +28 -28
  101. package/src/core/CoreNode.test.ts +203 -203
  102. package/src/core/CoreNode.ts +2494 -2486
  103. package/src/core/CoreShaderManager.ts +188 -188
  104. package/src/core/CoreTextNode.ts +448 -439
  105. package/src/core/CoreTextureManager.ts +601 -597
  106. package/src/core/Stage.ts +754 -738
  107. package/src/core/TextureMemoryManager.ts +395 -395
  108. package/src/core/animations/AnimationManager.ts +38 -38
  109. package/src/core/animations/CoreAnimation.ts +284 -284
  110. package/src/core/animations/CoreAnimationController.ts +157 -157
  111. package/src/core/lib/ContextSpy.ts +41 -41
  112. package/src/core/lib/ImageWorker.ts +280 -280
  113. package/src/core/lib/Matrix3d.ts +244 -244
  114. package/src/core/lib/RenderCoords.ts +71 -71
  115. package/src/core/lib/WebGlContextWrapper.ts +1374 -1374
  116. package/src/core/lib/textureCompression.ts +152 -152
  117. package/src/core/lib/textureSvg.ts +78 -78
  118. package/src/core/lib/utils.ts +386 -386
  119. package/src/core/lib/validateImageBitmap.ts +87 -76
  120. package/src/core/platform.ts +64 -64
  121. package/src/core/platforms/Platform.ts +77 -0
  122. package/src/core/platforms/web/WebPlatform.ts +84 -0
  123. package/src/core/renderers/CoreContextTexture.ts +43 -43
  124. package/src/core/renderers/CoreRenderOp.ts +22 -22
  125. package/src/core/renderers/CoreRenderer.ts +109 -107
  126. package/src/core/renderers/CoreShaderNode.ts +165 -165
  127. package/src/core/renderers/CoreShaderProgram.ts +23 -23
  128. package/src/core/renderers/canvas/CanvasRenderer.ts +298 -298
  129. package/src/core/renderers/canvas/CanvasShaderNode.ts +99 -99
  130. package/src/core/renderers/canvas/CanvasTexture.ts +156 -156
  131. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +220 -220
  132. package/src/core/renderers/canvas/internal/ColorUtils.ts +85 -85
  133. package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +86 -86
  134. package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +50 -50
  135. package/src/core/renderers/webgl/WebGlCtxTexture.ts +301 -301
  136. package/src/core/renderers/webgl/WebGlRenderOp.ts +161 -161
  137. package/src/core/renderers/webgl/WebGlRenderer.ts +750 -720
  138. package/src/core/renderers/webgl/WebGlShaderNode.ts +437 -437
  139. package/src/core/renderers/webgl/WebGlShaderProgram.ts +318 -318
  140. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  141. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  142. package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -281
  143. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  144. package/src/core/shaders/canvas/Border.ts +78 -78
  145. package/src/core/shaders/canvas/HolePunch.ts +62 -62
  146. package/src/core/shaders/canvas/LinearGradient.ts +69 -69
  147. package/src/core/shaders/canvas/RadialGradient.ts +113 -113
  148. package/src/core/shaders/canvas/Rounded.ts +55 -55
  149. package/src/core/shaders/canvas/RoundedWithBorder.ts +68 -68
  150. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +88 -88
  151. package/src/core/shaders/canvas/RoundedWithShadow.ts +69 -69
  152. package/src/core/shaders/canvas/Shadow.ts +52 -52
  153. package/src/core/shaders/canvas/utils/render.ts +151 -151
  154. package/src/core/shaders/templates/BorderTemplate.ts +115 -115
  155. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
  156. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
  157. package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -81
  158. package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
  159. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
  160. package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
  161. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
  162. package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
  163. package/src/core/shaders/templates/shaderUtils.ts +47 -47
  164. package/src/core/shaders/webgl/Border.ts +96 -96
  165. package/src/core/shaders/webgl/Default.ts +89 -89
  166. package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
  167. package/src/core/shaders/webgl/HolePunch.ts +78 -78
  168. package/src/core/shaders/webgl/LinearGradient.ts +81 -81
  169. package/src/core/shaders/webgl/RadialGradient.ts +84 -84
  170. package/src/core/shaders/webgl/Rounded.ts +117 -117
  171. package/src/core/shaders/webgl/RoundedWithBorder.ts +114 -114
  172. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +133 -133
  173. package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -98
  174. package/src/core/shaders/webgl/SdfShader.ts +134 -134
  175. package/src/core/shaders/webgl/Shadow.ts +115 -115
  176. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  177. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  178. package/src/core/text-rendering/TrFontManager.ts +183 -183
  179. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  180. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  181. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  182. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  183. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  184. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  185. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  186. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +514 -509
  187. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +863 -815
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +846 -840
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  192. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  193. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  194. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  195. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +497 -408
  197. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  198. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  199. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  200. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  201. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  202. package/src/core/text-rendering/renderers/TextRenderer.ts +567 -550
  203. package/src/core/textures/ColorTexture.ts +102 -102
  204. package/src/core/textures/ImageTexture.ts +410 -399
  205. package/src/core/textures/NoiseTexture.ts +104 -104
  206. package/src/core/textures/RenderTexture.ts +85 -85
  207. package/src/core/textures/SubTexture.ts +205 -205
  208. package/src/core/textures/Texture.ts +358 -337
  209. package/src/core/utils.ts +227 -227
  210. package/src/env.d.ts +7 -7
  211. package/src/main-api/INode.ts +100 -100
  212. package/src/main-api/Inspector.ts +522 -522
  213. package/src/main-api/Renderer.ts +675 -649
  214. package/src/main-api/utils.ts +45 -45
  215. package/src/utils.ts +267 -267
  216. package/dist/exports/core-api.d.ts +0 -74
  217. package/dist/exports/core-api.js +0 -96
  218. package/dist/exports/core-api.js.map +0 -1
  219. package/dist/exports/main-api.d.ts +0 -30
  220. package/dist/exports/main-api.js +0 -45
  221. package/dist/exports/main-api.js.map +0 -1
  222. package/dist/src/core/CoreExtension.d.ts +0 -12
  223. package/dist/src/core/CoreExtension.js +0 -29
  224. package/dist/src/core/CoreExtension.js.map +0 -1
  225. package/dist/src/core/CoreStuff.js +0 -138
  226. package/dist/src/core/CoreStuff.js.map +0 -1
  227. package/dist/src/core/CoreTexturizer.d.ts +0 -14
  228. package/dist/src/core/CoreTexturizer.js +0 -47
  229. package/dist/src/core/CoreTexturizer.js.map +0 -1
  230. package/dist/src/core/LngNode.d.ts +0 -736
  231. package/dist/src/core/LngNode.js +0 -1174
  232. package/dist/src/core/LngNode.js.map +0 -1
  233. package/dist/src/core/Matrix2DContext.d.ts +0 -15
  234. package/dist/src/core/Matrix2DContext.js +0 -45
  235. package/dist/src/core/Matrix2DContext.js.map +0 -1
  236. package/dist/src/core/ShaderNode.d.ts +0 -10
  237. package/dist/src/core/ShaderNode.js +0 -30
  238. package/dist/src/core/ShaderNode.js.map +0 -1
  239. package/dist/src/core/TextNode.d.ts +0 -103
  240. package/dist/src/core/TextNode.js +0 -331
  241. package/dist/src/core/TextNode.js.map +0 -1
  242. package/dist/src/core/lib/Coords.d.ts +0 -14
  243. package/dist/src/core/lib/Coords.js +0 -55
  244. package/dist/src/core/lib/Coords.js.map +0 -1
  245. package/dist/src/core/lib/glm/common.d.ts +0 -162
  246. package/dist/src/core/lib/glm/common.js +0 -81
  247. package/dist/src/core/lib/glm/common.js.map +0 -1
  248. package/dist/src/core/lib/glm/index.d.ts +0 -11
  249. package/dist/src/core/lib/glm/index.js +0 -30
  250. package/dist/src/core/lib/glm/index.js.map +0 -1
  251. package/dist/src/core/lib/glm/mat2.d.ts +0 -219
  252. package/dist/src/core/lib/glm/mat2.js +0 -396
  253. package/dist/src/core/lib/glm/mat2.js.map +0 -1
  254. package/dist/src/core/lib/glm/mat2d.d.ts +0 -237
  255. package/dist/src/core/lib/glm/mat2d.js +0 -442
  256. package/dist/src/core/lib/glm/mat2d.js.map +0 -1
  257. package/dist/src/core/lib/glm/mat3.d.ts +0 -283
  258. package/dist/src/core/lib/glm/mat3.js +0 -680
  259. package/dist/src/core/lib/glm/mat3.js.map +0 -1
  260. package/dist/src/core/lib/glm/mat4.d.ts +0 -550
  261. package/dist/src/core/lib/glm/mat4.js +0 -1802
  262. package/dist/src/core/lib/glm/mat4.js.map +0 -1
  263. package/dist/src/core/lib/glm/quat.d.ts +0 -363
  264. package/dist/src/core/lib/glm/quat.js +0 -693
  265. package/dist/src/core/lib/glm/quat.js.map +0 -1
  266. package/dist/src/core/lib/glm/quat2.d.ts +0 -356
  267. package/dist/src/core/lib/glm/quat2.js +0 -754
  268. package/dist/src/core/lib/glm/quat2.js.map +0 -1
  269. package/dist/src/core/lib/glm/vec2.d.ts +0 -365
  270. package/dist/src/core/lib/glm/vec2.js +0 -569
  271. package/dist/src/core/lib/glm/vec2.js.map +0 -1
  272. package/dist/src/core/lib/glm/vec3.d.ts +0 -406
  273. package/dist/src/core/lib/glm/vec3.js +0 -720
  274. package/dist/src/core/lib/glm/vec3.js.map +0 -1
  275. package/dist/src/core/lib/glm/vec4.d.ts +0 -330
  276. package/dist/src/core/lib/glm/vec4.js +0 -608
  277. package/dist/src/core/lib/glm/vec4.js.map +0 -1
  278. package/dist/src/core/renderers/CoreShaderManager.d.ts +0 -19
  279. package/dist/src/core/renderers/CoreShaderManager.js +0 -33
  280. package/dist/src/core/renderers/CoreShaderManager.js.map +0 -1
  281. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +0 -27
  282. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +0 -82
  283. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +0 -1
  284. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +0 -11
  285. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +0 -34
  286. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +0 -1
  287. package/dist/src/core/scene/Scene.d.ts +0 -59
  288. package/dist/src/core/scene/Scene.js +0 -106
  289. package/dist/src/core/scene/Scene.js.map +0 -1
  290. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +0 -20
  291. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +0 -55
  292. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +0 -1
  293. package/dist/src/main-api/ICoreDriver.d.ts +0 -27
  294. package/dist/src/main-api/ICoreDriver.js +0 -20
  295. package/dist/src/main-api/ICoreDriver.js.map +0 -1
  296. package/dist/src/main-api/IRenderDriver.d.ts +0 -20
  297. package/dist/src/main-api/IRenderDriver.js.map +0 -1
  298. package/dist/src/main-api/IShaderController.d.ts +0 -14
  299. package/dist/src/main-api/IShaderController.js +0 -30
  300. package/dist/src/main-api/IShaderController.js.map +0 -1
  301. package/dist/src/main-api/IShaderNode.d.ts +0 -17
  302. package/dist/src/main-api/IShaderNode.js +0 -19
  303. package/dist/src/main-api/IShaderNode.js.map +0 -1
  304. package/dist/src/main-api/RendererMain.d.ts +0 -375
  305. package/dist/src/main-api/RendererMain.js +0 -365
  306. package/dist/src/main-api/RendererMain.js.map +0 -1
  307. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
  308. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
  309. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
  310. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
  311. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
  312. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
  313. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
  314. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +0 -28
  315. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
  316. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -24
  317. package/dist/src/render-drivers/main/MainCoreDriver.js +0 -118
  318. package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
  319. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -99
  320. package/dist/src/render-drivers/main/MainOnlyNode.js +0 -396
  321. package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
  322. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +0 -6
  323. package/dist/src/render-drivers/main/MainOnlyShaderController.js +0 -15
  324. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +0 -1
  325. package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +0 -7
  326. package/dist/src/render-drivers/main/MainOnlyShaderNode.js +0 -34
  327. package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +0 -1
  328. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
  329. package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -205
  330. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
  331. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +0 -17
  332. package/dist/src/render-drivers/main/MainRenderDriver.js +0 -88
  333. package/dist/src/render-drivers/main/MainRenderDriver.js.map +0 -1
  334. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -90
  335. package/dist/src/render-drivers/threadx/NodeStruct.js +0 -281
  336. package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
  337. package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -39
  338. package/dist/src/render-drivers/threadx/SharedNode.js +0 -60
  339. package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
  340. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
  341. package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -201
  342. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
  343. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -28
  344. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -234
  345. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
  346. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -20
  347. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -84
  348. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
  349. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -44
  350. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -154
  351. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
  352. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +0 -6
  353. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +0 -16
  354. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +0 -1
  355. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +0 -7
  356. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +0 -15
  357. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +0 -1
  358. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
  359. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
  360. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
  361. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +0 -21
  362. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +0 -198
  363. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +0 -1
  364. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
  365. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
  366. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
  367. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
  368. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -177
  369. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
  370. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
  371. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -108
  372. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
  373. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +0 -1
  374. package/dist/src/render-drivers/threadx/worker/renderer.js +0 -145
  375. package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
  376. package/dist/src/render-drivers/utils.d.ts +0 -12
  377. package/dist/src/render-drivers/utils.js +0 -69
  378. package/dist/src/render-drivers/utils.js.map +0 -1
  379. /package/dist/src/core/{CoreStuff.d.ts → temp.d.ts} +0 -0
@@ -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
+ }