@lightningjs/renderer 2.9.0-beta4 → 2.9.0

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 (208) 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/CoreNode.d.ts +5 -1
  14. package/dist/src/core/CoreNode.js +14 -4
  15. package/dist/src/core/CoreNode.js.map +1 -1
  16. package/dist/src/core/CoreTextureManager.d.ts +24 -0
  17. package/dist/src/core/CoreTextureManager.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/main-api/ICoreDriver.d.ts +24 -0
  37. package/dist/src/main-api/ICoreDriver.js +20 -0
  38. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  39. package/dist/src/main-api/RendererMain.d.ts +378 -0
  40. package/dist/src/main-api/RendererMain.js +367 -0
  41. package/dist/src/main-api/RendererMain.js.map +1 -0
  42. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  43. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  44. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  45. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  46. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  47. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  48. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  49. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  50. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  51. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  52. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  53. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  54. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  55. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  56. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  57. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  58. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  59. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  60. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  61. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  62. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  63. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  64. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  65. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  66. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  67. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  68. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  69. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  70. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  71. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  72. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  73. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  74. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  75. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  76. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  77. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  78. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  79. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  80. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  81. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  82. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  83. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  84. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  85. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  86. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  87. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  88. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  89. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  90. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  91. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  92. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  93. package/dist/src/render-drivers/utils.d.ts +12 -0
  94. package/dist/src/render-drivers/utils.js +74 -0
  95. package/dist/src/render-drivers/utils.js.map +1 -0
  96. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  97. package/dist/tsconfig.tsbuildinfo +1 -0
  98. package/exports/canvas.ts +39 -39
  99. package/exports/index.ts +89 -89
  100. package/exports/inspector.ts +24 -24
  101. package/exports/utils.ts +44 -44
  102. package/exports/webgl.ts +38 -38
  103. package/package.json +1 -1
  104. package/scripts/please-use-pnpm.js +13 -13
  105. package/src/common/CommonTypes.ts +139 -139
  106. package/src/common/EventEmitter.ts +77 -77
  107. package/src/common/IAnimationController.ts +92 -92
  108. package/src/common/IEventEmitter.ts +28 -28
  109. package/src/core/CoreNode.test.ts +199 -199
  110. package/src/core/CoreNode.ts +2335 -2313
  111. package/src/core/CoreShaderManager.ts +292 -292
  112. package/src/core/CoreTextNode.ts +455 -455
  113. package/src/core/CoreTextureManager.ts +548 -522
  114. package/src/core/Stage.ts +700 -700
  115. package/src/core/TextureMemoryManager.ts +277 -277
  116. package/src/core/animations/AnimationManager.ts +38 -38
  117. package/src/core/animations/CoreAnimation.ts +340 -340
  118. package/src/core/animations/CoreAnimationController.ts +157 -157
  119. package/src/core/lib/ContextSpy.ts +41 -41
  120. package/src/core/lib/ImageWorker.ts +270 -270
  121. package/src/core/lib/Matrix3d.ts +244 -244
  122. package/src/core/lib/RenderCoords.ts +86 -86
  123. package/src/core/lib/WebGlContextWrapper.ts +1322 -1322
  124. package/src/core/lib/textureCompression.ts +152 -152
  125. package/src/core/lib/textureSvg.ts +78 -78
  126. package/src/core/lib/utils.ts +306 -306
  127. package/src/core/platform.ts +61 -61
  128. package/src/core/renderers/CoreContextTexture.ts +43 -43
  129. package/src/core/renderers/CoreRenderOp.ts +22 -22
  130. package/src/core/renderers/CoreRenderer.ts +114 -114
  131. package/src/core/renderers/CoreShader.ts +41 -41
  132. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -364
  133. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -150
  134. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  135. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  136. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  137. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  138. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  139. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -298
  140. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  141. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -805
  142. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  143. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  144. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  145. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  146. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  147. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  148. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  149. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  150. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  151. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  152. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  153. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  154. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  155. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  156. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  157. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  158. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  159. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  160. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  161. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  162. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  163. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  164. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  165. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  166. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  167. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  168. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  169. package/src/core/text-rendering/TrFontManager.ts +183 -183
  170. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  171. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  172. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  173. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  174. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  175. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  176. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  177. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  178. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  179. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  180. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  181. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  182. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  183. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  184. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  185. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  186. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  192. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  193. package/src/core/textures/ColorTexture.ts +102 -102
  194. package/src/core/textures/ImageTexture.ts +378 -378
  195. package/src/core/textures/NoiseTexture.ts +104 -104
  196. package/src/core/textures/RenderTexture.ts +85 -85
  197. package/src/core/textures/SubTexture.ts +171 -171
  198. package/src/core/textures/Texture.ts +423 -423
  199. package/src/core/utils.ts +227 -227
  200. package/src/env.d.ts +7 -7
  201. package/src/main-api/DynamicShaderController.ts +104 -104
  202. package/src/main-api/INode.ts +101 -101
  203. package/src/main-api/Inspector.ts +505 -505
  204. package/src/main-api/Renderer.ts +693 -693
  205. package/src/main-api/ShaderController.ts +80 -80
  206. package/src/main-api/utils.ts +45 -45
  207. package/src/utils.ts +248 -248
  208. package/COPYING +0 -1
@@ -1,522 +1,548 @@
1
- /*
2
- * If not stated otherwise in this file or this component's LICENSE file the
3
- * following copyright and licenses apply:
4
- *
5
- * Copyright 2023 Comcast Cable Communications Management, LLC.
6
- *
7
- * Licensed under the Apache License, Version 2.0 (the License);
8
- * you may not use this file except in compliance with the License.
9
- * You may obtain a copy of the License at
10
- *
11
- * http://www.apache.org/licenses/LICENSE-2.0
12
- *
13
- * Unless required by applicable law or agreed to in writing, software
14
- * distributed under the License is distributed on an "AS IS" BASIS,
15
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- * See the License for the specific language governing permissions and
17
- * limitations under the License.
18
- */
19
-
20
- import { ImageWorkerManager } from './lib/ImageWorker.js';
21
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
22
- import { ColorTexture } from './textures/ColorTexture.js';
23
- import { ImageTexture } from './textures/ImageTexture.js';
24
- import { NoiseTexture } from './textures/NoiseTexture.js';
25
- import { SubTexture } from './textures/SubTexture.js';
26
- import { RenderTexture } from './textures/RenderTexture.js';
27
- import type { Texture } from './textures/Texture.js';
28
- import { EventEmitter } from '../common/EventEmitter.js';
29
-
30
- /**
31
- * Augmentable map of texture class types
32
- *
33
- * @remarks
34
- * This interface can be augmented by other modules/apps to add additional
35
- * texture types. The ones included directly here are the ones that are
36
- * included in the core library.
37
- */
38
- export interface TextureMap {
39
- ColorTexture: typeof ColorTexture;
40
- ImageTexture: typeof ImageTexture;
41
- NoiseTexture: typeof NoiseTexture;
42
- SubTexture: typeof SubTexture;
43
- RenderTexture: typeof RenderTexture;
44
- }
45
-
46
- export interface CreateImageBitmapSupport {
47
- basic: boolean; // Supports createImageBitmap(image)
48
- options: boolean; // Supports createImageBitmap(image, options)
49
- full: boolean; // Supports createImageBitmap(image, sx, sy, sw, sh, options)
50
- }
51
-
52
- export type ExtractProps<Type> = Type extends { z$__type__Props: infer Props }
53
- ? Props
54
- : never;
55
-
56
- /**
57
- * Contains information about the texture manager's internal state
58
- * for debugging purposes.
59
- */
60
- export interface TextureManagerDebugInfo {
61
- keyCacheSize: number;
62
- }
63
-
64
- export type ResizeModeOptions =
65
- | {
66
- /**
67
- * Specifies that the image should be resized to cover the specified dimensions.
68
- */
69
- type: 'cover';
70
- /**
71
- * The horizontal clipping position
72
- * To clip the left, set clipX to 0. To clip the right, set clipX to 1.
73
- * clipX 0.5 will clip a equal amount from left and right
74
- *
75
- * @defaultValue 0.5
76
- */
77
- clipX?: number;
78
- /**
79
- * The vertical clipping position
80
- * To clip the top, set clipY to 0. To clip the bottom, set clipY to 1.
81
- * clipY 0.5 will clip a equal amount from top and bottom
82
- *
83
- * @defaultValue 0.5
84
- */
85
- clipY?: number;
86
- }
87
- | {
88
- /**
89
- * Specifies that the image should be resized to fit within the specified dimensions.
90
- */
91
- type: 'contain';
92
- };
93
-
94
- /**
95
- * Universal options for all texture types
96
- *
97
- * @remarks
98
- * Texture Options provide a way to specify options that are relevant to the
99
- * texture loading process (including caching) and specifically for how a
100
- * texture is rendered within a specific Node (or set of Nodes).
101
- *
102
- * They are not used in determining the cache key for a texture (except if
103
- * the `cacheKey` option is provided explicitly to oveerride the default
104
- * cache key for the texture instance) nor are they stored/referenced within
105
- * the texture instance itself. Instead, the options are stored/referenced
106
- * within individual Nodes. So a single texture instance can be used in
107
- * multiple Nodes each using a different set of options.
108
- */
109
- export interface TextureOptions {
110
- /**
111
- * Flip the texture horizontally when rendering
112
- *
113
- * @defaultValue `false`
114
- */
115
- flipX?: boolean;
116
-
117
- /**
118
- * Flip the texture vertically when rendering
119
- *
120
- * @defaultValue `false`
121
- */
122
- flipY?: boolean;
123
-
124
- /**
125
- * You can use resizeMode to determine the clipping automatically from the width
126
- * and height of the source texture. This can be convenient if you are unsure about
127
- * the exact image sizes but want the image to cover a specific area.
128
- *
129
- * The resize modes cover and contain are supported
130
- */
131
- resizeMode?: ResizeModeOptions;
132
- }
133
-
134
- export class CoreTextureManager extends EventEmitter {
135
- /**
136
- * Map of textures by cache key
137
- */
138
- keyCache: Map<string, Texture> = new Map();
139
-
140
- /**
141
- * Map of cache keys by texture
142
- */
143
- inverseKeyCache: WeakMap<Texture, string> = new WeakMap();
144
-
145
- /**
146
- * Map of texture constructors by their type name
147
- */
148
- txConstructors: Partial<TextureMap> = {};
149
-
150
- private downloadTextureSourceQueue: Array<Texture> = [];
151
- private priorityQueue: Array<Texture> = [];
152
- private uploadTextureQueue: Array<Texture> = [];
153
- private initialized = false;
154
-
155
- imageWorkerManager: ImageWorkerManager | null = null;
156
- hasCreateImageBitmap = !!self.createImageBitmap;
157
- imageBitmapSupported = {
158
- basic: false,
159
- options: false,
160
- full: false,
161
- };
162
-
163
- hasWorker = !!self.Worker;
164
- /**
165
- * Renderer that this texture manager is associated with
166
- *
167
- * @remarks
168
- * This MUST be set before the texture manager is used. Otherwise errors
169
- * will occur when using the texture manager.
170
- */
171
- renderer!: CoreRenderer;
172
-
173
- /**
174
- * The current frame time in milliseconds
175
- *
176
- * @remarks
177
- * This is used to populate the `lastRenderableChangeTime` property of
178
- * {@link Texture} instances when their renderable state changes.
179
- *
180
- * Set by stage via `updateFrameTime` method.
181
- */
182
- frameTime = 0;
183
-
184
- constructor(numImageWorkers: number) {
185
- super();
186
- this.validateCreateImageBitmap()
187
- .then((result) => {
188
- this.hasCreateImageBitmap =
189
- result.basic || result.options || result.full;
190
- this.imageBitmapSupported = result;
191
-
192
- if (!this.hasCreateImageBitmap) {
193
- console.warn(
194
- '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
195
- );
196
- }
197
-
198
- if (
199
- this.hasCreateImageBitmap &&
200
- this.hasWorker &&
201
- numImageWorkers > 0
202
- ) {
203
- this.imageWorkerManager = new ImageWorkerManager(
204
- numImageWorkers,
205
- result,
206
- );
207
- } else {
208
- console.warn(
209
- '[Lightning] Imageworker is 0 or not supported on this browser. Image loading will be slower.',
210
- );
211
- }
212
-
213
- this.initialized = true;
214
- this.emit('initialized');
215
- })
216
- .catch((e) => {
217
- console.warn(
218
- '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
219
- );
220
-
221
- // initialized without image worker manager and createImageBitmap
222
- this.initialized = true;
223
- this.emit('initialized');
224
- });
225
-
226
- this.registerTextureType('ImageTexture', ImageTexture);
227
- this.registerTextureType('ColorTexture', ColorTexture);
228
- this.registerTextureType('NoiseTexture', NoiseTexture);
229
- this.registerTextureType('SubTexture', SubTexture);
230
- this.registerTextureType('RenderTexture', RenderTexture);
231
- }
232
-
233
- private async validateCreateImageBitmap(): Promise<CreateImageBitmapSupport> {
234
- // Test if createImageBitmap is supported using a simple 1x1 PNG image
235
- // prettier-ignore
236
- const pngBinaryData = new Uint8Array([
237
- 0x89, 0x50, 0x4e, 0x47,
238
- 0x0d, 0x0a, 0x1a, 0x0a, // PNG signature
239
- 0x00, 0x00, 0x00, 0x0d, // IHDR chunk length
240
- 0x49, 0x48, 0x44, 0x52, // "IHDR" chunk type
241
- 0x00, 0x00, 0x00, 0x01, // Width: 1
242
- 0x00, 0x00, 0x00, 0x01, // Height: 1
243
- 0x01, // Bit depth: 1
244
- 0x03, // Color type: Indexed
245
- 0x00, // Compression method: Deflate
246
- 0x00, // Filter method: None
247
- 0x00, // Interlace method: None
248
- 0x25, 0xdb, 0x56, 0xca, // CRC for IHDR
249
- 0x00, 0x00, 0x00, 0x03, // PLTE chunk length
250
- 0x50, 0x4c, 0x54, 0x45, // "PLTE" chunk type
251
- 0x00, 0x00, 0x00, // Palette entry: Black
252
- 0xa7, 0x7a, 0x3d, 0xda, // CRC for PLTE
253
- 0x00, 0x00, 0x00, 0x01, // tRNS chunk length
254
- 0x74, 0x52, 0x4e, 0x53, // "tRNS" chunk type
255
- 0x00, // Transparency for black: Fully transparent
256
- 0x40, 0xe6, 0xd8, 0x66, // CRC for tRNS
257
- 0x00, 0x00, 0x00, 0x0a, // IDAT chunk length
258
- 0x49, 0x44, 0x41, 0x54, // "IDAT" chunk type
259
- 0x08, 0xd7, // Deflate header
260
- 0x63, 0x60, 0x00, 0x00,
261
- 0x00, 0x02, 0x00, 0x01, // Zlib-compressed data
262
- 0xe2, 0x21, 0xbc, 0x33, // CRC for IDAT
263
- 0x00, 0x00, 0x00, 0x00, // IEND chunk length
264
- 0x49, 0x45, 0x4e, 0x44, // "IEND" chunk type
265
- 0xae, 0x42, 0x60, 0x82, // CRC for IEND
266
- ]);
267
-
268
- const support: CreateImageBitmapSupport = {
269
- basic: false,
270
- options: false,
271
- full: false,
272
- };
273
-
274
- // Test basic createImageBitmap support
275
- const blob = new Blob([pngBinaryData], { type: 'image/png' });
276
- const bitmap = await createImageBitmap(blob);
277
- bitmap.close?.();
278
- support.basic = true;
279
-
280
- // Test createImageBitmap with options support
281
- try {
282
- const options = { premultiplyAlpha: 'none' as const };
283
- const bitmapWithOptions = await createImageBitmap(blob, options);
284
- bitmapWithOptions.close?.();
285
- support.options = true;
286
- } catch (e) {
287
- /* ignore */
288
- }
289
-
290
- // Test createImageBitmap with full options support
291
- try {
292
- const bitmapWithFullOptions = await createImageBitmap(blob, 0, 0, 1, 1, {
293
- premultiplyAlpha: 'none',
294
- });
295
- bitmapWithFullOptions.close?.();
296
- support.full = true;
297
- } catch (e) {
298
- /* ignore */
299
- }
300
-
301
- return support;
302
- }
303
-
304
- registerTextureType<Type extends keyof TextureMap>(
305
- textureType: Type,
306
- textureClass: TextureMap[Type],
307
- ): void {
308
- this.txConstructors[textureType] = textureClass;
309
- }
310
-
311
- /**
312
- * Enqueue a texture for downloading its source image.
313
- */
314
- enqueueDownloadTextureSource(texture: Texture): void {
315
- if (!this.downloadTextureSourceQueue.includes(texture)) {
316
- this.downloadTextureSourceQueue.push(texture);
317
- }
318
- }
319
-
320
- /**
321
- * Enqueue a texture for uploading to the GPU.
322
- *
323
- * @param texture - The texture to upload
324
- */
325
- enqueueUploadTexture(texture: Texture): void {
326
- if (this.uploadTextureQueue.includes(texture) === false) {
327
- this.uploadTextureQueue.push(texture);
328
- }
329
- }
330
-
331
- /**
332
- * Create a texture
333
- *
334
- * @param textureType - The type of texture to create
335
- * @param props - The properties to use for the texture
336
- */
337
- createTexture<Type extends keyof TextureMap>(
338
- textureType: Type,
339
- props: ExtractProps<TextureMap[Type]>,
340
- ): InstanceType<TextureMap[Type]> {
341
- let texture: Texture | undefined;
342
- const TextureClass = this.txConstructors[textureType];
343
- if (!TextureClass) {
344
- throw new Error(`Texture type "${textureType}" is not registered`);
345
- }
346
-
347
- const cacheKey = TextureClass.makeCacheKey(props as any);
348
- if (cacheKey && this.keyCache.has(cacheKey)) {
349
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
350
- texture = this.keyCache.get(cacheKey)!;
351
- } else {
352
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
353
- texture = new TextureClass(this, props as any);
354
-
355
- if (cacheKey) {
356
- this.initTextureToCache(texture, cacheKey);
357
- }
358
- }
359
-
360
- return texture as InstanceType<TextureMap[Type]>;
361
- }
362
-
363
- /**
364
- * Override loadTexture to use the batched approach.
365
- *
366
- * @param texture - The texture to load
367
- * @param immediate - Whether to prioritize the texture for immediate loading
368
- */
369
- loadTexture(texture: Texture, priority?: boolean): void {
370
- if (texture.state === 'loaded' || texture.state === 'loading') {
371
- return;
372
- }
373
-
374
- texture.setSourceState('loading');
375
- texture.setCoreCtxState('loading');
376
-
377
- // if we're not initialized, just queue the texture into the priority queue
378
- if (this.initialized === false) {
379
- this.priorityQueue.push(texture);
380
- return;
381
- }
382
-
383
- // prioritize the texture for immediate loading
384
- if (priority === true) {
385
- texture
386
- .getTextureData()
387
- .then(() => {
388
- this.uploadTexture(texture);
389
- })
390
- .catch((err) => {
391
- console.error(err);
392
- });
393
- }
394
-
395
- // enqueue the texture for download and upload
396
- this.enqueueDownloadTextureSource(texture);
397
- }
398
-
399
- /**
400
- * Upload a texture to the GPU
401
- *
402
- * @param texture Texture to upload
403
- */
404
- uploadTexture(texture: Texture): void {
405
- const coreContext = texture.loadCtxTexture();
406
- coreContext.load();
407
- }
408
-
409
- /**
410
- * Process a limited number of downloads and uploads.
411
- *
412
- * @param maxItems - The maximum number of items to process
413
- */
414
- processSome(maxItems = 0): void {
415
- if (this.initialized === false) {
416
- return;
417
- }
418
-
419
- let itemsProcessed = 0;
420
-
421
- // Process priority queue
422
- while (
423
- this.priorityQueue.length > 0 &&
424
- (maxItems === 0 || itemsProcessed < maxItems)
425
- ) {
426
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
427
- const texture = this.priorityQueue.shift()!;
428
- texture.getTextureData().then(() => {
429
- this.uploadTexture(texture);
430
- });
431
- itemsProcessed++;
432
- }
433
-
434
- // Process uploads
435
- while (
436
- this.uploadTextureQueue.length > 0 &&
437
- (maxItems === 0 || itemsProcessed < maxItems)
438
- ) {
439
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
440
- this.uploadTexture(this.uploadTextureQueue.shift()!);
441
- itemsProcessed++;
442
- }
443
-
444
- // Process downloads
445
- while (
446
- this.downloadTextureSourceQueue.length > 0 &&
447
- (maxItems === 0 || itemsProcessed < maxItems)
448
- ) {
449
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
450
- const texture = this.downloadTextureSourceQueue.shift()!;
451
- queueMicrotask(() => {
452
- texture.getTextureData().then(() => {
453
- this.enqueueUploadTexture(texture);
454
- });
455
- });
456
-
457
- itemsProcessed++;
458
- }
459
- }
460
-
461
- public hasUpdates(): boolean {
462
- return (
463
- this.downloadTextureSourceQueue.length > 0 ||
464
- this.uploadTextureQueue.length > 0
465
- );
466
- }
467
-
468
- /**
469
- * Initialize a texture to the cache
470
- *
471
- * @param texture Texture to cache
472
- * @param cacheKey Cache key for the texture
473
- */
474
- initTextureToCache(texture: Texture, cacheKey: string) {
475
- const { keyCache, inverseKeyCache } = this;
476
- keyCache.set(cacheKey, texture);
477
- inverseKeyCache.set(texture, cacheKey);
478
- }
479
-
480
- /**
481
- * Get a texture from the cache
482
- *
483
- * @param cacheKey
484
- */
485
- getTextureFromCache(cacheKey: string): Texture | undefined {
486
- return this.keyCache.get(cacheKey);
487
- }
488
-
489
- /**
490
- * Remove a texture from the cache
491
- *
492
- * @remarks
493
- * Called by Texture Cleanup when a texture is freed.
494
- *
495
- * @param texture
496
- */
497
- removeTextureFromCache(texture: Texture) {
498
- const { inverseKeyCache, keyCache } = this;
499
- const cacheKey = inverseKeyCache.get(texture);
500
- if (cacheKey) {
501
- keyCache.delete(cacheKey);
502
- }
503
- }
504
-
505
- /**
506
- * Resolve a parent texture from the cache or fallback to the provided texture.
507
- *
508
- * @param texture - The provided texture to resolve.
509
- * @returns The cached or provided texture.
510
- */
511
- resolveParentTexture(texture: ImageTexture): Texture {
512
- if (!texture?.props) {
513
- return texture;
514
- }
515
-
516
- const cacheKey = ImageTexture.makeCacheKey(texture.props);
517
- const cachedTexture = cacheKey
518
- ? this.getTextureFromCache(cacheKey)
519
- : undefined;
520
- return cachedTexture ?? texture;
521
- }
522
- }
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+
20
+ import { ImageWorkerManager } from './lib/ImageWorker.js';
21
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
22
+ import { ColorTexture } from './textures/ColorTexture.js';
23
+ import { ImageTexture } from './textures/ImageTexture.js';
24
+ import { NoiseTexture } from './textures/NoiseTexture.js';
25
+ import { SubTexture } from './textures/SubTexture.js';
26
+ import { RenderTexture } from './textures/RenderTexture.js';
27
+ import type { Texture } from './textures/Texture.js';
28
+ import { EventEmitter } from '../common/EventEmitter.js';
29
+
30
+ /**
31
+ * Augmentable map of texture class types
32
+ *
33
+ * @remarks
34
+ * This interface can be augmented by other modules/apps to add additional
35
+ * texture types. The ones included directly here are the ones that are
36
+ * included in the core library.
37
+ */
38
+ export interface TextureMap {
39
+ ColorTexture: typeof ColorTexture;
40
+ ImageTexture: typeof ImageTexture;
41
+ NoiseTexture: typeof NoiseTexture;
42
+ SubTexture: typeof SubTexture;
43
+ RenderTexture: typeof RenderTexture;
44
+ }
45
+
46
+ export interface CreateImageBitmapSupport {
47
+ basic: boolean; // Supports createImageBitmap(image)
48
+ options: boolean; // Supports createImageBitmap(image, options)
49
+ full: boolean; // Supports createImageBitmap(image, sx, sy, sw, sh, options)
50
+ }
51
+
52
+ export type ExtractProps<Type> = Type extends { z$__type__Props: infer Props }
53
+ ? Props
54
+ : never;
55
+
56
+ /**
57
+ * Contains information about the texture manager's internal state
58
+ * for debugging purposes.
59
+ */
60
+ export interface TextureManagerDebugInfo {
61
+ keyCacheSize: number;
62
+ }
63
+
64
+ export type ResizeModeOptions =
65
+ | {
66
+ /**
67
+ * Specifies that the image should be resized to cover the specified dimensions.
68
+ */
69
+ type: 'cover';
70
+ /**
71
+ * The horizontal clipping position
72
+ * To clip the left, set clipX to 0. To clip the right, set clipX to 1.
73
+ * clipX 0.5 will clip a equal amount from left and right
74
+ *
75
+ * @defaultValue 0.5
76
+ */
77
+ clipX?: number;
78
+ /**
79
+ * The vertical clipping position
80
+ * To clip the top, set clipY to 0. To clip the bottom, set clipY to 1.
81
+ * clipY 0.5 will clip a equal amount from top and bottom
82
+ *
83
+ * @defaultValue 0.5
84
+ */
85
+ clipY?: number;
86
+ }
87
+ | {
88
+ /**
89
+ * Specifies that the image should be resized to fit within the specified dimensions.
90
+ */
91
+ type: 'contain';
92
+ };
93
+
94
+ /**
95
+ * Universal options for all texture types
96
+ *
97
+ * @remarks
98
+ * Texture Options provide a way to specify options that are relevant to the
99
+ * texture loading process (including caching) and specifically for how a
100
+ * texture is rendered within a specific Node (or set of Nodes).
101
+ *
102
+ * They are not used in determining the cache key for a texture (except if
103
+ * the `cacheKey` option is provided explicitly to oveerride the default
104
+ * cache key for the texture instance) nor are they stored/referenced within
105
+ * the texture instance itself. Instead, the options are stored/referenced
106
+ * within individual Nodes. So a single texture instance can be used in
107
+ * multiple Nodes each using a different set of options.
108
+ */
109
+ export interface TextureOptions {
110
+ /**
111
+ * Preload the texture immediately even if it's not being rendered to the
112
+ * screen.
113
+ *
114
+ * @remarks
115
+ * This allows the texture to be used immediately without any delay when it
116
+ * is first needed for rendering. Otherwise the loading process will start
117
+ * when the texture is first rendered, which may cause a delay in that texture
118
+ * being shown properly.
119
+ *
120
+ * @defaultValue `false`
121
+ */
122
+ preload?: boolean;
123
+
124
+ /**
125
+ * Prevent clean up of the texture when it is no longer being used.
126
+ *
127
+ * @remarks
128
+ * This is useful when you want to keep the texture in memory for later use.
129
+ * Regardless of whether the texture is being used or not, it will not be
130
+ * cleaned up.
131
+ *
132
+ * @defaultValue `false`
133
+ */
134
+ preventCleanup?: boolean;
135
+
136
+ /**
137
+ * Flip the texture horizontally when rendering
138
+ *
139
+ * @defaultValue `false`
140
+ */
141
+ flipX?: boolean;
142
+
143
+ /**
144
+ * Flip the texture vertically when rendering
145
+ *
146
+ * @defaultValue `false`
147
+ */
148
+ flipY?: boolean;
149
+
150
+ /**
151
+ * You can use resizeMode to determine the clipping automatically from the width
152
+ * and height of the source texture. This can be convenient if you are unsure about
153
+ * the exact image sizes but want the image to cover a specific area.
154
+ *
155
+ * The resize modes cover and contain are supported
156
+ */
157
+ resizeMode?: ResizeModeOptions;
158
+ }
159
+
160
+ export class CoreTextureManager extends EventEmitter {
161
+ /**
162
+ * Map of textures by cache key
163
+ */
164
+ keyCache: Map<string, Texture> = new Map();
165
+
166
+ /**
167
+ * Map of cache keys by texture
168
+ */
169
+ inverseKeyCache: WeakMap<Texture, string> = new WeakMap();
170
+
171
+ /**
172
+ * Map of texture constructors by their type name
173
+ */
174
+ txConstructors: Partial<TextureMap> = {};
175
+
176
+ private downloadTextureSourceQueue: Array<Texture> = [];
177
+ private priorityQueue: Array<Texture> = [];
178
+ private uploadTextureQueue: Array<Texture> = [];
179
+ private initialized = false;
180
+
181
+ imageWorkerManager: ImageWorkerManager | null = null;
182
+ hasCreateImageBitmap = !!self.createImageBitmap;
183
+ imageBitmapSupported = {
184
+ basic: false,
185
+ options: false,
186
+ full: false,
187
+ };
188
+
189
+ hasWorker = !!self.Worker;
190
+ /**
191
+ * Renderer that this texture manager is associated with
192
+ *
193
+ * @remarks
194
+ * This MUST be set before the texture manager is used. Otherwise errors
195
+ * will occur when using the texture manager.
196
+ */
197
+ renderer!: CoreRenderer;
198
+
199
+ /**
200
+ * The current frame time in milliseconds
201
+ *
202
+ * @remarks
203
+ * This is used to populate the `lastRenderableChangeTime` property of
204
+ * {@link Texture} instances when their renderable state changes.
205
+ *
206
+ * Set by stage via `updateFrameTime` method.
207
+ */
208
+ frameTime = 0;
209
+
210
+ constructor(numImageWorkers: number) {
211
+ super();
212
+ this.validateCreateImageBitmap()
213
+ .then((result) => {
214
+ this.hasCreateImageBitmap =
215
+ result.basic || result.options || result.full;
216
+ this.imageBitmapSupported = result;
217
+
218
+ if (!this.hasCreateImageBitmap) {
219
+ console.warn(
220
+ '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
221
+ );
222
+ }
223
+
224
+ if (
225
+ this.hasCreateImageBitmap &&
226
+ this.hasWorker &&
227
+ numImageWorkers > 0
228
+ ) {
229
+ this.imageWorkerManager = new ImageWorkerManager(
230
+ numImageWorkers,
231
+ result,
232
+ );
233
+ } else {
234
+ console.warn(
235
+ '[Lightning] Imageworker is 0 or not supported on this browser. Image loading will be slower.',
236
+ );
237
+ }
238
+
239
+ this.initialized = true;
240
+ this.emit('initialized');
241
+ })
242
+ .catch((e) => {
243
+ console.warn(
244
+ '[Lightning] createImageBitmap is not supported on this browser. ImageTexture will be slower.',
245
+ );
246
+
247
+ // initialized without image worker manager and createImageBitmap
248
+ this.initialized = true;
249
+ this.emit('initialized');
250
+ });
251
+
252
+ this.registerTextureType('ImageTexture', ImageTexture);
253
+ this.registerTextureType('ColorTexture', ColorTexture);
254
+ this.registerTextureType('NoiseTexture', NoiseTexture);
255
+ this.registerTextureType('SubTexture', SubTexture);
256
+ this.registerTextureType('RenderTexture', RenderTexture);
257
+ }
258
+
259
+ private async validateCreateImageBitmap(): Promise<CreateImageBitmapSupport> {
260
+ // Test if createImageBitmap is supported using a simple 1x1 PNG image
261
+ // prettier-ignore
262
+ const pngBinaryData = new Uint8Array([
263
+ 0x89, 0x50, 0x4e, 0x47,
264
+ 0x0d, 0x0a, 0x1a, 0x0a, // PNG signature
265
+ 0x00, 0x00, 0x00, 0x0d, // IHDR chunk length
266
+ 0x49, 0x48, 0x44, 0x52, // "IHDR" chunk type
267
+ 0x00, 0x00, 0x00, 0x01, // Width: 1
268
+ 0x00, 0x00, 0x00, 0x01, // Height: 1
269
+ 0x01, // Bit depth: 1
270
+ 0x03, // Color type: Indexed
271
+ 0x00, // Compression method: Deflate
272
+ 0x00, // Filter method: None
273
+ 0x00, // Interlace method: None
274
+ 0x25, 0xdb, 0x56, 0xca, // CRC for IHDR
275
+ 0x00, 0x00, 0x00, 0x03, // PLTE chunk length
276
+ 0x50, 0x4c, 0x54, 0x45, // "PLTE" chunk type
277
+ 0x00, 0x00, 0x00, // Palette entry: Black
278
+ 0xa7, 0x7a, 0x3d, 0xda, // CRC for PLTE
279
+ 0x00, 0x00, 0x00, 0x01, // tRNS chunk length
280
+ 0x74, 0x52, 0x4e, 0x53, // "tRNS" chunk type
281
+ 0x00, // Transparency for black: Fully transparent
282
+ 0x40, 0xe6, 0xd8, 0x66, // CRC for tRNS
283
+ 0x00, 0x00, 0x00, 0x0a, // IDAT chunk length
284
+ 0x49, 0x44, 0x41, 0x54, // "IDAT" chunk type
285
+ 0x08, 0xd7, // Deflate header
286
+ 0x63, 0x60, 0x00, 0x00,
287
+ 0x00, 0x02, 0x00, 0x01, // Zlib-compressed data
288
+ 0xe2, 0x21, 0xbc, 0x33, // CRC for IDAT
289
+ 0x00, 0x00, 0x00, 0x00, // IEND chunk length
290
+ 0x49, 0x45, 0x4e, 0x44, // "IEND" chunk type
291
+ 0xae, 0x42, 0x60, 0x82, // CRC for IEND
292
+ ]);
293
+
294
+ const support: CreateImageBitmapSupport = {
295
+ basic: false,
296
+ options: false,
297
+ full: false,
298
+ };
299
+
300
+ // Test basic createImageBitmap support
301
+ const blob = new Blob([pngBinaryData], { type: 'image/png' });
302
+ const bitmap = await createImageBitmap(blob);
303
+ bitmap.close?.();
304
+ support.basic = true;
305
+
306
+ // Test createImageBitmap with options support
307
+ try {
308
+ const options = { premultiplyAlpha: 'none' as const };
309
+ const bitmapWithOptions = await createImageBitmap(blob, options);
310
+ bitmapWithOptions.close?.();
311
+ support.options = true;
312
+ } catch (e) {
313
+ /* ignore */
314
+ }
315
+
316
+ // Test createImageBitmap with full options support
317
+ try {
318
+ const bitmapWithFullOptions = await createImageBitmap(blob, 0, 0, 1, 1, {
319
+ premultiplyAlpha: 'none',
320
+ });
321
+ bitmapWithFullOptions.close?.();
322
+ support.full = true;
323
+ } catch (e) {
324
+ /* ignore */
325
+ }
326
+
327
+ return support;
328
+ }
329
+
330
+ registerTextureType<Type extends keyof TextureMap>(
331
+ textureType: Type,
332
+ textureClass: TextureMap[Type],
333
+ ): void {
334
+ this.txConstructors[textureType] = textureClass;
335
+ }
336
+
337
+ /**
338
+ * Enqueue a texture for downloading its source image.
339
+ */
340
+ enqueueDownloadTextureSource(texture: Texture): void {
341
+ if (!this.downloadTextureSourceQueue.includes(texture)) {
342
+ this.downloadTextureSourceQueue.push(texture);
343
+ }
344
+ }
345
+
346
+ /**
347
+ * Enqueue a texture for uploading to the GPU.
348
+ *
349
+ * @param texture - The texture to upload
350
+ */
351
+ enqueueUploadTexture(texture: Texture): void {
352
+ if (this.uploadTextureQueue.includes(texture) === false) {
353
+ this.uploadTextureQueue.push(texture);
354
+ }
355
+ }
356
+
357
+ /**
358
+ * Create a texture
359
+ *
360
+ * @param textureType - The type of texture to create
361
+ * @param props - The properties to use for the texture
362
+ */
363
+ createTexture<Type extends keyof TextureMap>(
364
+ textureType: Type,
365
+ props: ExtractProps<TextureMap[Type]>,
366
+ ): InstanceType<TextureMap[Type]> {
367
+ let texture: Texture | undefined;
368
+ const TextureClass = this.txConstructors[textureType];
369
+ if (!TextureClass) {
370
+ throw new Error(`Texture type "${textureType}" is not registered`);
371
+ }
372
+
373
+ const cacheKey = TextureClass.makeCacheKey(props as any);
374
+ if (cacheKey && this.keyCache.has(cacheKey)) {
375
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
376
+ texture = this.keyCache.get(cacheKey)!;
377
+ } else {
378
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
379
+ texture = new TextureClass(this, props as any);
380
+
381
+ if (cacheKey) {
382
+ this.initTextureToCache(texture, cacheKey);
383
+ }
384
+ }
385
+
386
+ return texture as InstanceType<TextureMap[Type]>;
387
+ }
388
+
389
+ /**
390
+ * Override loadTexture to use the batched approach.
391
+ *
392
+ * @param texture - The texture to load
393
+ * @param immediate - Whether to prioritize the texture for immediate loading
394
+ */
395
+ loadTexture(texture: Texture, priority?: boolean): void {
396
+ if (texture.state === 'loaded' || texture.state === 'loading') {
397
+ return;
398
+ }
399
+
400
+ texture.setSourceState('loading');
401
+ texture.setCoreCtxState('loading');
402
+
403
+ // if we're not initialized, just queue the texture into the priority queue
404
+ if (this.initialized === false) {
405
+ this.priorityQueue.push(texture);
406
+ return;
407
+ }
408
+
409
+ // prioritize the texture for immediate loading
410
+ if (priority === true) {
411
+ texture
412
+ .getTextureData()
413
+ .then(() => {
414
+ this.uploadTexture(texture);
415
+ })
416
+ .catch((err) => {
417
+ console.error(err);
418
+ });
419
+ }
420
+
421
+ // enqueue the texture for download and upload
422
+ this.enqueueDownloadTextureSource(texture);
423
+ }
424
+
425
+ /**
426
+ * Upload a texture to the GPU
427
+ *
428
+ * @param texture Texture to upload
429
+ */
430
+ uploadTexture(texture: Texture): void {
431
+ const coreContext = texture.loadCtxTexture();
432
+ coreContext.load();
433
+ }
434
+
435
+ /**
436
+ * Process a limited number of downloads and uploads.
437
+ *
438
+ * @param maxItems - The maximum number of items to process
439
+ */
440
+ processSome(maxItems = 0): void {
441
+ if (this.initialized === false) {
442
+ return;
443
+ }
444
+
445
+ let itemsProcessed = 0;
446
+
447
+ // Process priority queue
448
+ while (
449
+ this.priorityQueue.length > 0 &&
450
+ (maxItems === 0 || itemsProcessed < maxItems)
451
+ ) {
452
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
453
+ const texture = this.priorityQueue.shift()!;
454
+ texture.getTextureData().then(() => {
455
+ this.uploadTexture(texture);
456
+ });
457
+ itemsProcessed++;
458
+ }
459
+
460
+ // Process uploads
461
+ while (
462
+ this.uploadTextureQueue.length > 0 &&
463
+ (maxItems === 0 || itemsProcessed < maxItems)
464
+ ) {
465
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
466
+ this.uploadTexture(this.uploadTextureQueue.shift()!);
467
+ itemsProcessed++;
468
+ }
469
+
470
+ // Process downloads
471
+ while (
472
+ this.downloadTextureSourceQueue.length > 0 &&
473
+ (maxItems === 0 || itemsProcessed < maxItems)
474
+ ) {
475
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
476
+ const texture = this.downloadTextureSourceQueue.shift()!;
477
+ queueMicrotask(() => {
478
+ texture.getTextureData().then(() => {
479
+ this.enqueueUploadTexture(texture);
480
+ });
481
+ });
482
+
483
+ itemsProcessed++;
484
+ }
485
+ }
486
+
487
+ public hasUpdates(): boolean {
488
+ return (
489
+ this.downloadTextureSourceQueue.length > 0 ||
490
+ this.uploadTextureQueue.length > 0
491
+ );
492
+ }
493
+
494
+ /**
495
+ * Initialize a texture to the cache
496
+ *
497
+ * @param texture Texture to cache
498
+ * @param cacheKey Cache key for the texture
499
+ */
500
+ initTextureToCache(texture: Texture, cacheKey: string) {
501
+ const { keyCache, inverseKeyCache } = this;
502
+ keyCache.set(cacheKey, texture);
503
+ inverseKeyCache.set(texture, cacheKey);
504
+ }
505
+
506
+ /**
507
+ * Get a texture from the cache
508
+ *
509
+ * @param cacheKey
510
+ */
511
+ getTextureFromCache(cacheKey: string): Texture | undefined {
512
+ return this.keyCache.get(cacheKey);
513
+ }
514
+
515
+ /**
516
+ * Remove a texture from the cache
517
+ *
518
+ * @remarks
519
+ * Called by Texture Cleanup when a texture is freed.
520
+ *
521
+ * @param texture
522
+ */
523
+ removeTextureFromCache(texture: Texture) {
524
+ const { inverseKeyCache, keyCache } = this;
525
+ const cacheKey = inverseKeyCache.get(texture);
526
+ if (cacheKey) {
527
+ keyCache.delete(cacheKey);
528
+ }
529
+ }
530
+
531
+ /**
532
+ * Resolve a parent texture from the cache or fallback to the provided texture.
533
+ *
534
+ * @param texture - The provided texture to resolve.
535
+ * @returns The cached or provided texture.
536
+ */
537
+ resolveParentTexture(texture: ImageTexture): Texture {
538
+ if (!texture?.props) {
539
+ return texture;
540
+ }
541
+
542
+ const cacheKey = ImageTexture.makeCacheKey(texture.props);
543
+ const cachedTexture = cacheKey
544
+ ? this.getTextureFromCache(cacheKey)
545
+ : undefined;
546
+ return cachedTexture ?? texture;
547
+ }
548
+ }