44 *--------------------------------------------------------------------------------------------*/
55
66import type { IBuffer , IMarker , ITheme , Terminal as RawXtermTerminal } from 'xterm' ;
7+ import type { CanvasAddon as CanvasAddonType } from 'xterm-addon-canvas' ;
78import type { ISearchOptions , SearchAddon as SearchAddonType } from 'xterm-addon-search' ;
89import type { Unicode11Addon as Unicode11AddonType } from 'xterm-addon-unicode11' ;
910import type { WebglAddon as WebglAddonType } from 'xterm-addon-webgl' ;
10- import { SerializeAddon as SerializeAddonType } from 'xterm-addon-serialize' ;
11+ import type { SerializeAddon as SerializeAddonType } from 'xterm-addon-serialize' ;
1112import { IXtermCore } from 'vs/workbench/contrib/terminal/browser/xterm-private' ;
1213import { ConfigurationTarget , IConfigurationService } from 'vs/platform/configuration/common/configuration' ;
1314import { TerminalConfigHelper } from 'vs/workbench/contrib/terminal/browser/terminalConfigHelper' ;
@@ -42,10 +43,11 @@ import { IGenericMarkProperties } from 'vs/platform/terminal/common/terminalProc
4243const SLOW_CANVAS_RENDER_THRESHOLD = 50 ;
4344const NUMBER_OF_FRAMES_TO_MEASURE = 20 ;
4445
46+ let CanvasAddon : typeof CanvasAddonType ;
4547let SearchAddon : typeof SearchAddonType ;
48+ let SerializeAddon : typeof SerializeAddonType ;
4649let Unicode11Addon : typeof Unicode11AddonType ;
4750let WebglAddon : typeof WebglAddonType ;
48- let SerializeAddon : typeof SerializeAddonType ;
4951
5052/**
5153 * Wraps the xterm object with additional functionality. Interaction with the backing process is out
@@ -65,6 +67,7 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
6567 private _decorationAddon : DecorationAddon ;
6668
6769 // Optional addons
70+ private _canvasAddon ?: CanvasAddonType ;
6871 private _searchAddon ?: SearchAddonType ;
6972 private _unicode11Addon ?: Unicode11AddonType ;
7073 private _webglAddon ?: WebglAddonType ;
@@ -140,7 +143,6 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
140143 fastScrollModifier : 'alt' ,
141144 fastScrollSensitivity : config . fastScrollSensitivity ,
142145 scrollSensitivity : config . mouseWheelScrollSensitivity ,
143- // rendererType: this._getBuiltInXtermRenderer(config.gpuAcceleration, XtermTerminal._suggestedRendererType),
144146 wordSeparator : config . wordSeparators ,
145147 overviewRulerWidth : 10
146148 } ) ) ;
@@ -214,6 +216,9 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
214216 this . _container = container ;
215217 if ( this . _shouldLoadWebgl ( ) ) {
216218 this . _enableWebglRenderer ( ) ;
219+ } else if ( this . _shouldLoadCanvas ( ) ) {
220+ this . _enableCanvasRenderer ( ) ;
221+ // rendererType: this._getBuiltInXtermRenderer(config.gpuAcceleration, XtermTerminal._suggestedRendererType),
217222 }
218223 // Screen must be created at this point as xterm.open is called
219224 return this . _container . querySelector ( '.xterm-screen' ) ! ;
@@ -241,15 +246,22 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
241246 this . _enableWebglRenderer ( ) ;
242247 } else {
243248 this . _disposeOfWebglRenderer ( ) ;
244- // TODO: Fix renderer
245- // this.raw.options.rendererType = this._getBuiltInXtermRenderer(config.gpuAcceleration, XtermTerminal._suggestedRendererType);
249+ if ( this . _shouldLoadCanvas ( ) ) {
250+ this . _enableCanvasRenderer ( ) ;
251+ } else {
252+ this . _disposeOfCanvasRenderer ( ) ;
253+ }
246254 }
247255 }
248256
249257 private _shouldLoadWebgl ( ) : boolean {
250258 return ! isSafari && ( this . _configHelper . config . gpuAcceleration === 'auto' && XtermTerminal . _suggestedRendererType === undefined ) || this . _configHelper . config . gpuAcceleration === 'on' ;
251259 }
252260
261+ private _shouldLoadCanvas ( ) : boolean {
262+ return ( this . _configHelper . config . gpuAcceleration === 'auto' && ( XtermTerminal . _suggestedRendererType === undefined || XtermTerminal . _suggestedRendererType === 'canvas' ) ) || this . _configHelper . config . gpuAcceleration === 'canvas' ;
263+ }
264+
253265 forceRedraw ( ) {
254266 this . _webglAddon ?. clearTextureAtlas ( ) ;
255267 this . raw . clearTextureAtlas ( ) ;
@@ -436,6 +448,7 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
436448 }
437449 const Addon = await this . _getWebglAddonConstructor ( ) ;
438450 this . _webglAddon = new Addon ( ) ;
451+ this . _disposeOfCanvasRenderer ( ) ;
439452 try {
440453 this . raw . loadAddon ( this . _webglAddon ) ;
441454 this . _logService . trace ( 'Webgl was loaded' ) ;
@@ -458,13 +471,41 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
458471 if ( ! neverMeasureRenderTime && this . _configHelper . config . gpuAcceleration !== 'off' ) {
459472 this . _measureRenderTime ( ) ;
460473 }
461- // TODO: Fix renderer
462- // this.raw.options.rendererType = 'canvas';
463- // XtermTerminal._suggestedRendererType = 'canvas';
474+ XtermTerminal . _suggestedRendererType = 'canvas' ;
464475 this . _disposeOfWebglRenderer ( ) ;
476+ this . _enableCanvasRenderer ( ) ;
465477 }
466478 }
467479
480+ private async _enableCanvasRenderer ( ) : Promise < void > {
481+ if ( ! this . raw . element || this . _canvasAddon ) {
482+ return ;
483+ }
484+ const Addon = await this . _getCanvasAddonConstructor ( ) ;
485+ this . _canvasAddon = new Addon ( ) ;
486+ this . _disposeOfWebglRenderer ( ) ;
487+ try {
488+ this . raw . loadAddon ( this . _canvasAddon ) ;
489+ this . _logService . trace ( 'Canvas was loaded' ) ;
490+ } catch ( e ) {
491+ this . _logService . warn ( `Canvas could not be loaded. Falling back to the dom renderer type.` , e ) ;
492+ const neverMeasureRenderTime = this . _storageService . getBoolean ( TerminalStorageKeys . NeverMeasureRenderTime , StorageScope . APPLICATION , false ) ;
493+ // if it's already set to dom, no need to measure render time
494+ if ( ! neverMeasureRenderTime && this . _configHelper . config . gpuAcceleration !== 'off' ) {
495+ this . _measureRenderTime ( ) ;
496+ }
497+ XtermTerminal . _suggestedRendererType = 'dom' ;
498+ this . _disposeOfCanvasRenderer ( ) ;
499+ }
500+ }
501+
502+ protected async _getCanvasAddonConstructor ( ) : Promise < typeof CanvasAddonType > {
503+ if ( ! CanvasAddon ) {
504+ CanvasAddon = ( await import ( 'xterm-addon-canvas' ) ) . CanvasAddon ;
505+ }
506+ return CanvasAddon ;
507+ }
508+
468509 protected async _getSearchAddonConstructor ( ) : Promise < typeof SearchAddonType > {
469510 if ( ! SearchAddon ) {
470511 SearchAddon = ( await import ( 'xterm-addon-search' ) ) . SearchAddon ;
@@ -493,6 +534,15 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal, II
493534 return SerializeAddon ;
494535 }
495536
537+ private _disposeOfCanvasRenderer ( ) : void {
538+ try {
539+ this . _canvasAddon ?. dispose ( ) ;
540+ } catch {
541+ // ignore
542+ }
543+ this . _canvasAddon = undefined ;
544+ }
545+
496546 private _disposeOfWebglRenderer ( ) : void {
497547 try {
498548 this . _webglAddon ?. dispose ( ) ;
0 commit comments