@lightningjs/renderer 3.0.0-beta2 → 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 (387) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/exports/index.d.ts +1 -0
  6. package/dist/exports/index.js +1 -0
  7. package/dist/exports/index.js.map +1 -1
  8. package/dist/src/core/CoreNode.d.ts +3 -2
  9. package/dist/src/core/CoreNode.js +13 -7
  10. package/dist/src/core/CoreNode.js.map +1 -1
  11. package/dist/src/core/CoreShaderManager.d.ts +3 -5
  12. package/dist/src/core/CoreShaderManager.js.map +1 -1
  13. package/dist/src/core/CoreTextNode.d.ts +2 -0
  14. package/dist/src/core/CoreTextNode.js +7 -0
  15. package/dist/src/core/CoreTextNode.js.map +1 -1
  16. package/dist/src/core/CoreTextureManager.d.ts +2 -0
  17. package/dist/src/core/CoreTextureManager.js +7 -5
  18. package/dist/src/core/CoreTextureManager.js.map +1 -1
  19. package/dist/src/core/Stage.d.ts +5 -0
  20. package/dist/src/core/Stage.js +10 -5
  21. package/dist/src/core/Stage.js.map +1 -1
  22. package/dist/src/core/lib/validateImageBitmap.d.ts +2 -1
  23. package/dist/src/core/lib/validateImageBitmap.js +4 -4
  24. package/dist/src/core/lib/validateImageBitmap.js.map +1 -1
  25. package/dist/src/core/platforms/Platform.d.ts +37 -0
  26. package/dist/src/{main-api/IRenderDriver.js → core/platforms/Platform.js} +4 -2
  27. package/dist/src/core/platforms/Platform.js.map +1 -0
  28. package/dist/src/core/platforms/web/WebPlatform.d.ts +9 -0
  29. package/dist/src/core/platforms/web/WebPlatform.js +58 -0
  30. package/dist/src/core/platforms/web/WebPlatform.js.map +1 -0
  31. package/dist/src/core/renderers/CoreRenderer.d.ts +3 -1
  32. package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
  33. package/dist/src/core/renderers/CoreShaderNode.d.ts +1 -1
  34. package/dist/src/core/renderers/CoreShaderNode.js.map +1 -1
  35. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -1
  36. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +3 -1
  37. package/dist/src/core/renderers/webgl/WebGlRenderer.js +86 -60
  38. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -1
  39. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +35 -35
  40. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  41. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  42. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  43. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  44. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  45. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  46. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  47. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  48. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  49. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  50. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  51. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  52. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  53. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  54. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  55. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  56. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  57. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  58. package/dist/src/core/shaders/webgl/Border.js +59 -59
  59. package/dist/src/core/shaders/webgl/Default.js +47 -47
  60. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  61. package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
  62. package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
  63. package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
  64. package/dist/src/core/shaders/webgl/Rounded.js +71 -71
  65. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +66 -66
  66. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +79 -79
  67. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
  68. package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
  69. package/dist/src/core/shaders/webgl/Shadow.js +83 -83
  70. package/dist/src/core/temp.js +77 -0
  71. package/dist/src/core/temp.js.map +1 -0
  72. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +5 -0
  73. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  74. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.d.ts +1 -1
  75. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +50 -2
  76. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
  77. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +6 -2
  78. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  79. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.d.ts +1 -1
  80. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +66 -8
  81. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  82. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +13 -0
  83. package/dist/src/core/text-rendering/renderers/TextRenderer.js +3 -0
  84. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  85. package/dist/src/core/textures/ImageTexture.d.ts +1 -0
  86. package/dist/src/core/textures/ImageTexture.js +5 -3
  87. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  88. package/dist/src/core/textures/Texture.d.ts +9 -2
  89. package/dist/src/core/textures/Texture.js +18 -6
  90. package/dist/src/core/textures/Texture.js.map +1 -1
  91. package/dist/src/main-api/INode.d.ts +2 -2
  92. package/dist/src/main-api/Renderer.d.ts +13 -1
  93. package/dist/src/main-api/Renderer.js +14 -2
  94. package/dist/src/main-api/Renderer.js.map +1 -1
  95. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  96. package/exports/canvas-shaders.ts +28 -28
  97. package/exports/canvas.ts +45 -45
  98. package/exports/index.ts +90 -89
  99. package/exports/inspector.ts +24 -24
  100. package/exports/utils.ts +44 -44
  101. package/exports/webgl-shaders.ts +28 -28
  102. package/exports/webgl.ts +50 -50
  103. package/package.json +2 -3
  104. package/scripts/please-use-pnpm.js +13 -13
  105. package/src/common/CommonTypes.ts +146 -146
  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 +203 -203
  110. package/src/core/CoreNode.ts +2494 -2486
  111. package/src/core/CoreShaderManager.ts +188 -193
  112. package/src/core/CoreTextNode.ts +448 -439
  113. package/src/core/CoreTextureManager.ts +601 -597
  114. package/src/core/Stage.ts +754 -738
  115. package/src/core/TextureMemoryManager.ts +395 -395
  116. package/src/core/animations/AnimationManager.ts +38 -38
  117. package/src/core/animations/CoreAnimation.ts +284 -284
  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 +280 -280
  121. package/src/core/lib/Matrix3d.ts +244 -244
  122. package/src/core/lib/RenderCoords.ts +71 -71
  123. package/src/core/lib/WebGlContextWrapper.ts +1374 -1374
  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 +386 -386
  127. package/src/core/lib/validateImageBitmap.ts +87 -76
  128. package/src/core/platform.ts +64 -64
  129. package/src/core/platforms/Platform.ts +77 -0
  130. package/src/core/platforms/web/WebPlatform.ts +84 -0
  131. package/src/core/renderers/CoreContextTexture.ts +43 -43
  132. package/src/core/renderers/CoreRenderOp.ts +22 -22
  133. package/src/core/renderers/CoreRenderer.ts +109 -107
  134. package/src/core/renderers/CoreShaderNode.ts +165 -167
  135. package/src/core/renderers/CoreShaderProgram.ts +23 -23
  136. package/src/core/renderers/canvas/CanvasRenderer.ts +298 -298
  137. package/src/core/renderers/canvas/CanvasShaderNode.ts +99 -99
  138. package/src/core/renderers/canvas/CanvasTexture.ts +156 -156
  139. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +220 -220
  140. package/src/core/renderers/canvas/internal/ColorUtils.ts +85 -85
  141. package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +86 -86
  142. package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +50 -50
  143. package/src/core/renderers/webgl/WebGlCtxTexture.ts +301 -301
  144. package/src/core/renderers/webgl/WebGlRenderOp.ts +161 -161
  145. package/src/core/renderers/webgl/WebGlRenderer.ts +750 -720
  146. package/src/core/renderers/webgl/WebGlShaderNode.ts +437 -437
  147. package/src/core/renderers/webgl/WebGlShaderProgram.ts +318 -318
  148. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  149. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  150. package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -281
  151. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  152. package/src/core/shaders/canvas/Border.ts +78 -78
  153. package/src/core/shaders/canvas/HolePunch.ts +62 -62
  154. package/src/core/shaders/canvas/LinearGradient.ts +69 -69
  155. package/src/core/shaders/canvas/RadialGradient.ts +113 -113
  156. package/src/core/shaders/canvas/Rounded.ts +55 -55
  157. package/src/core/shaders/canvas/RoundedWithBorder.ts +68 -68
  158. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +88 -88
  159. package/src/core/shaders/canvas/RoundedWithShadow.ts +69 -69
  160. package/src/core/shaders/canvas/Shadow.ts +52 -52
  161. package/src/core/shaders/canvas/utils/render.ts +151 -151
  162. package/src/core/shaders/templates/BorderTemplate.ts +115 -115
  163. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
  164. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
  165. package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -81
  166. package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
  167. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
  168. package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
  169. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
  170. package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
  171. package/src/core/shaders/templates/shaderUtils.ts +47 -47
  172. package/src/core/shaders/webgl/Border.ts +96 -96
  173. package/src/core/shaders/webgl/Default.ts +89 -89
  174. package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
  175. package/src/core/shaders/webgl/HolePunch.ts +78 -78
  176. package/src/core/shaders/webgl/LinearGradient.ts +81 -81
  177. package/src/core/shaders/webgl/RadialGradient.ts +84 -84
  178. package/src/core/shaders/webgl/Rounded.ts +117 -117
  179. package/src/core/shaders/webgl/RoundedWithBorder.ts +114 -114
  180. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +133 -133
  181. package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -98
  182. package/src/core/shaders/webgl/SdfShader.ts +134 -134
  183. package/src/core/shaders/webgl/Shadow.ts +115 -115
  184. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  185. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  186. package/src/core/text-rendering/TrFontManager.ts +183 -183
  187. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  188. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  189. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  190. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  191. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  192. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  193. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  194. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +514 -509
  195. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +863 -815
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +846 -840
  197. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  198. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  199. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  200. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  201. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  202. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  203. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  204. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +497 -408
  205. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  206. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  207. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  208. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  209. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  210. package/src/core/text-rendering/renderers/TextRenderer.ts +567 -550
  211. package/src/core/textures/ColorTexture.ts +102 -102
  212. package/src/core/textures/ImageTexture.ts +410 -399
  213. package/src/core/textures/NoiseTexture.ts +104 -104
  214. package/src/core/textures/RenderTexture.ts +85 -85
  215. package/src/core/textures/SubTexture.ts +205 -205
  216. package/src/core/textures/Texture.ts +358 -337
  217. package/src/core/utils.ts +227 -227
  218. package/src/env.d.ts +7 -7
  219. package/src/main-api/INode.ts +100 -99
  220. package/src/main-api/Inspector.ts +522 -522
  221. package/src/main-api/Renderer.ts +675 -649
  222. package/src/main-api/utils.ts +45 -45
  223. package/src/utils.ts +267 -267
  224. package/dist/exports/core-api.d.ts +0 -74
  225. package/dist/exports/core-api.js +0 -96
  226. package/dist/exports/core-api.js.map +0 -1
  227. package/dist/exports/main-api.d.ts +0 -30
  228. package/dist/exports/main-api.js +0 -45
  229. package/dist/exports/main-api.js.map +0 -1
  230. package/dist/src/core/CoreExtension.d.ts +0 -12
  231. package/dist/src/core/CoreExtension.js +0 -29
  232. package/dist/src/core/CoreExtension.js.map +0 -1
  233. package/dist/src/core/CoreStuff.js +0 -138
  234. package/dist/src/core/CoreStuff.js.map +0 -1
  235. package/dist/src/core/CoreTexturizer.d.ts +0 -14
  236. package/dist/src/core/CoreTexturizer.js +0 -47
  237. package/dist/src/core/CoreTexturizer.js.map +0 -1
  238. package/dist/src/core/LngNode.d.ts +0 -736
  239. package/dist/src/core/LngNode.js +0 -1174
  240. package/dist/src/core/LngNode.js.map +0 -1
  241. package/dist/src/core/Matrix2DContext.d.ts +0 -15
  242. package/dist/src/core/Matrix2DContext.js +0 -45
  243. package/dist/src/core/Matrix2DContext.js.map +0 -1
  244. package/dist/src/core/ShaderNode.d.ts +0 -10
  245. package/dist/src/core/ShaderNode.js +0 -30
  246. package/dist/src/core/ShaderNode.js.map +0 -1
  247. package/dist/src/core/TextNode.d.ts +0 -103
  248. package/dist/src/core/TextNode.js +0 -331
  249. package/dist/src/core/TextNode.js.map +0 -1
  250. package/dist/src/core/lib/Coords.d.ts +0 -14
  251. package/dist/src/core/lib/Coords.js +0 -55
  252. package/dist/src/core/lib/Coords.js.map +0 -1
  253. package/dist/src/core/lib/glm/common.d.ts +0 -162
  254. package/dist/src/core/lib/glm/common.js +0 -81
  255. package/dist/src/core/lib/glm/common.js.map +0 -1
  256. package/dist/src/core/lib/glm/index.d.ts +0 -11
  257. package/dist/src/core/lib/glm/index.js +0 -30
  258. package/dist/src/core/lib/glm/index.js.map +0 -1
  259. package/dist/src/core/lib/glm/mat2.d.ts +0 -219
  260. package/dist/src/core/lib/glm/mat2.js +0 -396
  261. package/dist/src/core/lib/glm/mat2.js.map +0 -1
  262. package/dist/src/core/lib/glm/mat2d.d.ts +0 -237
  263. package/dist/src/core/lib/glm/mat2d.js +0 -442
  264. package/dist/src/core/lib/glm/mat2d.js.map +0 -1
  265. package/dist/src/core/lib/glm/mat3.d.ts +0 -283
  266. package/dist/src/core/lib/glm/mat3.js +0 -680
  267. package/dist/src/core/lib/glm/mat3.js.map +0 -1
  268. package/dist/src/core/lib/glm/mat4.d.ts +0 -550
  269. package/dist/src/core/lib/glm/mat4.js +0 -1802
  270. package/dist/src/core/lib/glm/mat4.js.map +0 -1
  271. package/dist/src/core/lib/glm/quat.d.ts +0 -363
  272. package/dist/src/core/lib/glm/quat.js +0 -693
  273. package/dist/src/core/lib/glm/quat.js.map +0 -1
  274. package/dist/src/core/lib/glm/quat2.d.ts +0 -356
  275. package/dist/src/core/lib/glm/quat2.js +0 -754
  276. package/dist/src/core/lib/glm/quat2.js.map +0 -1
  277. package/dist/src/core/lib/glm/vec2.d.ts +0 -365
  278. package/dist/src/core/lib/glm/vec2.js +0 -569
  279. package/dist/src/core/lib/glm/vec2.js.map +0 -1
  280. package/dist/src/core/lib/glm/vec3.d.ts +0 -406
  281. package/dist/src/core/lib/glm/vec3.js +0 -720
  282. package/dist/src/core/lib/glm/vec3.js.map +0 -1
  283. package/dist/src/core/lib/glm/vec4.d.ts +0 -330
  284. package/dist/src/core/lib/glm/vec4.js +0 -608
  285. package/dist/src/core/lib/glm/vec4.js.map +0 -1
  286. package/dist/src/core/renderers/CoreShaderManager.d.ts +0 -19
  287. package/dist/src/core/renderers/CoreShaderManager.js +0 -33
  288. package/dist/src/core/renderers/CoreShaderManager.js.map +0 -1
  289. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +0 -27
  290. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +0 -82
  291. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +0 -1
  292. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +0 -11
  293. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +0 -34
  294. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +0 -1
  295. package/dist/src/core/scene/Scene.d.ts +0 -59
  296. package/dist/src/core/scene/Scene.js +0 -106
  297. package/dist/src/core/scene/Scene.js.map +0 -1
  298. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +0 -20
  299. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +0 -55
  300. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +0 -1
  301. package/dist/src/main-api/ICoreDriver.d.ts +0 -27
  302. package/dist/src/main-api/ICoreDriver.js +0 -20
  303. package/dist/src/main-api/ICoreDriver.js.map +0 -1
  304. package/dist/src/main-api/IRenderDriver.d.ts +0 -20
  305. package/dist/src/main-api/IRenderDriver.js.map +0 -1
  306. package/dist/src/main-api/IShaderController.d.ts +0 -14
  307. package/dist/src/main-api/IShaderController.js +0 -30
  308. package/dist/src/main-api/IShaderController.js.map +0 -1
  309. package/dist/src/main-api/IShaderNode.d.ts +0 -17
  310. package/dist/src/main-api/IShaderNode.js +0 -19
  311. package/dist/src/main-api/IShaderNode.js.map +0 -1
  312. package/dist/src/main-api/RendererMain.d.ts +0 -375
  313. package/dist/src/main-api/RendererMain.js +0 -365
  314. package/dist/src/main-api/RendererMain.js.map +0 -1
  315. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
  316. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
  317. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
  318. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
  319. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
  320. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
  321. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
  322. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +0 -28
  323. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
  324. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -24
  325. package/dist/src/render-drivers/main/MainCoreDriver.js +0 -118
  326. package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
  327. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -99
  328. package/dist/src/render-drivers/main/MainOnlyNode.js +0 -396
  329. package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
  330. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +0 -6
  331. package/dist/src/render-drivers/main/MainOnlyShaderController.js +0 -15
  332. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +0 -1
  333. package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +0 -7
  334. package/dist/src/render-drivers/main/MainOnlyShaderNode.js +0 -34
  335. package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +0 -1
  336. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
  337. package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -205
  338. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
  339. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +0 -17
  340. package/dist/src/render-drivers/main/MainRenderDriver.js +0 -88
  341. package/dist/src/render-drivers/main/MainRenderDriver.js.map +0 -1
  342. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -90
  343. package/dist/src/render-drivers/threadx/NodeStruct.js +0 -281
  344. package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
  345. package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -39
  346. package/dist/src/render-drivers/threadx/SharedNode.js +0 -60
  347. package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
  348. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
  349. package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -201
  350. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
  351. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -28
  352. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -234
  353. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
  354. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -20
  355. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -84
  356. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
  357. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -44
  358. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -154
  359. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
  360. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +0 -6
  361. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +0 -16
  362. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +0 -1
  363. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +0 -7
  364. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +0 -15
  365. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +0 -1
  366. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
  367. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
  368. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
  369. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +0 -21
  370. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +0 -198
  371. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +0 -1
  372. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
  373. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
  374. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
  375. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
  376. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -177
  377. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
  378. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
  379. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -108
  380. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
  381. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +0 -1
  382. package/dist/src/render-drivers/threadx/worker/renderer.js +0 -145
  383. package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
  384. package/dist/src/render-drivers/utils.d.ts +0 -12
  385. package/dist/src/render-drivers/utils.js +0 -69
  386. package/dist/src/render-drivers/utils.js.map +0 -1
  387. /package/dist/src/core/{CoreStuff.d.ts → temp.d.ts} +0 -0
@@ -1,399 +1,410 @@
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 type { CoreTextureManager } from '../CoreTextureManager.js';
21
- import { Texture, TextureType, type TextureData } from './Texture.js';
22
- import {
23
- isCompressedTextureContainer,
24
- loadCompressedTexture,
25
- } from '../lib/textureCompression.js';
26
- import {
27
- convertUrlToAbsolute,
28
- dataURIToBlob,
29
- isBase64Image,
30
- } from '../lib/utils.js';
31
- import { isSvgImage, loadSvg } from '../lib/textureSvg.js';
32
- import { fetchJson } from '../text-rendering/font-face-types/utils.js';
33
-
34
- /**
35
- * Properties of the {@link ImageTexture}
36
- */
37
- export interface ImageTextureProps {
38
- /**
39
- * Source URL or ImageData for the image to be used as a texture.
40
- *
41
- * @remarks
42
- * The ImageData type is currently only supported internally. End users should
43
- * only set this property to a URL string.
44
- *
45
- * @default ''
46
- */
47
- src?: string | Blob | ImageData | (() => ImageData | null);
48
- /**
49
- * Whether to premultiply the alpha channel into the color channels of the
50
- * image.
51
- *
52
- * @remarks
53
- * Generally this should be set to `true` (the default). However, if the
54
- * texture's associated Shader expects straight (non-premultiplied) colors,
55
- * this should be set to `false`.
56
- *
57
- * @default true
58
- */
59
- premultiplyAlpha?: boolean | null;
60
- /**
61
- * `ImageData` textures are not cached unless a `key` is provided
62
- */
63
- key?: string | null;
64
- /**
65
- * Width of the image to be used as a texture. If not provided, the image's
66
- * natural width will be used.
67
- */
68
- width?: number | null;
69
- /**
70
- * Height of the image to be used as a texture. If not provided, the image's
71
- * natural height will be used.
72
- */
73
- height?: number | null;
74
- /**
75
- * Type, indicate an image type for overriding type detection
76
- *
77
- * @default null
78
- */
79
- type?: 'regular' | 'compressed' | 'svg' | null;
80
- /**
81
- * The width of the rectangle from which the ImageBitmap will be extracted. This value
82
- * can be negative. Only works when createImageBitmap is supported on the browser.
83
- *
84
- * @default null
85
- */
86
- sw?: number | null;
87
- /**
88
- * The height of the rectangle from which the ImageBitmap will be extracted. This value
89
- * can be negative. Only works when createImageBitmap is supported on the browser.
90
- *
91
- * @default null
92
- */
93
- sh?: number | null;
94
- /**
95
- * The y coordinate of the reference point of the rectangle from which the ImageBitmap
96
- * will be extracted. Only used when `sw` and `sh` are provided. And only works when
97
- * createImageBitmap is available.
98
- *
99
- * @default null
100
- */
101
- sx?: number | null;
102
- /**
103
- * The x coordinate of the reference point of the rectangle from which the
104
- * ImageBitmap will be extracted. Only used when source `sw` width and `sh` height
105
- * are provided. Only works when createImageBitmap is supported on the browser.
106
- *
107
- * @default null
108
- */
109
- sy?: number | null;
110
- }
111
-
112
- /**
113
- * Texture consisting of an image loaded from a URL
114
- *
115
- * @remarks
116
- * The ImageTexture's {@link ImageTextureProps.src} prop defines the image URL
117
- * to be downloaded.
118
- *
119
- * By default, the texture's alpha values will be premultiplied into its color
120
- * values which is generally the desired setting before they are sent to the
121
- * texture's associated {@link Shader}. However, in special cases you may want
122
- * the Shader to receive straight (non-premultiplied) values. In that case you
123
- * can disable the default behavior by setting the
124
- * {@link ImageTextureProps.premultiplyAlpha} prop to `false`.
125
- */
126
- export class ImageTexture extends Texture {
127
- public props: Required<ImageTextureProps>;
128
-
129
- public override type: TextureType = TextureType.image;
130
-
131
- constructor(txManager: CoreTextureManager, props: ImageTextureProps) {
132
- super(txManager);
133
- this.props = ImageTexture.resolveDefaults(props);
134
- }
135
-
136
- hasAlphaChannel(mimeType: string) {
137
- return mimeType.indexOf('image/png') !== -1;
138
- }
139
-
140
- async loadImageFallback(src: string | Blob, hasAlpha: boolean) {
141
- const img = new Image();
142
-
143
- if (typeof src === 'string' && isBase64Image(src) === false) {
144
- img.crossOrigin = 'anonymous';
145
- }
146
-
147
- return new Promise<{ data: HTMLImageElement; premultiplyAlpha: boolean }>(
148
- (resolve) => {
149
- img.onload = () => {
150
- resolve({ data: img, premultiplyAlpha: hasAlpha });
151
- };
152
-
153
- img.onerror = () => {
154
- console.warn('Image loading failed, returning fallback object.');
155
- resolve({ data: img, premultiplyAlpha: hasAlpha });
156
- };
157
-
158
- if (src instanceof Blob) {
159
- img.src = URL.createObjectURL(src);
160
- } else {
161
- img.src = src;
162
- }
163
- },
164
- );
165
- }
166
-
167
- async createImageBitmap(
168
- blob: Blob,
169
- premultiplyAlpha: boolean | null,
170
- sx: number | null,
171
- sy: number | null,
172
- sw: number | null,
173
- sh: number | null,
174
- ): Promise<{
175
- data: ImageBitmap | HTMLImageElement;
176
- premultiplyAlpha: boolean;
177
- }> {
178
- const hasAlphaChannel = premultiplyAlpha ?? blob.type.includes('image/png');
179
- const imageBitmapSupported = this.txManager.imageBitmapSupported;
180
-
181
- if (imageBitmapSupported.full === true && sw !== null && sh !== null) {
182
- // createImageBitmap with crop
183
- const bitmap = await createImageBitmap(blob, sx || 0, sy || 0, sw, sh, {
184
- premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
185
- colorSpaceConversion: 'none',
186
- imageOrientation: 'none',
187
- });
188
- return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
189
- } else if (imageBitmapSupported.basic === true) {
190
- // basic createImageBitmap without options or crop
191
- // this is supported for Chrome v50 to v52/54 that doesn't support options
192
- return {
193
- data: await createImageBitmap(blob),
194
- premultiplyAlpha: hasAlphaChannel,
195
- };
196
- }
197
-
198
- // default createImageBitmap without crop but with options
199
- const bitmap = await createImageBitmap(blob, {
200
- premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
201
- colorSpaceConversion: 'none',
202
- imageOrientation: 'none',
203
- });
204
- return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
205
- }
206
-
207
- async loadImage(src: string) {
208
- const { premultiplyAlpha, sx, sy, sw, sh } = this.props;
209
-
210
- if (this.txManager.hasCreateImageBitmap === true) {
211
- if (
212
- isBase64Image(src) === false &&
213
- this.txManager.hasWorker === true &&
214
- this.txManager.imageWorkerManager !== null
215
- ) {
216
- return this.txManager.imageWorkerManager.getImage(
217
- src,
218
- premultiplyAlpha,
219
- sx,
220
- sy,
221
- sw,
222
- sh,
223
- );
224
- }
225
-
226
- let blob;
227
-
228
- if (isBase64Image(src) === true) {
229
- blob = dataURIToBlob(src);
230
- } else {
231
- blob = await fetchJson(src, 'blob').then(
232
- (response) => response as Blob,
233
- );
234
- }
235
-
236
- return this.createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh);
237
- }
238
-
239
- return this.loadImageFallback(src, premultiplyAlpha ?? true);
240
- }
241
-
242
- override async getTextureSource(): Promise<TextureData> {
243
- let resp;
244
- try {
245
- resp = await this.determineImageTypeAndLoadImage();
246
- } catch (e) {
247
- this.setState('failed', e as Error);
248
- return {
249
- data: null,
250
- };
251
- }
252
-
253
- if (resp.data === null) {
254
- this.setState('failed', Error('ImageTexture: No image data'));
255
- return {
256
- data: null,
257
- };
258
- }
259
-
260
- let width, height;
261
- // check if resp.data is typeof Uint8ClampedArray else
262
- // use resp.data.width and resp.data.height
263
- if (resp.data instanceof Uint8Array) {
264
- width = this.props.width ?? 0;
265
- height = this.props.height ?? 0;
266
- } else {
267
- width = resp.data?.width ?? (this.props.width || 0);
268
- height = resp.data?.height ?? (this.props.height || 0);
269
- }
270
-
271
- // we're loaded!
272
- this.setState('fetched', {
273
- width,
274
- height,
275
- });
276
-
277
- return {
278
- data: resp.data,
279
- premultiplyAlpha: this.props.premultiplyAlpha ?? true,
280
- };
281
- }
282
-
283
- determineImageTypeAndLoadImage() {
284
- const { src, premultiplyAlpha, type } = this.props;
285
- if (src === null) {
286
- return {
287
- data: null,
288
- };
289
- }
290
-
291
- if (typeof src !== 'string') {
292
- if (src instanceof Blob) {
293
- if (this.txManager.hasCreateImageBitmap === true) {
294
- const { sx, sy, sw, sh } = this.props;
295
- return this.createImageBitmap(src, premultiplyAlpha, sx, sy, sw, sh);
296
- } else {
297
- return this.loadImageFallback(src, premultiplyAlpha ?? true);
298
- }
299
- }
300
- if (src instanceof ImageData) {
301
- return {
302
- data: src,
303
- premultiplyAlpha,
304
- };
305
- }
306
- return {
307
- data: src(),
308
- premultiplyAlpha,
309
- };
310
- }
311
-
312
- const absoluteSrc = convertUrlToAbsolute(src);
313
- if (type === 'regular') {
314
- return this.loadImage(absoluteSrc);
315
- }
316
-
317
- if (type === 'svg') {
318
- return loadSvg(
319
- absoluteSrc,
320
- this.props.width,
321
- this.props.height,
322
- this.props.sx,
323
- this.props.sy,
324
- this.props.sw,
325
- this.props.sh,
326
- );
327
- }
328
-
329
- if (isSvgImage(src) === true) {
330
- return loadSvg(
331
- absoluteSrc,
332
- this.props.width,
333
- this.props.height,
334
- this.props.sx,
335
- this.props.sy,
336
- this.props.sw,
337
- this.props.sh,
338
- );
339
- }
340
-
341
- if (type === 'compressed') {
342
- return loadCompressedTexture(absoluteSrc);
343
- }
344
-
345
- if (isCompressedTextureContainer(src) === true) {
346
- return loadCompressedTexture(absoluteSrc);
347
- }
348
-
349
- // default
350
- return this.loadImage(absoluteSrc);
351
- }
352
-
353
- /**
354
- * Generates a cache key for the ImageTexture based on the provided props.
355
- * @param props - The props used to generate the cache key.
356
- * @returns The cache key as a string, or `false` if the key cannot be generated.
357
- */
358
- static override makeCacheKey(props: ImageTextureProps): string | false {
359
- const resolvedProps = ImageTexture.resolveDefaults(props);
360
- // Only cache key-able textures; prioritise key
361
- const key = resolvedProps.key || resolvedProps.src;
362
- if (typeof key !== 'string') {
363
- return false;
364
- }
365
-
366
- // if we have source dimensions, cache the texture separately
367
- let dimensionProps = '';
368
- if (resolvedProps.sh !== null && resolvedProps.sw !== null) {
369
- dimensionProps += ',';
370
- dimensionProps += resolvedProps.sx ?? '';
371
- dimensionProps += resolvedProps.sy ?? '';
372
- dimensionProps += resolvedProps.sw || '';
373
- dimensionProps += resolvedProps.sh || '';
374
- }
375
-
376
- return `ImageTexture,${key},${
377
- resolvedProps.premultiplyAlpha ?? 'true'
378
- }${dimensionProps}`;
379
- }
380
-
381
- static override resolveDefaults(
382
- props: ImageTextureProps,
383
- ): Required<ImageTextureProps> {
384
- return {
385
- src: props.src ?? '',
386
- premultiplyAlpha: props.premultiplyAlpha ?? true, // null,
387
- key: props.key ?? null,
388
- type: props.type ?? null,
389
- width: props.width ?? null,
390
- height: props.height ?? null,
391
- sx: props.sx ?? null,
392
- sy: props.sy ?? null,
393
- sw: props.sw ?? null,
394
- sh: props.sh ?? null,
395
- };
396
- }
397
-
398
- static z$__type__Props: ImageTextureProps;
399
- }
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 type { CoreTextureManager } from '../CoreTextureManager.js';
21
+ import { Texture, TextureType, type TextureData } from './Texture.js';
22
+ import {
23
+ isCompressedTextureContainer,
24
+ loadCompressedTexture,
25
+ } from '../lib/textureCompression.js';
26
+ import {
27
+ convertUrlToAbsolute,
28
+ dataURIToBlob,
29
+ isBase64Image,
30
+ } from '../lib/utils.js';
31
+ import { isSvgImage, loadSvg } from '../lib/textureSvg.js';
32
+ import { fetchJson } from '../text-rendering/font-face-types/utils.js';
33
+ import type { Platform } from '../platforms/Platform.js';
34
+
35
+ /**
36
+ * Properties of the {@link ImageTexture}
37
+ */
38
+ export interface ImageTextureProps {
39
+ /**
40
+ * Source URL or ImageData for the image to be used as a texture.
41
+ *
42
+ * @remarks
43
+ * The ImageData type is currently only supported internally. End users should
44
+ * only set this property to a URL string.
45
+ *
46
+ * @default ''
47
+ */
48
+ src?: string | Blob | ImageData | (() => ImageData | null);
49
+ /**
50
+ * Whether to premultiply the alpha channel into the color channels of the
51
+ * image.
52
+ *
53
+ * @remarks
54
+ * Generally this should be set to `true` (the default). However, if the
55
+ * texture's associated Shader expects straight (non-premultiplied) colors,
56
+ * this should be set to `false`.
57
+ *
58
+ * @default true
59
+ */
60
+ premultiplyAlpha?: boolean | null;
61
+ /**
62
+ * `ImageData` textures are not cached unless a `key` is provided
63
+ */
64
+ key?: string | null;
65
+ /**
66
+ * Width of the image to be used as a texture. If not provided, the image's
67
+ * natural width will be used.
68
+ */
69
+ width?: number | null;
70
+ /**
71
+ * Height of the image to be used as a texture. If not provided, the image's
72
+ * natural height will be used.
73
+ */
74
+ height?: number | null;
75
+ /**
76
+ * Type, indicate an image type for overriding type detection
77
+ *
78
+ * @default null
79
+ */
80
+ type?: 'regular' | 'compressed' | 'svg' | null;
81
+ /**
82
+ * The width of the rectangle from which the ImageBitmap will be extracted. This value
83
+ * can be negative. Only works when createImageBitmap is supported on the browser.
84
+ *
85
+ * @default null
86
+ */
87
+ sw?: number | null;
88
+ /**
89
+ * The height of the rectangle from which the ImageBitmap will be extracted. This value
90
+ * can be negative. Only works when createImageBitmap is supported on the browser.
91
+ *
92
+ * @default null
93
+ */
94
+ sh?: number | null;
95
+ /**
96
+ * The y coordinate of the reference point of the rectangle from which the ImageBitmap
97
+ * will be extracted. Only used when `sw` and `sh` are provided. And only works when
98
+ * createImageBitmap is available.
99
+ *
100
+ * @default null
101
+ */
102
+ sx?: number | null;
103
+ /**
104
+ * The x coordinate of the reference point of the rectangle from which the
105
+ * ImageBitmap will be extracted. Only used when source `sw` width and `sh` height
106
+ * are provided. Only works when createImageBitmap is supported on the browser.
107
+ *
108
+ * @default null
109
+ */
110
+ sy?: number | null;
111
+ }
112
+
113
+ /**
114
+ * Texture consisting of an image loaded from a URL
115
+ *
116
+ * @remarks
117
+ * The ImageTexture's {@link ImageTextureProps.src} prop defines the image URL
118
+ * to be downloaded.
119
+ *
120
+ * By default, the texture's alpha values will be premultiplied into its color
121
+ * values which is generally the desired setting before they are sent to the
122
+ * texture's associated {@link Shader}. However, in special cases you may want
123
+ * the Shader to receive straight (non-premultiplied) values. In that case you
124
+ * can disable the default behavior by setting the
125
+ * {@link ImageTextureProps.premultiplyAlpha} prop to `false`.
126
+ */
127
+ export class ImageTexture extends Texture {
128
+ private platform: Platform;
129
+
130
+ public props: Required<ImageTextureProps>;
131
+ public override type: TextureType = TextureType.image;
132
+
133
+ constructor(txManager: CoreTextureManager, props: ImageTextureProps) {
134
+ super(txManager);
135
+
136
+ this.platform = txManager.platform;
137
+ this.props = ImageTexture.resolveDefaults(props);
138
+ }
139
+
140
+ hasAlphaChannel(mimeType: string) {
141
+ return mimeType.indexOf('image/png') !== -1;
142
+ }
143
+
144
+ async loadImageFallback(src: string | Blob, hasAlpha: boolean) {
145
+ const img = new Image();
146
+
147
+ if (typeof src === 'string' && isBase64Image(src) === false) {
148
+ img.crossOrigin = 'anonymous';
149
+ }
150
+
151
+ return new Promise<{ data: HTMLImageElement; premultiplyAlpha: boolean }>(
152
+ (resolve) => {
153
+ img.onload = () => {
154
+ resolve({ data: img, premultiplyAlpha: hasAlpha });
155
+ };
156
+
157
+ img.onerror = () => {
158
+ console.warn('Image loading failed, returning fallback object.');
159
+ resolve({ data: img, premultiplyAlpha: hasAlpha });
160
+ };
161
+
162
+ if (src instanceof Blob) {
163
+ img.src = URL.createObjectURL(src);
164
+ } else {
165
+ img.src = src;
166
+ }
167
+ },
168
+ );
169
+ }
170
+
171
+ async createImageBitmap(
172
+ blob: Blob,
173
+ premultiplyAlpha: boolean | null,
174
+ sx: number | null,
175
+ sy: number | null,
176
+ sw: number | null,
177
+ sh: number | null,
178
+ ): Promise<{
179
+ data: ImageBitmap | HTMLImageElement;
180
+ premultiplyAlpha: boolean;
181
+ }> {
182
+ const hasAlphaChannel = premultiplyAlpha ?? blob.type.includes('image/png');
183
+ const imageBitmapSupported = this.txManager.imageBitmapSupported;
184
+
185
+ if (imageBitmapSupported.full === true && sw !== null && sh !== null) {
186
+ // createImageBitmap with crop
187
+ const bitmap = await this.platform.createImageBitmap(
188
+ blob,
189
+ sx || 0,
190
+ sy || 0,
191
+ sw,
192
+ sh,
193
+ {
194
+ premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
195
+ colorSpaceConversion: 'none',
196
+ imageOrientation: 'none',
197
+ },
198
+ );
199
+ return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
200
+ } else if (imageBitmapSupported.basic === true) {
201
+ // basic createImageBitmap without options or crop
202
+ // this is supported for Chrome v50 to v52/54 that doesn't support options
203
+ return {
204
+ data: await this.platform.createImageBitmap(blob),
205
+ premultiplyAlpha: hasAlphaChannel,
206
+ };
207
+ }
208
+
209
+ // default createImageBitmap without crop but with options
210
+ const bitmap = await this.platform.createImageBitmap(blob, {
211
+ premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
212
+ colorSpaceConversion: 'none',
213
+ imageOrientation: 'none',
214
+ });
215
+ return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
216
+ }
217
+
218
+ async loadImage(src: string) {
219
+ const { premultiplyAlpha, sx, sy, sw, sh } = this.props;
220
+
221
+ if (this.txManager.hasCreateImageBitmap === true) {
222
+ if (
223
+ isBase64Image(src) === false &&
224
+ this.txManager.hasWorker === true &&
225
+ this.txManager.imageWorkerManager !== null
226
+ ) {
227
+ return this.txManager.imageWorkerManager.getImage(
228
+ src,
229
+ premultiplyAlpha,
230
+ sx,
231
+ sy,
232
+ sw,
233
+ sh,
234
+ );
235
+ }
236
+
237
+ let blob;
238
+
239
+ if (isBase64Image(src) === true) {
240
+ blob = dataURIToBlob(src);
241
+ } else {
242
+ blob = await fetchJson(src, 'blob').then(
243
+ (response) => response as Blob,
244
+ );
245
+ }
246
+
247
+ return this.createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh);
248
+ }
249
+
250
+ return this.loadImageFallback(src, premultiplyAlpha ?? true);
251
+ }
252
+
253
+ override async getTextureSource(): Promise<TextureData> {
254
+ let resp;
255
+ try {
256
+ resp = await this.determineImageTypeAndLoadImage();
257
+ } catch (e) {
258
+ this.setState('failed', e as Error);
259
+ return {
260
+ data: null,
261
+ };
262
+ }
263
+
264
+ if (resp.data === null) {
265
+ this.setState('failed', Error('ImageTexture: No image data'));
266
+ return {
267
+ data: null,
268
+ };
269
+ }
270
+
271
+ let width, height;
272
+ // check if resp.data is typeof Uint8ClampedArray else
273
+ // use resp.data.width and resp.data.height
274
+ if (resp.data instanceof Uint8Array) {
275
+ width = this.props.width ?? 0;
276
+ height = this.props.height ?? 0;
277
+ } else {
278
+ width = resp.data?.width ?? (this.props.width || 0);
279
+ height = resp.data?.height ?? (this.props.height || 0);
280
+ }
281
+
282
+ // we're loaded!
283
+ this.setState('fetched', {
284
+ width,
285
+ height,
286
+ });
287
+
288
+ return {
289
+ data: resp.data,
290
+ premultiplyAlpha: this.props.premultiplyAlpha ?? true,
291
+ };
292
+ }
293
+
294
+ determineImageTypeAndLoadImage() {
295
+ const { src, premultiplyAlpha, type } = this.props;
296
+ if (src === null) {
297
+ return {
298
+ data: null,
299
+ };
300
+ }
301
+
302
+ if (typeof src !== 'string') {
303
+ if (src instanceof Blob) {
304
+ if (this.txManager.hasCreateImageBitmap === true) {
305
+ const { sx, sy, sw, sh } = this.props;
306
+ return this.createImageBitmap(src, premultiplyAlpha, sx, sy, sw, sh);
307
+ } else {
308
+ return this.loadImageFallback(src, premultiplyAlpha ?? true);
309
+ }
310
+ }
311
+ if (src instanceof ImageData) {
312
+ return {
313
+ data: src,
314
+ premultiplyAlpha,
315
+ };
316
+ }
317
+ return {
318
+ data: src(),
319
+ premultiplyAlpha,
320
+ };
321
+ }
322
+
323
+ const absoluteSrc = convertUrlToAbsolute(src);
324
+ if (type === 'regular') {
325
+ return this.loadImage(absoluteSrc);
326
+ }
327
+
328
+ if (type === 'svg') {
329
+ return loadSvg(
330
+ absoluteSrc,
331
+ this.props.width,
332
+ this.props.height,
333
+ this.props.sx,
334
+ this.props.sy,
335
+ this.props.sw,
336
+ this.props.sh,
337
+ );
338
+ }
339
+
340
+ if (isSvgImage(src) === true) {
341
+ return loadSvg(
342
+ absoluteSrc,
343
+ this.props.width,
344
+ this.props.height,
345
+ this.props.sx,
346
+ this.props.sy,
347
+ this.props.sw,
348
+ this.props.sh,
349
+ );
350
+ }
351
+
352
+ if (type === 'compressed') {
353
+ return loadCompressedTexture(absoluteSrc);
354
+ }
355
+
356
+ if (isCompressedTextureContainer(src) === true) {
357
+ return loadCompressedTexture(absoluteSrc);
358
+ }
359
+
360
+ // default
361
+ return this.loadImage(absoluteSrc);
362
+ }
363
+
364
+ /**
365
+ * Generates a cache key for the ImageTexture based on the provided props.
366
+ * @param props - The props used to generate the cache key.
367
+ * @returns The cache key as a string, or `false` if the key cannot be generated.
368
+ */
369
+ static override makeCacheKey(props: ImageTextureProps): string | false {
370
+ const resolvedProps = ImageTexture.resolveDefaults(props);
371
+ // Only cache key-able textures; prioritise key
372
+ const key = resolvedProps.key || resolvedProps.src;
373
+ if (typeof key !== 'string') {
374
+ return false;
375
+ }
376
+
377
+ // if we have source dimensions, cache the texture separately
378
+ let dimensionProps = '';
379
+ if (resolvedProps.sh !== null && resolvedProps.sw !== null) {
380
+ dimensionProps += ',';
381
+ dimensionProps += resolvedProps.sx ?? '';
382
+ dimensionProps += resolvedProps.sy ?? '';
383
+ dimensionProps += resolvedProps.sw || '';
384
+ dimensionProps += resolvedProps.sh || '';
385
+ }
386
+
387
+ return `ImageTexture,${key},${
388
+ resolvedProps.premultiplyAlpha ?? 'true'
389
+ }${dimensionProps}`;
390
+ }
391
+
392
+ static override resolveDefaults(
393
+ props: ImageTextureProps,
394
+ ): Required<ImageTextureProps> {
395
+ return {
396
+ src: props.src ?? '',
397
+ premultiplyAlpha: props.premultiplyAlpha ?? true, // null,
398
+ key: props.key ?? null,
399
+ type: props.type ?? null,
400
+ width: props.width ?? null,
401
+ height: props.height ?? null,
402
+ sx: props.sx ?? null,
403
+ sy: props.sy ?? null,
404
+ sw: props.sw ?? null,
405
+ sh: props.sh ?? null,
406
+ };
407
+ }
408
+
409
+ static z$__type__Props: ImageTextureProps;
410
+ }