@lightningjs/renderer 2.16.0 → 3.0.0-beta10

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