@lightningjs/renderer 2.10.0 → 2.11.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 (327) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/CoreStuff.d.ts +1 -0
  14. package/dist/src/core/CoreStuff.js +138 -0
  15. package/dist/src/core/CoreStuff.js.map +1 -0
  16. package/dist/src/core/CoreTextureManager.d.ts +4 -1
  17. package/dist/src/core/CoreTextureManager.js +14 -3
  18. package/dist/src/core/CoreTextureManager.js.map +1 -1
  19. package/dist/src/core/LngNode.d.ts +736 -0
  20. package/dist/src/core/LngNode.js +1174 -0
  21. package/dist/src/core/LngNode.js.map +1 -0
  22. package/dist/src/core/Matrix2DContext.d.ts +15 -0
  23. package/dist/src/core/Matrix2DContext.js +45 -0
  24. package/dist/src/core/Matrix2DContext.js.map +1 -0
  25. package/dist/src/core/ShaderNode.d.ts +10 -0
  26. package/dist/src/core/ShaderNode.js +30 -0
  27. package/dist/src/core/ShaderNode.js.map +1 -0
  28. package/dist/src/core/Stage.js +1 -1
  29. package/dist/src/core/Stage.js.map +1 -1
  30. package/dist/src/core/TextNode.d.ts +103 -0
  31. package/dist/src/core/TextNode.js +331 -0
  32. package/dist/src/core/TextNode.js.map +1 -0
  33. package/dist/src/core/TextureMemoryManager.d.ts +30 -0
  34. package/dist/src/core/TextureMemoryManager.js +58 -38
  35. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  36. package/dist/src/core/lib/Coords.d.ts +14 -0
  37. package/dist/src/core/lib/Coords.js +55 -0
  38. package/dist/src/core/lib/Coords.js.map +1 -0
  39. package/dist/src/core/lib/glm/common.d.ts +162 -0
  40. package/dist/src/core/lib/glm/common.js +81 -0
  41. package/dist/src/core/lib/glm/common.js.map +1 -0
  42. package/dist/src/core/lib/glm/index.d.ts +11 -0
  43. package/dist/src/core/lib/glm/index.js +30 -0
  44. package/dist/src/core/lib/glm/index.js.map +1 -0
  45. package/dist/src/core/lib/glm/mat2.d.ts +219 -0
  46. package/dist/src/core/lib/glm/mat2.js +396 -0
  47. package/dist/src/core/lib/glm/mat2.js.map +1 -0
  48. package/dist/src/core/lib/glm/mat2d.d.ts +237 -0
  49. package/dist/src/core/lib/glm/mat2d.js +442 -0
  50. package/dist/src/core/lib/glm/mat2d.js.map +1 -0
  51. package/dist/src/core/lib/glm/mat3.d.ts +283 -0
  52. package/dist/src/core/lib/glm/mat3.js +680 -0
  53. package/dist/src/core/lib/glm/mat3.js.map +1 -0
  54. package/dist/src/core/lib/glm/mat4.d.ts +550 -0
  55. package/dist/src/core/lib/glm/mat4.js +1802 -0
  56. package/dist/src/core/lib/glm/mat4.js.map +1 -0
  57. package/dist/src/core/lib/glm/quat.d.ts +363 -0
  58. package/dist/src/core/lib/glm/quat.js +693 -0
  59. package/dist/src/core/lib/glm/quat.js.map +1 -0
  60. package/dist/src/core/lib/glm/quat2.d.ts +356 -0
  61. package/dist/src/core/lib/glm/quat2.js +754 -0
  62. package/dist/src/core/lib/glm/quat2.js.map +1 -0
  63. package/dist/src/core/lib/glm/vec2.d.ts +365 -0
  64. package/dist/src/core/lib/glm/vec2.js +569 -0
  65. package/dist/src/core/lib/glm/vec2.js.map +1 -0
  66. package/dist/src/core/lib/glm/vec3.d.ts +406 -0
  67. package/dist/src/core/lib/glm/vec3.js +720 -0
  68. package/dist/src/core/lib/glm/vec3.js.map +1 -0
  69. package/dist/src/core/lib/glm/vec4.d.ts +330 -0
  70. package/dist/src/core/lib/glm/vec4.js +608 -0
  71. package/dist/src/core/lib/glm/vec4.js.map +1 -0
  72. package/dist/src/core/lib/textureSvg.js +1 -1
  73. package/dist/src/core/lib/textureSvg.js.map +1 -1
  74. package/dist/src/core/renderers/CoreShaderManager.d.ts +19 -0
  75. package/dist/src/core/renderers/CoreShaderManager.js +33 -0
  76. package/dist/src/core/renderers/CoreShaderManager.js.map +1 -0
  77. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +4 -2
  78. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +1 -1
  79. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +4 -4
  80. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +1 -1
  81. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +9 -12
  82. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  83. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +27 -0
  84. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +82 -0
  85. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +1 -0
  86. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +11 -0
  87. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +34 -0
  88. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +1 -0
  89. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  90. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  91. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  92. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  93. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  94. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  95. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  96. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  97. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  98. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  99. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  100. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  101. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  102. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  103. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  104. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  105. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  106. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  107. package/dist/src/core/scene/Scene.d.ts +59 -0
  108. package/dist/src/core/scene/Scene.js +106 -0
  109. package/dist/src/core/scene/Scene.js.map +1 -0
  110. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  111. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  112. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  113. package/dist/src/core/textures/ColorTexture.js +1 -1
  114. package/dist/src/core/textures/ColorTexture.js.map +1 -1
  115. package/dist/src/core/textures/ImageTexture.js +3 -3
  116. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  117. package/dist/src/core/textures/NoiseTexture.js +1 -1
  118. package/dist/src/core/textures/NoiseTexture.js.map +1 -1
  119. package/dist/src/core/textures/RenderTexture.js +1 -1
  120. package/dist/src/core/textures/RenderTexture.js.map +1 -1
  121. package/dist/src/core/textures/SubTexture.d.ts +4 -0
  122. package/dist/src/core/textures/SubTexture.js +54 -16
  123. package/dist/src/core/textures/SubTexture.js.map +1 -1
  124. package/dist/src/core/textures/Texture.d.ts +2 -34
  125. package/dist/src/core/textures/Texture.js +13 -69
  126. package/dist/src/core/textures/Texture.js.map +1 -1
  127. package/dist/src/main-api/ICoreDriver.d.ts +27 -0
  128. package/dist/src/main-api/ICoreDriver.js +20 -0
  129. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  130. package/dist/src/main-api/IRenderDriver.d.ts +20 -0
  131. package/dist/src/main-api/IRenderDriver.js +20 -0
  132. package/dist/src/main-api/IRenderDriver.js.map +1 -0
  133. package/dist/src/main-api/IShaderController.d.ts +14 -0
  134. package/dist/src/main-api/IShaderController.js +30 -0
  135. package/dist/src/main-api/IShaderController.js.map +1 -0
  136. package/dist/src/main-api/IShaderNode.d.ts +17 -0
  137. package/dist/src/main-api/IShaderNode.js +19 -0
  138. package/dist/src/main-api/IShaderNode.js.map +1 -0
  139. package/dist/src/main-api/Renderer.js +1 -0
  140. package/dist/src/main-api/Renderer.js.map +1 -1
  141. package/dist/src/main-api/RendererMain.d.ts +375 -0
  142. package/dist/src/main-api/RendererMain.js +365 -0
  143. package/dist/src/main-api/RendererMain.js.map +1 -0
  144. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  145. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  146. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  147. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  148. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  149. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  150. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  151. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  152. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  153. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +24 -0
  154. package/dist/src/render-drivers/main/MainCoreDriver.js +118 -0
  155. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  156. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +99 -0
  157. package/dist/src/render-drivers/main/MainOnlyNode.js +396 -0
  158. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  159. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +6 -0
  160. package/dist/src/render-drivers/main/MainOnlyShaderController.js +15 -0
  161. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +1 -0
  162. package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +7 -0
  163. package/dist/src/render-drivers/main/MainOnlyShaderNode.js +34 -0
  164. package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +1 -0
  165. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  166. package/dist/src/render-drivers/main/MainOnlyTextNode.js +205 -0
  167. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  168. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +17 -0
  169. package/dist/src/render-drivers/main/MainRenderDriver.js +88 -0
  170. package/dist/src/render-drivers/main/MainRenderDriver.js.map +1 -0
  171. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +90 -0
  172. package/dist/src/render-drivers/threadx/NodeStruct.js +281 -0
  173. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  174. package/dist/src/render-drivers/threadx/SharedNode.d.ts +39 -0
  175. package/dist/src/render-drivers/threadx/SharedNode.js +60 -0
  176. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  177. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  178. package/dist/src/render-drivers/threadx/TextNodeStruct.js +201 -0
  179. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  180. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +28 -0
  181. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +234 -0
  182. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  183. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +20 -0
  184. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +84 -0
  185. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  186. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +44 -0
  187. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +154 -0
  188. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  189. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +6 -0
  190. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +16 -0
  191. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +1 -0
  192. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +7 -0
  193. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +15 -0
  194. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +1 -0
  195. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  196. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  197. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  198. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +21 -0
  199. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +198 -0
  200. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +1 -0
  201. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  202. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  203. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  204. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  205. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +177 -0
  206. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  207. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  208. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +108 -0
  209. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  210. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  211. package/dist/src/render-drivers/threadx/worker/renderer.js +145 -0
  212. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  213. package/dist/src/render-drivers/utils.d.ts +12 -0
  214. package/dist/src/render-drivers/utils.js +69 -0
  215. package/dist/src/render-drivers/utils.js.map +1 -0
  216. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  217. package/exports/canvas.ts +39 -39
  218. package/exports/index.ts +89 -89
  219. package/exports/inspector.ts +24 -24
  220. package/exports/utils.ts +44 -44
  221. package/exports/webgl.ts +38 -38
  222. package/package.json +2 -1
  223. package/scripts/please-use-pnpm.js +13 -13
  224. package/src/common/CommonTypes.ts +139 -139
  225. package/src/common/EventEmitter.ts +77 -77
  226. package/src/common/IAnimationController.ts +92 -92
  227. package/src/common/IEventEmitter.ts +28 -28
  228. package/src/core/CoreNode.test.ts +199 -199
  229. package/src/core/CoreNode.ts +2335 -2335
  230. package/src/core/CoreShaderManager.ts +292 -292
  231. package/src/core/CoreTextNode.ts +455 -455
  232. package/src/core/CoreTextureManager.ts +561 -545
  233. package/src/core/Stage.ts +700 -700
  234. package/src/core/TextureMemoryManager.ts +292 -277
  235. package/src/core/animations/AnimationManager.ts +38 -38
  236. package/src/core/animations/CoreAnimation.ts +340 -340
  237. package/src/core/animations/CoreAnimationController.ts +157 -157
  238. package/src/core/lib/ContextSpy.ts +41 -41
  239. package/src/core/lib/ImageWorker.ts +270 -270
  240. package/src/core/lib/Matrix3d.ts +244 -244
  241. package/src/core/lib/RenderCoords.ts +86 -86
  242. package/src/core/lib/WebGlContextWrapper.ts +1322 -1322
  243. package/src/core/lib/textureCompression.ts +152 -152
  244. package/src/core/lib/textureSvg.ts +78 -78
  245. package/src/core/lib/utils.ts +310 -310
  246. package/src/core/platform.ts +61 -61
  247. package/src/core/renderers/CoreContextTexture.ts +43 -43
  248. package/src/core/renderers/CoreRenderOp.ts +22 -22
  249. package/src/core/renderers/CoreRenderer.ts +114 -114
  250. package/src/core/renderers/CoreShader.ts +41 -41
  251. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +371 -369
  252. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -150
  253. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  254. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  255. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  256. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  257. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  258. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +295 -298
  259. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  260. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -805
  261. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  262. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  263. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  264. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  265. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  266. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  267. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  268. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  269. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  270. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  271. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  272. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  273. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  274. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  275. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  276. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  277. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  278. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  279. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  280. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  281. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  282. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  283. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  284. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  285. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  286. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  287. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  288. package/src/core/text-rendering/TrFontManager.ts +183 -183
  289. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  290. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  291. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  292. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  293. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  294. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  295. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  296. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +808 -808
  297. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  298. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  299. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  300. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  301. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  302. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  303. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  304. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  305. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +408 -408
  306. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  307. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  308. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  309. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  310. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  311. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  312. package/src/core/textures/ColorTexture.ts +102 -102
  313. package/src/core/textures/ImageTexture.ts +379 -379
  314. package/src/core/textures/NoiseTexture.ts +104 -104
  315. package/src/core/textures/RenderTexture.ts +85 -85
  316. package/src/core/textures/SubTexture.ts +225 -179
  317. package/src/core/textures/Texture.ts +347 -435
  318. package/src/core/utils.ts +227 -227
  319. package/src/env.d.ts +7 -7
  320. package/src/main-api/DynamicShaderController.ts +104 -104
  321. package/src/main-api/INode.ts +101 -101
  322. package/src/main-api/Inspector.ts +505 -505
  323. package/src/main-api/Renderer.ts +698 -694
  324. package/src/main-api/ShaderController.ts +80 -80
  325. package/src/main-api/utils.ts +45 -45
  326. package/src/utils.ts +248 -248
  327. package/COPYING +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
+ }