@lightningjs/renderer 2.13.0 → 2.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (213) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/lib/ImageWorker.js +2 -1
  14. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  15. package/dist/src/core/lib/utils.d.ts +4 -0
  16. package/dist/src/core/lib/utils.js +46 -0
  17. package/dist/src/core/lib/utils.js.map +1 -1
  18. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  19. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  20. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  21. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  22. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  23. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  24. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  25. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  26. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  27. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  28. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  29. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  30. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  31. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  32. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  33. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  34. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  35. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  36. package/dist/src/core/textures/ImageTexture.d.ts +2 -2
  37. package/dist/src/core/textures/ImageTexture.js +24 -4
  38. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  39. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  40. package/dist/src/main-api/ICoreDriver.js +20 -0
  41. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  42. package/dist/src/main-api/RendererMain.d.ts +378 -0
  43. package/dist/src/main-api/RendererMain.js +367 -0
  44. package/dist/src/main-api/RendererMain.js.map +1 -0
  45. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  46. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  47. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  48. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  49. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  50. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  51. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  52. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  53. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  54. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  55. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  56. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  57. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  58. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  59. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  60. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  61. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  62. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  63. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  64. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  65. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  66. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  67. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  68. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  69. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  70. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  71. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  72. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  73. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  74. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  75. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  76. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  77. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  78. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  79. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  80. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  81. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  82. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  83. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  84. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  85. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  86. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  87. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  88. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  89. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  90. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  91. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  92. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  93. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  94. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  95. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  96. package/dist/src/render-drivers/utils.d.ts +12 -0
  97. package/dist/src/render-drivers/utils.js +74 -0
  98. package/dist/src/render-drivers/utils.js.map +1 -0
  99. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  100. package/dist/tsconfig.tsbuildinfo +1 -0
  101. package/exports/canvas.ts +39 -39
  102. package/exports/index.ts +89 -89
  103. package/exports/inspector.ts +24 -24
  104. package/exports/utils.ts +44 -44
  105. package/exports/webgl.ts +38 -38
  106. package/package.json +2 -1
  107. package/scripts/please-use-pnpm.js +13 -13
  108. package/src/common/CommonTypes.ts +146 -146
  109. package/src/common/EventEmitter.ts +77 -77
  110. package/src/common/IAnimationController.ts +92 -92
  111. package/src/common/IEventEmitter.ts +28 -28
  112. package/src/core/CoreNode.test.ts +202 -202
  113. package/src/core/CoreNode.ts +2455 -2455
  114. package/src/core/CoreShaderManager.ts +292 -292
  115. package/src/core/CoreTextNode.ts +455 -455
  116. package/src/core/CoreTextureManager.ts +597 -597
  117. package/src/core/Stage.ts +743 -743
  118. package/src/core/TextureMemoryManager.ts +395 -395
  119. package/src/core/animations/AnimationManager.ts +38 -38
  120. package/src/core/animations/CoreAnimation.ts +340 -340
  121. package/src/core/animations/CoreAnimationController.ts +157 -157
  122. package/src/core/lib/ContextSpy.ts +41 -41
  123. package/src/core/lib/ImageWorker.ts +280 -279
  124. package/src/core/lib/Matrix3d.ts +244 -244
  125. package/src/core/lib/RenderCoords.ts +86 -86
  126. package/src/core/lib/WebGlContextWrapper.ts +1332 -1332
  127. package/src/core/lib/textureCompression.ts +152 -152
  128. package/src/core/lib/textureSvg.ts +78 -78
  129. package/src/core/lib/utils.ts +384 -310
  130. package/src/core/lib/validateImageBitmap.ts +76 -76
  131. package/src/core/platform.ts +63 -63
  132. package/src/core/renderers/CoreContextTexture.ts +43 -43
  133. package/src/core/renderers/CoreRenderOp.ts +22 -22
  134. package/src/core/renderers/CoreRenderer.ts +115 -115
  135. package/src/core/renderers/CoreShader.ts +41 -41
  136. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +375 -375
  137. package/src/core/renderers/canvas/CanvasCoreTexture.ts +153 -153
  138. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  139. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  140. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  141. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +86 -86
  142. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  143. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +301 -301
  144. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  145. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +815 -815
  146. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  147. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  148. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  149. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  150. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  151. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  152. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  153. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  154. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  155. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  156. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  157. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  158. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  159. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  160. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  161. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  162. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  163. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  164. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  165. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  166. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  167. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  168. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  169. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  170. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  171. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  172. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  173. package/src/core/text-rendering/TrFontManager.ts +183 -183
  174. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  175. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  176. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  177. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  178. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  179. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  180. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  181. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  182. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +808 -808
  183. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  184. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  185. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  186. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +408 -408
  192. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  193. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  194. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  195. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  197. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  198. package/src/core/textures/ColorTexture.ts +102 -102
  199. package/src/core/textures/ImageTexture.ts +399 -376
  200. package/src/core/textures/NoiseTexture.ts +104 -104
  201. package/src/core/textures/RenderTexture.ts +85 -85
  202. package/src/core/textures/SubTexture.ts +205 -205
  203. package/src/core/textures/Texture.ts +337 -337
  204. package/src/core/utils.ts +227 -227
  205. package/src/env.d.ts +7 -7
  206. package/src/main-api/DynamicShaderController.ts +104 -104
  207. package/src/main-api/INode.ts +101 -101
  208. package/src/main-api/Inspector.ts +522 -522
  209. package/src/main-api/Renderer.ts +751 -751
  210. package/src/main-api/ShaderController.ts +80 -80
  211. package/src/main-api/utils.ts +45 -45
  212. package/src/utils.ts +248 -248
  213. package/COPYING +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
+ }