@lightningjs/renderer 2.13.1 → 2.13.2

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 (344) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/exports/canvas-shaders.d.ts +10 -0
  6. package/dist/exports/canvas-shaders.js +27 -0
  7. package/dist/exports/canvas-shaders.js.map +1 -0
  8. package/dist/exports/webgl-shaders.d.ts +11 -0
  9. package/dist/exports/webgl-shaders.js +28 -0
  10. package/dist/exports/webgl-shaders.js.map +1 -0
  11. package/dist/src/core/renderers/CoreShaderNode.d.ts +59 -0
  12. package/dist/src/core/renderers/CoreShaderNode.js +107 -0
  13. package/dist/src/core/renderers/CoreShaderNode.js.map +1 -0
  14. package/dist/src/core/renderers/CoreShaderProgram.d.ts +4 -0
  15. package/dist/src/{main-api/ICoreDriver.js → core/renderers/CoreShaderProgram.js} +1 -1
  16. package/dist/src/core/renderers/CoreShaderProgram.js.map +1 -0
  17. package/dist/src/core/renderers/canvas/CanvasRenderer.d.ts +36 -0
  18. package/dist/src/core/renderers/canvas/CanvasRenderer.js +212 -0
  19. package/dist/src/core/renderers/canvas/CanvasRenderer.js.map +1 -0
  20. package/dist/src/core/renderers/canvas/CanvasShaderNode.d.ts +21 -0
  21. package/dist/src/core/renderers/canvas/CanvasShaderNode.js +60 -0
  22. package/dist/src/core/renderers/canvas/CanvasShaderNode.js.map +1 -0
  23. package/dist/src/core/renderers/canvas/CanvasTexture.d.ts +16 -0
  24. package/dist/src/core/renderers/canvas/CanvasTexture.js +123 -0
  25. package/dist/src/core/renderers/canvas/CanvasTexture.js.map +1 -0
  26. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.d.ts +12 -0
  27. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js +55 -0
  28. package/dist/src/core/renderers/webgl/WebGlCtxRenderTexture.js.map +1 -0
  29. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.d.ts +9 -0
  30. package/dist/src/{main-api/texture-usage-trackers/TextureUsageTracker.js → core/renderers/webgl/WebGlCtxSubTexture.js} +18 -8
  31. package/dist/src/core/renderers/webgl/WebGlCtxSubTexture.js.map +1 -0
  32. package/dist/src/core/renderers/webgl/WebGlCtxTexture.d.ts +57 -0
  33. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js +227 -0
  34. package/dist/src/core/renderers/webgl/WebGlCtxTexture.js.map +1 -0
  35. package/dist/src/core/renderers/webgl/WebGlRenderOp.d.ts +36 -0
  36. package/dist/src/core/renderers/webgl/WebGlRenderOp.js +107 -0
  37. package/dist/src/core/renderers/webgl/WebGlRenderOp.js.map +1 -0
  38. package/dist/src/core/renderers/webgl/WebGlRenderer.d.ts +134 -0
  39. package/dist/src/core/renderers/webgl/WebGlRenderer.js +546 -0
  40. package/dist/src/core/renderers/webgl/WebGlRenderer.js.map +1 -0
  41. package/dist/src/core/renderers/webgl/WebGlShaderNode.d.ts +221 -0
  42. package/dist/src/core/renderers/webgl/WebGlShaderNode.js +334 -0
  43. package/dist/src/core/renderers/webgl/WebGlShaderNode.js.map +1 -0
  44. package/dist/src/core/renderers/webgl/WebGlShaderProgram.d.ts +35 -0
  45. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js +195 -0
  46. package/dist/src/core/renderers/webgl/WebGlShaderProgram.js.map +1 -0
  47. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  48. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  49. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  50. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  51. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  52. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  53. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  54. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  55. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  56. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  57. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  58. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  59. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  60. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  61. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  62. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  63. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  64. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  65. package/dist/src/core/shaders/canvas/Border.d.ts +9 -0
  66. package/dist/src/core/shaders/canvas/Border.js +57 -0
  67. package/dist/src/core/shaders/canvas/Border.js.map +1 -0
  68. package/dist/src/core/shaders/canvas/HolePunch.d.ts +7 -0
  69. package/dist/src/core/shaders/canvas/HolePunch.js +38 -0
  70. package/dist/src/core/shaders/canvas/HolePunch.js.map +1 -0
  71. package/dist/src/core/shaders/canvas/LinearGradient.d.ts +10 -0
  72. package/dist/src/core/shaders/canvas/LinearGradient.js +46 -0
  73. package/dist/src/core/shaders/canvas/LinearGradient.js.map +1 -0
  74. package/dist/src/core/shaders/canvas/RadialGradient.d.ts +11 -0
  75. package/dist/src/core/shaders/canvas/RadialGradient.js +68 -0
  76. package/dist/src/core/shaders/canvas/RadialGradient.js.map +1 -0
  77. package/dist/src/core/shaders/canvas/Rounded.d.ts +7 -0
  78. package/dist/src/core/shaders/canvas/Rounded.js +33 -0
  79. package/dist/src/core/shaders/canvas/Rounded.js.map +1 -0
  80. package/dist/src/core/shaders/canvas/RoundedWithBorder.d.ts +7 -0
  81. package/dist/src/core/shaders/canvas/RoundedWithBorder.js +35 -0
  82. package/dist/src/core/shaders/canvas/RoundedWithBorder.js.map +1 -0
  83. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.d.ts +8 -0
  84. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js +39 -0
  85. package/dist/src/core/shaders/canvas/RoundedWithBorderAndShadow.js.map +1 -0
  86. package/dist/src/core/shaders/canvas/RoundedWithShadow.d.ts +7 -0
  87. package/dist/src/core/shaders/canvas/RoundedWithShadow.js +38 -0
  88. package/dist/src/core/shaders/canvas/RoundedWithShadow.js.map +1 -0
  89. package/dist/src/core/shaders/canvas/Shadow.d.ts +8 -0
  90. package/dist/src/core/shaders/canvas/Shadow.js +31 -0
  91. package/dist/src/core/shaders/canvas/Shadow.js.map +1 -0
  92. package/dist/src/core/shaders/canvas/utils/render.d.ts +5 -0
  93. package/dist/src/core/shaders/canvas/utils/render.js +84 -0
  94. package/dist/src/core/shaders/canvas/utils/render.js.map +1 -0
  95. package/dist/src/core/shaders/templates/BorderTemplate.d.ts +37 -0
  96. package/dist/src/core/shaders/templates/BorderTemplate.js +73 -0
  97. package/dist/src/core/shaders/templates/BorderTemplate.js.map +1 -0
  98. package/dist/src/core/shaders/templates/HolePunchTemplate.d.ts +46 -0
  99. package/dist/src/core/shaders/templates/HolePunchTemplate.js +35 -0
  100. package/dist/src/core/shaders/templates/HolePunchTemplate.js.map +1 -0
  101. package/dist/src/core/shaders/templates/LinearGradientTemplate.d.ts +23 -0
  102. package/dist/src/core/shaders/templates/LinearGradientTemplate.js +47 -0
  103. package/dist/src/core/shaders/templates/LinearGradientTemplate.js.map +1 -0
  104. package/dist/src/core/shaders/templates/RadialGradientTemplate.d.ts +31 -0
  105. package/dist/src/core/shaders/templates/RadialGradientTemplate.js +49 -0
  106. package/dist/src/core/shaders/templates/RadialGradientTemplate.js.map +1 -0
  107. package/dist/src/core/shaders/templates/RoundedTemplate.d.ts +29 -0
  108. package/dist/src/core/shaders/templates/RoundedTemplate.js +67 -0
  109. package/dist/src/core/shaders/templates/RoundedTemplate.js.map +1 -0
  110. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.d.ts +7 -0
  111. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js +24 -0
  112. package/dist/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.js.map +1 -0
  113. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.d.ts +6 -0
  114. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js +23 -0
  115. package/dist/src/core/shaders/templates/RoundedWithBorderTemplate.js.map +1 -0
  116. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.d.ts +6 -0
  117. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js +23 -0
  118. package/dist/src/core/shaders/templates/RoundedWithShadowTemplate.js.map +1 -0
  119. package/dist/src/core/shaders/templates/ShadowTemplate.d.ts +34 -0
  120. package/dist/src/core/shaders/templates/ShadowTemplate.js +66 -0
  121. package/dist/src/core/shaders/templates/ShadowTemplate.js.map +1 -0
  122. package/dist/src/core/shaders/templates/shaderUtils.d.ts +5 -0
  123. package/dist/src/core/shaders/templates/shaderUtils.js +41 -0
  124. package/dist/src/core/shaders/templates/shaderUtils.js.map +1 -0
  125. package/dist/src/core/shaders/webgl/Border.d.ts +3 -0
  126. package/dist/src/core/shaders/webgl/Border.js +87 -0
  127. package/dist/src/core/shaders/webgl/Border.js.map +1 -0
  128. package/dist/src/core/shaders/webgl/Default.d.ts +2 -0
  129. package/dist/src/core/shaders/webgl/Default.js +86 -0
  130. package/dist/src/core/shaders/webgl/Default.js.map +1 -0
  131. package/dist/src/core/shaders/webgl/DefaultBatched.d.ts +2 -0
  132. package/dist/src/core/shaders/webgl/DefaultBatched.js +104 -0
  133. package/dist/src/core/shaders/webgl/DefaultBatched.js.map +1 -0
  134. package/dist/src/core/shaders/webgl/HolePunch.d.ts +3 -0
  135. package/dist/src/core/shaders/webgl/HolePunch.js +64 -0
  136. package/dist/src/core/shaders/webgl/HolePunch.js.map +1 -0
  137. package/dist/src/core/shaders/webgl/LinearGradient.d.ts +3 -0
  138. package/dist/src/core/shaders/webgl/LinearGradient.js +75 -0
  139. package/dist/src/core/shaders/webgl/LinearGradient.js.map +1 -0
  140. package/dist/src/core/shaders/webgl/RadialGradient.d.ts +3 -0
  141. package/dist/src/core/shaders/webgl/RadialGradient.js +73 -0
  142. package/dist/src/core/shaders/webgl/RadialGradient.js.map +1 -0
  143. package/dist/src/core/shaders/webgl/Rounded.d.ts +7 -0
  144. package/dist/src/core/shaders/webgl/Rounded.js +86 -0
  145. package/dist/src/core/shaders/webgl/Rounded.js.map +1 -0
  146. package/dist/src/core/shaders/webgl/RoundedWithBorder.d.ts +3 -0
  147. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +97 -0
  148. package/dist/src/core/shaders/webgl/RoundedWithBorder.js.map +1 -0
  149. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.d.ts +3 -0
  150. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +112 -0
  151. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js.map +1 -0
  152. package/dist/src/core/shaders/webgl/RoundedWithShadow.d.ts +3 -0
  153. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +84 -0
  154. package/dist/src/core/shaders/webgl/RoundedWithShadow.js.map +1 -0
  155. package/dist/src/core/shaders/webgl/SdfShader.d.ts +32 -0
  156. package/dist/src/core/shaders/webgl/SdfShader.js +116 -0
  157. package/dist/src/core/shaders/webgl/SdfShader.js.map +1 -0
  158. package/dist/src/core/shaders/webgl/Shadow.d.ts +3 -0
  159. package/dist/src/core/shaders/webgl/Shadow.js +110 -0
  160. package/dist/src/core/shaders/webgl/Shadow.js.map +1 -0
  161. package/dist/src/core/textures/Texture.d.ts +4 -2
  162. package/dist/src/core/textures/Texture.js +18 -6
  163. package/dist/src/core/textures/Texture.js.map +1 -1
  164. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  165. package/exports/canvas.ts +39 -39
  166. package/exports/index.ts +89 -89
  167. package/exports/inspector.ts +24 -24
  168. package/exports/utils.ts +44 -44
  169. package/exports/webgl.ts +38 -38
  170. package/package.json +1 -2
  171. package/scripts/please-use-pnpm.js +13 -13
  172. package/src/common/CommonTypes.ts +146 -146
  173. package/src/common/EventEmitter.ts +77 -77
  174. package/src/common/IAnimationController.ts +92 -92
  175. package/src/common/IEventEmitter.ts +28 -28
  176. package/src/core/CoreNode.test.ts +202 -202
  177. package/src/core/CoreNode.ts +2455 -2455
  178. package/src/core/CoreShaderManager.ts +292 -292
  179. package/src/core/CoreTextNode.ts +455 -455
  180. package/src/core/CoreTextureManager.ts +597 -597
  181. package/src/core/Stage.ts +743 -743
  182. package/src/core/TextureMemoryManager.ts +395 -395
  183. package/src/core/animations/AnimationManager.ts +38 -38
  184. package/src/core/animations/CoreAnimation.ts +340 -340
  185. package/src/core/animations/CoreAnimationController.ts +157 -157
  186. package/src/core/lib/ContextSpy.ts +41 -41
  187. package/src/core/lib/ImageWorker.ts +280 -280
  188. package/src/core/lib/Matrix3d.ts +244 -244
  189. package/src/core/lib/RenderCoords.ts +86 -86
  190. package/src/core/lib/WebGlContextWrapper.ts +1332 -1332
  191. package/src/core/lib/textureCompression.ts +152 -152
  192. package/src/core/lib/textureSvg.ts +78 -78
  193. package/src/core/lib/utils.ts +384 -384
  194. package/src/core/lib/validateImageBitmap.ts +76 -76
  195. package/src/core/platform.ts +63 -63
  196. package/src/core/renderers/CoreContextTexture.ts +43 -43
  197. package/src/core/renderers/CoreRenderOp.ts +22 -22
  198. package/src/core/renderers/CoreRenderer.ts +115 -115
  199. package/src/core/renderers/CoreShader.ts +41 -41
  200. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +375 -375
  201. package/src/core/renderers/canvas/CanvasCoreTexture.ts +153 -153
  202. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  203. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  204. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  205. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +86 -86
  206. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  207. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +301 -301
  208. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  209. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +815 -815
  210. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  211. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  212. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  213. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  214. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  215. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  216. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  217. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  218. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  219. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  220. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  221. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  222. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  223. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  224. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  225. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  226. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  227. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  228. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  229. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  230. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  231. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  232. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  233. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  234. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  235. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  236. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  237. package/src/core/text-rendering/TrFontManager.ts +183 -183
  238. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  239. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  240. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  241. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  242. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  243. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  244. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  245. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  246. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +808 -808
  247. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  248. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  249. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  250. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  251. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  252. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  253. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  254. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  255. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +408 -408
  256. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  257. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  258. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  259. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  260. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  261. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  262. package/src/core/textures/ColorTexture.ts +102 -102
  263. package/src/core/textures/ImageTexture.ts +399 -399
  264. package/src/core/textures/NoiseTexture.ts +104 -104
  265. package/src/core/textures/RenderTexture.ts +85 -85
  266. package/src/core/textures/SubTexture.ts +205 -205
  267. package/src/core/textures/Texture.ts +353 -337
  268. package/src/core/utils.ts +227 -227
  269. package/src/env.d.ts +7 -7
  270. package/src/main-api/DynamicShaderController.ts +104 -104
  271. package/src/main-api/INode.ts +101 -101
  272. package/src/main-api/Inspector.ts +522 -522
  273. package/src/main-api/Renderer.ts +751 -751
  274. package/src/main-api/ShaderController.ts +80 -80
  275. package/src/main-api/utils.ts +45 -45
  276. package/src/utils.ts +248 -248
  277. package/dist/exports/core-api.d.ts +0 -74
  278. package/dist/exports/core-api.js +0 -96
  279. package/dist/exports/core-api.js.map +0 -1
  280. package/dist/exports/main-api.d.ts +0 -30
  281. package/dist/exports/main-api.js +0 -45
  282. package/dist/exports/main-api.js.map +0 -1
  283. package/dist/src/core/CoreExtension.d.ts +0 -12
  284. package/dist/src/core/CoreExtension.js +0 -29
  285. package/dist/src/core/CoreExtension.js.map +0 -1
  286. package/dist/src/main-api/ICoreDriver.d.ts +0 -24
  287. package/dist/src/main-api/ICoreDriver.js.map +0 -1
  288. package/dist/src/main-api/RendererMain.d.ts +0 -378
  289. package/dist/src/main-api/RendererMain.js +0 -367
  290. package/dist/src/main-api/RendererMain.js.map +0 -1
  291. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
  292. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
  293. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
  294. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
  295. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
  296. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
  297. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
  298. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
  299. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -21
  300. package/dist/src/render-drivers/main/MainCoreDriver.js +0 -115
  301. package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
  302. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -101
  303. package/dist/src/render-drivers/main/MainOnlyNode.js +0 -425
  304. package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
  305. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
  306. package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -204
  307. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
  308. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -93
  309. package/dist/src/render-drivers/threadx/NodeStruct.js +0 -290
  310. package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
  311. package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -40
  312. package/dist/src/render-drivers/threadx/SharedNode.js +0 -61
  313. package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
  314. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
  315. package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -203
  316. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
  317. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -25
  318. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -232
  319. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
  320. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -24
  321. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -113
  322. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
  323. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -46
  324. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -160
  325. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
  326. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
  327. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
  328. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
  329. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
  330. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
  331. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
  332. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
  333. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -184
  334. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
  335. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
  336. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -109
  337. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
  338. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +0 -1
  339. package/dist/src/render-drivers/threadx/worker/renderer.js +0 -147
  340. package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
  341. package/dist/src/render-drivers/utils.d.ts +0 -12
  342. package/dist/src/render-drivers/utils.js +0 -74
  343. package/dist/src/render-drivers/utils.js.map +0 -1
  344. package/dist/tsconfig.tsbuildinfo +0 -1
@@ -1,853 +1,853 @@
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 {
21
- type Bound,
22
- type Rect,
23
- createBound,
24
- type BoundWithValid,
25
- intersectRect,
26
- type RectWithValid,
27
- copyRect,
28
- boundsOverlap,
29
- convertBoundToRect,
30
- } from '../../../lib/utils.js';
31
- import {
32
- TextRenderer,
33
- type TrProps,
34
- type TextRendererState,
35
- type TrFontProps,
36
- type TrPropSetters,
37
- } from '../TextRenderer.js';
38
- import { SdfTrFontFace } from '../../font-face-types/SdfTrFontFace/SdfTrFontFace.js';
39
- import { FLOATS_PER_GLYPH } from './internal/constants.js';
40
- import { getStartConditions } from './internal/getStartConditions.js';
41
- import { layoutText } from './internal/layoutText.js';
42
- import {
43
- setRenderWindow,
44
- type SdfRenderWindow,
45
- } from './internal/setRenderWindow.js';
46
- import type { TrFontFace } from '../../font-face-types/TrFontFace.js';
47
- import { TrFontManager, type FontFamilyMap } from '../../TrFontManager.js';
48
- import { assertTruthy, mergeColorAlpha } from '../../../../utils.js';
49
- import type { Stage } from '../../../Stage.js';
50
- import { WebGlCoreRenderOp } from '../../../renderers/webgl/WebGlCoreRenderOp.js';
51
- import { BufferCollection } from '../../../renderers/webgl/internal/BufferCollection.js';
52
- import type {
53
- SdfShader,
54
- SdfShaderProps,
55
- } from '../../../renderers/webgl/shaders/SdfShader.js';
56
- import type { WebGlCoreCtxTexture } from '../../../renderers/webgl/WebGlCoreCtxTexture.js';
57
- import { EventEmitter } from '../../../../common/EventEmitter.js';
58
- import type { Matrix3d } from '../../../lib/Matrix3d.js';
59
- import type { Dimensions } from '../../../../common/CommonTypes.js';
60
- import { WebGlCoreRenderer } from '../../../renderers/webgl/WebGlCoreRenderer.js';
61
- import { calcDefaultLineHeight } from '../../TextRenderingUtils.js';
62
-
63
- declare module '../TextRenderer.js' {
64
- interface TextRendererMap {
65
- sdf: SdfTextRenderer;
66
- }
67
-
68
- // Add prefixed SDF-specific props to TextRendererDebugProps
69
- interface TextRendererDebugProps {
70
- sdfShaderDebug: boolean;
71
- }
72
- }
73
-
74
- export interface LineCacheItem {
75
- codepointIndex: number;
76
- maxY: number;
77
- maxX: number;
78
- }
79
-
80
- export interface SdfTextRendererState extends TextRendererState {
81
- /**
82
- * Cache for layout resume points indexed by the `curY` for each line
83
- * in the render sequence.
84
- *
85
- * Allows faster rendering by skipping parts of the layout loop that are
86
- * outside of the renderWindow.
87
- */
88
- lineCache: LineCacheItem[];
89
-
90
- renderWindow: SdfRenderWindow;
91
-
92
- elementBounds: BoundWithValid;
93
-
94
- clippingRect: RectWithValid;
95
-
96
- bufferNumFloats: number;
97
-
98
- bufferNumQuads: number;
99
-
100
- vertexBuffer: Float32Array | undefined;
101
-
102
- webGlBuffers: BufferCollection | null;
103
-
104
- bufferUploaded: boolean;
105
-
106
- distanceRange: number;
107
-
108
- trFontFace: SdfTrFontFace | undefined;
109
-
110
- /**
111
- * Resolved line height in logical screen pixel units
112
- */
113
- resLineHeight: number | undefined;
114
- }
115
-
116
- /**
117
- * Ephemeral rect object used for calculations
118
- */
119
- const tmpRect: Rect = {
120
- x: 0,
121
- y: 0,
122
- width: 0,
123
- height: 0,
124
- };
125
-
126
- /**
127
- * Singleton class for rendering text using signed distance fields.
128
- *
129
- * @remarks
130
- * SdfTextRenderer supports both single-channel and multi-channel signed distance fields.
131
- */
132
- export class SdfTextRenderer extends TextRenderer<SdfTextRendererState> {
133
- /**
134
- * Map of font family names to a set of font faces.
135
- */
136
- private ssdfFontFamilies: FontFamilyMap = {};
137
- private msdfFontFamilies: FontFamilyMap = {};
138
- private fontFamilyArray: FontFamilyMap[] = [
139
- this.ssdfFontFamilies,
140
- this.msdfFontFamilies,
141
- ];
142
- private sdfShader: SdfShader;
143
- private rendererBounds: Bound;
144
-
145
- public type: 'canvas' | 'sdf' = 'sdf';
146
-
147
- constructor(stage: Stage) {
148
- super(stage);
149
- this.sdfShader = this.stage.shManager.loadShader('SdfShader', {
150
- transform: new Float32Array(),
151
- color: 0,
152
- size: 0,
153
- scrollY: 0,
154
- distanceRange: 0,
155
- debug: false,
156
- }).shader;
157
- this.rendererBounds = {
158
- x1: 0,
159
- y1: 0,
160
- x2: this.stage.options.appWidth,
161
- y2: this.stage.options.appHeight,
162
- };
163
- }
164
-
165
- //#region Overrides
166
- getPropertySetters(): Partial<TrPropSetters<SdfTextRendererState>> {
167
- return {
168
- fontFamily: (state, value) => {
169
- state.props.fontFamily = value;
170
- this.releaseFontFace(state);
171
- this.invalidateLayoutCache(state);
172
- },
173
- fontWeight: (state, value) => {
174
- state.props.fontWeight = value;
175
- this.releaseFontFace(state);
176
- this.invalidateLayoutCache(state);
177
- },
178
- fontStyle: (state, value) => {
179
- state.props.fontStyle = value;
180
- this.releaseFontFace(state);
181
- this.invalidateLayoutCache(state);
182
- },
183
- fontStretch: (state, value) => {
184
- state.props.fontStretch = value;
185
- this.releaseFontFace(state);
186
- this.invalidateLayoutCache(state);
187
- },
188
- fontSize: (state, value) => {
189
- state.props.fontSize = value;
190
- this.invalidateLayoutCache(state);
191
- },
192
- text: (state, value) => {
193
- state.props.text = value;
194
- this.invalidateLayoutCache(state);
195
- },
196
- textAlign: (state, value) => {
197
- state.props.textAlign = value;
198
- this.invalidateLayoutCache(state);
199
- },
200
- color: (state, value) => {
201
- state.props.color = value;
202
- },
203
- x: (state, value) => {
204
- state.props.x = value;
205
- if (state.elementBounds.valid) {
206
- this.setElementBoundsX(state);
207
- // Only schedule an update if the text is not already rendered
208
- // (renderWindow is invalid) and the element possibly overlaps the screen
209
- // This is to avoid unnecessary updates when we know text is off-screen
210
- if (
211
- !state.renderWindow.valid &&
212
- boundsOverlap(state.elementBounds, this.rendererBounds)
213
- ) {
214
- this.scheduleUpdateState(state);
215
- }
216
- }
217
- },
218
- y: (state, value) => {
219
- state.props.y = value;
220
- if (state.elementBounds.valid) {
221
- this.setElementBoundsY(state);
222
- // See x() for explanation
223
- if (
224
- !state.renderWindow.valid &&
225
- boundsOverlap(state.elementBounds, this.rendererBounds)
226
- ) {
227
- this.scheduleUpdateState(state);
228
- }
229
- }
230
- },
231
- contain: (state, value) => {
232
- state.props.contain = value;
233
- this.invalidateLayoutCache(state);
234
- },
235
- width: (state, value) => {
236
- state.props.width = value;
237
- // Only invalidate layout cache if we're containing in the horizontal direction
238
- if (state.props.contain !== 'none') {
239
- this.invalidateLayoutCache(state);
240
- }
241
- },
242
- height: (state, value) => {
243
- state.props.height = value;
244
- // Only invalidate layout cache if we're containing in the vertical direction
245
- if (state.props.contain === 'both') {
246
- this.invalidateLayoutCache(state);
247
- }
248
- },
249
- offsetY: (state, value) => {
250
- state.props.offsetY = value;
251
- this.invalidateLayoutCache(state);
252
- },
253
- scrollable: (state, value) => {
254
- state.props.scrollable = value;
255
- this.invalidateLayoutCache(state);
256
- },
257
- scrollY: (state, value) => {
258
- state.props.scrollY = value;
259
- // Scrolling doesn't need to invalidate any caches, but it does need to
260
- // schedule an update
261
- this.scheduleUpdateState(state);
262
- },
263
- letterSpacing: (state, value) => {
264
- state.props.letterSpacing = value;
265
- this.invalidateLayoutCache(state);
266
- },
267
- lineHeight: (state, value) => {
268
- state.props.lineHeight = value;
269
- state.resLineHeight = undefined;
270
- this.invalidateLayoutCache(state);
271
- },
272
- maxLines: (state, value) => {
273
- state.props.maxLines = value;
274
- this.invalidateLayoutCache(state);
275
- },
276
- textBaseline: (state, value) => {
277
- state.props.textBaseline = value;
278
- this.invalidateLayoutCache(state);
279
- },
280
- verticalAlign: (state, value) => {
281
- state.props.verticalAlign = value;
282
- this.invalidateLayoutCache(state);
283
- },
284
- overflowSuffix: (state, value) => {
285
- state.props.overflowSuffix = value;
286
- this.invalidateLayoutCache(state);
287
- },
288
- debug: (state, value) => {
289
- state.props.debug = value;
290
- },
291
- };
292
- }
293
-
294
- override canRenderFont(props: TrFontProps): boolean {
295
- // TODO: Support matching on font stretch, weight and style (if/when needed)
296
- // For now we just match on the font family name
297
- // '$$SDF_FAILURE_TEST$$' is used to test the 'failure' event coming from text
298
- const { fontFamily } = props;
299
- return (
300
- fontFamily in this.ssdfFontFamilies ||
301
- fontFamily in this.msdfFontFamilies ||
302
- fontFamily === '$$SDF_FAILURE_TEST$$'
303
- );
304
- }
305
-
306
- override isFontFaceSupported(fontFace: TrFontFace): boolean {
307
- return fontFace instanceof SdfTrFontFace;
308
- }
309
-
310
- override addFontFace(fontFace: TrFontFace): void {
311
- // Make sure the font face is an SDF font face (it should have already passed
312
- // the `isFontFaceSupported` check)
313
- assertTruthy(fontFace instanceof SdfTrFontFace);
314
- const familyName = fontFace.fontFamily;
315
- const fontFamiles =
316
- fontFace.type === 'ssdf'
317
- ? this.ssdfFontFamilies
318
- : fontFace.type === 'msdf'
319
- ? this.msdfFontFamilies
320
- : undefined;
321
- if (!fontFamiles) {
322
- console.warn(`Invalid font face type: ${fontFace.type as string}`);
323
- return;
324
- }
325
- let faceSet = fontFamiles[familyName];
326
- if (!faceSet) {
327
- faceSet = new Set();
328
- fontFamiles[familyName] = faceSet;
329
- }
330
- faceSet.add(fontFace);
331
- }
332
-
333
- override createState(props: TrProps): SdfTextRendererState {
334
- return {
335
- props,
336
- status: 'initialState',
337
- updateScheduled: false,
338
- emitter: new EventEmitter(),
339
- lineCache: [],
340
- forceFullLayoutCalc: false,
341
- renderWindow: {
342
- screen: {
343
- x1: 0,
344
- y1: 0,
345
- x2: 0,
346
- y2: 0,
347
- },
348
- sdf: {
349
- x1: 0,
350
- y1: 0,
351
- x2: 0,
352
- y2: 0,
353
- },
354
- firstLineIdx: 0,
355
- numLines: 0,
356
- valid: false,
357
- },
358
- elementBounds: {
359
- x1: 0,
360
- y1: 0,
361
- x2: 0,
362
- y2: 0,
363
- valid: false,
364
- },
365
- clippingRect: {
366
- x: 0,
367
- y: 0,
368
- width: 0,
369
- height: 0,
370
- valid: false,
371
- },
372
- bufferNumFloats: 0,
373
- bufferNumQuads: 0,
374
- vertexBuffer: undefined,
375
- webGlBuffers: null,
376
- bufferUploaded: false,
377
- textH: undefined,
378
- textW: undefined,
379
- distanceRange: 0,
380
- trFontFace: undefined,
381
- isRenderable: false,
382
- resLineHeight: undefined,
383
- debugData: {
384
- updateCount: 0,
385
- layoutCount: 0,
386
- lastLayoutNumCharacters: 0,
387
- layoutSum: 0,
388
- drawSum: 0,
389
- drawCount: 0,
390
- bufferSize: 0,
391
- },
392
- };
393
- }
394
-
395
- override updateState(state: SdfTextRendererState): void {
396
- let { trFontFace } = state;
397
- const { textH, lineCache, debugData, forceFullLayoutCalc } = state;
398
- debugData.updateCount++;
399
-
400
- // On the first update call we need to set the status to loading
401
- if (state.status === 'initialState') {
402
- this.setStatus(state, 'loading');
403
- }
404
-
405
- // Resolve font face if we haven't yet
406
- if (trFontFace === undefined) {
407
- trFontFace = this.resolveFontFace(state.props);
408
- state.trFontFace = trFontFace;
409
- if (trFontFace === undefined) {
410
- const msg = `SdfTextRenderer: Could not resolve font face for family: '${state.props.fontFamily}'`;
411
- console.error(msg);
412
- this.setStatus(state, 'failed', new Error(msg));
413
- return;
414
- }
415
- trFontFace.texture.setRenderableOwner(state, true);
416
- }
417
-
418
- // If the font hasn't been loaded yet, stop here.
419
- // Listen for the 'loaded' event and forward fontLoaded event
420
- if (trFontFace.loaded === false) {
421
- trFontFace.once('loaded', () => {
422
- this.scheduleUpdateState(state);
423
- });
424
- return;
425
- }
426
-
427
- // If the font is loaded then so should the data
428
- assertTruthy(trFontFace.data, 'Font face data should be loaded');
429
- assertTruthy(trFontFace.metrics, 'Font face metrics should be loaded');
430
-
431
- const {
432
- text,
433
- fontSize,
434
- x,
435
- y,
436
- contain,
437
- width,
438
- height,
439
- verticalAlign,
440
- scrollable,
441
- overflowSuffix,
442
- maxLines,
443
- } = state.props;
444
-
445
- // scrollY only has an effect when contain === 'both' and scrollable === true
446
- const scrollY = contain === 'both' && scrollable ? state.props.scrollY : 0;
447
-
448
- const { renderWindow } = state;
449
-
450
- /**
451
- * The font size of the SDF font face (the basis for SDF space units)
452
- */
453
- const sdfFontSize = trFontFace.data.info.size;
454
-
455
- /**
456
- * Divide screen space units by this to get the SDF space units
457
- * Mulitple SDF space units by this to get screen space units
458
- */
459
- const fontSizeRatio = fontSize / sdfFontSize;
460
-
461
- // If not already resolved, resolve the line height and store it in the state
462
- let resLineHeight = state.resLineHeight;
463
- if (resLineHeight === undefined) {
464
- const lineHeight = state.props.lineHeight;
465
- // If lineHeight is undefined, use the maxCharHeight from the font face
466
- if (lineHeight === undefined) {
467
- resLineHeight = calcDefaultLineHeight(trFontFace.metrics, fontSize);
468
- } else {
469
- resLineHeight = lineHeight;
470
- }
471
- state.resLineHeight = resLineHeight;
472
- }
473
-
474
- // Needed in renderWindow calculation
475
- const sdfLineHeight = resLineHeight / fontSizeRatio;
476
-
477
- state.distanceRange =
478
- fontSizeRatio * trFontFace.data.distanceField.distanceRange;
479
-
480
- // Allocate buffers if needed
481
- const neededLength = text.length * FLOATS_PER_GLYPH;
482
- let vertexBuffer = state.vertexBuffer;
483
- if (!vertexBuffer || vertexBuffer.length < neededLength) {
484
- vertexBuffer = new Float32Array(neededLength * 2);
485
- }
486
-
487
- const elementBounds = state.elementBounds;
488
- if (!elementBounds.valid) {
489
- this.setElementBoundsX(state);
490
- this.setElementBoundsY(state);
491
- elementBounds.valid = true;
492
- }
493
-
494
- // Return early if we're still viewing inside the established render window
495
- // No need to re-render what we've already rendered
496
- // (Only if there's an established renderWindow and we're not suppressing early exit)
497
- if (!forceFullLayoutCalc && renderWindow.valid) {
498
- const rwScreen = renderWindow.screen;
499
- if (
500
- x + rwScreen.x1 <= elementBounds.x1 &&
501
- x + rwScreen.x2 >= elementBounds.x2 &&
502
- y - scrollY + rwScreen.y1 <= elementBounds.y1 &&
503
- y - scrollY + rwScreen.y2 >= elementBounds.y2
504
- ) {
505
- this.setStatus(state, 'loaded');
506
- return;
507
- }
508
- // Otherwise invalidate the renderWindow so it can be redone
509
- renderWindow.valid = false;
510
- this.setStatus(state, 'loading');
511
- }
512
-
513
- const { offsetY, textAlign } = state.props;
514
-
515
- // Create a new renderWindow if needed
516
- if (!renderWindow.valid) {
517
- const isPossiblyOnScreen = boundsOverlap(
518
- elementBounds,
519
- this.rendererBounds,
520
- );
521
-
522
- if (!isPossiblyOnScreen) {
523
- // If the element is not possibly on screen, we can skip the layout and rendering completely
524
- return;
525
- }
526
-
527
- setRenderWindow(
528
- renderWindow,
529
- x,
530
- y,
531
- scrollY,
532
- resLineHeight,
533
- contain === 'both' ? elementBounds.y2 - elementBounds.y1 : 0,
534
- elementBounds,
535
- fontSizeRatio,
536
- );
537
- // console.log('newRenderWindow', renderWindow);
538
- }
539
-
540
- const start = getStartConditions(
541
- sdfFontSize,
542
- sdfLineHeight,
543
- trFontFace,
544
- verticalAlign,
545
- offsetY,
546
- fontSizeRatio,
547
- renderWindow,
548
- lineCache,
549
- textH,
550
- );
551
-
552
- if (!start) {
553
- // Nothing to render, return early, but still mark as loaded (since the text is just scrolled
554
- // out of view)
555
- this.setStatus(state, 'loaded');
556
- return;
557
- }
558
-
559
- const { letterSpacing } = state.props;
560
-
561
- const out2 = layoutText(
562
- start.lineIndex,
563
- start.sdfX,
564
- start.sdfY,
565
- text,
566
- textAlign,
567
- width,
568
- height,
569
- fontSize,
570
- resLineHeight,
571
- letterSpacing,
572
- vertexBuffer,
573
- contain,
574
- lineCache,
575
- renderWindow.sdf,
576
- trFontFace,
577
- forceFullLayoutCalc,
578
- scrollable,
579
- overflowSuffix,
580
- maxLines,
581
- );
582
-
583
- state.bufferUploaded = false;
584
- state.bufferNumFloats = out2.bufferNumFloats;
585
- state.bufferNumQuads = out2.bufferNumQuads;
586
- state.vertexBuffer = vertexBuffer;
587
- state.renderWindow = renderWindow;
588
- debugData.lastLayoutNumCharacters = out2.layoutNumCharacters;
589
- debugData.bufferSize = vertexBuffer.byteLength;
590
-
591
- // If we didn't exit early, we know we have completely computed w/h
592
- if (out2.fullyProcessed) {
593
- state.textW = out2.maxX * fontSizeRatio;
594
- state.textH = out2.numLines * sdfLineHeight * fontSizeRatio;
595
- }
596
-
597
- // if (state.props.debug.printLayoutTime) {
598
- // debugData.layoutSum += performance.now() - updateStartTime;
599
- // debugData.layoutCount++;
600
- // }
601
- this.setStatus(state, 'loaded');
602
- }
603
-
604
- override renderQuads(
605
- state: SdfTextRendererState,
606
- transform: Matrix3d,
607
- clippingRect: Readonly<RectWithValid>,
608
- alpha: number,
609
- parentHasRenderTexture: boolean,
610
- framebufferDimensions: Dimensions,
611
- ): void {
612
- if (!state.vertexBuffer) {
613
- // Nothing to draw
614
- return;
615
- }
616
-
617
- const renderer = this.stage.renderer;
618
- assertTruthy(renderer instanceof WebGlCoreRenderer);
619
-
620
- const { fontSize, color, contain, scrollable, zIndex, debug } = state.props;
621
-
622
- // scrollY only has an effect when contain === 'both' and scrollable === true
623
- const scrollY = contain === 'both' && scrollable ? state.props.scrollY : 0;
624
-
625
- const {
626
- textW = 0,
627
- textH = 0,
628
- distanceRange,
629
- vertexBuffer,
630
- bufferUploaded,
631
- trFontFace,
632
- elementBounds,
633
- } = state;
634
-
635
- let { webGlBuffers } = state;
636
-
637
- if (!webGlBuffers) {
638
- const glw = renderer.glw;
639
- const stride = 4 * Float32Array.BYTES_PER_ELEMENT;
640
- const webGlBuffer = glw.createBuffer();
641
- assertTruthy(webGlBuffer);
642
- state.webGlBuffers = new BufferCollection([
643
- {
644
- buffer: webGlBuffer,
645
- attributes: {
646
- a_position: {
647
- name: 'a_position',
648
- size: 2, // 2 components per iteration
649
- type: glw.FLOAT, // the data is 32bit floats
650
- normalized: false, // don't normalize the data
651
- stride, // 0 = move forward size * sizeof(type) each iteration to get the next position
652
- offset: 0, // start at the beginning of the buffer
653
- },
654
- a_textureCoordinate: {
655
- name: 'a_textureCoordinate',
656
- size: 2,
657
- type: glw.FLOAT,
658
- normalized: false,
659
- stride,
660
- offset: 2 * Float32Array.BYTES_PER_ELEMENT,
661
- },
662
- },
663
- },
664
- ]);
665
- state.bufferUploaded = false;
666
- assertTruthy(state.webGlBuffers);
667
- webGlBuffers = state.webGlBuffers;
668
- }
669
-
670
- if (!bufferUploaded) {
671
- const glw = renderer.glw;
672
-
673
- const buffer = webGlBuffers?.getBuffer('a_textureCoordinate') ?? null;
674
- glw.arrayBufferData(buffer, vertexBuffer, glw.STATIC_DRAW);
675
- state.bufferUploaded = true;
676
- }
677
-
678
- assertTruthy(trFontFace);
679
- if (scrollable && contain === 'both') {
680
- assertTruthy(elementBounds.valid);
681
- const elementRect = convertBoundToRect(elementBounds, tmpRect);
682
-
683
- if (clippingRect.valid) {
684
- state.clippingRect.valid = true;
685
- clippingRect = intersectRect(
686
- clippingRect,
687
- elementRect,
688
- state.clippingRect,
689
- );
690
- } else {
691
- state.clippingRect.valid = true;
692
- clippingRect = copyRect(elementRect, state.clippingRect);
693
- }
694
- }
695
-
696
- const renderOp = new WebGlCoreRenderOp(
697
- renderer.glw,
698
- renderer.options,
699
- webGlBuffers,
700
- this.sdfShader,
701
- {
702
- transform: transform.getFloatArr(),
703
- // IMPORTANT: The SDF Shader expects the color NOT to be premultiplied
704
- // for the best blending results. Which is why we use `mergeColorAlpha`
705
- // instead of `mergeColorAlphaPremultiplied` here.
706
- color: mergeColorAlpha(color, alpha),
707
- size: fontSize / (trFontFace.data?.info.size || 0),
708
- scrollY,
709
- distanceRange,
710
- debug: debug.sdfShaderDebug,
711
- } satisfies SdfShaderProps,
712
- alpha,
713
- clippingRect,
714
- { height: textH, width: textW },
715
- 0,
716
- zIndex,
717
- false,
718
- parentHasRenderTexture,
719
- framebufferDimensions,
720
- );
721
-
722
- const texture = state.trFontFace?.texture;
723
- assertTruthy(texture);
724
- const ctxTexture = texture.ctxTexture;
725
-
726
- renderOp.addTexture(ctxTexture as WebGlCoreCtxTexture);
727
- renderOp.length = state.bufferNumFloats;
728
- renderOp.numQuads = state.bufferNumQuads;
729
-
730
- renderer.addRenderOp(renderOp);
731
-
732
- // if (!debug.disableScissor) {
733
- // renderer.enableScissor(
734
- // visibleRect.x,
735
- // visibleRect.y,
736
- // visibleRect.w,
737
- // visibleRect.h,
738
- // );
739
- // }
740
-
741
- // Draw the arrays
742
- // gl.drawArrays(
743
- // gl.TRIANGLES, // Primitive type
744
- // 0,
745
- // bufferNumVertices, // Number of verticies
746
- // );
747
-
748
- // renderer.disableScissor();
749
-
750
- // if (debug.showElementRect) {
751
- // this.renderer.drawBorder(
752
- // Colors.Blue,
753
- // elementRect.x,
754
- // elementRect.y,
755
- // elementRect.w,
756
- // elementRect.h,
757
- // );
758
- // }
759
-
760
- // if (debug.showVisibleRect) {
761
- // this.renderer.drawBorder(
762
- // Colors.Green,
763
- // visibleRect.x,
764
- // visibleRect.y,
765
- // visibleRect.w,
766
- // visibleRect.h,
767
- // );
768
- // }
769
-
770
- // if (debug.showRenderWindow && renderWindow) {
771
- // this.renderer.drawBorder(
772
- // Colors.Red,
773
- // x + renderWindow.x1,
774
- // y + renderWindow.y1 - scrollY,
775
- // x + renderWindow.x2 - (x + renderWindow.x1),
776
- // y + renderWindow.y2 - scrollY - (y + renderWindow.y1 - scrollY),
777
- // );
778
- // }
779
- // if (debug.printLayoutTime) {
780
- // debugData.drawSum += performance.now() - drawStartTime;
781
- // debugData.drawCount++;
782
- // }
783
- }
784
-
785
- override setIsRenderable(
786
- state: SdfTextRendererState,
787
- renderable: boolean,
788
- ): void {
789
- super.setIsRenderable(state, renderable);
790
- state.trFontFace?.texture.setRenderableOwner(state, renderable);
791
- }
792
-
793
- override destroyState(state: SdfTextRendererState): void {
794
- super.destroyState(state);
795
- // If there's a Font Face assigned we must free the owner relation to its texture
796
- state.trFontFace?.texture.setRenderableOwner(state, false);
797
- }
798
- //#endregion Overrides
799
-
800
- public resolveFontFace(props: TrFontProps): SdfTrFontFace | undefined {
801
- return this.stage.fontManager.resolveFontFace(
802
- this.fontFamilyArray,
803
- props,
804
- 'sdf',
805
- ) as SdfTrFontFace | undefined;
806
- }
807
-
808
- /**
809
- * Release the loaded SDF font face
810
- *
811
- * @param state
812
- */
813
- protected releaseFontFace(state: SdfTextRendererState) {
814
- state.resLineHeight = undefined;
815
- if (state.trFontFace) {
816
- state.trFontFace.texture.setRenderableOwner(state, false);
817
- state.trFontFace = undefined;
818
- }
819
- }
820
-
821
- /**
822
- * Invalidate the layout cache stored in the state. This will cause the text
823
- * to be re-layed out on the next update.
824
- *
825
- * @remarks
826
- * This also invalidates the visible window cache.
827
- *
828
- * @param state
829
- */
830
- protected invalidateLayoutCache(state: SdfTextRendererState): void {
831
- state.renderWindow.valid = false;
832
- state.elementBounds.valid = false;
833
- state.textH = undefined;
834
- state.textW = undefined;
835
- state.lineCache = [];
836
- this.setStatus(state, 'loading');
837
- this.scheduleUpdateState(state);
838
- }
839
-
840
- protected setElementBoundsX(state: SdfTextRendererState): void {
841
- const { x, contain, width } = state.props;
842
- const { elementBounds } = state;
843
- elementBounds.x1 = x;
844
- elementBounds.x2 = contain !== 'none' ? x + width : Infinity;
845
- }
846
-
847
- protected setElementBoundsY(state: SdfTextRendererState): void {
848
- const { y, contain, height } = state.props;
849
- const { elementBounds } = state;
850
- elementBounds.y1 = y;
851
- elementBounds.y2 = contain === 'both' ? y + height : Infinity;
852
- }
853
- }
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 {
21
+ type Bound,
22
+ type Rect,
23
+ createBound,
24
+ type BoundWithValid,
25
+ intersectRect,
26
+ type RectWithValid,
27
+ copyRect,
28
+ boundsOverlap,
29
+ convertBoundToRect,
30
+ } from '../../../lib/utils.js';
31
+ import {
32
+ TextRenderer,
33
+ type TrProps,
34
+ type TextRendererState,
35
+ type TrFontProps,
36
+ type TrPropSetters,
37
+ } from '../TextRenderer.js';
38
+ import { SdfTrFontFace } from '../../font-face-types/SdfTrFontFace/SdfTrFontFace.js';
39
+ import { FLOATS_PER_GLYPH } from './internal/constants.js';
40
+ import { getStartConditions } from './internal/getStartConditions.js';
41
+ import { layoutText } from './internal/layoutText.js';
42
+ import {
43
+ setRenderWindow,
44
+ type SdfRenderWindow,
45
+ } from './internal/setRenderWindow.js';
46
+ import type { TrFontFace } from '../../font-face-types/TrFontFace.js';
47
+ import { TrFontManager, type FontFamilyMap } from '../../TrFontManager.js';
48
+ import { assertTruthy, mergeColorAlpha } from '../../../../utils.js';
49
+ import type { Stage } from '../../../Stage.js';
50
+ import { WebGlCoreRenderOp } from '../../../renderers/webgl/WebGlCoreRenderOp.js';
51
+ import { BufferCollection } from '../../../renderers/webgl/internal/BufferCollection.js';
52
+ import type {
53
+ SdfShader,
54
+ SdfShaderProps,
55
+ } from '../../../renderers/webgl/shaders/SdfShader.js';
56
+ import type { WebGlCoreCtxTexture } from '../../../renderers/webgl/WebGlCoreCtxTexture.js';
57
+ import { EventEmitter } from '../../../../common/EventEmitter.js';
58
+ import type { Matrix3d } from '../../../lib/Matrix3d.js';
59
+ import type { Dimensions } from '../../../../common/CommonTypes.js';
60
+ import { WebGlCoreRenderer } from '../../../renderers/webgl/WebGlCoreRenderer.js';
61
+ import { calcDefaultLineHeight } from '../../TextRenderingUtils.js';
62
+
63
+ declare module '../TextRenderer.js' {
64
+ interface TextRendererMap {
65
+ sdf: SdfTextRenderer;
66
+ }
67
+
68
+ // Add prefixed SDF-specific props to TextRendererDebugProps
69
+ interface TextRendererDebugProps {
70
+ sdfShaderDebug: boolean;
71
+ }
72
+ }
73
+
74
+ export interface LineCacheItem {
75
+ codepointIndex: number;
76
+ maxY: number;
77
+ maxX: number;
78
+ }
79
+
80
+ export interface SdfTextRendererState extends TextRendererState {
81
+ /**
82
+ * Cache for layout resume points indexed by the `curY` for each line
83
+ * in the render sequence.
84
+ *
85
+ * Allows faster rendering by skipping parts of the layout loop that are
86
+ * outside of the renderWindow.
87
+ */
88
+ lineCache: LineCacheItem[];
89
+
90
+ renderWindow: SdfRenderWindow;
91
+
92
+ elementBounds: BoundWithValid;
93
+
94
+ clippingRect: RectWithValid;
95
+
96
+ bufferNumFloats: number;
97
+
98
+ bufferNumQuads: number;
99
+
100
+ vertexBuffer: Float32Array | undefined;
101
+
102
+ webGlBuffers: BufferCollection | null;
103
+
104
+ bufferUploaded: boolean;
105
+
106
+ distanceRange: number;
107
+
108
+ trFontFace: SdfTrFontFace | undefined;
109
+
110
+ /**
111
+ * Resolved line height in logical screen pixel units
112
+ */
113
+ resLineHeight: number | undefined;
114
+ }
115
+
116
+ /**
117
+ * Ephemeral rect object used for calculations
118
+ */
119
+ const tmpRect: Rect = {
120
+ x: 0,
121
+ y: 0,
122
+ width: 0,
123
+ height: 0,
124
+ };
125
+
126
+ /**
127
+ * Singleton class for rendering text using signed distance fields.
128
+ *
129
+ * @remarks
130
+ * SdfTextRenderer supports both single-channel and multi-channel signed distance fields.
131
+ */
132
+ export class SdfTextRenderer extends TextRenderer<SdfTextRendererState> {
133
+ /**
134
+ * Map of font family names to a set of font faces.
135
+ */
136
+ private ssdfFontFamilies: FontFamilyMap = {};
137
+ private msdfFontFamilies: FontFamilyMap = {};
138
+ private fontFamilyArray: FontFamilyMap[] = [
139
+ this.ssdfFontFamilies,
140
+ this.msdfFontFamilies,
141
+ ];
142
+ private sdfShader: SdfShader;
143
+ private rendererBounds: Bound;
144
+
145
+ public type: 'canvas' | 'sdf' = 'sdf';
146
+
147
+ constructor(stage: Stage) {
148
+ super(stage);
149
+ this.sdfShader = this.stage.shManager.loadShader('SdfShader', {
150
+ transform: new Float32Array(),
151
+ color: 0,
152
+ size: 0,
153
+ scrollY: 0,
154
+ distanceRange: 0,
155
+ debug: false,
156
+ }).shader;
157
+ this.rendererBounds = {
158
+ x1: 0,
159
+ y1: 0,
160
+ x2: this.stage.options.appWidth,
161
+ y2: this.stage.options.appHeight,
162
+ };
163
+ }
164
+
165
+ //#region Overrides
166
+ getPropertySetters(): Partial<TrPropSetters<SdfTextRendererState>> {
167
+ return {
168
+ fontFamily: (state, value) => {
169
+ state.props.fontFamily = value;
170
+ this.releaseFontFace(state);
171
+ this.invalidateLayoutCache(state);
172
+ },
173
+ fontWeight: (state, value) => {
174
+ state.props.fontWeight = value;
175
+ this.releaseFontFace(state);
176
+ this.invalidateLayoutCache(state);
177
+ },
178
+ fontStyle: (state, value) => {
179
+ state.props.fontStyle = value;
180
+ this.releaseFontFace(state);
181
+ this.invalidateLayoutCache(state);
182
+ },
183
+ fontStretch: (state, value) => {
184
+ state.props.fontStretch = value;
185
+ this.releaseFontFace(state);
186
+ this.invalidateLayoutCache(state);
187
+ },
188
+ fontSize: (state, value) => {
189
+ state.props.fontSize = value;
190
+ this.invalidateLayoutCache(state);
191
+ },
192
+ text: (state, value) => {
193
+ state.props.text = value;
194
+ this.invalidateLayoutCache(state);
195
+ },
196
+ textAlign: (state, value) => {
197
+ state.props.textAlign = value;
198
+ this.invalidateLayoutCache(state);
199
+ },
200
+ color: (state, value) => {
201
+ state.props.color = value;
202
+ },
203
+ x: (state, value) => {
204
+ state.props.x = value;
205
+ if (state.elementBounds.valid) {
206
+ this.setElementBoundsX(state);
207
+ // Only schedule an update if the text is not already rendered
208
+ // (renderWindow is invalid) and the element possibly overlaps the screen
209
+ // This is to avoid unnecessary updates when we know text is off-screen
210
+ if (
211
+ !state.renderWindow.valid &&
212
+ boundsOverlap(state.elementBounds, this.rendererBounds)
213
+ ) {
214
+ this.scheduleUpdateState(state);
215
+ }
216
+ }
217
+ },
218
+ y: (state, value) => {
219
+ state.props.y = value;
220
+ if (state.elementBounds.valid) {
221
+ this.setElementBoundsY(state);
222
+ // See x() for explanation
223
+ if (
224
+ !state.renderWindow.valid &&
225
+ boundsOverlap(state.elementBounds, this.rendererBounds)
226
+ ) {
227
+ this.scheduleUpdateState(state);
228
+ }
229
+ }
230
+ },
231
+ contain: (state, value) => {
232
+ state.props.contain = value;
233
+ this.invalidateLayoutCache(state);
234
+ },
235
+ width: (state, value) => {
236
+ state.props.width = value;
237
+ // Only invalidate layout cache if we're containing in the horizontal direction
238
+ if (state.props.contain !== 'none') {
239
+ this.invalidateLayoutCache(state);
240
+ }
241
+ },
242
+ height: (state, value) => {
243
+ state.props.height = value;
244
+ // Only invalidate layout cache if we're containing in the vertical direction
245
+ if (state.props.contain === 'both') {
246
+ this.invalidateLayoutCache(state);
247
+ }
248
+ },
249
+ offsetY: (state, value) => {
250
+ state.props.offsetY = value;
251
+ this.invalidateLayoutCache(state);
252
+ },
253
+ scrollable: (state, value) => {
254
+ state.props.scrollable = value;
255
+ this.invalidateLayoutCache(state);
256
+ },
257
+ scrollY: (state, value) => {
258
+ state.props.scrollY = value;
259
+ // Scrolling doesn't need to invalidate any caches, but it does need to
260
+ // schedule an update
261
+ this.scheduleUpdateState(state);
262
+ },
263
+ letterSpacing: (state, value) => {
264
+ state.props.letterSpacing = value;
265
+ this.invalidateLayoutCache(state);
266
+ },
267
+ lineHeight: (state, value) => {
268
+ state.props.lineHeight = value;
269
+ state.resLineHeight = undefined;
270
+ this.invalidateLayoutCache(state);
271
+ },
272
+ maxLines: (state, value) => {
273
+ state.props.maxLines = value;
274
+ this.invalidateLayoutCache(state);
275
+ },
276
+ textBaseline: (state, value) => {
277
+ state.props.textBaseline = value;
278
+ this.invalidateLayoutCache(state);
279
+ },
280
+ verticalAlign: (state, value) => {
281
+ state.props.verticalAlign = value;
282
+ this.invalidateLayoutCache(state);
283
+ },
284
+ overflowSuffix: (state, value) => {
285
+ state.props.overflowSuffix = value;
286
+ this.invalidateLayoutCache(state);
287
+ },
288
+ debug: (state, value) => {
289
+ state.props.debug = value;
290
+ },
291
+ };
292
+ }
293
+
294
+ override canRenderFont(props: TrFontProps): boolean {
295
+ // TODO: Support matching on font stretch, weight and style (if/when needed)
296
+ // For now we just match on the font family name
297
+ // '$$SDF_FAILURE_TEST$$' is used to test the 'failure' event coming from text
298
+ const { fontFamily } = props;
299
+ return (
300
+ fontFamily in this.ssdfFontFamilies ||
301
+ fontFamily in this.msdfFontFamilies ||
302
+ fontFamily === '$$SDF_FAILURE_TEST$$'
303
+ );
304
+ }
305
+
306
+ override isFontFaceSupported(fontFace: TrFontFace): boolean {
307
+ return fontFace instanceof SdfTrFontFace;
308
+ }
309
+
310
+ override addFontFace(fontFace: TrFontFace): void {
311
+ // Make sure the font face is an SDF font face (it should have already passed
312
+ // the `isFontFaceSupported` check)
313
+ assertTruthy(fontFace instanceof SdfTrFontFace);
314
+ const familyName = fontFace.fontFamily;
315
+ const fontFamiles =
316
+ fontFace.type === 'ssdf'
317
+ ? this.ssdfFontFamilies
318
+ : fontFace.type === 'msdf'
319
+ ? this.msdfFontFamilies
320
+ : undefined;
321
+ if (!fontFamiles) {
322
+ console.warn(`Invalid font face type: ${fontFace.type as string}`);
323
+ return;
324
+ }
325
+ let faceSet = fontFamiles[familyName];
326
+ if (!faceSet) {
327
+ faceSet = new Set();
328
+ fontFamiles[familyName] = faceSet;
329
+ }
330
+ faceSet.add(fontFace);
331
+ }
332
+
333
+ override createState(props: TrProps): SdfTextRendererState {
334
+ return {
335
+ props,
336
+ status: 'initialState',
337
+ updateScheduled: false,
338
+ emitter: new EventEmitter(),
339
+ lineCache: [],
340
+ forceFullLayoutCalc: false,
341
+ renderWindow: {
342
+ screen: {
343
+ x1: 0,
344
+ y1: 0,
345
+ x2: 0,
346
+ y2: 0,
347
+ },
348
+ sdf: {
349
+ x1: 0,
350
+ y1: 0,
351
+ x2: 0,
352
+ y2: 0,
353
+ },
354
+ firstLineIdx: 0,
355
+ numLines: 0,
356
+ valid: false,
357
+ },
358
+ elementBounds: {
359
+ x1: 0,
360
+ y1: 0,
361
+ x2: 0,
362
+ y2: 0,
363
+ valid: false,
364
+ },
365
+ clippingRect: {
366
+ x: 0,
367
+ y: 0,
368
+ width: 0,
369
+ height: 0,
370
+ valid: false,
371
+ },
372
+ bufferNumFloats: 0,
373
+ bufferNumQuads: 0,
374
+ vertexBuffer: undefined,
375
+ webGlBuffers: null,
376
+ bufferUploaded: false,
377
+ textH: undefined,
378
+ textW: undefined,
379
+ distanceRange: 0,
380
+ trFontFace: undefined,
381
+ isRenderable: false,
382
+ resLineHeight: undefined,
383
+ debugData: {
384
+ updateCount: 0,
385
+ layoutCount: 0,
386
+ lastLayoutNumCharacters: 0,
387
+ layoutSum: 0,
388
+ drawSum: 0,
389
+ drawCount: 0,
390
+ bufferSize: 0,
391
+ },
392
+ };
393
+ }
394
+
395
+ override updateState(state: SdfTextRendererState): void {
396
+ let { trFontFace } = state;
397
+ const { textH, lineCache, debugData, forceFullLayoutCalc } = state;
398
+ debugData.updateCount++;
399
+
400
+ // On the first update call we need to set the status to loading
401
+ if (state.status === 'initialState') {
402
+ this.setStatus(state, 'loading');
403
+ }
404
+
405
+ // Resolve font face if we haven't yet
406
+ if (trFontFace === undefined) {
407
+ trFontFace = this.resolveFontFace(state.props);
408
+ state.trFontFace = trFontFace;
409
+ if (trFontFace === undefined) {
410
+ const msg = `SdfTextRenderer: Could not resolve font face for family: '${state.props.fontFamily}'`;
411
+ console.error(msg);
412
+ this.setStatus(state, 'failed', new Error(msg));
413
+ return;
414
+ }
415
+ trFontFace.texture.setRenderableOwner(state, true);
416
+ }
417
+
418
+ // If the font hasn't been loaded yet, stop here.
419
+ // Listen for the 'loaded' event and forward fontLoaded event
420
+ if (trFontFace.loaded === false) {
421
+ trFontFace.once('loaded', () => {
422
+ this.scheduleUpdateState(state);
423
+ });
424
+ return;
425
+ }
426
+
427
+ // If the font is loaded then so should the data
428
+ assertTruthy(trFontFace.data, 'Font face data should be loaded');
429
+ assertTruthy(trFontFace.metrics, 'Font face metrics should be loaded');
430
+
431
+ const {
432
+ text,
433
+ fontSize,
434
+ x,
435
+ y,
436
+ contain,
437
+ width,
438
+ height,
439
+ verticalAlign,
440
+ scrollable,
441
+ overflowSuffix,
442
+ maxLines,
443
+ } = state.props;
444
+
445
+ // scrollY only has an effect when contain === 'both' and scrollable === true
446
+ const scrollY = contain === 'both' && scrollable ? state.props.scrollY : 0;
447
+
448
+ const { renderWindow } = state;
449
+
450
+ /**
451
+ * The font size of the SDF font face (the basis for SDF space units)
452
+ */
453
+ const sdfFontSize = trFontFace.data.info.size;
454
+
455
+ /**
456
+ * Divide screen space units by this to get the SDF space units
457
+ * Mulitple SDF space units by this to get screen space units
458
+ */
459
+ const fontSizeRatio = fontSize / sdfFontSize;
460
+
461
+ // If not already resolved, resolve the line height and store it in the state
462
+ let resLineHeight = state.resLineHeight;
463
+ if (resLineHeight === undefined) {
464
+ const lineHeight = state.props.lineHeight;
465
+ // If lineHeight is undefined, use the maxCharHeight from the font face
466
+ if (lineHeight === undefined) {
467
+ resLineHeight = calcDefaultLineHeight(trFontFace.metrics, fontSize);
468
+ } else {
469
+ resLineHeight = lineHeight;
470
+ }
471
+ state.resLineHeight = resLineHeight;
472
+ }
473
+
474
+ // Needed in renderWindow calculation
475
+ const sdfLineHeight = resLineHeight / fontSizeRatio;
476
+
477
+ state.distanceRange =
478
+ fontSizeRatio * trFontFace.data.distanceField.distanceRange;
479
+
480
+ // Allocate buffers if needed
481
+ const neededLength = text.length * FLOATS_PER_GLYPH;
482
+ let vertexBuffer = state.vertexBuffer;
483
+ if (!vertexBuffer || vertexBuffer.length < neededLength) {
484
+ vertexBuffer = new Float32Array(neededLength * 2);
485
+ }
486
+
487
+ const elementBounds = state.elementBounds;
488
+ if (!elementBounds.valid) {
489
+ this.setElementBoundsX(state);
490
+ this.setElementBoundsY(state);
491
+ elementBounds.valid = true;
492
+ }
493
+
494
+ // Return early if we're still viewing inside the established render window
495
+ // No need to re-render what we've already rendered
496
+ // (Only if there's an established renderWindow and we're not suppressing early exit)
497
+ if (!forceFullLayoutCalc && renderWindow.valid) {
498
+ const rwScreen = renderWindow.screen;
499
+ if (
500
+ x + rwScreen.x1 <= elementBounds.x1 &&
501
+ x + rwScreen.x2 >= elementBounds.x2 &&
502
+ y - scrollY + rwScreen.y1 <= elementBounds.y1 &&
503
+ y - scrollY + rwScreen.y2 >= elementBounds.y2
504
+ ) {
505
+ this.setStatus(state, 'loaded');
506
+ return;
507
+ }
508
+ // Otherwise invalidate the renderWindow so it can be redone
509
+ renderWindow.valid = false;
510
+ this.setStatus(state, 'loading');
511
+ }
512
+
513
+ const { offsetY, textAlign } = state.props;
514
+
515
+ // Create a new renderWindow if needed
516
+ if (!renderWindow.valid) {
517
+ const isPossiblyOnScreen = boundsOverlap(
518
+ elementBounds,
519
+ this.rendererBounds,
520
+ );
521
+
522
+ if (!isPossiblyOnScreen) {
523
+ // If the element is not possibly on screen, we can skip the layout and rendering completely
524
+ return;
525
+ }
526
+
527
+ setRenderWindow(
528
+ renderWindow,
529
+ x,
530
+ y,
531
+ scrollY,
532
+ resLineHeight,
533
+ contain === 'both' ? elementBounds.y2 - elementBounds.y1 : 0,
534
+ elementBounds,
535
+ fontSizeRatio,
536
+ );
537
+ // console.log('newRenderWindow', renderWindow);
538
+ }
539
+
540
+ const start = getStartConditions(
541
+ sdfFontSize,
542
+ sdfLineHeight,
543
+ trFontFace,
544
+ verticalAlign,
545
+ offsetY,
546
+ fontSizeRatio,
547
+ renderWindow,
548
+ lineCache,
549
+ textH,
550
+ );
551
+
552
+ if (!start) {
553
+ // Nothing to render, return early, but still mark as loaded (since the text is just scrolled
554
+ // out of view)
555
+ this.setStatus(state, 'loaded');
556
+ return;
557
+ }
558
+
559
+ const { letterSpacing } = state.props;
560
+
561
+ const out2 = layoutText(
562
+ start.lineIndex,
563
+ start.sdfX,
564
+ start.sdfY,
565
+ text,
566
+ textAlign,
567
+ width,
568
+ height,
569
+ fontSize,
570
+ resLineHeight,
571
+ letterSpacing,
572
+ vertexBuffer,
573
+ contain,
574
+ lineCache,
575
+ renderWindow.sdf,
576
+ trFontFace,
577
+ forceFullLayoutCalc,
578
+ scrollable,
579
+ overflowSuffix,
580
+ maxLines,
581
+ );
582
+
583
+ state.bufferUploaded = false;
584
+ state.bufferNumFloats = out2.bufferNumFloats;
585
+ state.bufferNumQuads = out2.bufferNumQuads;
586
+ state.vertexBuffer = vertexBuffer;
587
+ state.renderWindow = renderWindow;
588
+ debugData.lastLayoutNumCharacters = out2.layoutNumCharacters;
589
+ debugData.bufferSize = vertexBuffer.byteLength;
590
+
591
+ // If we didn't exit early, we know we have completely computed w/h
592
+ if (out2.fullyProcessed) {
593
+ state.textW = out2.maxX * fontSizeRatio;
594
+ state.textH = out2.numLines * sdfLineHeight * fontSizeRatio;
595
+ }
596
+
597
+ // if (state.props.debug.printLayoutTime) {
598
+ // debugData.layoutSum += performance.now() - updateStartTime;
599
+ // debugData.layoutCount++;
600
+ // }
601
+ this.setStatus(state, 'loaded');
602
+ }
603
+
604
+ override renderQuads(
605
+ state: SdfTextRendererState,
606
+ transform: Matrix3d,
607
+ clippingRect: Readonly<RectWithValid>,
608
+ alpha: number,
609
+ parentHasRenderTexture: boolean,
610
+ framebufferDimensions: Dimensions,
611
+ ): void {
612
+ if (!state.vertexBuffer) {
613
+ // Nothing to draw
614
+ return;
615
+ }
616
+
617
+ const renderer = this.stage.renderer;
618
+ assertTruthy(renderer instanceof WebGlCoreRenderer);
619
+
620
+ const { fontSize, color, contain, scrollable, zIndex, debug } = state.props;
621
+
622
+ // scrollY only has an effect when contain === 'both' and scrollable === true
623
+ const scrollY = contain === 'both' && scrollable ? state.props.scrollY : 0;
624
+
625
+ const {
626
+ textW = 0,
627
+ textH = 0,
628
+ distanceRange,
629
+ vertexBuffer,
630
+ bufferUploaded,
631
+ trFontFace,
632
+ elementBounds,
633
+ } = state;
634
+
635
+ let { webGlBuffers } = state;
636
+
637
+ if (!webGlBuffers) {
638
+ const glw = renderer.glw;
639
+ const stride = 4 * Float32Array.BYTES_PER_ELEMENT;
640
+ const webGlBuffer = glw.createBuffer();
641
+ assertTruthy(webGlBuffer);
642
+ state.webGlBuffers = new BufferCollection([
643
+ {
644
+ buffer: webGlBuffer,
645
+ attributes: {
646
+ a_position: {
647
+ name: 'a_position',
648
+ size: 2, // 2 components per iteration
649
+ type: glw.FLOAT, // the data is 32bit floats
650
+ normalized: false, // don't normalize the data
651
+ stride, // 0 = move forward size * sizeof(type) each iteration to get the next position
652
+ offset: 0, // start at the beginning of the buffer
653
+ },
654
+ a_textureCoordinate: {
655
+ name: 'a_textureCoordinate',
656
+ size: 2,
657
+ type: glw.FLOAT,
658
+ normalized: false,
659
+ stride,
660
+ offset: 2 * Float32Array.BYTES_PER_ELEMENT,
661
+ },
662
+ },
663
+ },
664
+ ]);
665
+ state.bufferUploaded = false;
666
+ assertTruthy(state.webGlBuffers);
667
+ webGlBuffers = state.webGlBuffers;
668
+ }
669
+
670
+ if (!bufferUploaded) {
671
+ const glw = renderer.glw;
672
+
673
+ const buffer = webGlBuffers?.getBuffer('a_textureCoordinate') ?? null;
674
+ glw.arrayBufferData(buffer, vertexBuffer, glw.STATIC_DRAW);
675
+ state.bufferUploaded = true;
676
+ }
677
+
678
+ assertTruthy(trFontFace);
679
+ if (scrollable && contain === 'both') {
680
+ assertTruthy(elementBounds.valid);
681
+ const elementRect = convertBoundToRect(elementBounds, tmpRect);
682
+
683
+ if (clippingRect.valid) {
684
+ state.clippingRect.valid = true;
685
+ clippingRect = intersectRect(
686
+ clippingRect,
687
+ elementRect,
688
+ state.clippingRect,
689
+ );
690
+ } else {
691
+ state.clippingRect.valid = true;
692
+ clippingRect = copyRect(elementRect, state.clippingRect);
693
+ }
694
+ }
695
+
696
+ const renderOp = new WebGlCoreRenderOp(
697
+ renderer.glw,
698
+ renderer.options,
699
+ webGlBuffers,
700
+ this.sdfShader,
701
+ {
702
+ transform: transform.getFloatArr(),
703
+ // IMPORTANT: The SDF Shader expects the color NOT to be premultiplied
704
+ // for the best blending results. Which is why we use `mergeColorAlpha`
705
+ // instead of `mergeColorAlphaPremultiplied` here.
706
+ color: mergeColorAlpha(color, alpha),
707
+ size: fontSize / (trFontFace.data?.info.size || 0),
708
+ scrollY,
709
+ distanceRange,
710
+ debug: debug.sdfShaderDebug,
711
+ } satisfies SdfShaderProps,
712
+ alpha,
713
+ clippingRect,
714
+ { height: textH, width: textW },
715
+ 0,
716
+ zIndex,
717
+ false,
718
+ parentHasRenderTexture,
719
+ framebufferDimensions,
720
+ );
721
+
722
+ const texture = state.trFontFace?.texture;
723
+ assertTruthy(texture);
724
+ const ctxTexture = texture.ctxTexture;
725
+
726
+ renderOp.addTexture(ctxTexture as WebGlCoreCtxTexture);
727
+ renderOp.length = state.bufferNumFloats;
728
+ renderOp.numQuads = state.bufferNumQuads;
729
+
730
+ renderer.addRenderOp(renderOp);
731
+
732
+ // if (!debug.disableScissor) {
733
+ // renderer.enableScissor(
734
+ // visibleRect.x,
735
+ // visibleRect.y,
736
+ // visibleRect.w,
737
+ // visibleRect.h,
738
+ // );
739
+ // }
740
+
741
+ // Draw the arrays
742
+ // gl.drawArrays(
743
+ // gl.TRIANGLES, // Primitive type
744
+ // 0,
745
+ // bufferNumVertices, // Number of verticies
746
+ // );
747
+
748
+ // renderer.disableScissor();
749
+
750
+ // if (debug.showElementRect) {
751
+ // this.renderer.drawBorder(
752
+ // Colors.Blue,
753
+ // elementRect.x,
754
+ // elementRect.y,
755
+ // elementRect.w,
756
+ // elementRect.h,
757
+ // );
758
+ // }
759
+
760
+ // if (debug.showVisibleRect) {
761
+ // this.renderer.drawBorder(
762
+ // Colors.Green,
763
+ // visibleRect.x,
764
+ // visibleRect.y,
765
+ // visibleRect.w,
766
+ // visibleRect.h,
767
+ // );
768
+ // }
769
+
770
+ // if (debug.showRenderWindow && renderWindow) {
771
+ // this.renderer.drawBorder(
772
+ // Colors.Red,
773
+ // x + renderWindow.x1,
774
+ // y + renderWindow.y1 - scrollY,
775
+ // x + renderWindow.x2 - (x + renderWindow.x1),
776
+ // y + renderWindow.y2 - scrollY - (y + renderWindow.y1 - scrollY),
777
+ // );
778
+ // }
779
+ // if (debug.printLayoutTime) {
780
+ // debugData.drawSum += performance.now() - drawStartTime;
781
+ // debugData.drawCount++;
782
+ // }
783
+ }
784
+
785
+ override setIsRenderable(
786
+ state: SdfTextRendererState,
787
+ renderable: boolean,
788
+ ): void {
789
+ super.setIsRenderable(state, renderable);
790
+ state.trFontFace?.texture.setRenderableOwner(state, renderable);
791
+ }
792
+
793
+ override destroyState(state: SdfTextRendererState): void {
794
+ super.destroyState(state);
795
+ // If there's a Font Face assigned we must free the owner relation to its texture
796
+ state.trFontFace?.texture.setRenderableOwner(state, false);
797
+ }
798
+ //#endregion Overrides
799
+
800
+ public resolveFontFace(props: TrFontProps): SdfTrFontFace | undefined {
801
+ return this.stage.fontManager.resolveFontFace(
802
+ this.fontFamilyArray,
803
+ props,
804
+ 'sdf',
805
+ ) as SdfTrFontFace | undefined;
806
+ }
807
+
808
+ /**
809
+ * Release the loaded SDF font face
810
+ *
811
+ * @param state
812
+ */
813
+ protected releaseFontFace(state: SdfTextRendererState) {
814
+ state.resLineHeight = undefined;
815
+ if (state.trFontFace) {
816
+ state.trFontFace.texture.setRenderableOwner(state, false);
817
+ state.trFontFace = undefined;
818
+ }
819
+ }
820
+
821
+ /**
822
+ * Invalidate the layout cache stored in the state. This will cause the text
823
+ * to be re-layed out on the next update.
824
+ *
825
+ * @remarks
826
+ * This also invalidates the visible window cache.
827
+ *
828
+ * @param state
829
+ */
830
+ protected invalidateLayoutCache(state: SdfTextRendererState): void {
831
+ state.renderWindow.valid = false;
832
+ state.elementBounds.valid = false;
833
+ state.textH = undefined;
834
+ state.textW = undefined;
835
+ state.lineCache = [];
836
+ this.setStatus(state, 'loading');
837
+ this.scheduleUpdateState(state);
838
+ }
839
+
840
+ protected setElementBoundsX(state: SdfTextRendererState): void {
841
+ const { x, contain, width } = state.props;
842
+ const { elementBounds } = state;
843
+ elementBounds.x1 = x;
844
+ elementBounds.x2 = contain !== 'none' ? x + width : Infinity;
845
+ }
846
+
847
+ protected setElementBoundsY(state: SdfTextRendererState): void {
848
+ const { y, contain, height } = state.props;
849
+ const { elementBounds } = state;
850
+ elementBounds.y1 = y;
851
+ elementBounds.y2 = contain === 'both' ? y + height : Infinity;
852
+ }
853
+ }