@xterm/xterm 5.6.0-beta.48 → 5.6.0-beta.49

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.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@xterm/xterm",
3
3
  "description": "Full xterm terminal, in your browser",
4
- "version": "5.6.0-beta.48",
4
+ "version": "5.6.0-beta.49",
5
5
  "main": "lib/xterm.js",
6
6
  "module": "lib/xterm.mjs",
7
7
  "style": "css/xterm.css",
@@ -27,9 +27,9 @@ const SELECTION_CLASS = 'xterm-selection';
27
27
  let nextTerminalId = 1;
28
28
 
29
29
  /**
30
- * A fallback renderer for when canvas is slow. This is not meant to be
31
- * particularly fast or feature complete, more just stable and usable for when
32
- * canvas is not an option.
30
+ * The standard renderer and fallback for when the webgl addon is slow. This is not meant to be
31
+ * particularly fast and will even lack some features such as custom glyphs, hoever this is more
32
+ * reliable as webgl may not work on some machines.
33
33
  */
34
34
  export class DomRenderer extends Disposable implements IRenderer {
35
35
  private _rowFactory: DomRendererRowFactory;
@@ -612,9 +612,6 @@ declare module '@xterm/xterm' {
612
612
  * What layer to render the decoration at when {@link backgroundColor} or
613
613
  * {@link foregroundColor} are used. `'bottom'` will render under the
614
614
  * selection, `'top`' will render above the selection\*.
615
- *
616
- * *\* The selection will render on top regardless of layer on the canvas
617
- * renderer due to how it renders selection separately.*
618
615
  */
619
616
  readonly layer?: 'bottom' | 'top';
620
617
 
@@ -1116,7 +1113,7 @@ declare module '@xterm/xterm' {
1116
1113
  * render together, since they aren't drawn as optimally as individual
1117
1114
  * characters.
1118
1115
  *
1119
- * NOTE: character joiners are only used by the canvas renderer.
1116
+ * NOTE: character joiners are only used by the webgl renderer.
1120
1117
  *
1121
1118
  * @param handler The function that determines character joins. It is called
1122
1119
  * with a string of text that is eligible for joining and returns an array
@@ -1128,7 +1125,7 @@ declare module '@xterm/xterm' {
1128
1125
 
1129
1126
  /**
1130
1127
  * (EXPERIMENTAL) Deregisters the character joiner if one was registered.
1131
- * NOTE: character joiners are only used by the canvas renderer.
1128
+ * NOTE: character joiners are only used by the webgl renderer.
1132
1129
  * @param joinerId The character joiner's ID (returned after register)
1133
1130
  */
1134
1131
  deregisterCharacterJoiner(joinerId: number): void;
@@ -1267,7 +1264,7 @@ declare module '@xterm/xterm' {
1267
1264
  refresh(start: number, end: number): void;
1268
1265
 
1269
1266
  /**
1270
- * Clears the texture atlas of the canvas renderer if it's active. Doing
1267
+ * Clears the texture atlas of the webgl renderer if it's active. Doing
1271
1268
  * this will force a redraw of all glyphs which can workaround issues
1272
1269
  * causing the texture to become corrupt, for example Chromium/Nvidia has an
1273
1270
  * issue where the texture gets messed up when resuming the OS from sleep.