@lightningjs/renderer 2.13.5 → 2.14.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 (287) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/src/core/CoreTextureManager.d.ts +3 -8
  5. package/dist/src/core/CoreTextureManager.js +34 -63
  6. package/dist/src/core/CoreTextureManager.js.map +1 -1
  7. package/dist/src/core/renderers/webgl/WebGlCoreShader.destroy.js +2 -0
  8. package/dist/src/core/renderers/webgl/WebGlCoreShader.destroy.js.map +1 -0
  9. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  10. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  11. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  12. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  13. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  14. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  15. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  16. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  17. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  18. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  19. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  20. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  21. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  22. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  23. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  24. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  25. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  26. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  27. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  28. package/exports/canvas.ts +39 -39
  29. package/exports/index.ts +89 -89
  30. package/exports/inspector.ts +24 -24
  31. package/exports/utils.ts +44 -44
  32. package/exports/webgl.ts +38 -38
  33. package/package.json +1 -1
  34. package/scripts/please-use-pnpm.js +13 -13
  35. package/src/common/CommonTypes.ts +146 -146
  36. package/src/common/EventEmitter.ts +77 -77
  37. package/src/common/IAnimationController.ts +92 -92
  38. package/src/common/IEventEmitter.ts +28 -28
  39. package/src/core/CoreNode.test.ts +202 -202
  40. package/src/core/CoreNode.ts +2462 -2462
  41. package/src/core/CoreShaderManager.ts +292 -292
  42. package/src/core/CoreTextNode.ts +455 -455
  43. package/src/core/CoreTextureManager.ts +558 -604
  44. package/src/core/Stage.ts +743 -743
  45. package/src/core/TextureMemoryManager.ts +404 -404
  46. package/src/core/animations/AnimationManager.ts +38 -38
  47. package/src/core/animations/CoreAnimation.ts +347 -347
  48. package/src/core/animations/CoreAnimationController.ts +164 -164
  49. package/src/core/lib/ContextSpy.ts +41 -41
  50. package/src/core/lib/ImageWorker.ts +280 -280
  51. package/src/core/lib/Matrix3d.ts +244 -244
  52. package/src/core/lib/RenderCoords.ts +86 -86
  53. package/src/core/lib/WebGlContextWrapper.ts +1332 -1332
  54. package/src/core/lib/textureCompression.ts +152 -152
  55. package/src/core/lib/textureSvg.ts +78 -78
  56. package/src/core/lib/utils.ts +384 -384
  57. package/src/core/lib/validateImageBitmap.ts +76 -76
  58. package/src/core/platform.ts +63 -63
  59. package/src/core/renderers/CoreContextTexture.ts +43 -43
  60. package/src/core/renderers/CoreRenderOp.ts +22 -22
  61. package/src/core/renderers/CoreRenderer.ts +115 -115
  62. package/src/core/renderers/CoreShader.ts +41 -41
  63. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +375 -375
  64. package/src/core/renderers/canvas/CanvasCoreTexture.ts +153 -153
  65. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  66. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  67. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  68. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +86 -86
  69. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  70. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +301 -301
  71. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  72. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +815 -815
  73. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  74. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  75. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  76. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  77. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  78. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  79. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  80. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  81. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  82. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  83. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  84. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  85. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  86. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  87. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  88. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  89. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  90. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  91. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  92. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  93. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  94. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  95. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  96. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  97. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  98. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  99. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  100. package/src/core/text-rendering/TrFontManager.ts +183 -183
  101. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  102. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  103. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  104. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  105. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  106. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  107. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  108. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  109. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +808 -808
  110. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  111. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  112. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  113. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  114. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  115. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  116. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  117. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  118. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +408 -408
  119. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  120. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  121. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  122. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  123. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  124. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  125. package/src/core/textures/ColorTexture.ts +102 -102
  126. package/src/core/textures/ImageTexture.ts +399 -399
  127. package/src/core/textures/NoiseTexture.ts +104 -104
  128. package/src/core/textures/RenderTexture.ts +85 -85
  129. package/src/core/textures/SubTexture.ts +205 -205
  130. package/src/core/textures/Texture.ts +367 -367
  131. package/src/core/utils.ts +227 -227
  132. package/src/env.d.ts +7 -7
  133. package/src/main-api/DynamicShaderController.ts +104 -104
  134. package/src/main-api/INode.ts +101 -101
  135. package/src/main-api/Inspector.ts +522 -522
  136. package/src/main-api/Renderer.ts +751 -751
  137. package/src/main-api/ShaderController.ts +80 -80
  138. package/src/main-api/utils.ts +45 -45
  139. package/src/utils.ts +248 -248
  140. package/COPYING +0 -1
  141. package/dist/exports/canvas-shaders.d.ts +0 -10
  142. package/dist/exports/canvas-shaders.js +0 -27
  143. package/dist/exports/canvas-shaders.js.map +0 -1
  144. package/dist/exports/webgl-shaders.d.ts +0 -11
  145. package/dist/exports/webgl-shaders.js +0 -28
  146. package/dist/exports/webgl-shaders.js.map +0 -1
  147. package/dist/src/core/platforms/Platform.d.ts +0 -37
  148. package/dist/src/core/platforms/Platform.js +0 -22
  149. package/dist/src/core/platforms/Platform.js.map +0 -1
  150. package/dist/src/core/platforms/web/WebPlatform.d.ts +0 -9
  151. package/dist/src/core/platforms/web/WebPlatform.js +0 -58
  152. package/dist/src/core/platforms/web/WebPlatform.js.map +0 -1
  153. package/dist/src/core/renderers/CoreShaderNode.d.ts +0 -58
  154. package/dist/src/core/renderers/CoreShaderNode.js +0 -104
  155. package/dist/src/core/renderers/CoreShaderNode.js.map +0 -1
  156. package/dist/src/core/renderers/CoreShaderProgram.d.ts +0 -4
  157. package/dist/src/core/renderers/CoreShaderProgram.js +0 -20
  158. package/dist/src/core/renderers/CoreShaderProgram.js.map +0 -1
  159. package/dist/src/core/renderers/canvas/CanvasRenderer.d.ts +0 -36
  160. package/dist/src/core/renderers/canvas/CanvasRenderer.js +0 -212
  161. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +0 -1
  162. package/dist/src/core/renderers/canvas/CanvasShaderNode.d.ts +0 -21
  163. package/dist/src/core/renderers/canvas/CanvasShaderNode.js +0 -60
  164. package/dist/src/core/renderers/canvas/CanvasShaderNode.js.map +0 -1
  165. package/dist/src/core/renderers/canvas/CanvasTexture.d.ts +0 -16
  166. package/dist/src/core/renderers/canvas/CanvasTexture.js +0 -124
  167. package/dist/src/core/renderers/canvas/CanvasTexture.js.map +0 -1
  168. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.d.ts +0 -12
  169. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js +0 -55
  170. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js.map +0 -1
  171. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.d.ts +0 -9
  172. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js +0 -38
  173. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js.map +0 -1
  174. package/dist/src/core/renderers/webgl/WebGlCtxTexture.d.ts +0 -57
  175. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js +0 -227
  176. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js.map +0 -1
  177. package/dist/src/core/renderers/webgl/WebGlRenderOp.d.ts +0 -44
  178. package/dist/src/core/renderers/webgl/WebGlRenderOp.js +0 -118
  179. package/dist/src/core/renderers/webgl/WebGlRenderOp.js.map +0 -1
  180. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +0 -135
  181. package/dist/src/core/renderers/webgl/WebGlRenderer.js +0 -571
  182. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +0 -1
  183. package/dist/src/core/renderers/webgl/WebGlShaderNode.d.ts +0 -222
  184. package/dist/src/core/renderers/webgl/WebGlShaderNode.js +0 -334
  185. package/dist/src/core/renderers/webgl/WebGlShaderNode.js.map +0 -1
  186. package/dist/src/core/renderers/webgl/WebGlShaderProgram.d.ts +0 -35
  187. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js +0 -201
  188. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js.map +0 -1
  189. package/dist/src/core/shaders/canvas/Border.d.ts +0 -9
  190. package/dist/src/core/shaders/canvas/Border.js +0 -57
  191. package/dist/src/core/shaders/canvas/Border.js.map +0 -1
  192. package/dist/src/core/shaders/canvas/HolePunch.d.ts +0 -7
  193. package/dist/src/core/shaders/canvas/HolePunch.js +0 -38
  194. package/dist/src/core/shaders/canvas/HolePunch.js.map +0 -1
  195. package/dist/src/core/shaders/canvas/LinearGradient.d.ts +0 -10
  196. package/dist/src/core/shaders/canvas/LinearGradient.js +0 -46
  197. package/dist/src/core/shaders/canvas/LinearGradient.js.map +0 -1
  198. package/dist/src/core/shaders/canvas/RadialGradient.d.ts +0 -11
  199. package/dist/src/core/shaders/canvas/RadialGradient.js +0 -68
  200. package/dist/src/core/shaders/canvas/RadialGradient.js.map +0 -1
  201. package/dist/src/core/shaders/canvas/Rounded.d.ts +0 -7
  202. package/dist/src/core/shaders/canvas/Rounded.js +0 -33
  203. package/dist/src/core/shaders/canvas/Rounded.js.map +0 -1
  204. package/dist/src/core/shaders/canvas/RoundedWithBorder.d.ts +0 -7
  205. package/dist/src/core/shaders/canvas/RoundedWithBorder.js +0 -41
  206. package/dist/src/core/shaders/canvas/RoundedWithBorder.js.map +0 -1
  207. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.d.ts +0 -8
  208. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js +0 -39
  209. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js.map +0 -1
  210. package/dist/src/core/shaders/canvas/RoundedWithShadow.d.ts +0 -7
  211. package/dist/src/core/shaders/canvas/RoundedWithShadow.js +0 -38
  212. package/dist/src/core/shaders/canvas/RoundedWithShadow.js.map +0 -1
  213. package/dist/src/core/shaders/canvas/Shadow.d.ts +0 -8
  214. package/dist/src/core/shaders/canvas/Shadow.js +0 -31
  215. package/dist/src/core/shaders/canvas/Shadow.js.map +0 -1
  216. package/dist/src/core/shaders/canvas/utils/render.d.ts +0 -5
  217. package/dist/src/core/shaders/canvas/utils/render.js +0 -84
  218. package/dist/src/core/shaders/canvas/utils/render.js.map +0 -1
  219. package/dist/src/core/shaders/templates/BorderTemplate.d.ts +0 -37
  220. package/dist/src/core/shaders/templates/BorderTemplate.js +0 -73
  221. package/dist/src/core/shaders/templates/BorderTemplate.js.map +0 -1
  222. package/dist/src/core/shaders/templates/HolePunchTemplate.d.ts +0 -46
  223. package/dist/src/core/shaders/templates/HolePunchTemplate.js +0 -35
  224. package/dist/src/core/shaders/templates/HolePunchTemplate.js.map +0 -1
  225. package/dist/src/core/shaders/templates/LinearGradientTemplate.d.ts +0 -23
  226. package/dist/src/core/shaders/templates/LinearGradientTemplate.js +0 -47
  227. package/dist/src/core/shaders/templates/LinearGradientTemplate.js.map +0 -1
  228. package/dist/src/core/shaders/templates/RadialGradientTemplate.d.ts +0 -31
  229. package/dist/src/core/shaders/templates/RadialGradientTemplate.js +0 -49
  230. package/dist/src/core/shaders/templates/RadialGradientTemplate.js.map +0 -1
  231. package/dist/src/core/shaders/templates/RoundedTemplate.d.ts +0 -29
  232. package/dist/src/core/shaders/templates/RoundedTemplate.js +0 -67
  233. package/dist/src/core/shaders/templates/RoundedTemplate.js.map +0 -1
  234. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.d.ts +0 -7
  235. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js +0 -24
  236. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js.map +0 -1
  237. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.d.ts +0 -6
  238. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js +0 -23
  239. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js.map +0 -1
  240. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.d.ts +0 -6
  241. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js +0 -23
  242. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js.map +0 -1
  243. package/dist/src/core/shaders/templates/ShadowTemplate.d.ts +0 -34
  244. package/dist/src/core/shaders/templates/ShadowTemplate.js +0 -66
  245. package/dist/src/core/shaders/templates/ShadowTemplate.js.map +0 -1
  246. package/dist/src/core/shaders/templates/shaderUtils.d.ts +0 -5
  247. package/dist/src/core/shaders/templates/shaderUtils.js +0 -41
  248. package/dist/src/core/shaders/templates/shaderUtils.js.map +0 -1
  249. package/dist/src/core/shaders/webgl/Border.d.ts +0 -3
  250. package/dist/src/core/shaders/webgl/Border.js +0 -110
  251. package/dist/src/core/shaders/webgl/Border.js.map +0 -1
  252. package/dist/src/core/shaders/webgl/Default.d.ts +0 -2
  253. package/dist/src/core/shaders/webgl/Default.js +0 -86
  254. package/dist/src/core/shaders/webgl/Default.js.map +0 -1
  255. package/dist/src/core/shaders/webgl/DefaultBatched.d.ts +0 -2
  256. package/dist/src/core/shaders/webgl/DefaultBatched.js +0 -104
  257. package/dist/src/core/shaders/webgl/DefaultBatched.js.map +0 -1
  258. package/dist/src/core/shaders/webgl/HolePunch.d.ts +0 -3
  259. package/dist/src/core/shaders/webgl/HolePunch.js +0 -64
  260. package/dist/src/core/shaders/webgl/HolePunch.js.map +0 -1
  261. package/dist/src/core/shaders/webgl/LinearGradient.d.ts +0 -3
  262. package/dist/src/core/shaders/webgl/LinearGradient.js +0 -75
  263. package/dist/src/core/shaders/webgl/LinearGradient.js.map +0 -1
  264. package/dist/src/core/shaders/webgl/RadialGradient.d.ts +0 -3
  265. package/dist/src/core/shaders/webgl/RadialGradient.js +0 -73
  266. package/dist/src/core/shaders/webgl/RadialGradient.js.map +0 -1
  267. package/dist/src/core/shaders/webgl/Rounded.d.ts +0 -7
  268. package/dist/src/core/shaders/webgl/Rounded.js +0 -86
  269. package/dist/src/core/shaders/webgl/Rounded.js.map +0 -1
  270. package/dist/src/core/shaders/webgl/RoundedWithBorder.d.ts +0 -3
  271. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +0 -129
  272. package/dist/src/core/shaders/webgl/RoundedWithBorder.js.map +0 -1
  273. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.d.ts +0 -3
  274. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +0 -149
  275. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js.map +0 -1
  276. package/dist/src/core/shaders/webgl/RoundedWithShadow.d.ts +0 -3
  277. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +0 -84
  278. package/dist/src/core/shaders/webgl/RoundedWithShadow.js.map +0 -1
  279. package/dist/src/core/shaders/webgl/SdfShader.d.ts +0 -32
  280. package/dist/src/core/shaders/webgl/SdfShader.js +0 -116
  281. package/dist/src/core/shaders/webgl/SdfShader.js.map +0 -1
  282. package/dist/src/core/shaders/webgl/Shadow.d.ts +0 -3
  283. package/dist/src/core/shaders/webgl/Shadow.js +0 -110
  284. package/dist/src/core/shaders/webgl/Shadow.js.map +0 -1
  285. package/dist/src/core/temp.js +0 -77
  286. package/dist/src/core/temp.js.map +0 -1
  287. /package/dist/src/core/{temp.d.ts → renderers/webgl/WebGlCoreShader.destroy.d.ts} +0 -0
@@ -1,808 +1,808 @@
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
- /* eslint-disable @typescript-eslint/no-non-null-assertion */
21
-
22
- import { assertTruthy } from '../../../utils.js';
23
- import { getRgbaString, type RGBA } from '../../lib/utils.js';
24
- import { calcDefaultLineHeight } from '../TextRenderingUtils.js';
25
- import {
26
- getWebFontMetrics,
27
- isZeroWidthSpace,
28
- } from '../TextTextureRendererUtils.js';
29
- import type { NormalizedFontMetrics } from '../font-face-types/TrFontFace.js';
30
- import type { WebTrFontFace } from '../font-face-types/WebTrFontFace.js';
31
-
32
- const MAX_TEXTURE_DIMENSION = 2048;
33
-
34
- /**
35
- * Text Overflow Values
36
- */
37
- export type TextOverflow =
38
- | 'ellipsis'
39
- | 'clip'
40
- | (string & Record<never, never>);
41
-
42
- /***
43
- * Text Horizontal Align Values
44
- */
45
- export type TextAlign = 'left' | 'center' | 'right';
46
-
47
- /***
48
- * Text Baseline Values
49
- */
50
- export type TextBaseline =
51
- | 'alphabetic'
52
- | 'top'
53
- | 'hanging'
54
- | 'middle'
55
- | 'ideographic'
56
- | 'bottom';
57
-
58
- /***
59
- * Text Vertical Align Values
60
- */
61
- export type TextVerticalAlign = 'top' | 'middle' | 'bottom';
62
-
63
- /**
64
- * Text Texture Settings
65
- */
66
- export interface Settings {
67
- w: number;
68
- h: number;
69
- text: string;
70
- fontStyle: string;
71
- fontSize: number;
72
- fontBaselineRatio: number;
73
- fontFamily: string | null;
74
- trFontFace: WebTrFontFace | null;
75
- wordWrap: boolean;
76
- wordWrapWidth: number;
77
- wordBreak: boolean;
78
- textOverflow: TextOverflow | null;
79
- lineHeight: number | null;
80
- textBaseline: TextBaseline;
81
- textAlign: TextAlign;
82
- verticalAlign: TextVerticalAlign;
83
- offsetY: number | null;
84
- maxLines: number;
85
- maxHeight: number | null;
86
- overflowSuffix: string;
87
- precision: number;
88
- textColor: RGBA;
89
- paddingLeft: number;
90
- paddingRight: number;
91
- shadow: boolean;
92
- shadowColor: RGBA;
93
- shadowOffsetX: number;
94
- shadowOffsetY: number;
95
- shadowBlur: number;
96
- highlight: boolean;
97
- highlightHeight: number;
98
- highlightColor: RGBA;
99
- highlightOffset: number;
100
- highlightPaddingLeft: number;
101
- highlightPaddingRight: number;
102
- letterSpacing: number;
103
- textIndent: number;
104
- cutSx: number;
105
- cutSy: number;
106
- cutEx: number;
107
- cutEy: number;
108
- advancedRenderer: boolean;
109
-
110
- // Normally stage options
111
- textRenderIssueMargin: number;
112
- }
113
-
114
- export interface RenderInfo {
115
- w: number;
116
- h: number;
117
- lines: string[];
118
- precision: number;
119
- remainingText: string;
120
- moreTextLines: boolean;
121
- width: number;
122
- innerWidth: number;
123
- height: number;
124
- fontSize: number;
125
- cutSx: number;
126
- cutSy: number;
127
- cutEx: number;
128
- cutEy: number;
129
- lineHeight: number;
130
- defLineHeight: number;
131
- lineWidths: number[];
132
- offsetY: number;
133
- paddingLeft: number;
134
- paddingRight: number;
135
- letterSpacing: number;
136
- textIndent: number;
137
- metrics: NormalizedFontMetrics;
138
- }
139
-
140
- /**
141
- * Calculate height for the canvas
142
- *
143
- * @param textBaseline
144
- * @param fontSize
145
- * @param lineHeight
146
- * @param numLines
147
- * @param offsetY
148
- * @returns
149
- */
150
- function calcHeight(
151
- textBaseline: TextBaseline,
152
- fontSize: number,
153
- lineHeight: number,
154
- numLines: number,
155
- offsetY: number | null,
156
- ) {
157
- const baselineOffset = textBaseline !== 'bottom' ? 0.5 * fontSize : 0;
158
- return (
159
- lineHeight * (numLines - 1) +
160
- baselineOffset +
161
- Math.max(lineHeight, fontSize) +
162
- (offsetY || 0)
163
- );
164
- }
165
-
166
- export class LightningTextTextureRenderer {
167
- private _canvas: OffscreenCanvas | HTMLCanvasElement;
168
- private _context:
169
- | OffscreenCanvasRenderingContext2D
170
- | CanvasRenderingContext2D;
171
- private _settings: Settings;
172
-
173
- constructor(
174
- canvas: OffscreenCanvas | HTMLCanvasElement,
175
- context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D,
176
- ) {
177
- this._canvas = canvas;
178
- this._context = context;
179
- this._settings = this.mergeDefaults({});
180
- }
181
-
182
- set settings(v: Partial<Settings>) {
183
- this._settings = this.mergeDefaults(v);
184
- }
185
-
186
- get settings(): Settings {
187
- return this._settings;
188
- }
189
-
190
- getPrecision() {
191
- return this._settings.precision;
192
- }
193
-
194
- setFontProperties() {
195
- this._context.font = this._getFontSetting();
196
- this._context.textBaseline = this._settings.textBaseline;
197
- }
198
-
199
- _getFontSetting() {
200
- const ff = [this._settings.fontFamily];
201
-
202
- const ffs = [];
203
- for (let i = 0, n = ff.length; i < n; i++) {
204
- if (ff[i] === 'serif' || ff[i] === 'sans-serif') {
205
- ffs.push(ff[i]);
206
- } else {
207
- ffs.push(`"${ff[i]!}"`);
208
- }
209
- }
210
-
211
- return `${this._settings.fontStyle} ${
212
- this._settings.fontSize * this.getPrecision()
213
- }px ${ffs.join(',')}`;
214
- }
215
-
216
- _load() {
217
- if (true && document.fonts) {
218
- const fontSetting = this._getFontSetting();
219
- try {
220
- if (!document.fonts.check(fontSetting, this._settings.text)) {
221
- // Use a promise that waits for loading.
222
- return document.fonts
223
- .load(fontSetting, this._settings.text)
224
- .catch((err) => {
225
- // Just load the fallback font.
226
- console.warn('[Lightning] Font load error', err, fontSetting);
227
- })
228
- .then(() => {
229
- if (!document.fonts.check(fontSetting, this._settings.text)) {
230
- console.warn('[Lightning] Font not found', fontSetting);
231
- }
232
- });
233
- }
234
- } catch (e) {
235
- console.warn("[Lightning] Can't check font loading for " + fontSetting);
236
- }
237
- }
238
- }
239
-
240
- calculateRenderInfo(): RenderInfo {
241
- const renderInfo: Partial<RenderInfo> = {};
242
-
243
- const precision = this.getPrecision();
244
-
245
- const paddingLeft = this._settings.paddingLeft * precision;
246
- const paddingRight = this._settings.paddingRight * precision;
247
- const fontSize = this._settings.fontSize * precision;
248
- let offsetY =
249
- this._settings.offsetY === null
250
- ? null
251
- : this._settings.offsetY * precision;
252
- const w = this._settings.w * precision;
253
- const h = this._settings.h * precision;
254
- let wordWrapWidth = this._settings.wordWrapWidth * precision;
255
- const cutSx = this._settings.cutSx * precision;
256
- const cutEx = this._settings.cutEx * precision;
257
- const cutSy = this._settings.cutSy * precision;
258
- const cutEy = this._settings.cutEy * precision;
259
- const letterSpacing = (this._settings.letterSpacing || 0) * precision;
260
- const textIndent = this._settings.textIndent * precision;
261
- const trFontFace = this._settings.trFontFace;
262
-
263
- // Set font properties.
264
- this.setFontProperties();
265
-
266
- assertTruthy(trFontFace);
267
- const metrics = getWebFontMetrics(this._context, trFontFace, fontSize);
268
- const defLineHeight = calcDefaultLineHeight(metrics, fontSize) * precision;
269
- const lineHeight =
270
- this._settings.lineHeight !== null
271
- ? this._settings.lineHeight * precision
272
- : defLineHeight;
273
-
274
- const maxHeight = this._settings.maxHeight;
275
- const containedMaxLines =
276
- maxHeight !== null && lineHeight > 0
277
- ? Math.floor(maxHeight / lineHeight)
278
- : 0;
279
-
280
- const setMaxLines = this._settings.maxLines;
281
- const calcMaxLines =
282
- containedMaxLines > 0 && setMaxLines > 0
283
- ? Math.min(containedMaxLines, setMaxLines)
284
- : Math.max(containedMaxLines, setMaxLines);
285
-
286
- // Total width.
287
- let width = w || 2048 / this.getPrecision();
288
-
289
- // Inner width.
290
- let innerWidth = width - paddingLeft;
291
- if (innerWidth < 10) {
292
- width += 10 - innerWidth;
293
- innerWidth = 10;
294
- }
295
-
296
- if (!wordWrapWidth) {
297
- wordWrapWidth = innerWidth;
298
- }
299
-
300
- // Text overflow
301
- if (this._settings.textOverflow && !this._settings.wordWrap) {
302
- let suffix;
303
- switch (this._settings.textOverflow) {
304
- case 'clip':
305
- suffix = '';
306
- break;
307
- case 'ellipsis':
308
- suffix = this._settings.overflowSuffix;
309
- break;
310
- default:
311
- suffix = this._settings.textOverflow;
312
- }
313
- this._settings.text = this.wrapWord(
314
- this._settings.text,
315
- wordWrapWidth - textIndent,
316
- suffix,
317
- );
318
- }
319
-
320
- // word wrap
321
- // preserve original text
322
- let linesInfo: { n: number[]; l: string[] };
323
- if (this._settings.wordWrap) {
324
- linesInfo = this.wrapText(
325
- this._settings.text,
326
- wordWrapWidth,
327
- letterSpacing,
328
- textIndent,
329
- );
330
- } else {
331
- linesInfo = { l: this._settings.text.split(/(?:\r\n|\r|\n)/), n: [] };
332
- const n = linesInfo.l.length;
333
- for (let i = 0; i < n - 1; i++) {
334
- linesInfo.n.push(i);
335
- }
336
- }
337
- let lines = linesInfo.l;
338
-
339
- if (calcMaxLines && lines.length > calcMaxLines) {
340
- const usedLines = lines.slice(0, calcMaxLines);
341
-
342
- let otherLines = null;
343
- if (this._settings.overflowSuffix) {
344
- // Wrap again with max lines suffix enabled.
345
- const w = this._settings.overflowSuffix
346
- ? this.measureText(this._settings.overflowSuffix)
347
- : 0;
348
- const al = this.wrapText(
349
- usedLines[usedLines.length - 1]!,
350
- wordWrapWidth - w,
351
- letterSpacing,
352
- textIndent,
353
- );
354
- usedLines[usedLines.length - 1] = `${al.l[0]!}${
355
- this._settings.overflowSuffix
356
- }`;
357
- otherLines = [al.l.length > 1 ? al.l[1] : ''];
358
- } else {
359
- otherLines = [''];
360
- }
361
-
362
- // Re-assemble the remaining text.
363
- let i;
364
- const n = lines.length;
365
- let j = 0;
366
- const m = linesInfo.n.length;
367
- for (i = calcMaxLines; i < n; i++) {
368
- otherLines[j] += `${otherLines[j] ? ' ' : ''}${lines[i]!}`;
369
- if (i + 1 < m && linesInfo.n[i + 1]) {
370
- j++;
371
- }
372
- }
373
-
374
- renderInfo.remainingText = otherLines.join('\n');
375
-
376
- renderInfo.moreTextLines = true;
377
-
378
- lines = usedLines;
379
- } else {
380
- renderInfo.moreTextLines = false;
381
- renderInfo.remainingText = '';
382
- }
383
-
384
- // calculate text width
385
- let maxLineWidth = 0;
386
- const lineWidths: number[] = [];
387
- for (let i = 0; i < lines.length; i++) {
388
- const lineWidth =
389
- this.measureText(lines[i]!, letterSpacing) + (i === 0 ? textIndent : 0);
390
- lineWidths.push(lineWidth);
391
- maxLineWidth = Math.max(maxLineWidth, lineWidth);
392
- }
393
-
394
- renderInfo.lineWidths = lineWidths;
395
-
396
- if (!w) {
397
- // Auto-set width to max text length.
398
- width = maxLineWidth + paddingLeft + paddingRight;
399
- innerWidth = maxLineWidth;
400
- }
401
-
402
- // If word wrap is enabled the width needs to be the width of the text.
403
- if (
404
- this._settings.wordWrap &&
405
- w > maxLineWidth &&
406
- this._settings.textAlign === 'left' &&
407
- lines.length === 1
408
- ) {
409
- width = maxLineWidth + paddingLeft + paddingRight;
410
- }
411
-
412
- let height;
413
- if (h) {
414
- height = h;
415
- } else {
416
- height = calcHeight(
417
- this._settings.textBaseline,
418
- fontSize,
419
- lineHeight,
420
- lines.length,
421
- offsetY,
422
- );
423
- }
424
-
425
- if (offsetY === null) {
426
- offsetY = fontSize;
427
- }
428
-
429
- renderInfo.w = width;
430
- renderInfo.h = height;
431
- renderInfo.lines = lines;
432
- renderInfo.precision = precision;
433
-
434
- if (!width) {
435
- // To prevent canvas errors.
436
- width = 1;
437
- }
438
-
439
- if (!height) {
440
- // To prevent canvas errors.
441
- height = 1;
442
- }
443
-
444
- if (cutSx || cutEx) {
445
- width = Math.min(width, cutEx - cutSx);
446
- }
447
-
448
- if (cutSy || cutEy) {
449
- height = Math.min(height, cutEy - cutSy);
450
- }
451
-
452
- renderInfo.width = width;
453
- renderInfo.innerWidth = innerWidth;
454
- renderInfo.height = height;
455
- renderInfo.fontSize = fontSize;
456
- renderInfo.cutSx = cutSx;
457
- renderInfo.cutSy = cutSy;
458
- renderInfo.cutEx = cutEx;
459
- renderInfo.cutEy = cutEy;
460
- renderInfo.lineHeight = lineHeight;
461
- renderInfo.defLineHeight = defLineHeight;
462
- renderInfo.lineWidths = lineWidths;
463
- renderInfo.offsetY = offsetY;
464
- renderInfo.paddingLeft = paddingLeft;
465
- renderInfo.paddingRight = paddingRight;
466
- renderInfo.letterSpacing = letterSpacing;
467
- renderInfo.textIndent = textIndent;
468
- renderInfo.metrics = metrics;
469
-
470
- return renderInfo as RenderInfo;
471
- }
472
-
473
- draw(
474
- renderInfo: RenderInfo,
475
- linesOverride?: { lines: string[]; lineWidths: number[] },
476
- ) {
477
- const precision = this.getPrecision();
478
-
479
- // Allow lines to be overriden for partial rendering.
480
- const lines = linesOverride?.lines || renderInfo.lines;
481
- const lineWidths = linesOverride?.lineWidths || renderInfo.lineWidths;
482
- const height = linesOverride
483
- ? calcHeight(
484
- this._settings.textBaseline,
485
- renderInfo.fontSize,
486
- renderInfo.lineHeight,
487
- linesOverride.lines.length,
488
- this._settings.offsetY === null
489
- ? null
490
- : this._settings.offsetY * precision,
491
- )
492
- : renderInfo.height;
493
-
494
- // Add extra margin to prevent issue with clipped text when scaling.
495
- this._canvas.width = Math.min(
496
- Math.ceil(renderInfo.width + this._settings.textRenderIssueMargin),
497
- MAX_TEXTURE_DIMENSION,
498
- );
499
- this._canvas.height = Math.min(Math.ceil(height), MAX_TEXTURE_DIMENSION);
500
-
501
- // Canvas context has been reset.
502
- this.setFontProperties();
503
-
504
- if (renderInfo.fontSize >= 128) {
505
- // WpeWebKit bug: must force compositing because cairo-traps-compositor will not work with text first.
506
- this._context.globalAlpha = 0.01;
507
- this._context.fillRect(0, 0, 0.01, 0.01);
508
- this._context.globalAlpha = 1.0;
509
- }
510
-
511
- if (renderInfo.cutSx || renderInfo.cutSy) {
512
- this._context.translate(-renderInfo.cutSx, -renderInfo.cutSy);
513
- }
514
-
515
- let linePositionX;
516
- let linePositionY;
517
-
518
- const drawLines = [];
519
-
520
- const { metrics } = renderInfo;
521
-
522
- /**
523
- * Ascender (in pixels)
524
- */
525
- const ascenderPx = metrics
526
- ? metrics.ascender * renderInfo.fontSize
527
- : renderInfo.fontSize;
528
-
529
- /**
530
- * Bare line height is the distance between the ascender and descender of the font.
531
- * without the line gap metric.
532
- */
533
- const bareLineHeightPx =
534
- (metrics.ascender - metrics.descender) * renderInfo.fontSize;
535
-
536
- // Draw lines line by line.
537
- for (let i = 0, n = lines.length; i < n; i++) {
538
- linePositionX = i === 0 ? renderInfo.textIndent : 0;
539
-
540
- // By default, text is aligned to top
541
- linePositionY = i * renderInfo.lineHeight + ascenderPx;
542
-
543
- if (this._settings.verticalAlign == 'middle') {
544
- linePositionY += (renderInfo.lineHeight - bareLineHeightPx) / 2;
545
- } else if (this._settings.verticalAlign == 'bottom') {
546
- linePositionY += renderInfo.lineHeight - bareLineHeightPx;
547
- }
548
-
549
- if (this._settings.textAlign === 'right') {
550
- linePositionX += renderInfo.innerWidth - lineWidths[i]!;
551
- } else if (this._settings.textAlign === 'center') {
552
- linePositionX += (renderInfo.innerWidth - lineWidths[i]!) / 2;
553
- }
554
- linePositionX += renderInfo.paddingLeft;
555
-
556
- drawLines.push({
557
- text: lines[i]!,
558
- x: linePositionX,
559
- y: linePositionY,
560
- w: lineWidths[i]!,
561
- });
562
- }
563
-
564
- // Highlight.
565
- if (this._settings.highlight) {
566
- const color = this._settings.highlightColor;
567
-
568
- const hlHeight =
569
- this._settings.highlightHeight * precision || renderInfo.fontSize * 1.5;
570
- const offset = this._settings.highlightOffset * precision;
571
- const hlPaddingLeft =
572
- this._settings.highlightPaddingLeft !== null
573
- ? this._settings.highlightPaddingLeft * precision
574
- : renderInfo.paddingLeft;
575
- const hlPaddingRight =
576
- this._settings.highlightPaddingRight !== null
577
- ? this._settings.highlightPaddingRight * precision
578
- : renderInfo.paddingRight;
579
-
580
- this._context.fillStyle = getRgbaString(color);
581
- for (let i = 0; i < drawLines.length; i++) {
582
- const drawLine = drawLines[i]!;
583
- this._context.fillRect(
584
- drawLine.x - hlPaddingLeft,
585
- drawLine.y - renderInfo.offsetY + offset,
586
- drawLine.w + hlPaddingRight + hlPaddingLeft,
587
- hlHeight,
588
- );
589
- }
590
- }
591
-
592
- // Text shadow.
593
- let prevShadowSettings: null | [string, number, number, number] = null;
594
- if (this._settings.shadow) {
595
- prevShadowSettings = [
596
- this._context.shadowColor,
597
- this._context.shadowOffsetX,
598
- this._context.shadowOffsetY,
599
- this._context.shadowBlur,
600
- ];
601
-
602
- this._context.shadowColor = getRgbaString(this._settings.shadowColor);
603
- this._context.shadowOffsetX = this._settings.shadowOffsetX * precision;
604
- this._context.shadowOffsetY = this._settings.shadowOffsetY * precision;
605
- this._context.shadowBlur = this._settings.shadowBlur * precision;
606
- }
607
-
608
- this._context.fillStyle = getRgbaString(this._settings.textColor);
609
- for (let i = 0, n = drawLines.length; i < n; i++) {
610
- const drawLine = drawLines[i]!;
611
-
612
- if (renderInfo.letterSpacing === 0) {
613
- this._context.fillText(drawLine.text, drawLine.x, drawLine.y);
614
- } else {
615
- const textSplit = drawLine.text.split('');
616
- let x = drawLine.x;
617
- for (let i = 0, j = textSplit.length; i < j; i++) {
618
- this._context.fillText(textSplit[i]!, x, drawLine.y);
619
- x += this.measureText(textSplit[i]!, renderInfo.letterSpacing);
620
- }
621
- }
622
- }
623
-
624
- if (prevShadowSettings) {
625
- this._context.shadowColor = prevShadowSettings[0];
626
- this._context.shadowOffsetX = prevShadowSettings[1];
627
- this._context.shadowOffsetY = prevShadowSettings[2];
628
- this._context.shadowBlur = prevShadowSettings[3];
629
- }
630
-
631
- if (renderInfo.cutSx || renderInfo.cutSy) {
632
- this._context.translate(renderInfo.cutSx, renderInfo.cutSy);
633
- }
634
- }
635
-
636
- wrapWord(word: string, wordWrapWidth: number, suffix: string) {
637
- const suffixWidth = this._context.measureText(suffix).width;
638
- const wordLen = word.length;
639
- const wordWidth = this._context.measureText(word).width;
640
-
641
- /* If word fits wrapWidth, do nothing */
642
- if (wordWidth <= wordWrapWidth) {
643
- return word;
644
- }
645
-
646
- /* Make initial guess for text cuttoff */
647
- let cutoffIndex = Math.floor((wordWrapWidth * wordLen) / wordWidth);
648
- let truncWordWidth =
649
- this._context.measureText(word.substring(0, cutoffIndex)).width +
650
- suffixWidth;
651
-
652
- /* In case guess was overestimated, shrink it letter by letter. */
653
- if (truncWordWidth > wordWrapWidth) {
654
- while (cutoffIndex > 0) {
655
- truncWordWidth =
656
- this._context.measureText(word.substring(0, cutoffIndex)).width +
657
- suffixWidth;
658
- if (truncWordWidth > wordWrapWidth) {
659
- cutoffIndex -= 1;
660
- } else {
661
- break;
662
- }
663
- }
664
-
665
- /* In case guess was underestimated, extend it letter by letter. */
666
- } else {
667
- while (cutoffIndex < wordLen) {
668
- truncWordWidth =
669
- this._context.measureText(word.substring(0, cutoffIndex)).width +
670
- suffixWidth;
671
- if (truncWordWidth < wordWrapWidth) {
672
- cutoffIndex += 1;
673
- } else {
674
- // Finally, when bound is crossed, retract last letter.
675
- cutoffIndex -= 1;
676
- break;
677
- }
678
- }
679
- }
680
-
681
- /* If wrapWidth is too short to even contain suffix alone, return empty string */
682
- return (
683
- word.substring(0, cutoffIndex) +
684
- (wordWrapWidth >= suffixWidth ? suffix : '')
685
- );
686
- }
687
-
688
- /**
689
- * Applies newlines to a string to have it optimally fit into the horizontal
690
- * bounds set by the Text object's wordWrapWidth property.
691
- */
692
- wrapText(
693
- text: string,
694
- wordWrapWidth: number,
695
- letterSpacing: number,
696
- indent = 0,
697
- ) {
698
- const spaceRegex = / |\u200B/g; // ZWSP and spaces
699
- const lines = text.split(/\r?\n/g);
700
- let allLines: string[] = [];
701
- const realNewlines: number[] = [];
702
-
703
- for (let i = 0; i < lines.length; i++) {
704
- const resultLines: string[] = [];
705
- let result = '';
706
- let spaceLeft = wordWrapWidth - indent;
707
-
708
- // Split the line into words, considering ZWSP
709
- const words = lines[i]!.split(spaceRegex);
710
- const spaces = lines[i]!.match(spaceRegex) || [];
711
-
712
- for (let j = 0; j < words.length; j++) {
713
- const space = spaces[j - 1] || '';
714
- const word = words[j]!;
715
- const wordWidth = this.measureText(word, letterSpacing);
716
- const wordWidthWithSpace = isZeroWidthSpace(space)
717
- ? wordWidth
718
- : wordWidth + this.measureText(space, letterSpacing);
719
-
720
- if (j === 0 || wordWidthWithSpace > spaceLeft) {
721
- if (j > 0) {
722
- resultLines.push(result);
723
- result = '';
724
- }
725
- result += word;
726
- spaceLeft = wordWrapWidth - wordWidth - (j === 0 ? indent : 0);
727
- } else {
728
- spaceLeft -= wordWidthWithSpace;
729
- result += space + word;
730
- }
731
- }
732
-
733
- resultLines.push(result);
734
- result = '';
735
- allLines = allLines.concat(resultLines);
736
-
737
- if (i < lines.length - 1) {
738
- realNewlines.push(allLines.length);
739
- }
740
- }
741
-
742
- return { l: allLines, n: realNewlines };
743
- }
744
-
745
- measureText(word: string, space = 0) {
746
- if (!space) {
747
- return this._context.measureText(word).width;
748
- }
749
-
750
- // Split word into characters, but skip ZWSP in the width calculation
751
- return word.split('').reduce((acc, char) => {
752
- // Check if the character is a zero-width space and skip it
753
- if (isZeroWidthSpace(char)) {
754
- return acc;
755
- }
756
- return acc + this._context.measureText(char).width + space;
757
- }, 0);
758
- }
759
-
760
- mergeDefaults(settings: Partial<Settings>): Settings {
761
- return {
762
- text: '',
763
- w: 0,
764
- h: 0,
765
- fontStyle: 'normal',
766
- fontSize: 40,
767
- fontFamily: null,
768
- trFontFace: null,
769
- wordWrap: true,
770
- wordWrapWidth: 0,
771
- wordBreak: false,
772
- textOverflow: '',
773
- lineHeight: null,
774
- textBaseline: 'alphabetic',
775
- textAlign: 'left',
776
- verticalAlign: 'top',
777
- offsetY: null,
778
- maxLines: 0,
779
- maxHeight: null,
780
- overflowSuffix: '...',
781
- textColor: [1.0, 1.0, 1.0, 1.0],
782
- paddingLeft: 0,
783
- paddingRight: 0,
784
- shadow: false,
785
- shadowColor: [0.0, 0.0, 0.0, 1.0],
786
- shadowOffsetX: 0,
787
- shadowOffsetY: 0,
788
- shadowBlur: 5,
789
- highlight: false,
790
- highlightHeight: 0,
791
- highlightColor: [0.0, 0.0, 0.0, 1.0],
792
- highlightOffset: 0,
793
- highlightPaddingLeft: 0,
794
- highlightPaddingRight: 0,
795
- letterSpacing: 0,
796
- textIndent: 0,
797
- cutSx: 0,
798
- cutEx: 0,
799
- cutSy: 0,
800
- cutEy: 0,
801
- advancedRenderer: false,
802
- fontBaselineRatio: 0,
803
- precision: 1,
804
- textRenderIssueMargin: 0,
805
- ...settings,
806
- };
807
- }
808
- }
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
+ /* eslint-disable @typescript-eslint/no-non-null-assertion */
21
+
22
+ import { assertTruthy } from '../../../utils.js';
23
+ import { getRgbaString, type RGBA } from '../../lib/utils.js';
24
+ import { calcDefaultLineHeight } from '../TextRenderingUtils.js';
25
+ import {
26
+ getWebFontMetrics,
27
+ isZeroWidthSpace,
28
+ } from '../TextTextureRendererUtils.js';
29
+ import type { NormalizedFontMetrics } from '../font-face-types/TrFontFace.js';
30
+ import type { WebTrFontFace } from '../font-face-types/WebTrFontFace.js';
31
+
32
+ const MAX_TEXTURE_DIMENSION = 2048;
33
+
34
+ /**
35
+ * Text Overflow Values
36
+ */
37
+ export type TextOverflow =
38
+ | 'ellipsis'
39
+ | 'clip'
40
+ | (string & Record<never, never>);
41
+
42
+ /***
43
+ * Text Horizontal Align Values
44
+ */
45
+ export type TextAlign = 'left' | 'center' | 'right';
46
+
47
+ /***
48
+ * Text Baseline Values
49
+ */
50
+ export type TextBaseline =
51
+ | 'alphabetic'
52
+ | 'top'
53
+ | 'hanging'
54
+ | 'middle'
55
+ | 'ideographic'
56
+ | 'bottom';
57
+
58
+ /***
59
+ * Text Vertical Align Values
60
+ */
61
+ export type TextVerticalAlign = 'top' | 'middle' | 'bottom';
62
+
63
+ /**
64
+ * Text Texture Settings
65
+ */
66
+ export interface Settings {
67
+ w: number;
68
+ h: number;
69
+ text: string;
70
+ fontStyle: string;
71
+ fontSize: number;
72
+ fontBaselineRatio: number;
73
+ fontFamily: string | null;
74
+ trFontFace: WebTrFontFace | null;
75
+ wordWrap: boolean;
76
+ wordWrapWidth: number;
77
+ wordBreak: boolean;
78
+ textOverflow: TextOverflow | null;
79
+ lineHeight: number | null;
80
+ textBaseline: TextBaseline;
81
+ textAlign: TextAlign;
82
+ verticalAlign: TextVerticalAlign;
83
+ offsetY: number | null;
84
+ maxLines: number;
85
+ maxHeight: number | null;
86
+ overflowSuffix: string;
87
+ precision: number;
88
+ textColor: RGBA;
89
+ paddingLeft: number;
90
+ paddingRight: number;
91
+ shadow: boolean;
92
+ shadowColor: RGBA;
93
+ shadowOffsetX: number;
94
+ shadowOffsetY: number;
95
+ shadowBlur: number;
96
+ highlight: boolean;
97
+ highlightHeight: number;
98
+ highlightColor: RGBA;
99
+ highlightOffset: number;
100
+ highlightPaddingLeft: number;
101
+ highlightPaddingRight: number;
102
+ letterSpacing: number;
103
+ textIndent: number;
104
+ cutSx: number;
105
+ cutSy: number;
106
+ cutEx: number;
107
+ cutEy: number;
108
+ advancedRenderer: boolean;
109
+
110
+ // Normally stage options
111
+ textRenderIssueMargin: number;
112
+ }
113
+
114
+ export interface RenderInfo {
115
+ w: number;
116
+ h: number;
117
+ lines: string[];
118
+ precision: number;
119
+ remainingText: string;
120
+ moreTextLines: boolean;
121
+ width: number;
122
+ innerWidth: number;
123
+ height: number;
124
+ fontSize: number;
125
+ cutSx: number;
126
+ cutSy: number;
127
+ cutEx: number;
128
+ cutEy: number;
129
+ lineHeight: number;
130
+ defLineHeight: number;
131
+ lineWidths: number[];
132
+ offsetY: number;
133
+ paddingLeft: number;
134
+ paddingRight: number;
135
+ letterSpacing: number;
136
+ textIndent: number;
137
+ metrics: NormalizedFontMetrics;
138
+ }
139
+
140
+ /**
141
+ * Calculate height for the canvas
142
+ *
143
+ * @param textBaseline
144
+ * @param fontSize
145
+ * @param lineHeight
146
+ * @param numLines
147
+ * @param offsetY
148
+ * @returns
149
+ */
150
+ function calcHeight(
151
+ textBaseline: TextBaseline,
152
+ fontSize: number,
153
+ lineHeight: number,
154
+ numLines: number,
155
+ offsetY: number | null,
156
+ ) {
157
+ const baselineOffset = textBaseline !== 'bottom' ? 0.5 * fontSize : 0;
158
+ return (
159
+ lineHeight * (numLines - 1) +
160
+ baselineOffset +
161
+ Math.max(lineHeight, fontSize) +
162
+ (offsetY || 0)
163
+ );
164
+ }
165
+
166
+ export class LightningTextTextureRenderer {
167
+ private _canvas: OffscreenCanvas | HTMLCanvasElement;
168
+ private _context:
169
+ | OffscreenCanvasRenderingContext2D
170
+ | CanvasRenderingContext2D;
171
+ private _settings: Settings;
172
+
173
+ constructor(
174
+ canvas: OffscreenCanvas | HTMLCanvasElement,
175
+ context: OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D,
176
+ ) {
177
+ this._canvas = canvas;
178
+ this._context = context;
179
+ this._settings = this.mergeDefaults({});
180
+ }
181
+
182
+ set settings(v: Partial<Settings>) {
183
+ this._settings = this.mergeDefaults(v);
184
+ }
185
+
186
+ get settings(): Settings {
187
+ return this._settings;
188
+ }
189
+
190
+ getPrecision() {
191
+ return this._settings.precision;
192
+ }
193
+
194
+ setFontProperties() {
195
+ this._context.font = this._getFontSetting();
196
+ this._context.textBaseline = this._settings.textBaseline;
197
+ }
198
+
199
+ _getFontSetting() {
200
+ const ff = [this._settings.fontFamily];
201
+
202
+ const ffs = [];
203
+ for (let i = 0, n = ff.length; i < n; i++) {
204
+ if (ff[i] === 'serif' || ff[i] === 'sans-serif') {
205
+ ffs.push(ff[i]);
206
+ } else {
207
+ ffs.push(`"${ff[i]!}"`);
208
+ }
209
+ }
210
+
211
+ return `${this._settings.fontStyle} ${
212
+ this._settings.fontSize * this.getPrecision()
213
+ }px ${ffs.join(',')}`;
214
+ }
215
+
216
+ _load() {
217
+ if (true && document.fonts) {
218
+ const fontSetting = this._getFontSetting();
219
+ try {
220
+ if (!document.fonts.check(fontSetting, this._settings.text)) {
221
+ // Use a promise that waits for loading.
222
+ return document.fonts
223
+ .load(fontSetting, this._settings.text)
224
+ .catch((err) => {
225
+ // Just load the fallback font.
226
+ console.warn('[Lightning] Font load error', err, fontSetting);
227
+ })
228
+ .then(() => {
229
+ if (!document.fonts.check(fontSetting, this._settings.text)) {
230
+ console.warn('[Lightning] Font not found', fontSetting);
231
+ }
232
+ });
233
+ }
234
+ } catch (e) {
235
+ console.warn("[Lightning] Can't check font loading for " + fontSetting);
236
+ }
237
+ }
238
+ }
239
+
240
+ calculateRenderInfo(): RenderInfo {
241
+ const renderInfo: Partial<RenderInfo> = {};
242
+
243
+ const precision = this.getPrecision();
244
+
245
+ const paddingLeft = this._settings.paddingLeft * precision;
246
+ const paddingRight = this._settings.paddingRight * precision;
247
+ const fontSize = this._settings.fontSize * precision;
248
+ let offsetY =
249
+ this._settings.offsetY === null
250
+ ? null
251
+ : this._settings.offsetY * precision;
252
+ const w = this._settings.w * precision;
253
+ const h = this._settings.h * precision;
254
+ let wordWrapWidth = this._settings.wordWrapWidth * precision;
255
+ const cutSx = this._settings.cutSx * precision;
256
+ const cutEx = this._settings.cutEx * precision;
257
+ const cutSy = this._settings.cutSy * precision;
258
+ const cutEy = this._settings.cutEy * precision;
259
+ const letterSpacing = (this._settings.letterSpacing || 0) * precision;
260
+ const textIndent = this._settings.textIndent * precision;
261
+ const trFontFace = this._settings.trFontFace;
262
+
263
+ // Set font properties.
264
+ this.setFontProperties();
265
+
266
+ assertTruthy(trFontFace);
267
+ const metrics = getWebFontMetrics(this._context, trFontFace, fontSize);
268
+ const defLineHeight = calcDefaultLineHeight(metrics, fontSize) * precision;
269
+ const lineHeight =
270
+ this._settings.lineHeight !== null
271
+ ? this._settings.lineHeight * precision
272
+ : defLineHeight;
273
+
274
+ const maxHeight = this._settings.maxHeight;
275
+ const containedMaxLines =
276
+ maxHeight !== null && lineHeight > 0
277
+ ? Math.floor(maxHeight / lineHeight)
278
+ : 0;
279
+
280
+ const setMaxLines = this._settings.maxLines;
281
+ const calcMaxLines =
282
+ containedMaxLines > 0 && setMaxLines > 0
283
+ ? Math.min(containedMaxLines, setMaxLines)
284
+ : Math.max(containedMaxLines, setMaxLines);
285
+
286
+ // Total width.
287
+ let width = w || 2048 / this.getPrecision();
288
+
289
+ // Inner width.
290
+ let innerWidth = width - paddingLeft;
291
+ if (innerWidth < 10) {
292
+ width += 10 - innerWidth;
293
+ innerWidth = 10;
294
+ }
295
+
296
+ if (!wordWrapWidth) {
297
+ wordWrapWidth = innerWidth;
298
+ }
299
+
300
+ // Text overflow
301
+ if (this._settings.textOverflow && !this._settings.wordWrap) {
302
+ let suffix;
303
+ switch (this._settings.textOverflow) {
304
+ case 'clip':
305
+ suffix = '';
306
+ break;
307
+ case 'ellipsis':
308
+ suffix = this._settings.overflowSuffix;
309
+ break;
310
+ default:
311
+ suffix = this._settings.textOverflow;
312
+ }
313
+ this._settings.text = this.wrapWord(
314
+ this._settings.text,
315
+ wordWrapWidth - textIndent,
316
+ suffix,
317
+ );
318
+ }
319
+
320
+ // word wrap
321
+ // preserve original text
322
+ let linesInfo: { n: number[]; l: string[] };
323
+ if (this._settings.wordWrap) {
324
+ linesInfo = this.wrapText(
325
+ this._settings.text,
326
+ wordWrapWidth,
327
+ letterSpacing,
328
+ textIndent,
329
+ );
330
+ } else {
331
+ linesInfo = { l: this._settings.text.split(/(?:\r\n|\r|\n)/), n: [] };
332
+ const n = linesInfo.l.length;
333
+ for (let i = 0; i < n - 1; i++) {
334
+ linesInfo.n.push(i);
335
+ }
336
+ }
337
+ let lines = linesInfo.l;
338
+
339
+ if (calcMaxLines && lines.length > calcMaxLines) {
340
+ const usedLines = lines.slice(0, calcMaxLines);
341
+
342
+ let otherLines = null;
343
+ if (this._settings.overflowSuffix) {
344
+ // Wrap again with max lines suffix enabled.
345
+ const w = this._settings.overflowSuffix
346
+ ? this.measureText(this._settings.overflowSuffix)
347
+ : 0;
348
+ const al = this.wrapText(
349
+ usedLines[usedLines.length - 1]!,
350
+ wordWrapWidth - w,
351
+ letterSpacing,
352
+ textIndent,
353
+ );
354
+ usedLines[usedLines.length - 1] = `${al.l[0]!}${
355
+ this._settings.overflowSuffix
356
+ }`;
357
+ otherLines = [al.l.length > 1 ? al.l[1] : ''];
358
+ } else {
359
+ otherLines = [''];
360
+ }
361
+
362
+ // Re-assemble the remaining text.
363
+ let i;
364
+ const n = lines.length;
365
+ let j = 0;
366
+ const m = linesInfo.n.length;
367
+ for (i = calcMaxLines; i < n; i++) {
368
+ otherLines[j] += `${otherLines[j] ? ' ' : ''}${lines[i]!}`;
369
+ if (i + 1 < m && linesInfo.n[i + 1]) {
370
+ j++;
371
+ }
372
+ }
373
+
374
+ renderInfo.remainingText = otherLines.join('\n');
375
+
376
+ renderInfo.moreTextLines = true;
377
+
378
+ lines = usedLines;
379
+ } else {
380
+ renderInfo.moreTextLines = false;
381
+ renderInfo.remainingText = '';
382
+ }
383
+
384
+ // calculate text width
385
+ let maxLineWidth = 0;
386
+ const lineWidths: number[] = [];
387
+ for (let i = 0; i < lines.length; i++) {
388
+ const lineWidth =
389
+ this.measureText(lines[i]!, letterSpacing) + (i === 0 ? textIndent : 0);
390
+ lineWidths.push(lineWidth);
391
+ maxLineWidth = Math.max(maxLineWidth, lineWidth);
392
+ }
393
+
394
+ renderInfo.lineWidths = lineWidths;
395
+
396
+ if (!w) {
397
+ // Auto-set width to max text length.
398
+ width = maxLineWidth + paddingLeft + paddingRight;
399
+ innerWidth = maxLineWidth;
400
+ }
401
+
402
+ // If word wrap is enabled the width needs to be the width of the text.
403
+ if (
404
+ this._settings.wordWrap &&
405
+ w > maxLineWidth &&
406
+ this._settings.textAlign === 'left' &&
407
+ lines.length === 1
408
+ ) {
409
+ width = maxLineWidth + paddingLeft + paddingRight;
410
+ }
411
+
412
+ let height;
413
+ if (h) {
414
+ height = h;
415
+ } else {
416
+ height = calcHeight(
417
+ this._settings.textBaseline,
418
+ fontSize,
419
+ lineHeight,
420
+ lines.length,
421
+ offsetY,
422
+ );
423
+ }
424
+
425
+ if (offsetY === null) {
426
+ offsetY = fontSize;
427
+ }
428
+
429
+ renderInfo.w = width;
430
+ renderInfo.h = height;
431
+ renderInfo.lines = lines;
432
+ renderInfo.precision = precision;
433
+
434
+ if (!width) {
435
+ // To prevent canvas errors.
436
+ width = 1;
437
+ }
438
+
439
+ if (!height) {
440
+ // To prevent canvas errors.
441
+ height = 1;
442
+ }
443
+
444
+ if (cutSx || cutEx) {
445
+ width = Math.min(width, cutEx - cutSx);
446
+ }
447
+
448
+ if (cutSy || cutEy) {
449
+ height = Math.min(height, cutEy - cutSy);
450
+ }
451
+
452
+ renderInfo.width = width;
453
+ renderInfo.innerWidth = innerWidth;
454
+ renderInfo.height = height;
455
+ renderInfo.fontSize = fontSize;
456
+ renderInfo.cutSx = cutSx;
457
+ renderInfo.cutSy = cutSy;
458
+ renderInfo.cutEx = cutEx;
459
+ renderInfo.cutEy = cutEy;
460
+ renderInfo.lineHeight = lineHeight;
461
+ renderInfo.defLineHeight = defLineHeight;
462
+ renderInfo.lineWidths = lineWidths;
463
+ renderInfo.offsetY = offsetY;
464
+ renderInfo.paddingLeft = paddingLeft;
465
+ renderInfo.paddingRight = paddingRight;
466
+ renderInfo.letterSpacing = letterSpacing;
467
+ renderInfo.textIndent = textIndent;
468
+ renderInfo.metrics = metrics;
469
+
470
+ return renderInfo as RenderInfo;
471
+ }
472
+
473
+ draw(
474
+ renderInfo: RenderInfo,
475
+ linesOverride?: { lines: string[]; lineWidths: number[] },
476
+ ) {
477
+ const precision = this.getPrecision();
478
+
479
+ // Allow lines to be overriden for partial rendering.
480
+ const lines = linesOverride?.lines || renderInfo.lines;
481
+ const lineWidths = linesOverride?.lineWidths || renderInfo.lineWidths;
482
+ const height = linesOverride
483
+ ? calcHeight(
484
+ this._settings.textBaseline,
485
+ renderInfo.fontSize,
486
+ renderInfo.lineHeight,
487
+ linesOverride.lines.length,
488
+ this._settings.offsetY === null
489
+ ? null
490
+ : this._settings.offsetY * precision,
491
+ )
492
+ : renderInfo.height;
493
+
494
+ // Add extra margin to prevent issue with clipped text when scaling.
495
+ this._canvas.width = Math.min(
496
+ Math.ceil(renderInfo.width + this._settings.textRenderIssueMargin),
497
+ MAX_TEXTURE_DIMENSION,
498
+ );
499
+ this._canvas.height = Math.min(Math.ceil(height), MAX_TEXTURE_DIMENSION);
500
+
501
+ // Canvas context has been reset.
502
+ this.setFontProperties();
503
+
504
+ if (renderInfo.fontSize >= 128) {
505
+ // WpeWebKit bug: must force compositing because cairo-traps-compositor will not work with text first.
506
+ this._context.globalAlpha = 0.01;
507
+ this._context.fillRect(0, 0, 0.01, 0.01);
508
+ this._context.globalAlpha = 1.0;
509
+ }
510
+
511
+ if (renderInfo.cutSx || renderInfo.cutSy) {
512
+ this._context.translate(-renderInfo.cutSx, -renderInfo.cutSy);
513
+ }
514
+
515
+ let linePositionX;
516
+ let linePositionY;
517
+
518
+ const drawLines = [];
519
+
520
+ const { metrics } = renderInfo;
521
+
522
+ /**
523
+ * Ascender (in pixels)
524
+ */
525
+ const ascenderPx = metrics
526
+ ? metrics.ascender * renderInfo.fontSize
527
+ : renderInfo.fontSize;
528
+
529
+ /**
530
+ * Bare line height is the distance between the ascender and descender of the font.
531
+ * without the line gap metric.
532
+ */
533
+ const bareLineHeightPx =
534
+ (metrics.ascender - metrics.descender) * renderInfo.fontSize;
535
+
536
+ // Draw lines line by line.
537
+ for (let i = 0, n = lines.length; i < n; i++) {
538
+ linePositionX = i === 0 ? renderInfo.textIndent : 0;
539
+
540
+ // By default, text is aligned to top
541
+ linePositionY = i * renderInfo.lineHeight + ascenderPx;
542
+
543
+ if (this._settings.verticalAlign == 'middle') {
544
+ linePositionY += (renderInfo.lineHeight - bareLineHeightPx) / 2;
545
+ } else if (this._settings.verticalAlign == 'bottom') {
546
+ linePositionY += renderInfo.lineHeight - bareLineHeightPx;
547
+ }
548
+
549
+ if (this._settings.textAlign === 'right') {
550
+ linePositionX += renderInfo.innerWidth - lineWidths[i]!;
551
+ } else if (this._settings.textAlign === 'center') {
552
+ linePositionX += (renderInfo.innerWidth - lineWidths[i]!) / 2;
553
+ }
554
+ linePositionX += renderInfo.paddingLeft;
555
+
556
+ drawLines.push({
557
+ text: lines[i]!,
558
+ x: linePositionX,
559
+ y: linePositionY,
560
+ w: lineWidths[i]!,
561
+ });
562
+ }
563
+
564
+ // Highlight.
565
+ if (this._settings.highlight) {
566
+ const color = this._settings.highlightColor;
567
+
568
+ const hlHeight =
569
+ this._settings.highlightHeight * precision || renderInfo.fontSize * 1.5;
570
+ const offset = this._settings.highlightOffset * precision;
571
+ const hlPaddingLeft =
572
+ this._settings.highlightPaddingLeft !== null
573
+ ? this._settings.highlightPaddingLeft * precision
574
+ : renderInfo.paddingLeft;
575
+ const hlPaddingRight =
576
+ this._settings.highlightPaddingRight !== null
577
+ ? this._settings.highlightPaddingRight * precision
578
+ : renderInfo.paddingRight;
579
+
580
+ this._context.fillStyle = getRgbaString(color);
581
+ for (let i = 0; i < drawLines.length; i++) {
582
+ const drawLine = drawLines[i]!;
583
+ this._context.fillRect(
584
+ drawLine.x - hlPaddingLeft,
585
+ drawLine.y - renderInfo.offsetY + offset,
586
+ drawLine.w + hlPaddingRight + hlPaddingLeft,
587
+ hlHeight,
588
+ );
589
+ }
590
+ }
591
+
592
+ // Text shadow.
593
+ let prevShadowSettings: null | [string, number, number, number] = null;
594
+ if (this._settings.shadow) {
595
+ prevShadowSettings = [
596
+ this._context.shadowColor,
597
+ this._context.shadowOffsetX,
598
+ this._context.shadowOffsetY,
599
+ this._context.shadowBlur,
600
+ ];
601
+
602
+ this._context.shadowColor = getRgbaString(this._settings.shadowColor);
603
+ this._context.shadowOffsetX = this._settings.shadowOffsetX * precision;
604
+ this._context.shadowOffsetY = this._settings.shadowOffsetY * precision;
605
+ this._context.shadowBlur = this._settings.shadowBlur * precision;
606
+ }
607
+
608
+ this._context.fillStyle = getRgbaString(this._settings.textColor);
609
+ for (let i = 0, n = drawLines.length; i < n; i++) {
610
+ const drawLine = drawLines[i]!;
611
+
612
+ if (renderInfo.letterSpacing === 0) {
613
+ this._context.fillText(drawLine.text, drawLine.x, drawLine.y);
614
+ } else {
615
+ const textSplit = drawLine.text.split('');
616
+ let x = drawLine.x;
617
+ for (let i = 0, j = textSplit.length; i < j; i++) {
618
+ this._context.fillText(textSplit[i]!, x, drawLine.y);
619
+ x += this.measureText(textSplit[i]!, renderInfo.letterSpacing);
620
+ }
621
+ }
622
+ }
623
+
624
+ if (prevShadowSettings) {
625
+ this._context.shadowColor = prevShadowSettings[0];
626
+ this._context.shadowOffsetX = prevShadowSettings[1];
627
+ this._context.shadowOffsetY = prevShadowSettings[2];
628
+ this._context.shadowBlur = prevShadowSettings[3];
629
+ }
630
+
631
+ if (renderInfo.cutSx || renderInfo.cutSy) {
632
+ this._context.translate(renderInfo.cutSx, renderInfo.cutSy);
633
+ }
634
+ }
635
+
636
+ wrapWord(word: string, wordWrapWidth: number, suffix: string) {
637
+ const suffixWidth = this._context.measureText(suffix).width;
638
+ const wordLen = word.length;
639
+ const wordWidth = this._context.measureText(word).width;
640
+
641
+ /* If word fits wrapWidth, do nothing */
642
+ if (wordWidth <= wordWrapWidth) {
643
+ return word;
644
+ }
645
+
646
+ /* Make initial guess for text cuttoff */
647
+ let cutoffIndex = Math.floor((wordWrapWidth * wordLen) / wordWidth);
648
+ let truncWordWidth =
649
+ this._context.measureText(word.substring(0, cutoffIndex)).width +
650
+ suffixWidth;
651
+
652
+ /* In case guess was overestimated, shrink it letter by letter. */
653
+ if (truncWordWidth > wordWrapWidth) {
654
+ while (cutoffIndex > 0) {
655
+ truncWordWidth =
656
+ this._context.measureText(word.substring(0, cutoffIndex)).width +
657
+ suffixWidth;
658
+ if (truncWordWidth > wordWrapWidth) {
659
+ cutoffIndex -= 1;
660
+ } else {
661
+ break;
662
+ }
663
+ }
664
+
665
+ /* In case guess was underestimated, extend it letter by letter. */
666
+ } else {
667
+ while (cutoffIndex < wordLen) {
668
+ truncWordWidth =
669
+ this._context.measureText(word.substring(0, cutoffIndex)).width +
670
+ suffixWidth;
671
+ if (truncWordWidth < wordWrapWidth) {
672
+ cutoffIndex += 1;
673
+ } else {
674
+ // Finally, when bound is crossed, retract last letter.
675
+ cutoffIndex -= 1;
676
+ break;
677
+ }
678
+ }
679
+ }
680
+
681
+ /* If wrapWidth is too short to even contain suffix alone, return empty string */
682
+ return (
683
+ word.substring(0, cutoffIndex) +
684
+ (wordWrapWidth >= suffixWidth ? suffix : '')
685
+ );
686
+ }
687
+
688
+ /**
689
+ * Applies newlines to a string to have it optimally fit into the horizontal
690
+ * bounds set by the Text object's wordWrapWidth property.
691
+ */
692
+ wrapText(
693
+ text: string,
694
+ wordWrapWidth: number,
695
+ letterSpacing: number,
696
+ indent = 0,
697
+ ) {
698
+ const spaceRegex = / |\u200B/g; // ZWSP and spaces
699
+ const lines = text.split(/\r?\n/g);
700
+ let allLines: string[] = [];
701
+ const realNewlines: number[] = [];
702
+
703
+ for (let i = 0; i < lines.length; i++) {
704
+ const resultLines: string[] = [];
705
+ let result = '';
706
+ let spaceLeft = wordWrapWidth - indent;
707
+
708
+ // Split the line into words, considering ZWSP
709
+ const words = lines[i]!.split(spaceRegex);
710
+ const spaces = lines[i]!.match(spaceRegex) || [];
711
+
712
+ for (let j = 0; j < words.length; j++) {
713
+ const space = spaces[j - 1] || '';
714
+ const word = words[j]!;
715
+ const wordWidth = this.measureText(word, letterSpacing);
716
+ const wordWidthWithSpace = isZeroWidthSpace(space)
717
+ ? wordWidth
718
+ : wordWidth + this.measureText(space, letterSpacing);
719
+
720
+ if (j === 0 || wordWidthWithSpace > spaceLeft) {
721
+ if (j > 0) {
722
+ resultLines.push(result);
723
+ result = '';
724
+ }
725
+ result += word;
726
+ spaceLeft = wordWrapWidth - wordWidth - (j === 0 ? indent : 0);
727
+ } else {
728
+ spaceLeft -= wordWidthWithSpace;
729
+ result += space + word;
730
+ }
731
+ }
732
+
733
+ resultLines.push(result);
734
+ result = '';
735
+ allLines = allLines.concat(resultLines);
736
+
737
+ if (i < lines.length - 1) {
738
+ realNewlines.push(allLines.length);
739
+ }
740
+ }
741
+
742
+ return { l: allLines, n: realNewlines };
743
+ }
744
+
745
+ measureText(word: string, space = 0) {
746
+ if (!space) {
747
+ return this._context.measureText(word).width;
748
+ }
749
+
750
+ // Split word into characters, but skip ZWSP in the width calculation
751
+ return word.split('').reduce((acc, char) => {
752
+ // Check if the character is a zero-width space and skip it
753
+ if (isZeroWidthSpace(char)) {
754
+ return acc;
755
+ }
756
+ return acc + this._context.measureText(char).width + space;
757
+ }, 0);
758
+ }
759
+
760
+ mergeDefaults(settings: Partial<Settings>): Settings {
761
+ return {
762
+ text: '',
763
+ w: 0,
764
+ h: 0,
765
+ fontStyle: 'normal',
766
+ fontSize: 40,
767
+ fontFamily: null,
768
+ trFontFace: null,
769
+ wordWrap: true,
770
+ wordWrapWidth: 0,
771
+ wordBreak: false,
772
+ textOverflow: '',
773
+ lineHeight: null,
774
+ textBaseline: 'alphabetic',
775
+ textAlign: 'left',
776
+ verticalAlign: 'top',
777
+ offsetY: null,
778
+ maxLines: 0,
779
+ maxHeight: null,
780
+ overflowSuffix: '...',
781
+ textColor: [1.0, 1.0, 1.0, 1.0],
782
+ paddingLeft: 0,
783
+ paddingRight: 0,
784
+ shadow: false,
785
+ shadowColor: [0.0, 0.0, 0.0, 1.0],
786
+ shadowOffsetX: 0,
787
+ shadowOffsetY: 0,
788
+ shadowBlur: 5,
789
+ highlight: false,
790
+ highlightHeight: 0,
791
+ highlightColor: [0.0, 0.0, 0.0, 1.0],
792
+ highlightOffset: 0,
793
+ highlightPaddingLeft: 0,
794
+ highlightPaddingRight: 0,
795
+ letterSpacing: 0,
796
+ textIndent: 0,
797
+ cutSx: 0,
798
+ cutEx: 0,
799
+ cutSy: 0,
800
+ cutEy: 0,
801
+ advancedRenderer: false,
802
+ fontBaselineRatio: 0,
803
+ precision: 1,
804
+ textRenderIssueMargin: 0,
805
+ ...settings,
806
+ };
807
+ }
808
+ }