@lightningjs/renderer 0.7.1 → 0.7.3

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 (215) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +221 -221
  5. package/dist/exports/main-api.d.ts +1 -0
  6. package/dist/src/common/CommonTypes.d.ts +7 -0
  7. package/dist/src/core/CoreShaderManager.d.ts +13 -6
  8. package/dist/src/core/CoreShaderManager.js +6 -6
  9. package/dist/src/core/CoreShaderManager.js.map +1 -1
  10. package/dist/src/core/Stage.d.ts +2 -1
  11. package/dist/src/core/Stage.js +4 -0
  12. package/dist/src/core/Stage.js.map +1 -1
  13. package/dist/src/core/animations/CoreAnimation.js +3 -0
  14. package/dist/src/core/animations/CoreAnimation.js.map +1 -1
  15. package/dist/src/core/animations/CoreAnimationController.d.ts +8 -0
  16. package/dist/src/core/animations/CoreAnimationController.js +26 -0
  17. package/dist/src/core/animations/CoreAnimationController.js.map +1 -1
  18. package/dist/src/core/lib/ImageWorker.js +21 -21
  19. package/dist/src/core/lib/WebGlContextWrapper.d.ts +9 -0
  20. package/dist/src/core/lib/WebGlContextWrapper.js +12 -0
  21. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  22. package/dist/src/core/lib/textureCompression.d.ts +16 -0
  23. package/dist/src/core/lib/textureCompression.js +129 -0
  24. package/dist/src/core/lib/textureCompression.js.map +1 -0
  25. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +12 -0
  26. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  27. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +47 -47
  28. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  29. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  30. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  31. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +49 -49
  32. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  33. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +5 -5
  34. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  35. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  36. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  37. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  38. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  39. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  40. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +31 -31
  41. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +13 -13
  42. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  43. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  44. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.d.ts +4 -0
  45. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +11 -0
  46. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  47. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.js.map +1 -1
  48. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +10 -1
  49. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  50. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +21 -7
  51. package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
  52. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  53. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +2 -1
  54. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  55. package/dist/src/core/textures/ImageTexture.js +5 -0
  56. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  57. package/dist/src/core/textures/Texture.d.ts +28 -1
  58. package/dist/src/core/textures/Texture.js.map +1 -1
  59. package/dist/src/main-api/ICoreDriver.d.ts +2 -1
  60. package/dist/src/main-api/Inspector.d.ts +21 -0
  61. package/dist/src/main-api/Inspector.js +302 -0
  62. package/dist/src/main-api/Inspector.js.map +1 -0
  63. package/dist/src/main-api/RendererMain.d.ts +12 -0
  64. package/dist/src/main-api/RendererMain.js +19 -1
  65. package/dist/src/main-api/RendererMain.js.map +1 -1
  66. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +2 -1
  67. package/dist/src/render-drivers/main/MainCoreDriver.js +7 -1
  68. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -1
  69. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +2 -1
  70. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +7 -0
  71. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -1
  72. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +9 -1
  73. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -1
  74. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  75. package/exports/core-api.ts +102 -102
  76. package/exports/main-api.ts +60 -51
  77. package/exports/utils.ts +41 -41
  78. package/package.json +5 -3
  79. package/scripts/please-use-pnpm.js +13 -0
  80. package/src/common/CommonTypes.ts +113 -105
  81. package/src/common/EventEmitter.ts +77 -77
  82. package/src/common/IAnimationController.ts +29 -29
  83. package/src/core/CoreExtension.ts +32 -32
  84. package/src/core/CoreNode.ts +926 -926
  85. package/src/core/CoreShaderManager.ts +243 -210
  86. package/src/core/CoreTextNode.ts +391 -391
  87. package/src/core/CoreTextureManager.ts +326 -326
  88. package/src/core/Stage.ts +354 -342
  89. package/src/core/animations/AnimationManager.ts +38 -38
  90. package/src/core/animations/CoreAnimation.ts +181 -177
  91. package/src/core/animations/CoreAnimationController.ts +148 -117
  92. package/src/core/lib/ContextSpy.ts +41 -41
  93. package/src/core/lib/ImageWorker.ts +124 -124
  94. package/src/core/lib/Matrix3d.ts +290 -290
  95. package/src/core/lib/WebGlContextWrapper.ts +992 -965
  96. package/src/core/lib/textureCompression.ts +152 -0
  97. package/src/core/lib/utils.ts +241 -241
  98. package/src/core/platform.ts +46 -46
  99. package/src/core/renderers/CoreContextTexture.ts +30 -30
  100. package/src/core/renderers/CoreRenderOp.ts +22 -22
  101. package/src/core/renderers/CoreRenderer.ts +63 -63
  102. package/src/core/renderers/CoreShader.ts +41 -41
  103. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +37 -37
  104. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +231 -211
  105. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +107 -107
  106. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +520 -520
  107. package/src/core/renderers/webgl/WebGlCoreShader.ts +337 -337
  108. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  109. package/src/core/renderers/webgl/internal/RendererUtils.ts +131 -131
  110. package/src/core/renderers/webgl/internal/ShaderUtils.ts +136 -136
  111. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  112. package/src/core/renderers/webgl/shaders/DefaultShader.ts +95 -95
  113. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  114. package/src/core/renderers/webgl/shaders/DynamicShader.ts +474 -474
  115. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +161 -161
  116. package/src/core/renderers/webgl/shaders/SdfShader.ts +174 -174
  117. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  118. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +86 -86
  119. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  120. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  121. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  122. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +33 -33
  123. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +135 -135
  124. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +145 -145
  125. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  126. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +176 -176
  127. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +159 -159
  128. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +186 -186
  129. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +121 -121
  130. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +114 -114
  131. package/src/core/text-rendering/TextTextureRendererUtils.ts +189 -189
  132. package/src/core/text-rendering/TrFontManager.ts +96 -96
  133. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +141 -127
  134. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  135. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -165
  136. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +169 -166
  137. package/src/core/text-rendering/font-face-types/TrFontFace.ts +105 -105
  138. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +77 -77
  139. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +751 -738
  140. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +741 -707
  141. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +775 -777
  142. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  143. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  144. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  145. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  146. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +84 -84
  147. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  148. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  149. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +393 -392
  150. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -46
  151. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +51 -51
  152. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  153. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  154. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  155. package/src/core/text-rendering/renderers/TextRenderer.ts +504 -504
  156. package/src/core/textures/ColorTexture.ts +86 -86
  157. package/src/core/textures/ImageTexture.ts +133 -124
  158. package/src/core/textures/NoiseTexture.ts +96 -96
  159. package/src/core/textures/SubTexture.ts +143 -143
  160. package/src/core/textures/Texture.ts +218 -186
  161. package/src/core/utils.ts +224 -224
  162. package/src/env.d.ts +7 -7
  163. package/src/main-api/ICoreDriver.ts +66 -61
  164. package/src/main-api/INode.ts +470 -470
  165. package/src/main-api/Inspector.ts +432 -0
  166. package/src/main-api/RendererMain.ts +649 -610
  167. package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts +45 -45
  168. package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts +154 -154
  169. package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts +54 -54
  170. package/src/render-drivers/main/MainCoreDriver.ts +148 -133
  171. package/src/render-drivers/main/MainOnlyNode.ts +453 -453
  172. package/src/render-drivers/main/MainOnlyTextNode.ts +261 -261
  173. package/src/render-drivers/threadx/NodeStruct.ts +300 -300
  174. package/src/render-drivers/threadx/SharedNode.ts +97 -97
  175. package/src/render-drivers/threadx/TextNodeStruct.ts +211 -211
  176. package/src/render-drivers/threadx/ThreadXCoreDriver.ts +285 -273
  177. package/src/render-drivers/threadx/ThreadXMainAnimationController.ts +99 -99
  178. package/src/render-drivers/threadx/ThreadXMainNode.ts +178 -178
  179. package/src/render-drivers/threadx/ThreadXMainTextNode.ts +85 -85
  180. package/src/render-drivers/threadx/ThreadXRendererMessage.ts +110 -97
  181. package/src/render-drivers/threadx/worker/ThreadXRendererNode.ts +238 -238
  182. package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts +149 -149
  183. package/src/render-drivers/threadx/worker/renderer.ts +151 -151
  184. package/src/render-drivers/utils.ts +57 -57
  185. package/src/utils.ts +207 -207
  186. package/dist/src/core/lib/WebGlContext.d.ts +0 -414
  187. package/dist/src/core/lib/WebGlContext.js +0 -640
  188. package/dist/src/core/lib/WebGlContext.js.map +0 -1
  189. package/dist/src/core/scene/Scene.d.ts +0 -59
  190. package/dist/src/core/scene/Scene.js +0 -106
  191. package/dist/src/core/scene/Scene.js.map +0 -1
  192. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.d.ts +0 -8
  193. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js +0 -29
  194. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js.map +0 -1
  195. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.d.ts +0 -19
  196. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js +0 -84
  197. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js.map +0 -1
  198. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.d.ts +0 -8
  199. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js +0 -40
  200. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js.map +0 -1
  201. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.d.ts +0 -2
  202. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js +0 -41
  203. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js.map +0 -1
  204. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.d.ts +0 -1
  205. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js +0 -4
  206. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js.map +0 -1
  207. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.d.ts +0 -1
  208. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js +0 -2
  209. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js.map +0 -1
  210. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +0 -20
  211. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +0 -55
  212. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +0 -1
  213. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.d.ts +0 -9
  214. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js +0 -32
  215. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js.map +0 -1
@@ -1,391 +1,391 @@
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 type {
21
- TextRenderer,
22
- TextRendererMap,
23
- TrProps,
24
- TextRendererState,
25
- TrFailedEventHandler,
26
- TrLoadedEventHandler,
27
- } from './text-rendering/renderers/TextRenderer.js';
28
- import { CoreNode, type CoreNodeProps } from './CoreNode.js';
29
- import type { Stage } from './Stage.js';
30
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
31
- import type {
32
- NodeTextFailedPayload,
33
- NodeTextLoadedPayload,
34
- } from '../common/CommonTypes.js';
35
- import type { Rect, RectWithValid } from './lib/utils.js';
36
- import { assertTruthy } from '../utils.js';
37
-
38
- export interface CoreTextNodeProps extends CoreNodeProps, TrProps {
39
- text: string;
40
- textRendererOverride: keyof TextRendererMap | null;
41
- }
42
-
43
- type ICoreTextNode = Omit<
44
- CoreTextNodeProps,
45
- 'texture' | 'textureOptions' | 'shader' | 'shaderProps'
46
- >;
47
-
48
- export class CoreTextNode extends CoreNode implements ICoreTextNode {
49
- textRenderer: TextRenderer;
50
- trState: TextRendererState;
51
- private _textRendererOverride: CoreTextNodeProps['textRendererOverride'] =
52
- null;
53
-
54
- constructor(stage: Stage, props: CoreTextNodeProps) {
55
- super(stage, props);
56
- this._textRendererOverride = props.textRendererOverride;
57
- const { resolvedTextRenderer, textRendererState } =
58
- this.resolveTextRendererAndState(
59
- {
60
- x: this.absX,
61
- y: this.absY,
62
- width: props.width,
63
- height: props.height,
64
- textAlign: props.textAlign,
65
- color: props.color,
66
- zIndex: props.zIndex,
67
- contain: props.contain,
68
- scrollable: props.scrollable,
69
- scrollY: props.scrollY,
70
- offsetY: props.offsetY,
71
- letterSpacing: props.letterSpacing,
72
- debug: props.debug,
73
- fontFamily: props.fontFamily,
74
- fontSize: props.fontSize,
75
- fontStretch: props.fontStretch,
76
- fontStyle: props.fontStyle,
77
- fontWeight: props.fontWeight,
78
- text: props.text,
79
- lineHeight: props.lineHeight,
80
- maxLines: props.maxLines,
81
- textBaseline: props.textBaseline,
82
- verticalAlign: props.verticalAlign,
83
- overflowSuffix: props.overflowSuffix,
84
- },
85
- undefined,
86
- );
87
- this.textRenderer = resolvedTextRenderer;
88
- this.trState = textRendererState;
89
- }
90
-
91
- private onTextLoaded: TrLoadedEventHandler = () => {
92
- const { contain } = this;
93
- const setWidth = this.trState.props.width;
94
- const setHeight = this.trState.props.height;
95
- const calcWidth = this.trState.textW || 0;
96
- const calcHeight = this.trState.textH || 0;
97
-
98
- if (contain === 'both') {
99
- this.props.width = setWidth;
100
- this.props.height = setHeight;
101
- } else if (contain === 'width') {
102
- this.props.width = setWidth;
103
- this.props.height = calcHeight;
104
- } else if (contain === 'none') {
105
- this.props.width = calcWidth;
106
- this.props.height = calcHeight;
107
- }
108
- this.updateLocalTransform();
109
-
110
- // Incase the RAF loop has been stopped already before text was loaded,
111
- // we request a render so it can be drawn.
112
- this.stage.requestRender();
113
- this.emit('loaded', {
114
- type: 'text',
115
- dimensions: {
116
- width: this.trState.textW || 0,
117
- height: this.trState.textH || 0,
118
- },
119
- } satisfies NodeTextLoadedPayload);
120
- };
121
-
122
- private onTextFailed: TrFailedEventHandler = (target, error) => {
123
- this.emit('failed', {
124
- type: 'text',
125
- error,
126
- } satisfies NodeTextFailedPayload);
127
- };
128
-
129
- override get width(): number {
130
- return this.trState.props.width;
131
- }
132
-
133
- override set width(value: number) {
134
- this.textRenderer.set.width(this.trState, value);
135
- }
136
-
137
- override get height(): number {
138
- return this.trState.props.height;
139
- }
140
-
141
- override set height(value: number) {
142
- this.textRenderer.set.height(this.trState, value);
143
- }
144
-
145
- override get color(): number {
146
- return this.trState.props.color;
147
- }
148
-
149
- override set color(value: number) {
150
- this.textRenderer.set.color(this.trState, value);
151
- }
152
-
153
- get text(): string {
154
- return this.trState.props.text;
155
- }
156
-
157
- set text(value: string) {
158
- this.textRenderer.set.text(this.trState, value);
159
- this.checkIsRenderable();
160
- }
161
-
162
- get textRendererOverride(): CoreTextNodeProps['textRendererOverride'] {
163
- return this._textRendererOverride;
164
- }
165
-
166
- set textRendererOverride(value: CoreTextNodeProps['textRendererOverride']) {
167
- this._textRendererOverride = value;
168
-
169
- const { resolvedTextRenderer, textRendererState } =
170
- this.resolveTextRendererAndState(this.trState.props, this.trState);
171
- this.textRenderer = resolvedTextRenderer;
172
- this.trState = textRendererState;
173
- }
174
-
175
- get fontSize(): CoreTextNodeProps['fontSize'] {
176
- return this.trState.props.fontSize;
177
- }
178
-
179
- set fontSize(value: CoreTextNodeProps['fontSize']) {
180
- this.textRenderer.set.fontSize(this.trState, value);
181
- }
182
-
183
- get fontFamily(): CoreTextNodeProps['fontFamily'] {
184
- return this.trState.props.fontFamily;
185
- }
186
-
187
- set fontFamily(value: CoreTextNodeProps['fontFamily']) {
188
- this.textRenderer.set.fontFamily(this.trState, value);
189
- }
190
-
191
- get fontStretch(): CoreTextNodeProps['fontStretch'] {
192
- return this.trState.props.fontStretch;
193
- }
194
-
195
- set fontStretch(value: CoreTextNodeProps['fontStretch']) {
196
- this.textRenderer.set.fontStretch(this.trState, value);
197
- }
198
-
199
- get fontStyle(): CoreTextNodeProps['fontStyle'] {
200
- return this.trState.props.fontStyle;
201
- }
202
-
203
- set fontStyle(value: CoreTextNodeProps['fontStyle']) {
204
- this.textRenderer.set.fontStyle(this.trState, value);
205
- }
206
-
207
- get fontWeight(): CoreTextNodeProps['fontWeight'] {
208
- return this.trState.props.fontWeight;
209
- }
210
-
211
- set fontWeight(value: CoreTextNodeProps['fontWeight']) {
212
- this.textRenderer.set.fontWeight(this.trState, value);
213
- }
214
-
215
- get textAlign(): CoreTextNodeProps['textAlign'] {
216
- return this.trState.props.textAlign;
217
- }
218
-
219
- set textAlign(value: CoreTextNodeProps['textAlign']) {
220
- this.textRenderer.set.textAlign(this.trState, value);
221
- }
222
-
223
- get contain(): CoreTextNodeProps['contain'] {
224
- return this.trState.props.contain;
225
- }
226
-
227
- set contain(value: CoreTextNodeProps['contain']) {
228
- this.textRenderer.set.contain(this.trState, value);
229
- }
230
-
231
- get scrollable(): CoreTextNodeProps['scrollable'] {
232
- return this.trState.props.scrollable;
233
- }
234
-
235
- set scrollable(value: CoreTextNodeProps['scrollable']) {
236
- this.textRenderer.set.scrollable(this.trState, value);
237
- }
238
-
239
- get scrollY(): CoreTextNodeProps['scrollY'] {
240
- return this.trState.props.scrollY;
241
- }
242
-
243
- set scrollY(value: CoreTextNodeProps['scrollY']) {
244
- this.textRenderer.set.scrollY(this.trState, value);
245
- }
246
-
247
- get offsetY(): CoreTextNodeProps['offsetY'] {
248
- return this.trState.props.offsetY;
249
- }
250
-
251
- set offsetY(value: CoreTextNodeProps['offsetY']) {
252
- this.textRenderer.set.offsetY(this.trState, value);
253
- }
254
-
255
- get letterSpacing(): CoreTextNodeProps['letterSpacing'] {
256
- return this.trState.props.letterSpacing;
257
- }
258
-
259
- set letterSpacing(value: CoreTextNodeProps['letterSpacing']) {
260
- this.textRenderer.set.letterSpacing(this.trState, value);
261
- }
262
-
263
- get lineHeight(): CoreTextNodeProps['lineHeight'] {
264
- return this.trState.props.lineHeight;
265
- }
266
-
267
- set lineHeight(value: CoreTextNodeProps['lineHeight']) {
268
- if (this.textRenderer.set.lineHeight) {
269
- this.textRenderer.set.lineHeight(this.trState, value);
270
- }
271
- }
272
-
273
- get maxLines(): CoreTextNodeProps['maxLines'] {
274
- return this.trState.props.maxLines;
275
- }
276
-
277
- set maxLines(value: CoreTextNodeProps['maxLines']) {
278
- if (this.textRenderer.set.maxLines) {
279
- this.textRenderer.set.maxLines(this.trState, value);
280
- }
281
- }
282
-
283
- get textBaseline(): CoreTextNodeProps['textBaseline'] {
284
- return this.trState.props.textBaseline;
285
- }
286
-
287
- set textBaseline(value: CoreTextNodeProps['textBaseline']) {
288
- if (this.textRenderer.set.textBaseline) {
289
- this.textRenderer.set.textBaseline(this.trState, value);
290
- }
291
- }
292
-
293
- get verticalAlign(): CoreTextNodeProps['verticalAlign'] {
294
- return this.trState.props.verticalAlign;
295
- }
296
-
297
- set verticalAlign(value: CoreTextNodeProps['verticalAlign']) {
298
- if (this.textRenderer.set.verticalAlign) {
299
- this.textRenderer.set.verticalAlign(this.trState, value);
300
- }
301
- }
302
-
303
- get overflowSuffix(): CoreTextNodeProps['overflowSuffix'] {
304
- return this.trState.props.overflowSuffix;
305
- }
306
-
307
- set overflowSuffix(value: CoreTextNodeProps['overflowSuffix']) {
308
- if (this.textRenderer.set.overflowSuffix) {
309
- this.textRenderer.set.overflowSuffix(this.trState, value);
310
- }
311
- }
312
-
313
- get debug(): CoreTextNodeProps['debug'] {
314
- return this.trState.props.debug;
315
- }
316
-
317
- set debug(value: CoreTextNodeProps['debug']) {
318
- this.textRenderer.set.debug(this.trState, value);
319
- }
320
-
321
- override update(delta: number, parentClippingRect: RectWithValid) {
322
- super.update(delta, parentClippingRect);
323
-
324
- assertTruthy(this.globalTransform);
325
-
326
- // globalTransform is updated in super.update(delta)
327
- this.textRenderer.set.x(this.trState, this.globalTransform.tx);
328
- this.textRenderer.set.y(this.trState, this.globalTransform.ty);
329
- }
330
-
331
- override checkIsRenderable(): boolean {
332
- if (super.checkIsRenderable()) {
333
- return true;
334
- }
335
-
336
- if (this.trState.props.text !== '') {
337
- return (this.isRenderable = true);
338
- }
339
-
340
- return (this.isRenderable = false);
341
- }
342
-
343
- override renderQuads(renderer: CoreRenderer) {
344
- assertTruthy(this.globalTransform);
345
- this.textRenderer.renderQuads(
346
- this.trState,
347
- this.globalTransform,
348
- this.clippingRect,
349
- this.worldAlpha,
350
- );
351
- }
352
-
353
- /**
354
- * Resolve a text renderer and a new state based on the current text renderer props provided
355
- * @param props
356
- * @returns
357
- */
358
- private resolveTextRendererAndState(
359
- props: TrProps,
360
- prevState?: TextRendererState,
361
- ): {
362
- resolvedTextRenderer: TextRenderer;
363
- textRendererState: TextRendererState;
364
- } {
365
- const resolvedTextRenderer = this.stage.resolveTextRenderer(
366
- props,
367
- this._textRendererOverride,
368
- );
369
-
370
- const textRendererState = resolvedTextRenderer.createState(props);
371
-
372
- const stateEvents = ['loading', 'loaded', 'failed'];
373
-
374
- if (prevState) {
375
- // Remove the old event listeners from previous state obj there was one
376
- stateEvents.forEach((eventName) => {
377
- prevState.emitter.off(eventName);
378
- });
379
- }
380
-
381
- textRendererState.emitter.on('loaded', this.onTextLoaded);
382
- textRendererState.emitter.on('failed', this.onTextFailed);
383
-
384
- resolvedTextRenderer.scheduleUpdateState(textRendererState);
385
-
386
- return {
387
- resolvedTextRenderer,
388
- textRendererState,
389
- };
390
- }
391
- }
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 type {
21
+ TextRenderer,
22
+ TextRendererMap,
23
+ TrProps,
24
+ TextRendererState,
25
+ TrFailedEventHandler,
26
+ TrLoadedEventHandler,
27
+ } from './text-rendering/renderers/TextRenderer.js';
28
+ import { CoreNode, type CoreNodeProps } from './CoreNode.js';
29
+ import type { Stage } from './Stage.js';
30
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
31
+ import type {
32
+ NodeTextFailedPayload,
33
+ NodeTextLoadedPayload,
34
+ } from '../common/CommonTypes.js';
35
+ import type { Rect, RectWithValid } from './lib/utils.js';
36
+ import { assertTruthy } from '../utils.js';
37
+
38
+ export interface CoreTextNodeProps extends CoreNodeProps, TrProps {
39
+ text: string;
40
+ textRendererOverride: keyof TextRendererMap | null;
41
+ }
42
+
43
+ type ICoreTextNode = Omit<
44
+ CoreTextNodeProps,
45
+ 'texture' | 'textureOptions' | 'shader' | 'shaderProps'
46
+ >;
47
+
48
+ export class CoreTextNode extends CoreNode implements ICoreTextNode {
49
+ textRenderer: TextRenderer;
50
+ trState: TextRendererState;
51
+ private _textRendererOverride: CoreTextNodeProps['textRendererOverride'] =
52
+ null;
53
+
54
+ constructor(stage: Stage, props: CoreTextNodeProps) {
55
+ super(stage, props);
56
+ this._textRendererOverride = props.textRendererOverride;
57
+ const { resolvedTextRenderer, textRendererState } =
58
+ this.resolveTextRendererAndState(
59
+ {
60
+ x: this.absX,
61
+ y: this.absY,
62
+ width: props.width,
63
+ height: props.height,
64
+ textAlign: props.textAlign,
65
+ color: props.color,
66
+ zIndex: props.zIndex,
67
+ contain: props.contain,
68
+ scrollable: props.scrollable,
69
+ scrollY: props.scrollY,
70
+ offsetY: props.offsetY,
71
+ letterSpacing: props.letterSpacing,
72
+ debug: props.debug,
73
+ fontFamily: props.fontFamily,
74
+ fontSize: props.fontSize,
75
+ fontStretch: props.fontStretch,
76
+ fontStyle: props.fontStyle,
77
+ fontWeight: props.fontWeight,
78
+ text: props.text,
79
+ lineHeight: props.lineHeight,
80
+ maxLines: props.maxLines,
81
+ textBaseline: props.textBaseline,
82
+ verticalAlign: props.verticalAlign,
83
+ overflowSuffix: props.overflowSuffix,
84
+ },
85
+ undefined,
86
+ );
87
+ this.textRenderer = resolvedTextRenderer;
88
+ this.trState = textRendererState;
89
+ }
90
+
91
+ private onTextLoaded: TrLoadedEventHandler = () => {
92
+ const { contain } = this;
93
+ const setWidth = this.trState.props.width;
94
+ const setHeight = this.trState.props.height;
95
+ const calcWidth = this.trState.textW || 0;
96
+ const calcHeight = this.trState.textH || 0;
97
+
98
+ if (contain === 'both') {
99
+ this.props.width = setWidth;
100
+ this.props.height = setHeight;
101
+ } else if (contain === 'width') {
102
+ this.props.width = setWidth;
103
+ this.props.height = calcHeight;
104
+ } else if (contain === 'none') {
105
+ this.props.width = calcWidth;
106
+ this.props.height = calcHeight;
107
+ }
108
+ this.updateLocalTransform();
109
+
110
+ // Incase the RAF loop has been stopped already before text was loaded,
111
+ // we request a render so it can be drawn.
112
+ this.stage.requestRender();
113
+ this.emit('loaded', {
114
+ type: 'text',
115
+ dimensions: {
116
+ width: this.trState.textW || 0,
117
+ height: this.trState.textH || 0,
118
+ },
119
+ } satisfies NodeTextLoadedPayload);
120
+ };
121
+
122
+ private onTextFailed: TrFailedEventHandler = (target, error) => {
123
+ this.emit('failed', {
124
+ type: 'text',
125
+ error,
126
+ } satisfies NodeTextFailedPayload);
127
+ };
128
+
129
+ override get width(): number {
130
+ return this.trState.props.width;
131
+ }
132
+
133
+ override set width(value: number) {
134
+ this.textRenderer.set.width(this.trState, value);
135
+ }
136
+
137
+ override get height(): number {
138
+ return this.trState.props.height;
139
+ }
140
+
141
+ override set height(value: number) {
142
+ this.textRenderer.set.height(this.trState, value);
143
+ }
144
+
145
+ override get color(): number {
146
+ return this.trState.props.color;
147
+ }
148
+
149
+ override set color(value: number) {
150
+ this.textRenderer.set.color(this.trState, value);
151
+ }
152
+
153
+ get text(): string {
154
+ return this.trState.props.text;
155
+ }
156
+
157
+ set text(value: string) {
158
+ this.textRenderer.set.text(this.trState, value);
159
+ this.checkIsRenderable();
160
+ }
161
+
162
+ get textRendererOverride(): CoreTextNodeProps['textRendererOverride'] {
163
+ return this._textRendererOverride;
164
+ }
165
+
166
+ set textRendererOverride(value: CoreTextNodeProps['textRendererOverride']) {
167
+ this._textRendererOverride = value;
168
+
169
+ const { resolvedTextRenderer, textRendererState } =
170
+ this.resolveTextRendererAndState(this.trState.props, this.trState);
171
+ this.textRenderer = resolvedTextRenderer;
172
+ this.trState = textRendererState;
173
+ }
174
+
175
+ get fontSize(): CoreTextNodeProps['fontSize'] {
176
+ return this.trState.props.fontSize;
177
+ }
178
+
179
+ set fontSize(value: CoreTextNodeProps['fontSize']) {
180
+ this.textRenderer.set.fontSize(this.trState, value);
181
+ }
182
+
183
+ get fontFamily(): CoreTextNodeProps['fontFamily'] {
184
+ return this.trState.props.fontFamily;
185
+ }
186
+
187
+ set fontFamily(value: CoreTextNodeProps['fontFamily']) {
188
+ this.textRenderer.set.fontFamily(this.trState, value);
189
+ }
190
+
191
+ get fontStretch(): CoreTextNodeProps['fontStretch'] {
192
+ return this.trState.props.fontStretch;
193
+ }
194
+
195
+ set fontStretch(value: CoreTextNodeProps['fontStretch']) {
196
+ this.textRenderer.set.fontStretch(this.trState, value);
197
+ }
198
+
199
+ get fontStyle(): CoreTextNodeProps['fontStyle'] {
200
+ return this.trState.props.fontStyle;
201
+ }
202
+
203
+ set fontStyle(value: CoreTextNodeProps['fontStyle']) {
204
+ this.textRenderer.set.fontStyle(this.trState, value);
205
+ }
206
+
207
+ get fontWeight(): CoreTextNodeProps['fontWeight'] {
208
+ return this.trState.props.fontWeight;
209
+ }
210
+
211
+ set fontWeight(value: CoreTextNodeProps['fontWeight']) {
212
+ this.textRenderer.set.fontWeight(this.trState, value);
213
+ }
214
+
215
+ get textAlign(): CoreTextNodeProps['textAlign'] {
216
+ return this.trState.props.textAlign;
217
+ }
218
+
219
+ set textAlign(value: CoreTextNodeProps['textAlign']) {
220
+ this.textRenderer.set.textAlign(this.trState, value);
221
+ }
222
+
223
+ get contain(): CoreTextNodeProps['contain'] {
224
+ return this.trState.props.contain;
225
+ }
226
+
227
+ set contain(value: CoreTextNodeProps['contain']) {
228
+ this.textRenderer.set.contain(this.trState, value);
229
+ }
230
+
231
+ get scrollable(): CoreTextNodeProps['scrollable'] {
232
+ return this.trState.props.scrollable;
233
+ }
234
+
235
+ set scrollable(value: CoreTextNodeProps['scrollable']) {
236
+ this.textRenderer.set.scrollable(this.trState, value);
237
+ }
238
+
239
+ get scrollY(): CoreTextNodeProps['scrollY'] {
240
+ return this.trState.props.scrollY;
241
+ }
242
+
243
+ set scrollY(value: CoreTextNodeProps['scrollY']) {
244
+ this.textRenderer.set.scrollY(this.trState, value);
245
+ }
246
+
247
+ get offsetY(): CoreTextNodeProps['offsetY'] {
248
+ return this.trState.props.offsetY;
249
+ }
250
+
251
+ set offsetY(value: CoreTextNodeProps['offsetY']) {
252
+ this.textRenderer.set.offsetY(this.trState, value);
253
+ }
254
+
255
+ get letterSpacing(): CoreTextNodeProps['letterSpacing'] {
256
+ return this.trState.props.letterSpacing;
257
+ }
258
+
259
+ set letterSpacing(value: CoreTextNodeProps['letterSpacing']) {
260
+ this.textRenderer.set.letterSpacing(this.trState, value);
261
+ }
262
+
263
+ get lineHeight(): CoreTextNodeProps['lineHeight'] {
264
+ return this.trState.props.lineHeight;
265
+ }
266
+
267
+ set lineHeight(value: CoreTextNodeProps['lineHeight']) {
268
+ if (this.textRenderer.set.lineHeight) {
269
+ this.textRenderer.set.lineHeight(this.trState, value);
270
+ }
271
+ }
272
+
273
+ get maxLines(): CoreTextNodeProps['maxLines'] {
274
+ return this.trState.props.maxLines;
275
+ }
276
+
277
+ set maxLines(value: CoreTextNodeProps['maxLines']) {
278
+ if (this.textRenderer.set.maxLines) {
279
+ this.textRenderer.set.maxLines(this.trState, value);
280
+ }
281
+ }
282
+
283
+ get textBaseline(): CoreTextNodeProps['textBaseline'] {
284
+ return this.trState.props.textBaseline;
285
+ }
286
+
287
+ set textBaseline(value: CoreTextNodeProps['textBaseline']) {
288
+ if (this.textRenderer.set.textBaseline) {
289
+ this.textRenderer.set.textBaseline(this.trState, value);
290
+ }
291
+ }
292
+
293
+ get verticalAlign(): CoreTextNodeProps['verticalAlign'] {
294
+ return this.trState.props.verticalAlign;
295
+ }
296
+
297
+ set verticalAlign(value: CoreTextNodeProps['verticalAlign']) {
298
+ if (this.textRenderer.set.verticalAlign) {
299
+ this.textRenderer.set.verticalAlign(this.trState, value);
300
+ }
301
+ }
302
+
303
+ get overflowSuffix(): CoreTextNodeProps['overflowSuffix'] {
304
+ return this.trState.props.overflowSuffix;
305
+ }
306
+
307
+ set overflowSuffix(value: CoreTextNodeProps['overflowSuffix']) {
308
+ if (this.textRenderer.set.overflowSuffix) {
309
+ this.textRenderer.set.overflowSuffix(this.trState, value);
310
+ }
311
+ }
312
+
313
+ get debug(): CoreTextNodeProps['debug'] {
314
+ return this.trState.props.debug;
315
+ }
316
+
317
+ set debug(value: CoreTextNodeProps['debug']) {
318
+ this.textRenderer.set.debug(this.trState, value);
319
+ }
320
+
321
+ override update(delta: number, parentClippingRect: RectWithValid) {
322
+ super.update(delta, parentClippingRect);
323
+
324
+ assertTruthy(this.globalTransform);
325
+
326
+ // globalTransform is updated in super.update(delta)
327
+ this.textRenderer.set.x(this.trState, this.globalTransform.tx);
328
+ this.textRenderer.set.y(this.trState, this.globalTransform.ty);
329
+ }
330
+
331
+ override checkIsRenderable(): boolean {
332
+ if (super.checkIsRenderable()) {
333
+ return true;
334
+ }
335
+
336
+ if (this.trState.props.text !== '') {
337
+ return (this.isRenderable = true);
338
+ }
339
+
340
+ return (this.isRenderable = false);
341
+ }
342
+
343
+ override renderQuads(renderer: CoreRenderer) {
344
+ assertTruthy(this.globalTransform);
345
+ this.textRenderer.renderQuads(
346
+ this.trState,
347
+ this.globalTransform,
348
+ this.clippingRect,
349
+ this.worldAlpha,
350
+ );
351
+ }
352
+
353
+ /**
354
+ * Resolve a text renderer and a new state based on the current text renderer props provided
355
+ * @param props
356
+ * @returns
357
+ */
358
+ private resolveTextRendererAndState(
359
+ props: TrProps,
360
+ prevState?: TextRendererState,
361
+ ): {
362
+ resolvedTextRenderer: TextRenderer;
363
+ textRendererState: TextRendererState;
364
+ } {
365
+ const resolvedTextRenderer = this.stage.resolveTextRenderer(
366
+ props,
367
+ this._textRendererOverride,
368
+ );
369
+
370
+ const textRendererState = resolvedTextRenderer.createState(props);
371
+
372
+ const stateEvents = ['loading', 'loaded', 'failed'];
373
+
374
+ if (prevState) {
375
+ // Remove the old event listeners from previous state obj there was one
376
+ stateEvents.forEach((eventName) => {
377
+ prevState.emitter.off(eventName);
378
+ });
379
+ }
380
+
381
+ textRendererState.emitter.on('loaded', this.onTextLoaded);
382
+ textRendererState.emitter.on('failed', this.onTextFailed);
383
+
384
+ resolvedTextRenderer.scheduleUpdateState(textRendererState);
385
+
386
+ return {
387
+ resolvedTextRenderer,
388
+ textRendererState,
389
+ };
390
+ }
391
+ }