@lightningjs/renderer 0.7.5 → 0.8.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 (252) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +233 -221
  4. package/dist/src/common/CommonTypes.d.ts +12 -0
  5. package/dist/src/core/CoreNode.d.ts +83 -9
  6. package/dist/src/core/CoreNode.js +232 -44
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextNode.d.ts +6 -1
  9. package/dist/src/core/CoreTextNode.js +33 -20
  10. package/dist/src/core/CoreTextNode.js.map +1 -1
  11. package/dist/src/core/CoreTextureManager.d.ts +3 -1
  12. package/dist/src/core/CoreTextureManager.js +11 -2
  13. package/dist/src/core/CoreTextureManager.js.map +1 -1
  14. package/dist/src/core/Stage.d.ts +6 -0
  15. package/dist/src/core/Stage.js +16 -1
  16. package/dist/src/core/Stage.js.map +1 -1
  17. package/dist/src/core/TextureMemoryManager.d.ts +12 -0
  18. package/dist/src/core/TextureMemoryManager.js +42 -0
  19. package/dist/src/core/TextureMemoryManager.js.map +1 -0
  20. package/dist/src/core/lib/ImageWorker.d.ts +0 -1
  21. package/dist/src/core/lib/ImageWorker.js +55 -40
  22. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  23. package/dist/src/core/lib/RenderCoords.d.ts +13 -0
  24. package/dist/src/core/lib/RenderCoords.js +63 -0
  25. package/dist/src/core/lib/RenderCoords.js.map +1 -0
  26. package/dist/src/core/lib/WebGlContext.d.ts +414 -0
  27. package/dist/src/core/lib/WebGlContext.js +640 -0
  28. package/dist/src/core/lib/WebGlContext.js.map +1 -0
  29. package/dist/src/core/lib/utils.d.ts +1 -0
  30. package/dist/src/core/lib/utils.js +6 -0
  31. package/dist/src/core/lib/utils.js.map +1 -1
  32. package/dist/src/core/platform.js +8 -0
  33. package/dist/src/core/platform.js.map +1 -1
  34. package/dist/src/core/renderers/CoreContextTexture.d.ts +5 -1
  35. package/dist/src/core/renderers/CoreContextTexture.js +3 -1
  36. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.d.ts +2 -1
  38. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +2 -2
  39. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -1
  40. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +3 -1
  41. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +26 -6
  42. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  43. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +3 -0
  44. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +4 -2
  45. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  46. package/dist/src/core/renderers/webgl/internal/RendererUtils.d.ts +9 -0
  47. package/dist/src/core/renderers/webgl/internal/RendererUtils.js +14 -0
  48. package/dist/src/core/renderers/webgl/internal/RendererUtils.js.map +1 -1
  49. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +47 -47
  50. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  51. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  52. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  53. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +49 -49
  54. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  55. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +5 -5
  56. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  57. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  58. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  59. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  60. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  61. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  62. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +44 -57
  63. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +1 -1
  64. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.d.ts +1 -0
  65. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +33 -39
  66. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +1 -1
  67. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  68. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  69. package/dist/src/core/scene/Scene.d.ts +59 -0
  70. package/dist/src/core/scene/Scene.js +106 -0
  71. package/dist/src/core/scene/Scene.js.map +1 -0
  72. package/dist/src/core/text-rendering/TrFontManager.js +30 -25
  73. package/dist/src/core/text-rendering/TrFontManager.js.map +1 -1
  74. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts +2 -0
  75. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +26 -2
  76. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  77. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +8 -0
  78. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +34 -6
  79. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  80. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.d.ts +8 -0
  81. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js +29 -0
  82. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js.map +1 -0
  83. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +1 -3
  84. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  85. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.d.ts +19 -0
  86. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js +84 -0
  87. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js.map +1 -0
  88. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.d.ts +8 -0
  89. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js +40 -0
  90. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js.map +1 -0
  91. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.d.ts +2 -0
  92. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js +41 -0
  93. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js.map +1 -0
  94. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.d.ts +1 -0
  95. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js +4 -0
  96. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js.map +1 -0
  97. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.d.ts +1 -0
  98. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js +2 -0
  99. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js.map +1 -0
  100. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  101. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  102. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  103. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.d.ts +9 -0
  104. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js +32 -0
  105. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js.map +1 -0
  106. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +31 -0
  107. package/dist/src/core/text-rendering/renderers/TextRenderer.js +26 -0
  108. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  109. package/dist/src/core/textures/ImageTexture.js +16 -2
  110. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  111. package/dist/src/core/textures/Texture.d.ts +27 -2
  112. package/dist/src/core/textures/Texture.js +30 -1
  113. package/dist/src/core/textures/Texture.js.map +1 -1
  114. package/dist/src/core/utils.d.ts +1 -1
  115. package/dist/src/main-api/ICoreDriver.d.ts +1 -0
  116. package/dist/src/main-api/Inspector.js +2 -1
  117. package/dist/src/main-api/Inspector.js.map +1 -1
  118. package/dist/src/main-api/RendererMain.d.ts +15 -0
  119. package/dist/src/main-api/RendererMain.js +7 -1
  120. package/dist/src/main-api/RendererMain.js.map +1 -1
  121. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +1 -0
  122. package/dist/src/render-drivers/main/MainCoreDriver.js +8 -0
  123. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -1
  124. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +5 -0
  125. package/dist/src/render-drivers/main/MainOnlyNode.js +26 -0
  126. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -1
  127. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +2 -0
  128. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -1
  129. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +2 -0
  130. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -1
  131. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +3 -0
  132. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -1
  133. package/dist/src/render-drivers/threadx/worker/renderer.js +2 -0
  134. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -1
  135. package/dist/src/utils.d.ts +6 -0
  136. package/dist/src/utils.js +9 -1
  137. package/dist/src/utils.js.map +1 -1
  138. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  139. package/exports/core-api.ts +102 -102
  140. package/exports/main-api.ts +60 -60
  141. package/exports/utils.ts +41 -41
  142. package/package.json +1 -1
  143. package/scripts/please-use-pnpm.js +13 -13
  144. package/src/common/CommonTypes.ts +132 -113
  145. package/src/common/EventEmitter.ts +77 -77
  146. package/src/common/IAnimationController.ts +29 -29
  147. package/src/core/CoreExtension.ts +32 -32
  148. package/src/core/CoreNode.ts +1199 -955
  149. package/src/core/CoreShaderManager.ts +243 -243
  150. package/src/core/CoreTextNode.ts +400 -391
  151. package/src/core/CoreTextureManager.ts +339 -326
  152. package/src/core/Stage.ts +375 -354
  153. package/src/core/TextureMemoryManager.ts +66 -0
  154. package/src/core/animations/AnimationManager.ts +38 -38
  155. package/src/core/animations/CoreAnimation.ts +181 -181
  156. package/src/core/animations/CoreAnimationController.ts +148 -148
  157. package/src/core/lib/ContextSpy.ts +41 -41
  158. package/src/core/lib/ImageWorker.ts +149 -135
  159. package/src/core/lib/Matrix3d.ts +290 -290
  160. package/src/core/lib/RenderCoords.ts +86 -0
  161. package/src/core/lib/WebGlContextWrapper.ts +992 -992
  162. package/src/core/lib/textureCompression.ts +152 -152
  163. package/src/core/lib/utils.ts +250 -241
  164. package/src/core/platform.ts +54 -46
  165. package/src/core/renderers/CoreContextTexture.ts +35 -30
  166. package/src/core/renderers/CoreRenderOp.ts +22 -22
  167. package/src/core/renderers/CoreRenderer.ts +63 -63
  168. package/src/core/renderers/CoreShader.ts +41 -41
  169. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +42 -37
  170. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +261 -230
  171. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +107 -107
  172. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +528 -520
  173. package/src/core/renderers/webgl/WebGlCoreShader.ts +337 -337
  174. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  175. package/src/core/renderers/webgl/internal/RendererUtils.ts +148 -131
  176. package/src/core/renderers/webgl/internal/ShaderUtils.ts +136 -136
  177. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  178. package/src/core/renderers/webgl/shaders/DefaultShader.ts +95 -95
  179. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  180. package/src/core/renderers/webgl/shaders/DynamicShader.ts +474 -474
  181. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +161 -161
  182. package/src/core/renderers/webgl/shaders/SdfShader.ts +174 -174
  183. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  184. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +86 -86
  185. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  186. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  187. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  188. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +33 -33
  189. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +135 -135
  190. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +145 -145
  191. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  192. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +160 -176
  193. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +153 -159
  194. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +186 -186
  195. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +121 -121
  196. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +114 -114
  197. package/src/core/text-rendering/TextTextureRendererUtils.ts +189 -189
  198. package/src/core/text-rendering/TrFontManager.ts +170 -166
  199. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +141 -141
  200. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  201. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  202. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +169 -169
  203. package/src/core/text-rendering/font-face-types/TrFontFace.ts +105 -105
  204. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +77 -77
  205. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +780 -751
  206. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +741 -741
  207. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +812 -778
  208. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  209. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  210. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  211. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  212. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +84 -84
  213. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  214. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  215. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +391 -393
  216. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  217. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +51 -51
  218. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  219. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  220. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  221. package/src/core/text-rendering/renderers/TextRenderer.ts +548 -504
  222. package/src/core/textures/ColorTexture.ts +86 -86
  223. package/src/core/textures/ImageTexture.ts +154 -140
  224. package/src/core/textures/NoiseTexture.ts +96 -96
  225. package/src/core/textures/SubTexture.ts +143 -143
  226. package/src/core/textures/Texture.ts +261 -218
  227. package/src/core/utils.ts +224 -224
  228. package/src/env.d.ts +7 -7
  229. package/src/main-api/ICoreDriver.ts +68 -66
  230. package/src/main-api/INode.ts +499 -499
  231. package/src/main-api/Inspector.ts +440 -439
  232. package/src/main-api/RendererMain.ts +676 -652
  233. package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts +45 -45
  234. package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts +154 -154
  235. package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts +54 -54
  236. package/src/render-drivers/main/MainCoreDriver.ts +158 -148
  237. package/src/render-drivers/main/MainOnlyNode.ts +500 -466
  238. package/src/render-drivers/main/MainOnlyTextNode.ts +261 -261
  239. package/src/render-drivers/threadx/NodeStruct.ts +300 -300
  240. package/src/render-drivers/threadx/SharedNode.ts +97 -97
  241. package/src/render-drivers/threadx/TextNodeStruct.ts +211 -211
  242. package/src/render-drivers/threadx/ThreadXCoreDriver.ts +287 -285
  243. package/src/render-drivers/threadx/ThreadXMainAnimationController.ts +99 -99
  244. package/src/render-drivers/threadx/ThreadXMainNode.ts +192 -192
  245. package/src/render-drivers/threadx/ThreadXMainTextNode.ts +85 -85
  246. package/src/render-drivers/threadx/ThreadXRendererMessage.ts +112 -110
  247. package/src/render-drivers/threadx/worker/ThreadXRendererNode.ts +245 -238
  248. package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts +149 -149
  249. package/src/render-drivers/threadx/worker/renderer.ts +153 -151
  250. package/src/render-drivers/utils.ts +97 -97
  251. package/src/utils.ts +216 -207
  252. package/COPYING +0 -1
@@ -1,751 +1,780 @@
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 { EventEmitter } from '../../../common/EventEmitter.js';
21
- import { assertTruthy, mergeColorAlphaPremultiplied } from '../../../utils.js';
22
- import type { Stage } from '../../Stage.js';
23
- import type { Matrix3d } from '../../lib/Matrix3d.js';
24
- import {
25
- intersectRect,
26
- type Bound,
27
- intersectBound,
28
- getNormalizedRgbaComponents,
29
- type Rect,
30
- getNormalizedAlphaComponent,
31
- type BoundWithValid,
32
- createBound,
33
- type RectWithValid,
34
- } from '../../lib/utils.js';
35
- import type { ImageTexture } from '../../textures/ImageTexture.js';
36
- import type { TrFontFace } from '../font-face-types/TrFontFace.js';
37
- import { WebTrFontFace } from '../font-face-types/WebTrFontFace.js';
38
- import {
39
- LightningTextTextureRenderer,
40
- type RenderInfo,
41
- } from './LightningTextTextureRenderer.js';
42
- import {
43
- TextRenderer,
44
- type TextRendererState,
45
- type TrFontProps,
46
- type TrPropSetters,
47
- type TrProps,
48
- } from './TextRenderer.js';
49
-
50
- const resolvedGlobal = typeof self === 'undefined' ? globalThis : self;
51
-
52
- /**
53
- * Global font set regardless of if run in the main thread or a web worker
54
- */
55
- const globalFontSet = ((resolvedGlobal.document as any)?.fonts ||
56
- (resolvedGlobal as any).fonts) as FontFaceSet;
57
-
58
- declare module './TextRenderer.js' {
59
- interface TextRendererMap {
60
- canvas: CanvasTextRenderer;
61
- }
62
- }
63
-
64
- interface CanvasPageInfo {
65
- texture: ImageTexture | undefined;
66
- lineNumStart: number;
67
- lineNumEnd: number;
68
- valid: boolean;
69
- }
70
-
71
- function getFontCssString(props: TrProps): string {
72
- const { fontFamily, fontStyle, fontWeight, fontStretch, fontSize } = props;
73
- return [fontStyle, fontWeight, fontStretch, `${fontSize}px`, fontFamily].join(
74
- ' ',
75
- );
76
- }
77
-
78
- export interface CanvasTextRendererState extends TextRendererState {
79
- props: TrProps;
80
-
81
- fontFaceLoadedHandler: (() => void) | undefined;
82
- fontInfo:
83
- | {
84
- cssString: string;
85
- loaded: boolean;
86
- }
87
- | undefined;
88
- canvasPages: [CanvasPageInfo, CanvasPageInfo, CanvasPageInfo] | undefined;
89
- lightning2TextRenderer: LightningTextTextureRenderer;
90
- renderInfo: RenderInfo | undefined;
91
- renderWindow: Bound | undefined;
92
- visibleWindow: BoundWithValid;
93
- }
94
-
95
- /**
96
- * Ephemeral bounds object used for intersection calculations
97
- *
98
- * @remarks
99
- * Used to avoid creating a new object every time we need to intersect
100
- * element bounds.
101
- */
102
- const tmpElementBounds = createBound(0, 0, 0, 0);
103
-
104
- export class CanvasTextRenderer extends TextRenderer<CanvasTextRendererState> {
105
- protected canvas: OffscreenCanvas | HTMLCanvasElement;
106
- protected context:
107
- | OffscreenCanvasRenderingContext2D
108
- | CanvasRenderingContext2D;
109
- private rendererBounds: Bound;
110
-
111
- constructor(stage: Stage) {
112
- super(stage);
113
- if (typeof OffscreenCanvas !== 'undefined') {
114
- this.canvas = new OffscreenCanvas(0, 0);
115
- } else {
116
- this.canvas = document.createElement('canvas');
117
- }
118
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
119
- let context = this.canvas.getContext('2d') as
120
- | OffscreenCanvasRenderingContext2D
121
- | CanvasRenderingContext2D
122
- | null;
123
- if (!context) {
124
- // A browser may appear to support OffscreenCanvas but not actually support the Canvas '2d' context
125
- // Here we try getting the context again after falling back to an HTMLCanvasElement.
126
- // See: https://github.com/lightning-js/renderer/issues/26#issuecomment-1750438486
127
- this.canvas = document.createElement('canvas');
128
- context = this.canvas.getContext('2d');
129
- }
130
- assertTruthy(context);
131
- this.context = context;
132
- this.rendererBounds = {
133
- x1: 0,
134
- y1: 0,
135
- x2: this.stage.options.appWidth,
136
- y2: this.stage.options.appHeight,
137
- };
138
- }
139
-
140
- //#region Overrides
141
- override getPropertySetters(): Partial<
142
- TrPropSetters<CanvasTextRendererState>
143
- > {
144
- return {
145
- fontFamily: (state, value) => {
146
- state.props.fontFamily = value;
147
- state.fontInfo = undefined;
148
- this.invalidateLayoutCache(state);
149
- },
150
- fontWeight: (state, value) => {
151
- state.props.fontWeight = value;
152
- state.fontInfo = undefined;
153
- this.invalidateLayoutCache(state);
154
- },
155
- fontStyle: (state, value) => {
156
- state.props.fontStyle = value;
157
- state.fontInfo = undefined;
158
- this.invalidateLayoutCache(state);
159
- },
160
- fontStretch: (state, value) => {
161
- state.props.fontStretch = value;
162
- state.fontInfo = undefined;
163
- this.invalidateLayoutCache(state);
164
- },
165
- fontSize: (state, value) => {
166
- state.props.fontSize = value;
167
- state.fontInfo = undefined;
168
- this.invalidateLayoutCache(state);
169
- },
170
- text: (state, value) => {
171
- state.props.text = value;
172
- this.invalidateLayoutCache(state);
173
- },
174
- textAlign: (state, value) => {
175
- state.props.textAlign = value;
176
- this.invalidateLayoutCache(state);
177
- },
178
- color: (state, value) => {
179
- state.props.color = value;
180
- this.invalidateLayoutCache(state);
181
- },
182
- x: (state, value) => {
183
- state.props.x = value;
184
- this.invalidateVisibleWindowCache(state);
185
- },
186
- y: (state, value) => {
187
- state.props.y = value;
188
- this.invalidateVisibleWindowCache(state);
189
- },
190
- contain: (state, value) => {
191
- state.props.contain = value;
192
- this.invalidateLayoutCache(state);
193
- },
194
- width: (state, value) => {
195
- state.props.width = value;
196
- this.invalidateLayoutCache(state);
197
- },
198
- height: (state, value) => {
199
- state.props.height = value;
200
- this.invalidateLayoutCache(state);
201
- },
202
- offsetY: (state, value) => {
203
- state.props.offsetY = value;
204
- this.invalidateLayoutCache(state);
205
- },
206
- scrollY: (state, value) => {
207
- state.props.scrollY = value;
208
- },
209
- letterSpacing: (state, value) => {
210
- state.props.letterSpacing = value;
211
- this.invalidateLayoutCache(state);
212
- },
213
- lineHeight: (state, value) => {
214
- state.props.lineHeight = value;
215
- this.invalidateLayoutCache(state);
216
- },
217
- maxLines: (state, value) => {
218
- state.props.maxLines = value;
219
- this.invalidateLayoutCache(state);
220
- },
221
- textBaseline: (state, value) => {
222
- state.props.textBaseline = value;
223
- this.invalidateLayoutCache(state);
224
- },
225
- verticalAlign: (state, value) => {
226
- state.props.verticalAlign = value;
227
- this.invalidateLayoutCache(state);
228
- },
229
- overflowSuffix: (state, value) => {
230
- state.props.overflowSuffix = value;
231
- this.invalidateLayoutCache(state);
232
- },
233
- // debug: (state, value) => {
234
- // state.props.debug = value;
235
- // },
236
- };
237
- }
238
-
239
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
240
- override canRenderFont(props: TrFontProps): boolean {
241
- // The canvas renderer can render any font because it automatically
242
- // falls back to system fonts. The CanvasTextRenderer should be
243
- // checked last if other renderers are preferred.
244
- return true;
245
- }
246
-
247
- override isFontFaceSupported(fontFace: TrFontFace): boolean {
248
- return fontFace instanceof WebTrFontFace;
249
- }
250
-
251
- override addFontFace(fontFace: TrFontFace): void {
252
- // Make sure the font face is an Canvas font face (it should have already passed
253
- // the `isFontFaceSupported` check)
254
- assertTruthy(fontFace instanceof WebTrFontFace);
255
-
256
- // We simply add the font face to the document
257
- // @ts-expect-error `add()` method should be available from a FontFaceSet
258
- // eslint-disable-next-line @typescript-eslint/no-unsafe-call
259
- globalFontSet.add(fontFace.fontFace);
260
- }
261
-
262
- override createState(props: TrProps): CanvasTextRendererState {
263
- return {
264
- props,
265
- status: 'initialState',
266
- updateScheduled: false,
267
- emitter: new EventEmitter(),
268
- canvasPages: undefined,
269
- lightning2TextRenderer: new LightningTextTextureRenderer(
270
- this.canvas,
271
- this.context,
272
- ),
273
- renderWindow: undefined,
274
- visibleWindow: {
275
- x1: 0,
276
- y1: 0,
277
- x2: 0,
278
- y2: 0,
279
- valid: false,
280
- },
281
- renderInfo: undefined,
282
- forceFullLayoutCalc: false,
283
- textW: 0,
284
- textH: 0,
285
- fontInfo: undefined,
286
- fontFaceLoadedHandler: undefined,
287
- debugData: {
288
- updateCount: 0,
289
- layoutCount: 0,
290
- drawCount: 0,
291
- lastLayoutNumCharacters: 0,
292
- layoutSum: 0,
293
- drawSum: 0,
294
- bufferSize: 0,
295
- },
296
- };
297
- }
298
-
299
- override updateState(state: CanvasTextRendererState): void {
300
- // On the first update call we need to set the status to loading
301
- if (state.status === 'initialState') {
302
- this.setStatus(state, 'loading');
303
- }
304
-
305
- // If fontInfo is invalid, we need to establish it
306
- if (!state.fontInfo) {
307
- const cssString = getFontCssString(state.props);
308
- state.fontInfo = {
309
- cssString: cssString,
310
- // TODO: For efficiency we would use this here but it's not reliable on WPE -> document.fonts.check(cssString),
311
- loaded: false,
312
- };
313
- // If font is not loaded, set up a handler to update the font info when the font loads
314
- if (!state.fontInfo.loaded) {
315
- globalFontSet
316
- .load(cssString)
317
- .then(this.onFontLoaded.bind(this, state, cssString))
318
- .catch(this.onFontLoadError.bind(this, state, cssString));
319
- return;
320
- }
321
- }
322
-
323
- // If we're waiting for a font face to load, don't render anything
324
- if (!state.fontInfo.loaded) {
325
- return;
326
- }
327
-
328
- if (!state.renderInfo) {
329
- const maxLines = state.props.maxLines;
330
- const containedMaxLines =
331
- state.props.contain === 'both'
332
- ? Math.floor(
333
- (state.props.height - state.props.offsetY) /
334
- state.props.lineHeight,
335
- )
336
- : 0;
337
- const calcMaxLines =
338
- containedMaxLines > 0 && maxLines > 0
339
- ? Math.min(containedMaxLines, maxLines)
340
- : Math.max(containedMaxLines, maxLines);
341
- state.lightning2TextRenderer.settings = {
342
- text: state.props.text,
343
- textAlign: state.props.textAlign,
344
- fontFace: state.props.fontFamily,
345
- fontSize: state.props.fontSize,
346
- fontStyle: [
347
- state.props.fontStretch,
348
- state.props.fontStyle,
349
- state.props.fontWeight,
350
- ].join(' '),
351
- textColor: getNormalizedRgbaComponents(state.props.color),
352
- offsetY: state.props.fontSize + state.props.offsetY,
353
- wordWrap: state.props.contain !== 'none',
354
- wordWrapWidth:
355
- state.props.contain === 'none' ? undefined : state.props.width,
356
- letterSpacing: state.props.letterSpacing,
357
- lineHeight: state.props.lineHeight,
358
- maxLines: calcMaxLines,
359
- textBaseline: state.props.textBaseline,
360
- verticalAlign: state.props.verticalAlign,
361
- overflowSuffix: state.props.overflowSuffix,
362
- };
363
- // const renderInfoCalculateTime = performance.now();
364
- state.renderInfo = state.lightning2TextRenderer.calculateRenderInfo();
365
- // console.log(
366
- // 'Render info calculated in',
367
- // performance.now() - renderInfoCalculateTime,
368
- // 'ms',
369
- // );
370
- state.textH = state.renderInfo.lineHeight * state.renderInfo.lines.length;
371
- state.textW = state.renderInfo.width;
372
-
373
- // Invalidate renderWindow because the renderInfo changed
374
- state.renderWindow = undefined;
375
- }
376
-
377
- const { x, y, width, height, scrollY, contain } = state.props;
378
- const { visibleWindow } = state;
379
- let { renderWindow, canvasPages } = state;
380
-
381
- if (!visibleWindow.valid) {
382
- // Figure out whats actually in the bounds of the renderer/canvas (visibleWindow)
383
- const elementBounds = createBound(
384
- x,
385
- y,
386
- contain !== 'none' ? x + width : Infinity,
387
- contain === 'both' ? y + height : Infinity,
388
- tmpElementBounds,
389
- );
390
- /**
391
- * Area that is visible on the screen.
392
- */
393
- intersectBound(this.rendererBounds, elementBounds, visibleWindow);
394
- visibleWindow.valid = true;
395
- }
396
-
397
- const visibleWindowHeight = visibleWindow.y2 - visibleWindow.y1;
398
-
399
- const maxLinesPerCanvasPage = Math.ceil(
400
- visibleWindowHeight / state.renderInfo.lineHeight,
401
- );
402
-
403
- if (visibleWindowHeight === 0) {
404
- // Nothing to render. Clear any canvasPages and existing renderWindow
405
- // Return early.
406
- canvasPages = undefined;
407
- renderWindow = undefined;
408
- this.setStatus(state, 'loaded');
409
- return;
410
- } else if (renderWindow && canvasPages) {
411
- // Return early if we're still viewing inside the established render window
412
- // No need to re-render what we've already rendered
413
- const renderWindowScreenX1 = x + renderWindow.x1;
414
- const renderWindowScreenY1 = y - scrollY + renderWindow.y1;
415
- const renderWindowScreenX2 = x + renderWindow.x2;
416
- const renderWindowScreenY2 = y - scrollY + renderWindow.y2;
417
-
418
- if (
419
- renderWindowScreenX1 <= visibleWindow.x1 &&
420
- renderWindowScreenX2 >= visibleWindow.x2 &&
421
- renderWindowScreenY1 <= visibleWindow.y1 &&
422
- renderWindowScreenY2 >= visibleWindow.y2
423
- ) {
424
- this.setStatus(state, 'loaded');
425
- return;
426
- }
427
- if (renderWindowScreenY2 < visibleWindow.y2) {
428
- // We've scrolled up, so we need to render the next page
429
- renderWindow.y1 += maxLinesPerCanvasPage * state.renderInfo.lineHeight;
430
- renderWindow.y2 += maxLinesPerCanvasPage * state.renderInfo.lineHeight;
431
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
432
- canvasPages.push(canvasPages.shift()!);
433
- canvasPages[2].lineNumStart =
434
- canvasPages[1].lineNumStart + maxLinesPerCanvasPage;
435
- canvasPages[2].lineNumEnd =
436
- canvasPages[2].lineNumStart + maxLinesPerCanvasPage;
437
- canvasPages[2].valid = false;
438
- } else if (renderWindowScreenY1 > visibleWindow.y1) {
439
- // We've scrolled down, so we need to render the previous page
440
- renderWindow.y1 -= maxLinesPerCanvasPage * state.renderInfo.lineHeight;
441
- renderWindow.y2 -= maxLinesPerCanvasPage * state.renderInfo.lineHeight;
442
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
443
- canvasPages.unshift(canvasPages.pop()!);
444
- canvasPages[0].lineNumStart =
445
- canvasPages[1].lineNumStart - maxLinesPerCanvasPage;
446
- canvasPages[0].lineNumEnd =
447
- canvasPages[0].lineNumStart + maxLinesPerCanvasPage;
448
- canvasPages[0].valid = false;
449
- }
450
- } else {
451
- const pageHeight = state.renderInfo.lineHeight * maxLinesPerCanvasPage;
452
- const page1Block = Math.ceil(scrollY / pageHeight);
453
- const page1LineStart = page1Block * maxLinesPerCanvasPage;
454
- const page0LineStart = page1LineStart - maxLinesPerCanvasPage;
455
- const page2LineStart = page1LineStart + maxLinesPerCanvasPage;
456
-
457
- // We haven't rendered anything yet, so we need to render the first page
458
- // If canvasPages already exist, let's re-use the textures
459
- canvasPages = [
460
- {
461
- texture: canvasPages?.[0].texture,
462
- lineNumStart: page0LineStart,
463
- lineNumEnd: page0LineStart + maxLinesPerCanvasPage,
464
- valid: false,
465
- },
466
- {
467
- texture: canvasPages?.[1].texture,
468
- lineNumStart: page1LineStart,
469
- lineNumEnd: page1LineStart + maxLinesPerCanvasPage,
470
- valid: false,
471
- },
472
- {
473
- texture: canvasPages?.[2].texture,
474
- lineNumStart: page2LineStart,
475
- lineNumEnd: page2LineStart + maxLinesPerCanvasPage,
476
- valid: false,
477
- },
478
- ];
479
- state.canvasPages = canvasPages;
480
-
481
- const scrollYNearestPage = page1Block * pageHeight;
482
-
483
- renderWindow = {
484
- x1: 0,
485
- y1: scrollYNearestPage - pageHeight,
486
- x2: width,
487
- y2: scrollYNearestPage + pageHeight * 2,
488
- };
489
- }
490
-
491
- state.renderWindow = renderWindow;
492
-
493
- const pageDrawTime = performance.now();
494
- for (const pageInfo of canvasPages) {
495
- if (pageInfo.valid) continue;
496
- if (pageInfo.lineNumStart < 0) {
497
- pageInfo.texture = this.stage.txManager.loadTexture('ImageTexture', {
498
- src: '',
499
- });
500
- pageInfo.valid = true;
501
- continue;
502
- }
503
- state.lightning2TextRenderer.draw(state.renderInfo, {
504
- lines: state.renderInfo.lines.slice(
505
- pageInfo.lineNumStart,
506
- pageInfo.lineNumEnd,
507
- ),
508
- lineWidths: state.renderInfo.lineWidths.slice(
509
- pageInfo.lineNumStart,
510
- pageInfo.lineNumEnd,
511
- ),
512
- });
513
- if (!(this.canvas.width === 0 || this.canvas.height === 0)) {
514
- pageInfo.texture = this.stage.txManager.loadTexture(
515
- 'ImageTexture',
516
- {
517
- src: this.context.getImageData(
518
- 0,
519
- 0,
520
- this.canvas.width,
521
- this.canvas.height,
522
- ),
523
- },
524
- {
525
- preload: true,
526
- },
527
- );
528
- }
529
- pageInfo.valid = true;
530
- }
531
- // console.log('pageDrawTime', performance.now() - pageDrawTime, 'ms');
532
-
533
- // Report final status
534
- this.setStatus(state, 'loaded');
535
- }
536
-
537
- override renderQuads(
538
- state: CanvasTextRendererState,
539
- transform: Matrix3d,
540
- clippingRect: RectWithValid,
541
- alpha: number,
542
- ): void {
543
- const { stage } = this;
544
-
545
- const { canvasPages, textW = 0, textH = 0, renderWindow } = state;
546
-
547
- if (!canvasPages || !renderWindow) return;
548
-
549
- const { x, y, scrollY, contain, width, height /*, debug*/ } = state.props;
550
-
551
- const elementRect = {
552
- x: x,
553
- y: y,
554
- width: contain !== 'none' ? width : textW,
555
- height: contain === 'both' ? height : textH,
556
- };
557
-
558
- const visibleRect = intersectRect(
559
- {
560
- x: 0,
561
- y: 0,
562
- width: stage.options.appWidth,
563
- height: stage.options.appHeight,
564
- },
565
- elementRect,
566
- );
567
-
568
- // if (!debug.disableScissor) {
569
- // renderer.enableScissor(
570
- // visibleRect.x,
571
- // visibleRect.y,
572
- // visibleRect.w,
573
- // visibleRect.h,
574
- // );
575
- // }
576
-
577
- assertTruthy(canvasPages, 'canvasPages is not defined');
578
- assertTruthy(renderWindow, 'renderWindow is not defined');
579
-
580
- const renderWindowHeight = renderWindow.y2 - renderWindow.y1;
581
- const pageSize = renderWindowHeight / 3.0;
582
-
583
- const { zIndex, color } = state.props;
584
-
585
- // Color alpha of text is not properly rendered to the Canvas texture, so we
586
- // need to apply it here.
587
- const combinedAlpha = alpha * getNormalizedAlphaComponent(color);
588
- const quadColor = mergeColorAlphaPremultiplied(0xffffffff, combinedAlpha);
589
- if (canvasPages[0].valid) {
590
- this.stage.renderer.addQuad({
591
- alpha: combinedAlpha,
592
- clippingRect,
593
- colorBl: quadColor,
594
- colorBr: quadColor,
595
- colorTl: quadColor,
596
- colorTr: quadColor,
597
- width: canvasPages[0].texture?.dimensions?.width || 0,
598
- height: canvasPages[0].texture?.dimensions?.height || 0,
599
- texture: canvasPages[0].texture!,
600
- textureOptions: {},
601
- shader: null,
602
- shaderProps: null,
603
- zIndex,
604
- tx: transform.tx,
605
- ty: transform.ty - scrollY + renderWindow.y1,
606
- ta: transform.ta,
607
- tb: transform.tb,
608
- tc: transform.tc,
609
- td: transform.td,
610
- });
611
- }
612
- if (canvasPages[1].valid) {
613
- this.stage.renderer.addQuad({
614
- alpha: combinedAlpha,
615
- clippingRect,
616
- colorBl: quadColor,
617
- colorBr: quadColor,
618
- colorTl: quadColor,
619
- colorTr: quadColor,
620
- width: canvasPages[1].texture?.dimensions?.width || 0,
621
- height: canvasPages[1].texture?.dimensions?.height || 0,
622
- texture: canvasPages[1].texture!,
623
- textureOptions: {},
624
- shader: null,
625
- shaderProps: null,
626
- zIndex,
627
- tx: transform.tx,
628
- ty: transform.ty - scrollY + renderWindow.y1 + pageSize,
629
- ta: transform.ta,
630
- tb: transform.tb,
631
- tc: transform.tc,
632
- td: transform.td,
633
- });
634
- }
635
- if (canvasPages[2].valid) {
636
- this.stage.renderer.addQuad({
637
- alpha: combinedAlpha,
638
- clippingRect,
639
- colorBl: quadColor,
640
- colorBr: quadColor,
641
- colorTl: quadColor,
642
- colorTr: quadColor,
643
- width: canvasPages[2].texture?.dimensions?.width || 0,
644
- height: canvasPages[2].texture?.dimensions?.height || 0,
645
- texture: canvasPages[2].texture!,
646
- textureOptions: {},
647
- shader: null,
648
- shaderProps: null,
649
- zIndex,
650
- tx: transform.tx,
651
- ty: transform.ty - scrollY + renderWindow.y1 + pageSize + pageSize,
652
- ta: transform.ta,
653
- tb: transform.tb,
654
- tc: transform.tc,
655
- td: transform.td,
656
- });
657
- }
658
-
659
- // renderer.disableScissor();
660
-
661
- // if (debug.showElementRect) {
662
- // this.renderer.drawBorder(
663
- // Colors.Blue,
664
- // elementRect.x,
665
- // elementRect.y,
666
- // elementRect.w,
667
- // elementRect.h,
668
- // );
669
- // }
670
-
671
- // if (debug.showVisibleRect) {
672
- // this.renderer.drawBorder(
673
- // Colors.Green,
674
- // visibleRect.x,
675
- // visibleRect.y,
676
- // visibleRect.w,
677
- // visibleRect.h,
678
- // );
679
- // }
680
-
681
- // if (debug.showRenderWindow && renderWindow) {
682
- // this.renderer.drawBorder(
683
- // Colors.Red,
684
- // x + renderWindow.x1,
685
- // y + renderWindow.y1 - scrollY,
686
- // x + renderWindow.x2 - (x + renderWindow.x1),
687
- // y + renderWindow.y2 - scrollY - (y + renderWindow.y1 - scrollY),
688
- // );
689
- // }
690
- }
691
- //#endregion Overrides
692
-
693
- /**
694
- * Invalidate the visible window stored in the state. This will cause a new
695
- * visible window to be calculated on the next update.
696
- *
697
- * @param state
698
- */
699
- protected invalidateVisibleWindowCache(state: CanvasTextRendererState): void {
700
- state.visibleWindow.valid = false;
701
- this.setStatus(state, 'loading');
702
- this.scheduleUpdateState(state);
703
- }
704
-
705
- /**
706
- * Invalidate the layout cache stored in the state. This will cause the text
707
- * to be re-layed out on the next update.
708
- *
709
- * @remarks
710
- * This also invalidates the visible window cache.
711
- *
712
- * @param state
713
- */
714
- private invalidateLayoutCache(state: CanvasTextRendererState): void {
715
- state.renderInfo = undefined;
716
- state.visibleWindow.valid = false;
717
- this.setStatus(state, 'loading');
718
- this.scheduleUpdateState(state);
719
- }
720
-
721
- private onFontLoaded(
722
- state: CanvasTextRendererState,
723
- cssString: string,
724
- ): void {
725
- if (cssString !== state.fontInfo?.cssString || !state.fontInfo) {
726
- return;
727
- }
728
- state.fontInfo.loaded = true;
729
- this.scheduleUpdateState(state);
730
- }
731
-
732
- private onFontLoadError(
733
- state: CanvasTextRendererState,
734
- cssString: string,
735
- error: Error,
736
- ): void {
737
- if (cssString !== state.fontInfo?.cssString || !state.fontInfo) {
738
- return;
739
- }
740
-
741
- // Font didn't actually load, but we'll log the error and mark it as loaded
742
- // because the browser can still render with a fallback font.
743
- state.fontInfo.loaded = true;
744
-
745
- console.error(
746
- `CanvasTextRenderer: Error loading font '${state.fontInfo.cssString}'`,
747
- error,
748
- );
749
- this.scheduleUpdateState(state);
750
- }
751
- }
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 { EventEmitter } from '../../../common/EventEmitter.js';
21
+ import { assertTruthy, mergeColorAlphaPremultiplied } from '../../../utils.js';
22
+ import type { Stage } from '../../Stage.js';
23
+ import type { Matrix3d } from '../../lib/Matrix3d.js';
24
+ import {
25
+ intersectRect,
26
+ type Bound,
27
+ intersectBound,
28
+ getNormalizedRgbaComponents,
29
+ type Rect,
30
+ getNormalizedAlphaComponent,
31
+ type BoundWithValid,
32
+ createBound,
33
+ type RectWithValid,
34
+ } from '../../lib/utils.js';
35
+ import type { ImageTexture } from '../../textures/ImageTexture.js';
36
+ import type { TrFontFace } from '../font-face-types/TrFontFace.js';
37
+ import { WebTrFontFace } from '../font-face-types/WebTrFontFace.js';
38
+ import {
39
+ LightningTextTextureRenderer,
40
+ type RenderInfo,
41
+ } from './LightningTextTextureRenderer.js';
42
+ import {
43
+ TextRenderer,
44
+ type TextRendererState,
45
+ type TrFontProps,
46
+ type TrPropSetters,
47
+ type TrProps,
48
+ } from './TextRenderer.js';
49
+
50
+ const resolvedGlobal = typeof self === 'undefined' ? globalThis : self;
51
+
52
+ /**
53
+ * Global font set regardless of if run in the main thread or a web worker
54
+ */
55
+ const globalFontSet = ((resolvedGlobal.document as any)?.fonts ||
56
+ (resolvedGlobal as any).fonts) as FontFaceSet;
57
+
58
+ declare module './TextRenderer.js' {
59
+ interface TextRendererMap {
60
+ canvas: CanvasTextRenderer;
61
+ }
62
+ }
63
+
64
+ interface CanvasPageInfo {
65
+ texture: ImageTexture | undefined;
66
+ lineNumStart: number;
67
+ lineNumEnd: number;
68
+ valid: boolean;
69
+ }
70
+
71
+ function getFontCssString(props: TrProps): string {
72
+ const { fontFamily, fontStyle, fontWeight, fontStretch, fontSize } = props;
73
+ return [fontStyle, fontWeight, fontStretch, `${fontSize}px`, fontFamily].join(
74
+ ' ',
75
+ );
76
+ }
77
+
78
+ export interface CanvasTextRendererState extends TextRendererState {
79
+ props: TrProps;
80
+
81
+ fontFaceLoadedHandler: (() => void) | undefined;
82
+ fontInfo:
83
+ | {
84
+ cssString: string;
85
+ loaded: boolean;
86
+ }
87
+ | undefined;
88
+ canvasPages: [CanvasPageInfo, CanvasPageInfo, CanvasPageInfo] | undefined;
89
+ lightning2TextRenderer: LightningTextTextureRenderer;
90
+ renderInfo: RenderInfo | undefined;
91
+ renderWindow: Bound | undefined;
92
+ visibleWindow: BoundWithValid;
93
+ }
94
+
95
+ /**
96
+ * Ephemeral bounds object used for intersection calculations
97
+ *
98
+ * @remarks
99
+ * Used to avoid creating a new object every time we need to intersect
100
+ * element bounds.
101
+ */
102
+ const tmpElementBounds = createBound(0, 0, 0, 0);
103
+
104
+ export class CanvasTextRenderer extends TextRenderer<CanvasTextRendererState> {
105
+ protected canvas: OffscreenCanvas | HTMLCanvasElement;
106
+ protected context:
107
+ | OffscreenCanvasRenderingContext2D
108
+ | CanvasRenderingContext2D;
109
+ private rendererBounds: Bound;
110
+
111
+ constructor(stage: Stage) {
112
+ super(stage);
113
+ if (typeof OffscreenCanvas !== 'undefined') {
114
+ this.canvas = new OffscreenCanvas(0, 0);
115
+ } else {
116
+ this.canvas = document.createElement('canvas');
117
+ }
118
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
119
+ let context = this.canvas.getContext('2d') as
120
+ | OffscreenCanvasRenderingContext2D
121
+ | CanvasRenderingContext2D
122
+ | null;
123
+ if (!context) {
124
+ // A browser may appear to support OffscreenCanvas but not actually support the Canvas '2d' context
125
+ // Here we try getting the context again after falling back to an HTMLCanvasElement.
126
+ // See: https://github.com/lightning-js/renderer/issues/26#issuecomment-1750438486
127
+ this.canvas = document.createElement('canvas');
128
+ context = this.canvas.getContext('2d');
129
+ }
130
+ assertTruthy(context);
131
+ this.context = context;
132
+ this.rendererBounds = {
133
+ x1: 0,
134
+ y1: 0,
135
+ x2: this.stage.options.appWidth,
136
+ y2: this.stage.options.appHeight,
137
+ };
138
+ }
139
+
140
+ //#region Overrides
141
+ override getPropertySetters(): Partial<
142
+ TrPropSetters<CanvasTextRendererState>
143
+ > {
144
+ return {
145
+ fontFamily: (state, value) => {
146
+ state.props.fontFamily = value;
147
+ state.fontInfo = undefined;
148
+ this.invalidateLayoutCache(state);
149
+ },
150
+ fontWeight: (state, value) => {
151
+ state.props.fontWeight = value;
152
+ state.fontInfo = undefined;
153
+ this.invalidateLayoutCache(state);
154
+ },
155
+ fontStyle: (state, value) => {
156
+ state.props.fontStyle = value;
157
+ state.fontInfo = undefined;
158
+ this.invalidateLayoutCache(state);
159
+ },
160
+ fontStretch: (state, value) => {
161
+ state.props.fontStretch = value;
162
+ state.fontInfo = undefined;
163
+ this.invalidateLayoutCache(state);
164
+ },
165
+ fontSize: (state, value) => {
166
+ state.props.fontSize = value;
167
+ state.fontInfo = undefined;
168
+ this.invalidateLayoutCache(state);
169
+ },
170
+ text: (state, value) => {
171
+ state.props.text = value;
172
+ this.invalidateLayoutCache(state);
173
+ },
174
+ textAlign: (state, value) => {
175
+ state.props.textAlign = value;
176
+ this.invalidateLayoutCache(state);
177
+ },
178
+ color: (state, value) => {
179
+ state.props.color = value;
180
+ this.invalidateLayoutCache(state);
181
+ },
182
+ x: (state, value) => {
183
+ state.props.x = value;
184
+ this.invalidateVisibleWindowCache(state);
185
+ },
186
+ y: (state, value) => {
187
+ state.props.y = value;
188
+ this.invalidateVisibleWindowCache(state);
189
+ },
190
+ contain: (state, value) => {
191
+ state.props.contain = value;
192
+ this.invalidateLayoutCache(state);
193
+ },
194
+ width: (state, value) => {
195
+ state.props.width = value;
196
+ // Only invalidate layout cache if we're containing in the horizontal direction
197
+ if (state.props.contain !== 'none') {
198
+ this.invalidateLayoutCache(state);
199
+ }
200
+ },
201
+ height: (state, value) => {
202
+ state.props.height = value;
203
+ // Only invalidate layout cache if we're containing in the vertical direction
204
+ if (state.props.contain === 'both') {
205
+ this.invalidateLayoutCache(state);
206
+ }
207
+ },
208
+ offsetY: (state, value) => {
209
+ state.props.offsetY = value;
210
+ this.invalidateLayoutCache(state);
211
+ },
212
+ scrollY: (state, value) => {
213
+ state.props.scrollY = value;
214
+ },
215
+ letterSpacing: (state, value) => {
216
+ state.props.letterSpacing = value;
217
+ this.invalidateLayoutCache(state);
218
+ },
219
+ lineHeight: (state, value) => {
220
+ state.props.lineHeight = value;
221
+ this.invalidateLayoutCache(state);
222
+ },
223
+ maxLines: (state, value) => {
224
+ state.props.maxLines = value;
225
+ this.invalidateLayoutCache(state);
226
+ },
227
+ textBaseline: (state, value) => {
228
+ state.props.textBaseline = value;
229
+ this.invalidateLayoutCache(state);
230
+ },
231
+ verticalAlign: (state, value) => {
232
+ state.props.verticalAlign = value;
233
+ this.invalidateLayoutCache(state);
234
+ },
235
+ overflowSuffix: (state, value) => {
236
+ state.props.overflowSuffix = value;
237
+ this.invalidateLayoutCache(state);
238
+ },
239
+ // debug: (state, value) => {
240
+ // state.props.debug = value;
241
+ // },
242
+ };
243
+ }
244
+
245
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
246
+ override canRenderFont(props: TrFontProps): boolean {
247
+ // The canvas renderer can render any font because it automatically
248
+ // falls back to system fonts. The CanvasTextRenderer should be
249
+ // checked last if other renderers are preferred.
250
+ return true;
251
+ }
252
+
253
+ override isFontFaceSupported(fontFace: TrFontFace): boolean {
254
+ return fontFace instanceof WebTrFontFace;
255
+ }
256
+
257
+ override addFontFace(fontFace: TrFontFace): void {
258
+ // Make sure the font face is an Canvas font face (it should have already passed
259
+ // the `isFontFaceSupported` check)
260
+ assertTruthy(fontFace instanceof WebTrFontFace);
261
+
262
+ // We simply add the font face to the document
263
+ // @ts-expect-error `add()` method should be available from a FontFaceSet
264
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-call
265
+ globalFontSet.add(fontFace.fontFace);
266
+ }
267
+
268
+ override createState(props: TrProps): CanvasTextRendererState {
269
+ return {
270
+ props,
271
+ status: 'initialState',
272
+ updateScheduled: false,
273
+ emitter: new EventEmitter(),
274
+ canvasPages: undefined,
275
+ lightning2TextRenderer: new LightningTextTextureRenderer(
276
+ this.canvas,
277
+ this.context,
278
+ ),
279
+ renderWindow: undefined,
280
+ visibleWindow: {
281
+ x1: 0,
282
+ y1: 0,
283
+ x2: 0,
284
+ y2: 0,
285
+ valid: false,
286
+ },
287
+ renderInfo: undefined,
288
+ forceFullLayoutCalc: false,
289
+ textW: 0,
290
+ textH: 0,
291
+ fontInfo: undefined,
292
+ fontFaceLoadedHandler: undefined,
293
+ isRenderable: false,
294
+ debugData: {
295
+ updateCount: 0,
296
+ layoutCount: 0,
297
+ drawCount: 0,
298
+ lastLayoutNumCharacters: 0,
299
+ layoutSum: 0,
300
+ drawSum: 0,
301
+ bufferSize: 0,
302
+ },
303
+ };
304
+ }
305
+
306
+ override updateState(state: CanvasTextRendererState): void {
307
+ // On the first update call we need to set the status to loading
308
+ if (state.status === 'initialState') {
309
+ this.setStatus(state, 'loading');
310
+ }
311
+
312
+ // If fontInfo is invalid, we need to establish it
313
+ if (!state.fontInfo) {
314
+ const cssString = getFontCssString(state.props);
315
+ state.fontInfo = {
316
+ cssString: cssString,
317
+ // TODO: For efficiency we would use this here but it's not reliable on WPE -> document.fonts.check(cssString),
318
+ loaded: false,
319
+ };
320
+ // If font is not loaded, set up a handler to update the font info when the font loads
321
+ if (!state.fontInfo.loaded) {
322
+ globalFontSet
323
+ .load(cssString)
324
+ .then(this.onFontLoaded.bind(this, state, cssString))
325
+ .catch(this.onFontLoadError.bind(this, state, cssString));
326
+ return;
327
+ }
328
+ }
329
+
330
+ // If we're waiting for a font face to load, don't render anything
331
+ if (!state.fontInfo.loaded) {
332
+ return;
333
+ }
334
+
335
+ if (!state.renderInfo) {
336
+ const maxLines = state.props.maxLines;
337
+ const containedMaxLines =
338
+ state.props.contain === 'both'
339
+ ? Math.floor(
340
+ (state.props.height - state.props.offsetY) /
341
+ state.props.lineHeight,
342
+ )
343
+ : 0;
344
+ const calcMaxLines =
345
+ containedMaxLines > 0 && maxLines > 0
346
+ ? Math.min(containedMaxLines, maxLines)
347
+ : Math.max(containedMaxLines, maxLines);
348
+ state.lightning2TextRenderer.settings = {
349
+ text: state.props.text,
350
+ textAlign: state.props.textAlign,
351
+ fontFace: state.props.fontFamily,
352
+ fontSize: state.props.fontSize,
353
+ fontStyle: [
354
+ state.props.fontStretch,
355
+ state.props.fontStyle,
356
+ state.props.fontWeight,
357
+ ].join(' '),
358
+ textColor: getNormalizedRgbaComponents(state.props.color),
359
+ offsetY: state.props.fontSize + state.props.offsetY,
360
+ wordWrap: state.props.contain !== 'none',
361
+ wordWrapWidth:
362
+ state.props.contain === 'none' ? undefined : state.props.width,
363
+ letterSpacing: state.props.letterSpacing,
364
+ lineHeight: state.props.lineHeight,
365
+ maxLines: calcMaxLines,
366
+ textBaseline: state.props.textBaseline,
367
+ verticalAlign: state.props.verticalAlign,
368
+ overflowSuffix: state.props.overflowSuffix,
369
+ };
370
+ // const renderInfoCalculateTime = performance.now();
371
+ state.renderInfo = state.lightning2TextRenderer.calculateRenderInfo();
372
+ // console.log(
373
+ // 'Render info calculated in',
374
+ // performance.now() - renderInfoCalculateTime,
375
+ // 'ms',
376
+ // );
377
+ state.textH = state.renderInfo.lineHeight * state.renderInfo.lines.length;
378
+ state.textW = state.renderInfo.width;
379
+
380
+ // Invalidate renderWindow because the renderInfo changed
381
+ state.renderWindow = undefined;
382
+ }
383
+
384
+ const { x, y, width, height, scrollY, contain } = state.props;
385
+ const { visibleWindow } = state;
386
+ let { renderWindow, canvasPages } = state;
387
+
388
+ if (!visibleWindow.valid) {
389
+ // Figure out whats actually in the bounds of the renderer/canvas (visibleWindow)
390
+ const elementBounds = createBound(
391
+ x,
392
+ y,
393
+ contain !== 'none' ? x + width : Infinity,
394
+ contain === 'both' ? y + height : Infinity,
395
+ tmpElementBounds,
396
+ );
397
+ /**
398
+ * Area that is visible on the screen.
399
+ */
400
+ intersectBound(this.rendererBounds, elementBounds, visibleWindow);
401
+ visibleWindow.valid = true;
402
+ }
403
+
404
+ const visibleWindowHeight = visibleWindow.y2 - visibleWindow.y1;
405
+
406
+ const maxLinesPerCanvasPage = Math.ceil(
407
+ visibleWindowHeight / state.renderInfo.lineHeight,
408
+ );
409
+
410
+ if (visibleWindowHeight === 0) {
411
+ // Nothing to render. Clear any canvasPages and existing renderWindow
412
+ // Return early.
413
+ canvasPages = undefined;
414
+ renderWindow = undefined;
415
+ this.setStatus(state, 'loaded');
416
+ return;
417
+ } else if (renderWindow && canvasPages) {
418
+ // Return early if we're still viewing inside the established render window
419
+ // No need to re-render what we've already rendered
420
+ const renderWindowScreenX1 = x + renderWindow.x1;
421
+ const renderWindowScreenY1 = y - scrollY + renderWindow.y1;
422
+ const renderWindowScreenX2 = x + renderWindow.x2;
423
+ const renderWindowScreenY2 = y - scrollY + renderWindow.y2;
424
+
425
+ if (
426
+ renderWindowScreenX1 <= visibleWindow.x1 &&
427
+ renderWindowScreenX2 >= visibleWindow.x2 &&
428
+ renderWindowScreenY1 <= visibleWindow.y1 &&
429
+ renderWindowScreenY2 >= visibleWindow.y2
430
+ ) {
431
+ this.setStatus(state, 'loaded');
432
+ return;
433
+ }
434
+ if (renderWindowScreenY2 < visibleWindow.y2) {
435
+ // We've scrolled up, so we need to render the next page
436
+ renderWindow.y1 += maxLinesPerCanvasPage * state.renderInfo.lineHeight;
437
+ renderWindow.y2 += maxLinesPerCanvasPage * state.renderInfo.lineHeight;
438
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
439
+ canvasPages.push(canvasPages.shift()!);
440
+ canvasPages[2].lineNumStart =
441
+ canvasPages[1].lineNumStart + maxLinesPerCanvasPage;
442
+ canvasPages[2].lineNumEnd =
443
+ canvasPages[2].lineNumStart + maxLinesPerCanvasPage;
444
+ canvasPages[2].valid = false;
445
+ } else if (renderWindowScreenY1 > visibleWindow.y1) {
446
+ // We've scrolled down, so we need to render the previous page
447
+ renderWindow.y1 -= maxLinesPerCanvasPage * state.renderInfo.lineHeight;
448
+ renderWindow.y2 -= maxLinesPerCanvasPage * state.renderInfo.lineHeight;
449
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
450
+ canvasPages.unshift(canvasPages.pop()!);
451
+ canvasPages[0].lineNumStart =
452
+ canvasPages[1].lineNumStart - maxLinesPerCanvasPage;
453
+ canvasPages[0].lineNumEnd =
454
+ canvasPages[0].lineNumStart + maxLinesPerCanvasPage;
455
+ canvasPages[0].valid = false;
456
+ }
457
+ } else {
458
+ const pageHeight = state.renderInfo.lineHeight * maxLinesPerCanvasPage;
459
+ const page1Block = Math.ceil(scrollY / pageHeight);
460
+ const page1LineStart = page1Block * maxLinesPerCanvasPage;
461
+ const page0LineStart = page1LineStart - maxLinesPerCanvasPage;
462
+ const page2LineStart = page1LineStart + maxLinesPerCanvasPage;
463
+
464
+ // We haven't rendered anything yet, so we need to render the first page
465
+ // If canvasPages already exist, let's re-use the textures
466
+ canvasPages = [
467
+ {
468
+ texture: canvasPages?.[0].texture,
469
+ lineNumStart: page0LineStart,
470
+ lineNumEnd: page0LineStart + maxLinesPerCanvasPage,
471
+ valid: false,
472
+ },
473
+ {
474
+ texture: canvasPages?.[1].texture,
475
+ lineNumStart: page1LineStart,
476
+ lineNumEnd: page1LineStart + maxLinesPerCanvasPage,
477
+ valid: false,
478
+ },
479
+ {
480
+ texture: canvasPages?.[2].texture,
481
+ lineNumStart: page2LineStart,
482
+ lineNumEnd: page2LineStart + maxLinesPerCanvasPage,
483
+ valid: false,
484
+ },
485
+ ];
486
+ state.canvasPages = canvasPages;
487
+
488
+ const scrollYNearestPage = page1Block * pageHeight;
489
+
490
+ renderWindow = {
491
+ x1: 0,
492
+ y1: scrollYNearestPage - pageHeight,
493
+ x2: width,
494
+ y2: scrollYNearestPage + pageHeight * 2,
495
+ };
496
+ }
497
+
498
+ state.renderWindow = renderWindow;
499
+
500
+ const pageDrawTime = performance.now();
501
+ for (const pageInfo of canvasPages) {
502
+ if (pageInfo.valid) continue;
503
+ if (pageInfo.lineNumStart < 0) {
504
+ pageInfo.texture?.setRenderableOwner(state, false);
505
+ pageInfo.texture = this.stage.txManager.loadTexture('ImageTexture', {
506
+ src: '',
507
+ });
508
+ pageInfo.texture.setRenderableOwner(state, state.isRenderable);
509
+ pageInfo.valid = true;
510
+ continue;
511
+ }
512
+ state.lightning2TextRenderer.draw(state.renderInfo, {
513
+ lines: state.renderInfo.lines.slice(
514
+ pageInfo.lineNumStart,
515
+ pageInfo.lineNumEnd,
516
+ ),
517
+ lineWidths: state.renderInfo.lineWidths.slice(
518
+ pageInfo.lineNumStart,
519
+ pageInfo.lineNumEnd,
520
+ ),
521
+ });
522
+ if (!(this.canvas.width === 0 || this.canvas.height === 0)) {
523
+ pageInfo.texture?.setRenderableOwner(state, false);
524
+ pageInfo.texture = this.stage.txManager.loadTexture(
525
+ 'ImageTexture',
526
+ {
527
+ src: this.context.getImageData(
528
+ 0,
529
+ 0,
530
+ this.canvas.width,
531
+ this.canvas.height,
532
+ ),
533
+ },
534
+ {
535
+ preload: true,
536
+ },
537
+ );
538
+ pageInfo.texture.setRenderableOwner(state, state.isRenderable);
539
+ }
540
+ pageInfo.valid = true;
541
+ }
542
+ // console.log('pageDrawTime', performance.now() - pageDrawTime, 'ms');
543
+
544
+ // Report final status
545
+ this.setStatus(state, 'loaded');
546
+ }
547
+
548
+ override renderQuads(
549
+ state: CanvasTextRendererState,
550
+ transform: Matrix3d,
551
+ clippingRect: RectWithValid,
552
+ alpha: number,
553
+ ): void {
554
+ const { stage } = this;
555
+
556
+ const { canvasPages, textW = 0, textH = 0, renderWindow } = state;
557
+
558
+ if (!canvasPages || !renderWindow) return;
559
+
560
+ const { x, y, scrollY, contain, width, height /*, debug*/ } = state.props;
561
+
562
+ const elementRect = {
563
+ x: x,
564
+ y: y,
565
+ width: contain !== 'none' ? width : textW,
566
+ height: contain === 'both' ? height : textH,
567
+ };
568
+
569
+ const visibleRect = intersectRect(
570
+ {
571
+ x: 0,
572
+ y: 0,
573
+ width: stage.options.appWidth,
574
+ height: stage.options.appHeight,
575
+ },
576
+ elementRect,
577
+ );
578
+
579
+ // if (!debug.disableScissor) {
580
+ // renderer.enableScissor(
581
+ // visibleRect.x,
582
+ // visibleRect.y,
583
+ // visibleRect.w,
584
+ // visibleRect.h,
585
+ // );
586
+ // }
587
+
588
+ assertTruthy(canvasPages, 'canvasPages is not defined');
589
+ assertTruthy(renderWindow, 'renderWindow is not defined');
590
+
591
+ const renderWindowHeight = renderWindow.y2 - renderWindow.y1;
592
+ const pageSize = renderWindowHeight / 3.0;
593
+
594
+ const { zIndex, color } = state.props;
595
+
596
+ // Color alpha of text is not properly rendered to the Canvas texture, so we
597
+ // need to apply it here.
598
+ const combinedAlpha = alpha * getNormalizedAlphaComponent(color);
599
+ const quadColor = mergeColorAlphaPremultiplied(0xffffffff, combinedAlpha);
600
+ if (canvasPages[0].valid) {
601
+ this.stage.renderer.addQuad({
602
+ alpha: combinedAlpha,
603
+ clippingRect,
604
+ colorBl: quadColor,
605
+ colorBr: quadColor,
606
+ colorTl: quadColor,
607
+ colorTr: quadColor,
608
+ width: canvasPages[0].texture?.dimensions?.width || 0,
609
+ height: canvasPages[0].texture?.dimensions?.height || 0,
610
+ texture: canvasPages[0].texture!,
611
+ textureOptions: {},
612
+ shader: null,
613
+ shaderProps: null,
614
+ zIndex,
615
+ tx: transform.tx,
616
+ ty: transform.ty - scrollY + renderWindow.y1,
617
+ ta: transform.ta,
618
+ tb: transform.tb,
619
+ tc: transform.tc,
620
+ td: transform.td,
621
+ });
622
+ }
623
+ if (canvasPages[1].valid) {
624
+ this.stage.renderer.addQuad({
625
+ alpha: combinedAlpha,
626
+ clippingRect,
627
+ colorBl: quadColor,
628
+ colorBr: quadColor,
629
+ colorTl: quadColor,
630
+ colorTr: quadColor,
631
+ width: canvasPages[1].texture?.dimensions?.width || 0,
632
+ height: canvasPages[1].texture?.dimensions?.height || 0,
633
+ texture: canvasPages[1].texture!,
634
+ textureOptions: {},
635
+ shader: null,
636
+ shaderProps: null,
637
+ zIndex,
638
+ tx: transform.tx,
639
+ ty: transform.ty - scrollY + renderWindow.y1 + pageSize,
640
+ ta: transform.ta,
641
+ tb: transform.tb,
642
+ tc: transform.tc,
643
+ td: transform.td,
644
+ });
645
+ }
646
+ if (canvasPages[2].valid) {
647
+ this.stage.renderer.addQuad({
648
+ alpha: combinedAlpha,
649
+ clippingRect,
650
+ colorBl: quadColor,
651
+ colorBr: quadColor,
652
+ colorTl: quadColor,
653
+ colorTr: quadColor,
654
+ width: canvasPages[2].texture?.dimensions?.width || 0,
655
+ height: canvasPages[2].texture?.dimensions?.height || 0,
656
+ texture: canvasPages[2].texture!,
657
+ textureOptions: {},
658
+ shader: null,
659
+ shaderProps: null,
660
+ zIndex,
661
+ tx: transform.tx,
662
+ ty: transform.ty - scrollY + renderWindow.y1 + pageSize + pageSize,
663
+ ta: transform.ta,
664
+ tb: transform.tb,
665
+ tc: transform.tc,
666
+ td: transform.td,
667
+ });
668
+ }
669
+
670
+ // renderer.disableScissor();
671
+
672
+ // if (debug.showElementRect) {
673
+ // this.renderer.drawBorder(
674
+ // Colors.Blue,
675
+ // elementRect.x,
676
+ // elementRect.y,
677
+ // elementRect.w,
678
+ // elementRect.h,
679
+ // );
680
+ // }
681
+
682
+ // if (debug.showVisibleRect) {
683
+ // this.renderer.drawBorder(
684
+ // Colors.Green,
685
+ // visibleRect.x,
686
+ // visibleRect.y,
687
+ // visibleRect.w,
688
+ // visibleRect.h,
689
+ // );
690
+ // }
691
+
692
+ // if (debug.showRenderWindow && renderWindow) {
693
+ // this.renderer.drawBorder(
694
+ // Colors.Red,
695
+ // x + renderWindow.x1,
696
+ // y + renderWindow.y1 - scrollY,
697
+ // x + renderWindow.x2 - (x + renderWindow.x1),
698
+ // y + renderWindow.y2 - scrollY - (y + renderWindow.y1 - scrollY),
699
+ // );
700
+ // }
701
+ }
702
+
703
+ override setIsRenderable(
704
+ state: CanvasTextRendererState,
705
+ renderable: boolean,
706
+ ): void {
707
+ super.setIsRenderable(state, renderable);
708
+ // Set state object owner from any canvas page textures
709
+ state.canvasPages?.forEach((pageInfo) => {
710
+ pageInfo.texture?.setRenderableOwner(state, renderable);
711
+ });
712
+ }
713
+
714
+ override destroyState(state: CanvasTextRendererState): void {
715
+ // Remove state object owner from any canvas page textures
716
+ state.canvasPages?.forEach((pageInfo) => {
717
+ pageInfo.texture?.setRenderableOwner(state, false);
718
+ });
719
+ }
720
+ //#endregion Overrides
721
+
722
+ /**
723
+ * Invalidate the visible window stored in the state. This will cause a new
724
+ * visible window to be calculated on the next update.
725
+ *
726
+ * @param state
727
+ */
728
+ protected invalidateVisibleWindowCache(state: CanvasTextRendererState): void {
729
+ state.visibleWindow.valid = false;
730
+ this.setStatus(state, 'loading');
731
+ this.scheduleUpdateState(state);
732
+ }
733
+
734
+ /**
735
+ * Invalidate the layout cache stored in the state. This will cause the text
736
+ * to be re-layed out on the next update.
737
+ *
738
+ * @remarks
739
+ * This also invalidates the visible window cache.
740
+ *
741
+ * @param state
742
+ */
743
+ private invalidateLayoutCache(state: CanvasTextRendererState): void {
744
+ state.renderInfo = undefined;
745
+ state.visibleWindow.valid = false;
746
+ this.setStatus(state, 'loading');
747
+ this.scheduleUpdateState(state);
748
+ }
749
+
750
+ private onFontLoaded(
751
+ state: CanvasTextRendererState,
752
+ cssString: string,
753
+ ): void {
754
+ if (cssString !== state.fontInfo?.cssString || !state.fontInfo) {
755
+ return;
756
+ }
757
+ state.fontInfo.loaded = true;
758
+ this.scheduleUpdateState(state);
759
+ }
760
+
761
+ private onFontLoadError(
762
+ state: CanvasTextRendererState,
763
+ cssString: string,
764
+ error: Error,
765
+ ): void {
766
+ if (cssString !== state.fontInfo?.cssString || !state.fontInfo) {
767
+ return;
768
+ }
769
+
770
+ // Font didn't actually load, but we'll log the error and mark it as loaded
771
+ // because the browser can still render with a fallback font.
772
+ state.fontInfo.loaded = true;
773
+
774
+ console.error(
775
+ `CanvasTextRenderer: Error loading font '${state.fontInfo.cssString}'`,
776
+ error,
777
+ );
778
+ this.scheduleUpdateState(state);
779
+ }
780
+ }