@lightningjs/renderer 2.9.0-beta3 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (217) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/CoreNode.d.ts +33 -7
  14. package/dist/src/core/CoreNode.js +113 -75
  15. package/dist/src/core/CoreNode.js.map +1 -1
  16. package/dist/src/core/CoreTextNode.d.ts +2 -2
  17. package/dist/src/core/CoreTextNode.js +7 -4
  18. package/dist/src/core/CoreTextNode.js.map +1 -1
  19. package/dist/src/core/CoreTextureManager.d.ts +24 -0
  20. package/dist/src/core/CoreTextureManager.js.map +1 -1
  21. package/dist/src/core/Stage.js +1 -0
  22. package/dist/src/core/Stage.js.map +1 -1
  23. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  24. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  25. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  26. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  27. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  28. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  29. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  30. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  31. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  32. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  33. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  34. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  35. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  36. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  37. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  38. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +12 -12
  39. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  40. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  41. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +6 -0
  42. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  43. package/dist/src/core/textures/Texture.d.ts +1 -1
  44. package/dist/src/core/textures/Texture.js +13 -5
  45. package/dist/src/core/textures/Texture.js.map +1 -1
  46. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  47. package/dist/src/main-api/ICoreDriver.js +20 -0
  48. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  49. package/dist/src/main-api/RendererMain.d.ts +378 -0
  50. package/dist/src/main-api/RendererMain.js +367 -0
  51. package/dist/src/main-api/RendererMain.js.map +1 -0
  52. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  53. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  54. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  55. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  56. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  57. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  58. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  59. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  60. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  61. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  62. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  63. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  64. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  65. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  66. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  67. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  68. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  69. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  70. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  71. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  72. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  73. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  74. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  75. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  76. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  77. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  78. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  79. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  80. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  81. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  82. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  83. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  84. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  85. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  86. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  87. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  88. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  89. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  90. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  91. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  92. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  93. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  94. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  95. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  96. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  97. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  98. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  99. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  100. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  101. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  102. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  103. package/dist/src/render-drivers/utils.d.ts +12 -0
  104. package/dist/src/render-drivers/utils.js +74 -0
  105. package/dist/src/render-drivers/utils.js.map +1 -0
  106. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  107. package/dist/tsconfig.tsbuildinfo +1 -0
  108. package/exports/canvas.ts +39 -39
  109. package/exports/index.ts +89 -89
  110. package/exports/inspector.ts +24 -24
  111. package/exports/utils.ts +44 -44
  112. package/exports/webgl.ts +38 -38
  113. package/package.json +1 -1
  114. package/scripts/please-use-pnpm.js +13 -13
  115. package/src/common/CommonTypes.ts +139 -139
  116. package/src/common/EventEmitter.ts +77 -77
  117. package/src/common/IAnimationController.ts +92 -92
  118. package/src/common/IEventEmitter.ts +28 -28
  119. package/src/core/CoreNode.test.ts +199 -95
  120. package/src/core/CoreNode.ts +2335 -2282
  121. package/src/core/CoreShaderManager.ts +292 -292
  122. package/src/core/CoreTextNode.ts +455 -450
  123. package/src/core/CoreTextureManager.ts +548 -522
  124. package/src/core/Stage.ts +700 -699
  125. package/src/core/TextureMemoryManager.ts +277 -277
  126. package/src/core/animations/AnimationManager.ts +38 -38
  127. package/src/core/animations/CoreAnimation.ts +340 -340
  128. package/src/core/animations/CoreAnimationController.ts +157 -157
  129. package/src/core/lib/ContextSpy.ts +41 -41
  130. package/src/core/lib/ImageWorker.ts +270 -270
  131. package/src/core/lib/Matrix3d.ts +244 -244
  132. package/src/core/lib/RenderCoords.ts +86 -86
  133. package/src/core/lib/WebGlContextWrapper.ts +1322 -1322
  134. package/src/core/lib/textureCompression.ts +152 -152
  135. package/src/core/lib/textureSvg.ts +78 -78
  136. package/src/core/lib/utils.ts +306 -306
  137. package/src/core/platform.ts +61 -61
  138. package/src/core/renderers/CoreContextTexture.ts +43 -43
  139. package/src/core/renderers/CoreRenderOp.ts +22 -22
  140. package/src/core/renderers/CoreRenderer.ts +114 -114
  141. package/src/core/renderers/CoreShader.ts +41 -41
  142. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -364
  143. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -150
  144. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  145. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  146. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  147. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  148. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  149. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -298
  150. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  151. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -805
  152. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  153. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  154. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  155. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  156. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  157. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  158. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  159. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  160. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  161. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  162. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  163. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  164. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  165. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  166. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  167. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  168. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  169. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  170. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  171. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  172. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  173. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  174. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  175. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  176. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  177. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  178. package/src/core/text-rendering/TrFontManager.ts +183 -183
  179. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -169
  180. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  181. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  182. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  183. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  184. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  185. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  186. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  192. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  193. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  194. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  195. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  197. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  198. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  199. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  200. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  201. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  202. package/src/core/textures/ColorTexture.ts +102 -102
  203. package/src/core/textures/ImageTexture.ts +378 -378
  204. package/src/core/textures/NoiseTexture.ts +104 -104
  205. package/src/core/textures/RenderTexture.ts +85 -85
  206. package/src/core/textures/SubTexture.ts +171 -171
  207. package/src/core/textures/Texture.ts +423 -407
  208. package/src/core/utils.ts +227 -227
  209. package/src/env.d.ts +7 -7
  210. package/src/main-api/DynamicShaderController.ts +104 -104
  211. package/src/main-api/INode.ts +101 -101
  212. package/src/main-api/Inspector.ts +505 -505
  213. package/src/main-api/Renderer.ts +693 -693
  214. package/src/main-api/ShaderController.ts +80 -80
  215. package/src/main-api/utils.ts +45 -45
  216. package/src/utils.ts +248 -248
  217. package/COPYING +0 -1
@@ -1,152 +1,152 @@
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 TextureData } from '../textures/Texture.js';
21
-
22
- /**
23
- * Tests if the given location is a compressed texture container
24
- * @param url
25
- * @remarks
26
- * This function is used to determine if the given image url is a compressed
27
- * and only supports the following extensions: .ktx and .pvr
28
- * @returns
29
- */
30
- export function isCompressedTextureContainer(url: string): boolean {
31
- return /\.(ktx|pvr)$/.test(url);
32
- }
33
-
34
- /**
35
- * Loads a compressed texture container
36
- * @param url
37
- * @returns
38
- */
39
- export const loadCompressedTexture = async (
40
- url: string,
41
- ): Promise<TextureData> => {
42
- const response = await fetch(url);
43
- const arrayBuffer = await response.arrayBuffer();
44
-
45
- if (url.indexOf('.ktx') !== -1) {
46
- return loadKTXData(arrayBuffer);
47
- }
48
-
49
- return loadPVRData(arrayBuffer);
50
- };
51
-
52
- /**
53
- * Loads a KTX texture container and returns the texture data
54
- * @param buffer
55
- * @returns
56
- */
57
- const loadKTXData = async (buffer: ArrayBuffer): Promise<TextureData> => {
58
- const view = new DataView(buffer);
59
- const littleEndian = view.getUint32(12) === 16909060 ? true : false;
60
- const mipmaps = [];
61
-
62
- const data = {
63
- glInternalFormat: view.getUint32(28, littleEndian),
64
- pixelWidth: view.getUint32(36, littleEndian),
65
- pixelHeight: view.getUint32(40, littleEndian),
66
- numberOfMipmapLevels: view.getUint32(56, littleEndian),
67
- bytesOfKeyValueData: view.getUint32(60, littleEndian),
68
- };
69
-
70
- let offset = 64;
71
-
72
- // Key Value Pairs of data start at byte offset 64
73
- // But the only known kvp is the API version, so skipping parsing.
74
- offset += data.bytesOfKeyValueData;
75
-
76
- for (let i = 0; i < data.numberOfMipmapLevels; i++) {
77
- const imageSize = view.getUint32(offset);
78
- offset += 4;
79
-
80
- mipmaps.push(view.buffer.slice(offset, imageSize));
81
- offset += imageSize;
82
- }
83
-
84
- return {
85
- data: {
86
- glInternalFormat: data.glInternalFormat,
87
- mipmaps,
88
- width: data.pixelWidth || 0,
89
- height: data.pixelHeight || 0,
90
- type: 'ktx',
91
- },
92
- premultiplyAlpha: false,
93
- };
94
- };
95
-
96
- /**
97
- * Loads a PVR texture container and returns the texture data
98
- * @param buffer
99
- * @returns
100
- */
101
- const loadPVRData = async (buffer: ArrayBuffer): Promise<TextureData> => {
102
- // pvr header length in 32 bits
103
- const pvrHeaderLength = 13;
104
- // for now only we only support: COMPRESSED_RGB_ETC1_WEBGL
105
- const pvrFormatEtc1 = 0x8d64;
106
- const pvrWidth = 7;
107
- const pvrHeight = 6;
108
- const pvrMipmapCount = 11;
109
- const pvrMetadata = 12;
110
- const arrayBuffer = buffer;
111
- const header = new Int32Array(arrayBuffer, 0, pvrHeaderLength);
112
-
113
- // @ts-expect-error Object possibly undefined
114
- // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
115
- const dataOffset = header[pvrMetadata] + 52;
116
- const pvrtcData = new Uint8Array(arrayBuffer, dataOffset);
117
- const mipmaps = [];
118
- const data = {
119
- pixelWidth: header[pvrWidth],
120
- pixelHeight: header[pvrHeight],
121
- numberOfMipmapLevels: header[pvrMipmapCount] || 0,
122
- };
123
-
124
- let offset = 0;
125
- let width = data.pixelWidth || 0;
126
- let height = data.pixelHeight || 0;
127
-
128
- for (let i = 0; i < data.numberOfMipmapLevels; i++) {
129
- const level = ((width + 3) >> 2) * ((height + 3) >> 2) * 8;
130
- const view = new Uint8Array(
131
- arrayBuffer,
132
- pvrtcData.byteOffset + offset,
133
- level,
134
- );
135
-
136
- mipmaps.push(view);
137
- offset += level;
138
- width = width >> 1;
139
- height = height >> 1;
140
- }
141
-
142
- return {
143
- data: {
144
- glInternalFormat: pvrFormatEtc1,
145
- mipmaps: mipmaps,
146
- width: data.pixelWidth || 0,
147
- height: data.pixelHeight || 0,
148
- type: 'pvr',
149
- },
150
- premultiplyAlpha: false,
151
- };
152
- };
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 TextureData } from '../textures/Texture.js';
21
+
22
+ /**
23
+ * Tests if the given location is a compressed texture container
24
+ * @param url
25
+ * @remarks
26
+ * This function is used to determine if the given image url is a compressed
27
+ * and only supports the following extensions: .ktx and .pvr
28
+ * @returns
29
+ */
30
+ export function isCompressedTextureContainer(url: string): boolean {
31
+ return /\.(ktx|pvr)$/.test(url);
32
+ }
33
+
34
+ /**
35
+ * Loads a compressed texture container
36
+ * @param url
37
+ * @returns
38
+ */
39
+ export const loadCompressedTexture = async (
40
+ url: string,
41
+ ): Promise<TextureData> => {
42
+ const response = await fetch(url);
43
+ const arrayBuffer = await response.arrayBuffer();
44
+
45
+ if (url.indexOf('.ktx') !== -1) {
46
+ return loadKTXData(arrayBuffer);
47
+ }
48
+
49
+ return loadPVRData(arrayBuffer);
50
+ };
51
+
52
+ /**
53
+ * Loads a KTX texture container and returns the texture data
54
+ * @param buffer
55
+ * @returns
56
+ */
57
+ const loadKTXData = async (buffer: ArrayBuffer): Promise<TextureData> => {
58
+ const view = new DataView(buffer);
59
+ const littleEndian = view.getUint32(12) === 16909060 ? true : false;
60
+ const mipmaps = [];
61
+
62
+ const data = {
63
+ glInternalFormat: view.getUint32(28, littleEndian),
64
+ pixelWidth: view.getUint32(36, littleEndian),
65
+ pixelHeight: view.getUint32(40, littleEndian),
66
+ numberOfMipmapLevels: view.getUint32(56, littleEndian),
67
+ bytesOfKeyValueData: view.getUint32(60, littleEndian),
68
+ };
69
+
70
+ let offset = 64;
71
+
72
+ // Key Value Pairs of data start at byte offset 64
73
+ // But the only known kvp is the API version, so skipping parsing.
74
+ offset += data.bytesOfKeyValueData;
75
+
76
+ for (let i = 0; i < data.numberOfMipmapLevels; i++) {
77
+ const imageSize = view.getUint32(offset);
78
+ offset += 4;
79
+
80
+ mipmaps.push(view.buffer.slice(offset, imageSize));
81
+ offset += imageSize;
82
+ }
83
+
84
+ return {
85
+ data: {
86
+ glInternalFormat: data.glInternalFormat,
87
+ mipmaps,
88
+ width: data.pixelWidth || 0,
89
+ height: data.pixelHeight || 0,
90
+ type: 'ktx',
91
+ },
92
+ premultiplyAlpha: false,
93
+ };
94
+ };
95
+
96
+ /**
97
+ * Loads a PVR texture container and returns the texture data
98
+ * @param buffer
99
+ * @returns
100
+ */
101
+ const loadPVRData = async (buffer: ArrayBuffer): Promise<TextureData> => {
102
+ // pvr header length in 32 bits
103
+ const pvrHeaderLength = 13;
104
+ // for now only we only support: COMPRESSED_RGB_ETC1_WEBGL
105
+ const pvrFormatEtc1 = 0x8d64;
106
+ const pvrWidth = 7;
107
+ const pvrHeight = 6;
108
+ const pvrMipmapCount = 11;
109
+ const pvrMetadata = 12;
110
+ const arrayBuffer = buffer;
111
+ const header = new Int32Array(arrayBuffer, 0, pvrHeaderLength);
112
+
113
+ // @ts-expect-error Object possibly undefined
114
+ // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
115
+ const dataOffset = header[pvrMetadata] + 52;
116
+ const pvrtcData = new Uint8Array(arrayBuffer, dataOffset);
117
+ const mipmaps = [];
118
+ const data = {
119
+ pixelWidth: header[pvrWidth],
120
+ pixelHeight: header[pvrHeight],
121
+ numberOfMipmapLevels: header[pvrMipmapCount] || 0,
122
+ };
123
+
124
+ let offset = 0;
125
+ let width = data.pixelWidth || 0;
126
+ let height = data.pixelHeight || 0;
127
+
128
+ for (let i = 0; i < data.numberOfMipmapLevels; i++) {
129
+ const level = ((width + 3) >> 2) * ((height + 3) >> 2) * 8;
130
+ const view = new Uint8Array(
131
+ arrayBuffer,
132
+ pvrtcData.byteOffset + offset,
133
+ level,
134
+ );
135
+
136
+ mipmaps.push(view);
137
+ offset += level;
138
+ width = width >> 1;
139
+ height = height >> 1;
140
+ }
141
+
142
+ return {
143
+ data: {
144
+ glInternalFormat: pvrFormatEtc1,
145
+ mipmaps: mipmaps,
146
+ width: data.pixelWidth || 0,
147
+ height: data.pixelHeight || 0,
148
+ type: 'pvr',
149
+ },
150
+ premultiplyAlpha: false,
151
+ };
152
+ };
@@ -1,78 +1,78 @@
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 { assertTruthy } from '../../utils.js';
21
- import { type TextureData } from '../textures/Texture.js';
22
-
23
- /**
24
- * Tests if the given location is a SVG
25
- * @param url
26
- * @remarks
27
- * This function is used to determine if the given image url is a SVG
28
- * image
29
- * @returns
30
- */
31
- export function isSvgImage(url: string): boolean {
32
- return /\.(svg)$/.test(url);
33
- }
34
-
35
- /**
36
- * Loads a SVG image
37
- * @param url
38
- * @returns
39
- */
40
- export const loadSvg = (
41
- url: string,
42
- width: number | null,
43
- height: number | null,
44
- sx: number | null,
45
- sy: number | null,
46
- sw: number | null,
47
- sh: number | null,
48
- ): Promise<TextureData> => {
49
- return new Promise((resolve, reject) => {
50
- const canvas = document.createElement('canvas');
51
- const ctx = canvas.getContext('2d');
52
- assertTruthy(ctx);
53
-
54
- ctx.imageSmoothingEnabled = true;
55
- const img = new Image();
56
- img.onload = () => {
57
- const x = sx ?? 0;
58
- const y = sy ?? 0;
59
- const w = width || img.width;
60
- const h = height || img.height;
61
-
62
- canvas.width = w;
63
- canvas.height = h;
64
- ctx.drawImage(img, 0, 0, w, h);
65
-
66
- resolve({
67
- data: ctx.getImageData(x, y, sw ?? w, sh ?? h),
68
- premultiplyAlpha: false,
69
- });
70
- };
71
-
72
- img.onerror = (err) => {
73
- reject(err);
74
- };
75
-
76
- img.src = url;
77
- });
78
- };
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 { assertTruthy } from '../../utils.js';
21
+ import { type TextureData } from '../textures/Texture.js';
22
+
23
+ /**
24
+ * Tests if the given location is a SVG
25
+ * @param url
26
+ * @remarks
27
+ * This function is used to determine if the given image url is a SVG
28
+ * image
29
+ * @returns
30
+ */
31
+ export function isSvgImage(url: string): boolean {
32
+ return /\.(svg)$/.test(url);
33
+ }
34
+
35
+ /**
36
+ * Loads a SVG image
37
+ * @param url
38
+ * @returns
39
+ */
40
+ export const loadSvg = (
41
+ url: string,
42
+ width: number | null,
43
+ height: number | null,
44
+ sx: number | null,
45
+ sy: number | null,
46
+ sw: number | null,
47
+ sh: number | null,
48
+ ): Promise<TextureData> => {
49
+ return new Promise((resolve, reject) => {
50
+ const canvas = document.createElement('canvas');
51
+ const ctx = canvas.getContext('2d');
52
+ assertTruthy(ctx);
53
+
54
+ ctx.imageSmoothingEnabled = true;
55
+ const img = new Image();
56
+ img.onload = () => {
57
+ const x = sx ?? 0;
58
+ const y = sy ?? 0;
59
+ const w = width || img.width;
60
+ const h = height || img.height;
61
+
62
+ canvas.width = w;
63
+ canvas.height = h;
64
+ ctx.drawImage(img, 0, 0, w, h);
65
+
66
+ resolve({
67
+ data: ctx.getImageData(x, y, sw ?? w, sh ?? h),
68
+ premultiplyAlpha: false,
69
+ });
70
+ };
71
+
72
+ img.onerror = (err) => {
73
+ reject(err);
74
+ };
75
+
76
+ img.src = url;
77
+ });
78
+ };