@lightningjs/renderer 0.7.4 → 0.7.6

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