@lightningjs/renderer 2.9.0-beta2 → 2.9.0-beta3

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 (189) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/src/core/CoreNode.d.ts +2 -1
  6. package/dist/src/core/CoreNode.js +54 -43
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextureManager.d.ts +61 -15
  9. package/dist/src/core/CoreTextureManager.js +179 -104
  10. package/dist/src/core/CoreTextureManager.js.map +1 -1
  11. package/dist/src/core/Stage.d.ts +7 -0
  12. package/dist/src/core/Stage.js +33 -1
  13. package/dist/src/core/Stage.js.map +1 -1
  14. package/dist/src/core/TextureMemoryManager.js +2 -5
  15. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  16. package/dist/src/core/lib/ImageWorker.js +31 -28
  17. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  18. package/dist/src/core/lib/WebGlContextWrapper.d.ts +1 -0
  19. package/dist/src/core/lib/WebGlContextWrapper.js +2 -0
  20. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  21. package/dist/src/core/renderers/CoreContextTexture.d.ts +1 -0
  22. package/dist/src/core/renderers/CoreContextTexture.js +1 -0
  23. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  24. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.d.ts +1 -1
  25. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +13 -5
  26. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +1 -1
  27. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +6 -8
  28. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +1 -1
  29. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +3 -1
  30. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -1
  31. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +1 -2
  32. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +26 -24
  33. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  34. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +0 -1
  35. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +7 -17
  36. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  38. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  39. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  40. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  41. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  42. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  43. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  44. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  45. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  46. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  47. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  48. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  49. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  50. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  51. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  52. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  53. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  54. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  55. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +3 -5
  56. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  57. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +2 -1
  58. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  59. package/dist/src/core/textures/ColorTexture.d.ts +1 -1
  60. package/dist/src/core/textures/ColorTexture.js +2 -1
  61. package/dist/src/core/textures/ColorTexture.js.map +1 -1
  62. package/dist/src/core/textures/ImageTexture.d.ts +8 -1
  63. package/dist/src/core/textures/ImageTexture.js +39 -1
  64. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  65. package/dist/src/core/textures/NoiseTexture.d.ts +1 -1
  66. package/dist/src/core/textures/NoiseTexture.js +2 -1
  67. package/dist/src/core/textures/NoiseTexture.js.map +1 -1
  68. package/dist/src/core/textures/RenderTexture.d.ts +1 -1
  69. package/dist/src/core/textures/RenderTexture.js +2 -1
  70. package/dist/src/core/textures/RenderTexture.js.map +1 -1
  71. package/dist/src/core/textures/SubTexture.d.ts +1 -1
  72. package/dist/src/core/textures/SubTexture.js +21 -4
  73. package/dist/src/core/textures/SubTexture.js.map +1 -1
  74. package/dist/src/core/textures/Texture.d.ts +43 -21
  75. package/dist/src/core/textures/Texture.js +105 -33
  76. package/dist/src/core/textures/Texture.js.map +1 -1
  77. package/dist/src/main-api/Renderer.d.ts +18 -0
  78. package/dist/src/main-api/Renderer.js +6 -4
  79. package/dist/src/main-api/Renderer.js.map +1 -1
  80. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  81. package/exports/canvas.ts +39 -39
  82. package/exports/index.ts +89 -89
  83. package/exports/inspector.ts +24 -24
  84. package/exports/utils.ts +44 -44
  85. package/exports/webgl.ts +38 -38
  86. package/package.json +1 -1
  87. package/scripts/please-use-pnpm.js +13 -13
  88. package/src/common/CommonTypes.ts +139 -139
  89. package/src/common/EventEmitter.ts +77 -77
  90. package/src/common/IAnimationController.ts +92 -92
  91. package/src/common/IEventEmitter.ts +28 -28
  92. package/src/core/CoreNode.test.ts +95 -95
  93. package/src/core/CoreNode.ts +2282 -2258
  94. package/src/core/CoreShaderManager.ts +292 -292
  95. package/src/core/CoreTextNode.ts +450 -450
  96. package/src/core/CoreTextureManager.ts +522 -432
  97. package/src/core/Stage.ts +699 -652
  98. package/src/core/TextureMemoryManager.ts +277 -279
  99. package/src/core/animations/AnimationManager.ts +38 -38
  100. package/src/core/animations/CoreAnimation.ts +340 -340
  101. package/src/core/animations/CoreAnimationController.ts +157 -157
  102. package/src/core/lib/ContextSpy.ts +41 -41
  103. package/src/core/lib/ImageWorker.ts +270 -267
  104. package/src/core/lib/Matrix3d.ts +244 -244
  105. package/src/core/lib/RenderCoords.ts +86 -86
  106. package/src/core/lib/WebGlContextWrapper.ts +1322 -1320
  107. package/src/core/lib/textureCompression.ts +152 -152
  108. package/src/core/lib/textureSvg.ts +78 -78
  109. package/src/core/lib/utils.ts +306 -306
  110. package/src/core/platform.ts +61 -61
  111. package/src/core/renderers/CoreContextTexture.ts +43 -42
  112. package/src/core/renderers/CoreRenderOp.ts +22 -22
  113. package/src/core/renderers/CoreRenderer.ts +114 -114
  114. package/src/core/renderers/CoreShader.ts +41 -41
  115. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -353
  116. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -149
  117. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  118. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  119. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  120. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  121. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -48
  122. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -290
  123. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  124. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -817
  125. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  126. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  127. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  128. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  129. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  130. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  131. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  132. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  133. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  134. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  135. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  136. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  137. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  138. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  139. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  140. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  141. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  142. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  143. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  144. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  145. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  146. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  147. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  148. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  149. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  150. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  151. package/src/core/text-rendering/TrFontManager.ts +183 -183
  152. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +169 -171
  153. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  154. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  155. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  156. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  157. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  158. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -507
  159. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  160. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  161. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  162. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  163. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  164. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  165. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  166. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  167. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  168. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  169. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  170. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  171. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  172. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  173. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  174. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  175. package/src/core/textures/ColorTexture.ts +102 -100
  176. package/src/core/textures/ImageTexture.ts +378 -337
  177. package/src/core/textures/NoiseTexture.ts +104 -101
  178. package/src/core/textures/RenderTexture.ts +85 -83
  179. package/src/core/textures/SubTexture.ts +171 -146
  180. package/src/core/textures/Texture.ts +407 -318
  181. package/src/core/utils.ts +227 -227
  182. package/src/env.d.ts +7 -7
  183. package/src/main-api/DynamicShaderController.ts +104 -104
  184. package/src/main-api/INode.ts +101 -101
  185. package/src/main-api/Inspector.ts +505 -505
  186. package/src/main-api/Renderer.ts +693 -670
  187. package/src/main-api/ShaderController.ts +80 -80
  188. package/src/main-api/utils.ts +45 -45
  189. package/src/utils.ts +248 -248
@@ -1,403 +1,403 @@
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 { assertTruthy } from '../../../../../utils.js';
21
- import type { Bound } from '../../../../lib/utils.js';
22
- import type {
23
- FontShaperProps,
24
- MappedGlyphInfo,
25
- UnmappedCharacterInfo,
26
- } from '../../../font-face-types/SdfTrFontFace/internal/FontShaper.js';
27
- import type { TrProps, TextRendererState } from '../../TextRenderer.js';
28
- import type { SdfTextRendererState } from '../SdfTextRenderer.js';
29
- import { PeekableIterator } from './PeekableGenerator.js';
30
- import { getUnicodeCodepoints } from './getUnicodeCodepoints.js';
31
- import { measureText } from './measureText.js';
32
-
33
- export function layoutText(
34
- curLineIndex: number,
35
- startX: number,
36
- startY: number,
37
- text: TrProps['text'],
38
- textAlign: TrProps['textAlign'],
39
- width: TrProps['width'],
40
- height: TrProps['height'],
41
- fontSize: TrProps['fontSize'],
42
- lineHeight: number,
43
- letterSpacing: TrProps['letterSpacing'],
44
- /**
45
- * Mutated
46
- */
47
- vertexBuffer: NonNullable<SdfTextRendererState['vertexBuffer']>,
48
- contain: TrProps['contain'],
49
- /**
50
- * Mutated
51
- */
52
- lineCache: SdfTextRendererState['lineCache'],
53
- rwSdf: Bound,
54
- trFontFace: SdfTextRendererState['trFontFace'],
55
- forceFullLayoutCalc: TextRendererState['forceFullLayoutCalc'],
56
- scrollable: TrProps['scrollable'],
57
- overflowSuffix: TrProps['overflowSuffix'],
58
- maxLines: TrProps['maxLines'],
59
- ): {
60
- bufferNumFloats: number;
61
- bufferNumQuads: number;
62
- layoutNumCharacters: number;
63
- fullyProcessed: boolean;
64
- maxX: number;
65
- maxY: number;
66
- numLines: number;
67
- } {
68
- assertTruthy(trFontFace, 'Font face must be loaded');
69
- assertTruthy(trFontFace.loaded, 'Font face must be loaded');
70
- assertTruthy(trFontFace.data, 'Font face must be loaded');
71
- assertTruthy(trFontFace.shaper, 'Font face must be loaded');
72
-
73
- // Regardless of fontSize (or other scaling properties), we layout the vertices of each glyph
74
- // using the fixed coordinate space determined by font size used to produce the atlas.
75
- // Scaling for display is handled by shader uniforms inexpensively.
76
- // So we have:
77
- // - vertex space: the space in which the vertices of each glyph are laid out
78
- // - screen space: the screen pixel space
79
- // Input properties such as x, y, w, fontSize, letterSpacing, etc. are all expressed in screen space.
80
- // We convert these to the vertex space by dividing them the `fontSizeRatio` factor.
81
-
82
- /**
83
- * See above
84
- */
85
- const fontSizeRatio = fontSize / trFontFace.data.info.size;
86
-
87
- /**
88
- * `lineHeight` in vertex coordinates
89
- */
90
- const vertexLineHeight = lineHeight / fontSizeRatio;
91
- /**
92
- * `w` in vertex coordinates
93
- */
94
- const vertexW = width / fontSizeRatio;
95
- /**
96
- * `letterSpacing` in vertex coordinates
97
- */
98
- const vertexLSpacing = letterSpacing / fontSizeRatio;
99
-
100
- const startingLineCacheEntry = lineCache[curLineIndex];
101
- const startingCodepointIndex = startingLineCacheEntry?.codepointIndex || 0;
102
- const startingMaxX = startingLineCacheEntry?.maxX || 0;
103
- const startingMaxY = startingLineCacheEntry?.maxY || 0;
104
-
105
- let maxX = startingMaxX;
106
- let maxY = startingMaxY;
107
- let curX = startX;
108
- let curY = startY;
109
-
110
- let bufferOffset = 0;
111
- /**
112
- * Buffer offset to last word boundry. This is -1 when we aren't in a word boundry.
113
- */
114
- const lastWord: {
115
- codepointIndex: number;
116
- bufferOffset: number;
117
- xStart: number;
118
- } = {
119
- codepointIndex: -1,
120
- bufferOffset: -1,
121
- xStart: -1,
122
- };
123
-
124
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
125
- const shaper = trFontFace.shaper;
126
-
127
- const shaperProps: FontShaperProps = {
128
- letterSpacing: vertexLSpacing,
129
- };
130
-
131
- // Get glyphs
132
- let glyphs = shaper.shapeText(
133
- shaperProps,
134
- new PeekableIterator(
135
- getUnicodeCodepoints(text, startingCodepointIndex),
136
- startingCodepointIndex,
137
- ),
138
- );
139
-
140
- let glyphResult:
141
- | IteratorResult<MappedGlyphInfo | UnmappedCharacterInfo, void>
142
- | undefined;
143
-
144
- let curLineBufferStart = -1;
145
-
146
- const bufferLineInfos: {
147
- bufferStart: number;
148
- bufferEnd: number;
149
- }[] = [];
150
-
151
- const vertexTruncateHeight = height / fontSizeRatio;
152
- const overflowSuffVertexWidth = measureText(
153
- overflowSuffix,
154
- shaperProps,
155
- shaper,
156
- );
157
-
158
- // Line-by-line layout
159
- let moreLines = true;
160
- while (moreLines) {
161
- const nextLineWillFit =
162
- (maxLines === 0 || curLineIndex + 1 < maxLines) &&
163
- (contain !== 'both' ||
164
- scrollable ||
165
- curY + vertexLineHeight + trFontFace.maxCharHeight <=
166
- vertexTruncateHeight);
167
- const lineVertexW = nextLineWillFit
168
- ? vertexW
169
- : vertexW - overflowSuffVertexWidth;
170
- /**
171
- * Vertex X position to the beginning of the last word boundary. This becomes -1 when we start traversing a word.
172
- */
173
- let xStartLastWordBoundary = 0;
174
-
175
- const lineIsBelowWindowTop = curY + trFontFace.maxCharHeight >= rwSdf.y1;
176
- const lineIsAboveWindowBottom = curY <= rwSdf.y2;
177
- const lineIsWithinWindow = lineIsBelowWindowTop && lineIsAboveWindowBottom;
178
- // Layout glyphs in this line
179
- // Any break statements in this while loop will trigger a line break
180
- while ((glyphResult = glyphs.next()) && !glyphResult.done) {
181
- const glyph = glyphResult.value;
182
-
183
- if (curLineIndex === lineCache.length) {
184
- lineCache.push({
185
- codepointIndex: glyph.cluster,
186
- maxY,
187
- maxX,
188
- });
189
- } else if (curLineIndex > lineCache.length) {
190
- throw new Error('Unexpected lineCache length');
191
- }
192
-
193
- // If we encounter a word boundary (white space or newline) we invalidate
194
- // the lastWord and set the xStartLastWordBoundary if we haven't already.
195
- if (
196
- glyph.codepoint === 32 ||
197
- glyph.codepoint === 10 ||
198
- glyph.codepoint === 8203
199
- ) {
200
- if (lastWord.codepointIndex !== -1) {
201
- lastWord.codepointIndex = -1;
202
- xStartLastWordBoundary = curX;
203
- }
204
- } else if (lastWord.codepointIndex === -1) {
205
- lastWord.codepointIndex = glyph.cluster;
206
- lastWord.bufferOffset = bufferOffset;
207
- lastWord.xStart = xStartLastWordBoundary;
208
- }
209
-
210
- if (glyph.mapped) {
211
- // Mapped glyph
212
- const charEndX = curX + glyph.xOffset + glyph.width;
213
- // Word wrap check
214
- if (
215
- // We are containing the text
216
- contain !== 'none' &&
217
- // The current glyph reaches outside the contained width
218
- charEndX >= lineVertexW &&
219
- // There is a last word that we can break to the next line
220
- lastWord.codepointIndex !== -1 &&
221
- // Prevents infinite loop when a single word is longer than the width
222
- lastWord.xStart > 0
223
- ) {
224
- // The current word is about to go off the edge of the container width
225
- // Reinitialize the iterator starting at the last word
226
- // and proceeding to the next line
227
- if (nextLineWillFit) {
228
- glyphs = shaper.shapeText(
229
- shaperProps,
230
- new PeekableIterator(
231
- getUnicodeCodepoints(text, lastWord.codepointIndex),
232
- lastWord.codepointIndex,
233
- ),
234
- );
235
- bufferOffset = lastWord.bufferOffset;
236
- break;
237
- } else {
238
- glyphs = shaper.shapeText(
239
- shaperProps,
240
- new PeekableIterator(getUnicodeCodepoints(overflowSuffix, 0), 0),
241
- );
242
- curX = lastWord.xStart;
243
- bufferOffset = lastWord.bufferOffset;
244
- // HACK: For the rest of the line when inserting the overflow suffix,
245
- // set contain = 'none' to prevent an infinite loop.
246
- contain = 'none';
247
- }
248
- } else {
249
- // This glyph fits, so we can add it to the buffer
250
- const quadX = curX + glyph.xOffset;
251
- const quadY = curY + glyph.yOffset;
252
-
253
- // Only add to buffer for rendering if the line is within the render window
254
- if (lineIsWithinWindow) {
255
- if (curLineBufferStart === -1) {
256
- curLineBufferStart = bufferOffset;
257
- }
258
-
259
- const atlasEntry = trFontFace.getAtlasEntry(glyph.glyphId);
260
-
261
- // Add texture coordinates
262
- const u = atlasEntry.x / trFontFace.data.common.scaleW;
263
- const v = atlasEntry.y / trFontFace.data.common.scaleH;
264
- const uvWidth = atlasEntry.width / trFontFace.data.common.scaleW;
265
- const uvHeight = atlasEntry.height / trFontFace.data.common.scaleH;
266
-
267
- // TODO: (Performance) We can optimize this by using ELEMENT_ARRAY_BUFFER
268
- // eliminating the need to duplicate vertices
269
-
270
- // Top-left
271
- vertexBuffer[bufferOffset++] = quadX;
272
- vertexBuffer[bufferOffset++] = quadY;
273
- vertexBuffer[bufferOffset++] = u;
274
- vertexBuffer[bufferOffset++] = v;
275
-
276
- // Top-right
277
- vertexBuffer[bufferOffset++] = quadX + glyph.width;
278
- vertexBuffer[bufferOffset++] = quadY;
279
- vertexBuffer[bufferOffset++] = u + uvWidth;
280
- vertexBuffer[bufferOffset++] = v;
281
-
282
- // Bottom-left
283
- vertexBuffer[bufferOffset++] = quadX;
284
- vertexBuffer[bufferOffset++] = quadY + glyph.height;
285
- vertexBuffer[bufferOffset++] = u;
286
- vertexBuffer[bufferOffset++] = v + uvHeight;
287
-
288
- // Bottom-right
289
- vertexBuffer[bufferOffset++] = quadX + glyph.width;
290
- vertexBuffer[bufferOffset++] = quadY + glyph.height;
291
- vertexBuffer[bufferOffset++] = u + uvWidth;
292
- vertexBuffer[bufferOffset++] = v + uvHeight;
293
- }
294
-
295
- maxY = Math.max(maxY, quadY + glyph.height);
296
- maxX = Math.max(maxX, quadX + glyph.width);
297
- curX += glyph.xAdvance;
298
- }
299
- } else {
300
- // Unmapped character
301
-
302
- // Handle newlines
303
- if (glyph.codepoint === 10) {
304
- if (nextLineWillFit) {
305
- // The whole line fit, so we can break to the next line
306
- break;
307
- } else {
308
- // The whole line won't fit, so we need to add the overflow suffix
309
- glyphs = shaper.shapeText(
310
- shaperProps,
311
- new PeekableIterator(getUnicodeCodepoints(overflowSuffix, 0), 0),
312
- );
313
- // HACK: For the rest of the line when inserting the overflow suffix,
314
- // set contain = 'none' to prevent an infinite loop.
315
- contain = 'none';
316
- }
317
- }
318
- }
319
- }
320
-
321
- // Prepare for the next line...
322
- if (curLineBufferStart !== -1) {
323
- bufferLineInfos.push({
324
- bufferStart: curLineBufferStart,
325
- bufferEnd: bufferOffset,
326
- });
327
- curLineBufferStart = -1;
328
- }
329
- curX = 0;
330
- curY += vertexLineHeight;
331
- curLineIndex++;
332
- lastWord.codepointIndex = -1;
333
- xStartLastWordBoundary = 0;
334
-
335
- // Figure out if there are any more lines to render...
336
- if (!forceFullLayoutCalc && contain === 'both' && curY > rwSdf.y2) {
337
- // Stop layout calculation early (for performance purposes) if:
338
- // - We're not forcing a full layout calculation (for width/height calculation)
339
- // - ...and we're containing the text vertically+horizontally (contain === 'both')
340
- // - ...and we have a render window
341
- // - ...and the next line is below the bottom of the render window
342
- moreLines = false;
343
- } else if (glyphResult && glyphResult.done) {
344
- // If we've reached the end of the text, we know we're done
345
- moreLines = false;
346
- } else if (!nextLineWillFit) {
347
- // If we're contained vertically+horizontally (contain === 'both')
348
- // but not scrollable and the next line won't fit, we're done.
349
- moreLines = false;
350
- }
351
- }
352
-
353
- // Use textAlign to determine if we need to adjust the x position of the text
354
- // in the buffer line by line
355
- if (textAlign === 'center') {
356
- const vertexTextW = contain === 'none' ? maxX : vertexW;
357
-
358
- for (let i = 0; i < bufferLineInfos.length; i++) {
359
- const line = bufferLineInfos[i]!;
360
- // - 4 = the x position of a rightmost vertex
361
- const lineWidth =
362
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
363
- vertexBuffer[line.bufferEnd - 4]! - vertexBuffer[line.bufferStart]!;
364
-
365
- const xOffset = (vertexTextW - lineWidth) / 2;
366
- for (let j = line.bufferStart; j < line.bufferEnd; j += 4) {
367
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
368
- vertexBuffer[j]! += xOffset;
369
- }
370
- }
371
- } else if (textAlign === 'right') {
372
- const vertexTextW = contain === 'none' ? maxX : vertexW;
373
-
374
- for (let i = 0; i < bufferLineInfos.length; i++) {
375
- const line = bufferLineInfos[i]!;
376
- const lineWidth =
377
- line.bufferEnd === line.bufferStart
378
- ? 0
379
- : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
380
- vertexBuffer[line.bufferEnd - 4]! - vertexBuffer[line.bufferStart]!;
381
-
382
- const xOffset = vertexTextW - lineWidth;
383
- for (let j = line.bufferStart; j < line.bufferEnd; j += 4) {
384
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
385
- vertexBuffer[j]! += xOffset;
386
- }
387
- }
388
- }
389
-
390
- assertTruthy(glyphResult);
391
-
392
- return {
393
- bufferNumFloats: bufferOffset,
394
- bufferNumQuads: bufferOffset / 16,
395
- layoutNumCharacters: glyphResult.done
396
- ? text.length - startingCodepointIndex
397
- : glyphResult.value.cluster - startingCodepointIndex + 1,
398
- fullyProcessed: !!glyphResult.done,
399
- maxX,
400
- maxY,
401
- numLines: lineCache.length,
402
- };
403
- }
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 { assertTruthy } from '../../../../../utils.js';
21
+ import type { Bound } from '../../../../lib/utils.js';
22
+ import type {
23
+ FontShaperProps,
24
+ MappedGlyphInfo,
25
+ UnmappedCharacterInfo,
26
+ } from '../../../font-face-types/SdfTrFontFace/internal/FontShaper.js';
27
+ import type { TrProps, TextRendererState } from '../../TextRenderer.js';
28
+ import type { SdfTextRendererState } from '../SdfTextRenderer.js';
29
+ import { PeekableIterator } from './PeekableGenerator.js';
30
+ import { getUnicodeCodepoints } from './getUnicodeCodepoints.js';
31
+ import { measureText } from './measureText.js';
32
+
33
+ export function layoutText(
34
+ curLineIndex: number,
35
+ startX: number,
36
+ startY: number,
37
+ text: TrProps['text'],
38
+ textAlign: TrProps['textAlign'],
39
+ width: TrProps['width'],
40
+ height: TrProps['height'],
41
+ fontSize: TrProps['fontSize'],
42
+ lineHeight: number,
43
+ letterSpacing: TrProps['letterSpacing'],
44
+ /**
45
+ * Mutated
46
+ */
47
+ vertexBuffer: NonNullable<SdfTextRendererState['vertexBuffer']>,
48
+ contain: TrProps['contain'],
49
+ /**
50
+ * Mutated
51
+ */
52
+ lineCache: SdfTextRendererState['lineCache'],
53
+ rwSdf: Bound,
54
+ trFontFace: SdfTextRendererState['trFontFace'],
55
+ forceFullLayoutCalc: TextRendererState['forceFullLayoutCalc'],
56
+ scrollable: TrProps['scrollable'],
57
+ overflowSuffix: TrProps['overflowSuffix'],
58
+ maxLines: TrProps['maxLines'],
59
+ ): {
60
+ bufferNumFloats: number;
61
+ bufferNumQuads: number;
62
+ layoutNumCharacters: number;
63
+ fullyProcessed: boolean;
64
+ maxX: number;
65
+ maxY: number;
66
+ numLines: number;
67
+ } {
68
+ assertTruthy(trFontFace, 'Font face must be loaded');
69
+ assertTruthy(trFontFace.loaded, 'Font face must be loaded');
70
+ assertTruthy(trFontFace.data, 'Font face must be loaded');
71
+ assertTruthy(trFontFace.shaper, 'Font face must be loaded');
72
+
73
+ // Regardless of fontSize (or other scaling properties), we layout the vertices of each glyph
74
+ // using the fixed coordinate space determined by font size used to produce the atlas.
75
+ // Scaling for display is handled by shader uniforms inexpensively.
76
+ // So we have:
77
+ // - vertex space: the space in which the vertices of each glyph are laid out
78
+ // - screen space: the screen pixel space
79
+ // Input properties such as x, y, w, fontSize, letterSpacing, etc. are all expressed in screen space.
80
+ // We convert these to the vertex space by dividing them the `fontSizeRatio` factor.
81
+
82
+ /**
83
+ * See above
84
+ */
85
+ const fontSizeRatio = fontSize / trFontFace.data.info.size;
86
+
87
+ /**
88
+ * `lineHeight` in vertex coordinates
89
+ */
90
+ const vertexLineHeight = lineHeight / fontSizeRatio;
91
+ /**
92
+ * `w` in vertex coordinates
93
+ */
94
+ const vertexW = width / fontSizeRatio;
95
+ /**
96
+ * `letterSpacing` in vertex coordinates
97
+ */
98
+ const vertexLSpacing = letterSpacing / fontSizeRatio;
99
+
100
+ const startingLineCacheEntry = lineCache[curLineIndex];
101
+ const startingCodepointIndex = startingLineCacheEntry?.codepointIndex || 0;
102
+ const startingMaxX = startingLineCacheEntry?.maxX || 0;
103
+ const startingMaxY = startingLineCacheEntry?.maxY || 0;
104
+
105
+ let maxX = startingMaxX;
106
+ let maxY = startingMaxY;
107
+ let curX = startX;
108
+ let curY = startY;
109
+
110
+ let bufferOffset = 0;
111
+ /**
112
+ * Buffer offset to last word boundry. This is -1 when we aren't in a word boundry.
113
+ */
114
+ const lastWord: {
115
+ codepointIndex: number;
116
+ bufferOffset: number;
117
+ xStart: number;
118
+ } = {
119
+ codepointIndex: -1,
120
+ bufferOffset: -1,
121
+ xStart: -1,
122
+ };
123
+
124
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
125
+ const shaper = trFontFace.shaper;
126
+
127
+ const shaperProps: FontShaperProps = {
128
+ letterSpacing: vertexLSpacing,
129
+ };
130
+
131
+ // Get glyphs
132
+ let glyphs = shaper.shapeText(
133
+ shaperProps,
134
+ new PeekableIterator(
135
+ getUnicodeCodepoints(text, startingCodepointIndex),
136
+ startingCodepointIndex,
137
+ ),
138
+ );
139
+
140
+ let glyphResult:
141
+ | IteratorResult<MappedGlyphInfo | UnmappedCharacterInfo, void>
142
+ | undefined;
143
+
144
+ let curLineBufferStart = -1;
145
+
146
+ const bufferLineInfos: {
147
+ bufferStart: number;
148
+ bufferEnd: number;
149
+ }[] = [];
150
+
151
+ const vertexTruncateHeight = height / fontSizeRatio;
152
+ const overflowSuffVertexWidth = measureText(
153
+ overflowSuffix,
154
+ shaperProps,
155
+ shaper,
156
+ );
157
+
158
+ // Line-by-line layout
159
+ let moreLines = true;
160
+ while (moreLines) {
161
+ const nextLineWillFit =
162
+ (maxLines === 0 || curLineIndex + 1 < maxLines) &&
163
+ (contain !== 'both' ||
164
+ scrollable ||
165
+ curY + vertexLineHeight + trFontFace.maxCharHeight <=
166
+ vertexTruncateHeight);
167
+ const lineVertexW = nextLineWillFit
168
+ ? vertexW
169
+ : vertexW - overflowSuffVertexWidth;
170
+ /**
171
+ * Vertex X position to the beginning of the last word boundary. This becomes -1 when we start traversing a word.
172
+ */
173
+ let xStartLastWordBoundary = 0;
174
+
175
+ const lineIsBelowWindowTop = curY + trFontFace.maxCharHeight >= rwSdf.y1;
176
+ const lineIsAboveWindowBottom = curY <= rwSdf.y2;
177
+ const lineIsWithinWindow = lineIsBelowWindowTop && lineIsAboveWindowBottom;
178
+ // Layout glyphs in this line
179
+ // Any break statements in this while loop will trigger a line break
180
+ while ((glyphResult = glyphs.next()) && !glyphResult.done) {
181
+ const glyph = glyphResult.value;
182
+
183
+ if (curLineIndex === lineCache.length) {
184
+ lineCache.push({
185
+ codepointIndex: glyph.cluster,
186
+ maxY,
187
+ maxX,
188
+ });
189
+ } else if (curLineIndex > lineCache.length) {
190
+ throw new Error('Unexpected lineCache length');
191
+ }
192
+
193
+ // If we encounter a word boundary (white space or newline) we invalidate
194
+ // the lastWord and set the xStartLastWordBoundary if we haven't already.
195
+ if (
196
+ glyph.codepoint === 32 ||
197
+ glyph.codepoint === 10 ||
198
+ glyph.codepoint === 8203
199
+ ) {
200
+ if (lastWord.codepointIndex !== -1) {
201
+ lastWord.codepointIndex = -1;
202
+ xStartLastWordBoundary = curX;
203
+ }
204
+ } else if (lastWord.codepointIndex === -1) {
205
+ lastWord.codepointIndex = glyph.cluster;
206
+ lastWord.bufferOffset = bufferOffset;
207
+ lastWord.xStart = xStartLastWordBoundary;
208
+ }
209
+
210
+ if (glyph.mapped) {
211
+ // Mapped glyph
212
+ const charEndX = curX + glyph.xOffset + glyph.width;
213
+ // Word wrap check
214
+ if (
215
+ // We are containing the text
216
+ contain !== 'none' &&
217
+ // The current glyph reaches outside the contained width
218
+ charEndX >= lineVertexW &&
219
+ // There is a last word that we can break to the next line
220
+ lastWord.codepointIndex !== -1 &&
221
+ // Prevents infinite loop when a single word is longer than the width
222
+ lastWord.xStart > 0
223
+ ) {
224
+ // The current word is about to go off the edge of the container width
225
+ // Reinitialize the iterator starting at the last word
226
+ // and proceeding to the next line
227
+ if (nextLineWillFit) {
228
+ glyphs = shaper.shapeText(
229
+ shaperProps,
230
+ new PeekableIterator(
231
+ getUnicodeCodepoints(text, lastWord.codepointIndex),
232
+ lastWord.codepointIndex,
233
+ ),
234
+ );
235
+ bufferOffset = lastWord.bufferOffset;
236
+ break;
237
+ } else {
238
+ glyphs = shaper.shapeText(
239
+ shaperProps,
240
+ new PeekableIterator(getUnicodeCodepoints(overflowSuffix, 0), 0),
241
+ );
242
+ curX = lastWord.xStart;
243
+ bufferOffset = lastWord.bufferOffset;
244
+ // HACK: For the rest of the line when inserting the overflow suffix,
245
+ // set contain = 'none' to prevent an infinite loop.
246
+ contain = 'none';
247
+ }
248
+ } else {
249
+ // This glyph fits, so we can add it to the buffer
250
+ const quadX = curX + glyph.xOffset;
251
+ const quadY = curY + glyph.yOffset;
252
+
253
+ // Only add to buffer for rendering if the line is within the render window
254
+ if (lineIsWithinWindow) {
255
+ if (curLineBufferStart === -1) {
256
+ curLineBufferStart = bufferOffset;
257
+ }
258
+
259
+ const atlasEntry = trFontFace.getAtlasEntry(glyph.glyphId);
260
+
261
+ // Add texture coordinates
262
+ const u = atlasEntry.x / trFontFace.data.common.scaleW;
263
+ const v = atlasEntry.y / trFontFace.data.common.scaleH;
264
+ const uvWidth = atlasEntry.width / trFontFace.data.common.scaleW;
265
+ const uvHeight = atlasEntry.height / trFontFace.data.common.scaleH;
266
+
267
+ // TODO: (Performance) We can optimize this by using ELEMENT_ARRAY_BUFFER
268
+ // eliminating the need to duplicate vertices
269
+
270
+ // Top-left
271
+ vertexBuffer[bufferOffset++] = quadX;
272
+ vertexBuffer[bufferOffset++] = quadY;
273
+ vertexBuffer[bufferOffset++] = u;
274
+ vertexBuffer[bufferOffset++] = v;
275
+
276
+ // Top-right
277
+ vertexBuffer[bufferOffset++] = quadX + glyph.width;
278
+ vertexBuffer[bufferOffset++] = quadY;
279
+ vertexBuffer[bufferOffset++] = u + uvWidth;
280
+ vertexBuffer[bufferOffset++] = v;
281
+
282
+ // Bottom-left
283
+ vertexBuffer[bufferOffset++] = quadX;
284
+ vertexBuffer[bufferOffset++] = quadY + glyph.height;
285
+ vertexBuffer[bufferOffset++] = u;
286
+ vertexBuffer[bufferOffset++] = v + uvHeight;
287
+
288
+ // Bottom-right
289
+ vertexBuffer[bufferOffset++] = quadX + glyph.width;
290
+ vertexBuffer[bufferOffset++] = quadY + glyph.height;
291
+ vertexBuffer[bufferOffset++] = u + uvWidth;
292
+ vertexBuffer[bufferOffset++] = v + uvHeight;
293
+ }
294
+
295
+ maxY = Math.max(maxY, quadY + glyph.height);
296
+ maxX = Math.max(maxX, quadX + glyph.width);
297
+ curX += glyph.xAdvance;
298
+ }
299
+ } else {
300
+ // Unmapped character
301
+
302
+ // Handle newlines
303
+ if (glyph.codepoint === 10) {
304
+ if (nextLineWillFit) {
305
+ // The whole line fit, so we can break to the next line
306
+ break;
307
+ } else {
308
+ // The whole line won't fit, so we need to add the overflow suffix
309
+ glyphs = shaper.shapeText(
310
+ shaperProps,
311
+ new PeekableIterator(getUnicodeCodepoints(overflowSuffix, 0), 0),
312
+ );
313
+ // HACK: For the rest of the line when inserting the overflow suffix,
314
+ // set contain = 'none' to prevent an infinite loop.
315
+ contain = 'none';
316
+ }
317
+ }
318
+ }
319
+ }
320
+
321
+ // Prepare for the next line...
322
+ if (curLineBufferStart !== -1) {
323
+ bufferLineInfos.push({
324
+ bufferStart: curLineBufferStart,
325
+ bufferEnd: bufferOffset,
326
+ });
327
+ curLineBufferStart = -1;
328
+ }
329
+ curX = 0;
330
+ curY += vertexLineHeight;
331
+ curLineIndex++;
332
+ lastWord.codepointIndex = -1;
333
+ xStartLastWordBoundary = 0;
334
+
335
+ // Figure out if there are any more lines to render...
336
+ if (!forceFullLayoutCalc && contain === 'both' && curY > rwSdf.y2) {
337
+ // Stop layout calculation early (for performance purposes) if:
338
+ // - We're not forcing a full layout calculation (for width/height calculation)
339
+ // - ...and we're containing the text vertically+horizontally (contain === 'both')
340
+ // - ...and we have a render window
341
+ // - ...and the next line is below the bottom of the render window
342
+ moreLines = false;
343
+ } else if (glyphResult && glyphResult.done) {
344
+ // If we've reached the end of the text, we know we're done
345
+ moreLines = false;
346
+ } else if (!nextLineWillFit) {
347
+ // If we're contained vertically+horizontally (contain === 'both')
348
+ // but not scrollable and the next line won't fit, we're done.
349
+ moreLines = false;
350
+ }
351
+ }
352
+
353
+ // Use textAlign to determine if we need to adjust the x position of the text
354
+ // in the buffer line by line
355
+ if (textAlign === 'center') {
356
+ const vertexTextW = contain === 'none' ? maxX : vertexW;
357
+
358
+ for (let i = 0; i < bufferLineInfos.length; i++) {
359
+ const line = bufferLineInfos[i]!;
360
+ // - 4 = the x position of a rightmost vertex
361
+ const lineWidth =
362
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
363
+ vertexBuffer[line.bufferEnd - 4]! - vertexBuffer[line.bufferStart]!;
364
+
365
+ const xOffset = (vertexTextW - lineWidth) / 2;
366
+ for (let j = line.bufferStart; j < line.bufferEnd; j += 4) {
367
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
368
+ vertexBuffer[j]! += xOffset;
369
+ }
370
+ }
371
+ } else if (textAlign === 'right') {
372
+ const vertexTextW = contain === 'none' ? maxX : vertexW;
373
+
374
+ for (let i = 0; i < bufferLineInfos.length; i++) {
375
+ const line = bufferLineInfos[i]!;
376
+ const lineWidth =
377
+ line.bufferEnd === line.bufferStart
378
+ ? 0
379
+ : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
380
+ vertexBuffer[line.bufferEnd - 4]! - vertexBuffer[line.bufferStart]!;
381
+
382
+ const xOffset = vertexTextW - lineWidth;
383
+ for (let j = line.bufferStart; j < line.bufferEnd; j += 4) {
384
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
385
+ vertexBuffer[j]! += xOffset;
386
+ }
387
+ }
388
+ }
389
+
390
+ assertTruthy(glyphResult);
391
+
392
+ return {
393
+ bufferNumFloats: bufferOffset,
394
+ bufferNumQuads: bufferOffset / 16,
395
+ layoutNumCharacters: glyphResult.done
396
+ ? text.length - startingCodepointIndex
397
+ : glyphResult.value.cluster - startingCodepointIndex + 1,
398
+ fullyProcessed: !!glyphResult.done,
399
+ maxX,
400
+ maxY,
401
+ numLines: lineCache.length,
402
+ };
403
+ }