@lightningjs/renderer 3.0.0-beta3 → 3.0.0-beta4

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