Support pausing in RenderCoordinator
This actually removes the pause rendering functionality when the resize and theme changes but simplifies it as a result, they also rarely happen especially when off screen/hidden. Fixes #2099
This commit is contained in:
+1
-1
@@ -766,7 +766,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
|
|||||||
this._colorManager.setTheme(this._theme);
|
this._colorManager.setTheme(this._theme);
|
||||||
this._setupRenderer();
|
this._setupRenderer();
|
||||||
|
|
||||||
this._renderCoordinator = new RenderCoordinator(this.renderer, this.rows);
|
this._renderCoordinator = new RenderCoordinator(this.renderer, this.rows, this.screenElement);
|
||||||
this._renderCoordinator.onRender(e => this._onRender.fire(e));
|
this._renderCoordinator.onRender(e => this._onRender.fire(e));
|
||||||
this.onResize(e => this._renderCoordinator.resize(e.cols, e.rows));
|
this.onResize(e => this._renderCoordinator.resize(e.cols, e.rows));
|
||||||
|
|
||||||
|
|||||||
@@ -14,17 +14,20 @@ export class RenderCoordinator extends Disposable {
|
|||||||
private _renderDebouncer: RenderDebouncer;
|
private _renderDebouncer: RenderDebouncer;
|
||||||
private _screenDprMonitor: ScreenDprMonitor;
|
private _screenDprMonitor: ScreenDprMonitor;
|
||||||
|
|
||||||
|
private _isPaused: boolean = false;
|
||||||
|
private _needsFullRefresh: boolean = false;
|
||||||
|
private _canvasWidth: number = 0;
|
||||||
|
private _canvasHeight: number = 0;
|
||||||
|
|
||||||
private _onCanvasResize = new EventEmitter2<{ width: number, height: number }>();
|
private _onCanvasResize = new EventEmitter2<{ width: number, height: number }>();
|
||||||
public get onCanvasResize(): IEvent<{ width: number, height: number }> { return this._onCanvasResize.event; }
|
public get onCanvasResize(): IEvent<{ width: number, height: number }> { return this._onCanvasResize.event; }
|
||||||
private _onRender = new EventEmitter2<{ start: number, end: number }>();
|
private _onRender = new EventEmitter2<{ start: number, end: number }>();
|
||||||
public get onRender(): IEvent<{ start: number, end: number }> { return this._onRender.event; }
|
public get onRender(): IEvent<{ start: number, end: number }> { return this._onRender.event; }
|
||||||
|
|
||||||
private _canvasWidth: number = 0;
|
|
||||||
private _canvasHeight: number = 0;
|
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
private _renderer: IRenderer,
|
private _renderer: IRenderer,
|
||||||
private _rowCount: number
|
private _rowCount: number,
|
||||||
|
screenElement: HTMLElement
|
||||||
) {
|
) {
|
||||||
super();
|
super();
|
||||||
this._renderDebouncer = new RenderDebouncer((start, end) => this._renderRows(start, end));
|
this._renderDebouncer = new RenderDebouncer((start, end) => this._renderRows(start, end));
|
||||||
@@ -37,9 +40,29 @@ export class RenderCoordinator extends Disposable {
|
|||||||
// dprchange should handle this case, we need this as well for browsers that don't support the
|
// dprchange should handle this case, we need this as well for browsers that don't support the
|
||||||
// matchMedia query.
|
// matchMedia query.
|
||||||
this.register(addDisposableDomListener(window, 'resize', () => this._renderer.onDevicePixelRatioChange()));
|
this.register(addDisposableDomListener(window, 'resize', () => this._renderer.onDevicePixelRatioChange()));
|
||||||
|
|
||||||
|
// Detect whether IntersectionObserver is detected and enable renderer pause
|
||||||
|
// and resume based on terminal visibility if so
|
||||||
|
if ('IntersectionObserver' in window) {
|
||||||
|
const observer = new IntersectionObserver(e => this._onIntersectionChange(e[e.length - 1]), { threshold: 0 });
|
||||||
|
observer.observe(screenElement);
|
||||||
|
this.register({ dispose: () => observer.disconnect() });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private _onIntersectionChange(entry: IntersectionObserverEntry): void {
|
||||||
|
this._isPaused = entry.intersectionRatio === 0;
|
||||||
|
if (!this._isPaused && this._needsFullRefresh) {
|
||||||
|
this.refreshRows(0, this._rowCount - 1);
|
||||||
|
this._needsFullRefresh = false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public refreshRows(start: number, end: number): void {
|
public refreshRows(start: number, end: number): void {
|
||||||
|
if (this._isPaused) {
|
||||||
|
this._needsFullRefresh = true;
|
||||||
|
return;
|
||||||
|
}
|
||||||
this._renderDebouncer.refresh(start, end, this._rowCount);
|
this._renderDebouncer.refresh(start, end, this._rowCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,8 +16,6 @@ import { IColorSet } from '../ui/Types';
|
|||||||
export class Renderer extends Disposable implements IRenderer {
|
export class Renderer extends Disposable implements IRenderer {
|
||||||
private _renderLayers: IRenderLayer[];
|
private _renderLayers: IRenderLayer[];
|
||||||
private _devicePixelRatio: number;
|
private _devicePixelRatio: number;
|
||||||
private _isPaused: boolean = false;
|
|
||||||
private _needsFullRefresh: boolean = false;
|
|
||||||
private _characterJoinerRegistry: ICharacterJoinerRegistry;
|
private _characterJoinerRegistry: ICharacterJoinerRegistry;
|
||||||
|
|
||||||
public dimensions: IRenderDimensions;
|
public dimensions: IRenderDimensions;
|
||||||
@@ -53,14 +51,6 @@ export class Renderer extends Disposable implements IRenderer {
|
|||||||
this._devicePixelRatio = window.devicePixelRatio;
|
this._devicePixelRatio = window.devicePixelRatio;
|
||||||
this._updateDimensions();
|
this._updateDimensions();
|
||||||
this.onOptionsChanged();
|
this.onOptionsChanged();
|
||||||
|
|
||||||
// Detect whether IntersectionObserver is detected and enable renderer pause
|
|
||||||
// and resume based on terminal visibility if so
|
|
||||||
if ('IntersectionObserver' in window) {
|
|
||||||
const observer = new IntersectionObserver(e => this.onIntersectionChange(e[e.length - 1]), { threshold: 0 });
|
|
||||||
observer.observe(this._terminal.element);
|
|
||||||
this.register({ dispose: () => observer.disconnect() });
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public dispose(): void {
|
public dispose(): void {
|
||||||
@@ -68,14 +58,6 @@ export class Renderer extends Disposable implements IRenderer {
|
|||||||
this._renderLayers.forEach(l => l.dispose());
|
this._renderLayers.forEach(l => l.dispose());
|
||||||
}
|
}
|
||||||
|
|
||||||
public onIntersectionChange(entry: IntersectionObserverEntry): void {
|
|
||||||
this._isPaused = entry.intersectionRatio === 0;
|
|
||||||
if (!this._isPaused && this._needsFullRefresh) {
|
|
||||||
this._terminal.refresh(0, this._terminal.rows - 1);
|
|
||||||
this._needsFullRefresh = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public onDevicePixelRatioChange(): void {
|
public onDevicePixelRatioChange(): void {
|
||||||
// If the device pixel ratio changed, the char atlas needs to be regenerated
|
// If the device pixel ratio changed, the char atlas needs to be regenerated
|
||||||
// and the terminal needs to refreshed
|
// and the terminal needs to refreshed
|
||||||
@@ -94,11 +76,7 @@ export class Renderer extends Disposable implements IRenderer {
|
|||||||
l.reset(this._terminal);
|
l.reset(this._terminal);
|
||||||
});
|
});
|
||||||
|
|
||||||
if (this._isPaused) {
|
this._terminal.refresh(0, this._terminal.rows - 1);
|
||||||
this._needsFullRefresh = true;
|
|
||||||
} else {
|
|
||||||
this._terminal.refresh(0, this._terminal.rows - 1);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public onResize(cols: number, rows: number): void {
|
public onResize(cols: number, rows: number): void {
|
||||||
@@ -109,11 +87,7 @@ export class Renderer extends Disposable implements IRenderer {
|
|||||||
this._renderLayers.forEach(l => l.resize(this._terminal, this.dimensions));
|
this._renderLayers.forEach(l => l.resize(this._terminal, this.dimensions));
|
||||||
|
|
||||||
// Force a refresh
|
// Force a refresh
|
||||||
if (this._isPaused) {
|
this._terminal.refresh(0, this._terminal.rows - 1);
|
||||||
this._needsFullRefresh = true;
|
|
||||||
} else {
|
|
||||||
this._terminal.refresh(0, this._terminal.rows - 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resize the screen
|
// Resize the screen
|
||||||
this._terminal.screenElement.style.width = `${this.dimensions.canvasWidth}px`;
|
this._terminal.screenElement.style.width = `${this.dimensions.canvasWidth}px`;
|
||||||
@@ -149,11 +123,7 @@ export class Renderer extends Disposable implements IRenderer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private _runOperation(operation: (layer: IRenderLayer) => void): void {
|
private _runOperation(operation: (layer: IRenderLayer) => void): void {
|
||||||
if (this._isPaused) {
|
this._renderLayers.forEach(l => operation(l));
|
||||||
this._needsFullRefresh = true;
|
|
||||||
} else {
|
|
||||||
this._renderLayers.forEach(l => operation(l));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user