Merge remote-tracking branch 'upstream/master' into 3969

This commit is contained in:
Daniel Imms
2022-07-31 11:35:47 -07:00
6 changed files with 127 additions and 41 deletions
+5
View File
@@ -2,6 +2,7 @@
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+. An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.
The purpose of this addon is to be used as a fallback for the [webgl addon](https://www.npmjs.com/package/xterm-addon-webgl) when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.
### Install ### Install
@@ -21,3 +22,7 @@ terminal.loadAddon(new CanvasAddon());
``` ```
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-canvas/typings/xterm-addon-canvas.d.ts) for more advanced usage. See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-canvas/typings/xterm-addon-canvas.d.ts) for more advanced usage.
### See also
- [xterm-addon-webgl](https://www.npmjs.com/package/xterm-addon-webgl) A renderer for xterm.js that uses WebGL
+4
View File
@@ -36,3 +36,7 @@ terminal.loadAddon(addon);
``` ```
Read more about handling WebGL context losses on the [Khronos wiki](https://www.khronos.org/webgl/wiki/HandlingContextLost). Read more about handling WebGL context losses on the [Khronos wiki](https://www.khronos.org/webgl/wiki/HandlingContextLost).
### See also
- [xterm-addon-canvas](https://www.npmjs.com/package/xterm-addon-canvas) A renderer for xterm.js that uses a 2d canvas that can be used as a fallback when WebGL is not available
+10 -3
View File
@@ -406,6 +406,7 @@ export class WebglRenderer extends Disposable implements IRenderer {
// override logic throughout the different sub-renderers // override logic throughout the different sub-renderers
let bgOverride: number | undefined; let bgOverride: number | undefined;
let fgOverride: number | undefined; let fgOverride: number | undefined;
let isSelected: boolean = false;
// Apply decorations on the bottom layer // Apply decorations on the bottom layer
for (const d of this._decorationService.getDecorationsAtCell(x, y, 'bottom')) { for (const d of this._decorationService.getDecorationsAtCell(x, y, 'bottom')) {
@@ -418,7 +419,8 @@ export class WebglRenderer extends Disposable implements IRenderer {
} }
// Apply the selection color if needed // Apply the selection color if needed
if (this._isCellSelected(x, y)) { isSelected = this._isCellSelected(x, y);
if (isSelected) {
bgOverride = (this._coreBrowserService.isFocused ? this._colors.selectionBackgroundOpaque : this._colors.selectionInactiveBackgroundOpaque).rgba >> 8 & 0xFFFFFF; bgOverride = (this._coreBrowserService.isFocused ? this._colors.selectionBackgroundOpaque : this._colors.selectionInactiveBackgroundOpaque).rgba >> 8 & 0xFFFFFF;
if (this._colors.selectionForeground) { if (this._colors.selectionForeground) {
fgOverride = this._colors.selectionForeground.rgba >> 8 & 0xFFFFFF; fgOverride = this._colors.selectionForeground.rgba >> 8 & 0xFFFFFF;
@@ -438,8 +440,13 @@ export class WebglRenderer extends Disposable implements IRenderer {
// Convert any overrides from rgba to the fg/bg packed format. This resolves the inverse flag // Convert any overrides from rgba to the fg/bg packed format. This resolves the inverse flag
// ahead of time in order to use the correct cache key // ahead of time in order to use the correct cache key
if (bgOverride !== undefined) { if (bgOverride !== undefined) {
// Non-RGB attributes from model + override + force RGB color mode if (isSelected) {
bgOverride = (this._workCell.bg & ~Attributes.RGB_MASK) | bgOverride | Attributes.CM_RGB; // Non-RGB attributes from model + force non-dim + override + force RGB color mode
bgOverride = (this._workCell.bg & ~Attributes.RGB_MASK & ~BgFlags.DIM) | bgOverride | Attributes.CM_RGB;
} else {
// Non-RGB attributes from model + override + force RGB color mode
bgOverride = (this._workCell.bg & ~Attributes.RGB_MASK) | bgOverride | Attributes.CM_RGB;
}
} }
if (fgOverride !== undefined) { if (fgOverride !== undefined) {
// Non-RGB attributes from model + force disable inverse + override + force RGB color mode // Non-RGB attributes from model + force disable inverse + override + force RGB color mode
@@ -45,6 +45,12 @@ const NULL_RASTERIZED_GLYPH: IRasterizedGlyph = {
const TMP_CANVAS_GLYPH_PADDING = 2; const TMP_CANVAS_GLYPH_PADDING = 2;
interface ICharAtlasActiveRow {
x: number;
y: number;
height: number;
}
export class WebglCharAtlas implements IDisposable { export class WebglCharAtlas implements IDisposable {
private _didWarmUp: boolean = false; private _didWarmUp: boolean = false;
@@ -59,13 +65,22 @@ export class WebglCharAtlas implements IDisposable {
// A temporary context that glyphs are drawn to before being transfered to the atlas. // A temporary context that glyphs are drawn to before being transfered to the atlas.
private _tmpCtx: CanvasRenderingContext2D; private _tmpCtx: CanvasRenderingContext2D;
// Since glyphs are expected to be around the same height, the packing // Texture atlas current positioning data. The texture packing strategy used is to fill from
// strategy used it to fill a row with glyphs while keeping track of the // left-to-right and top-to-bottom. When the glyph being written is less than half of the current
// tallest glyph in the row. Once the row is full a new row is started at // row's height, the following happens:
// (0,lastRow+lastRowTallestGlyph). //
private _currentRowY: number = 0; // - The current row becomes the fixed height row A
private _currentRowX: number = 0; // - A new fixed height row B the exact size of the glyph is created below the current row
private _currentRowHeight: number = 0; // - A new dynamic height current row is created below B
//
// This strategy does a good job preventing space being wasted for very short glyphs such as
// underscores, hyphens etc. or those with underlines rendered.
private _currentRow: ICharAtlasActiveRow = {
x: 0,
y: 0,
height: 0
};
private readonly _fixedRows: ICharAtlasActiveRow[] = [];
public hasCanvasChanged = false; public hasCanvasChanged = false;
@@ -118,7 +133,7 @@ export class WebglCharAtlas implements IDisposable {
} }
public beginFrame(): boolean { public beginFrame(): boolean {
if (this._currentRowY > TEXTURE_CAPACITY) { if (this._currentRow.y > TEXTURE_CAPACITY) {
this.clearTexture(); this.clearTexture();
this.warmUp(); this.warmUp();
return true; return true;
@@ -127,15 +142,16 @@ export class WebglCharAtlas implements IDisposable {
} }
public clearTexture(): void { public clearTexture(): void {
if (this._currentRowX === 0 && this._currentRowY === 0) { if (this._currentRow.x === 0 && this._currentRow.y === 0) {
return; return;
} }
this._cacheCtx.clearRect(0, 0, TEXTURE_WIDTH, TEXTURE_HEIGHT); this._cacheCtx.clearRect(0, 0, TEXTURE_WIDTH, TEXTURE_HEIGHT);
this._cacheMap = {}; this._cacheMap = {};
this._cacheMapCombined = {}; this._cacheMapCombined = {};
this._currentRowHeight = 0; this._currentRow.x = 0;
this._currentRowX = 0; this._currentRow.y = 0;
this._currentRowY = 0; this._currentRow.height = 0;
this._fixedRows.length = 0;
this._didWarmUp = false; this._didWarmUp = false;
} }
@@ -422,8 +438,10 @@ export class WebglCharAtlas implements IDisposable {
// Draw underline // Draw underline
if (underline) { if (underline) {
this._tmpCtx.save(); this._tmpCtx.save();
const lineWidth = Math.max(1, Math.floor(this._config.fontSize * window.devicePixelRatio / 10)); const lineWidth = Math.max(1, Math.floor(this._config.fontSize * window.devicePixelRatio / 15));
const yOffset = this._tmpCtx.lineWidth % 2 === 1 ? 0.5 : 0; // When the width is odd, draw at 0.5 position // When the width is odd, draw at 0.5 position. Offset by an additional 1 dpr to bring the
// underline closer to the character
const yOffset = (lineWidth % 2 === 1 ? 0.5 : 0) + window.devicePixelRatio;
this._tmpCtx.lineWidth = lineWidth; this._tmpCtx.lineWidth = lineWidth;
// Underline color // Underline color
@@ -492,18 +510,18 @@ export class WebglCharAtlas implements IDisposable {
break; break;
case UnderlineStyle.DOTTED: case UnderlineStyle.DOTTED:
this._tmpCtx.setLineDash([window.devicePixelRatio * 2, window.devicePixelRatio]); this._tmpCtx.setLineDash([window.devicePixelRatio * 2, window.devicePixelRatio]);
this._tmpCtx.moveTo(xLeft, yMid); this._tmpCtx.moveTo(xLeft, yTop);
this._tmpCtx.lineTo(xRight, yMid); this._tmpCtx.lineTo(xRight, yTop);
break; break;
case UnderlineStyle.DASHED: case UnderlineStyle.DASHED:
this._tmpCtx.setLineDash([window.devicePixelRatio * 4, window.devicePixelRatio * 3]); this._tmpCtx.setLineDash([window.devicePixelRatio * 4, window.devicePixelRatio * 3]);
this._tmpCtx.moveTo(xLeft, yMid); this._tmpCtx.moveTo(xLeft, yTop);
this._tmpCtx.lineTo(xRight, yMid); this._tmpCtx.lineTo(xRight, yTop);
break; break;
case UnderlineStyle.SINGLE: case UnderlineStyle.SINGLE:
default: default:
this._tmpCtx.moveTo(xLeft, yMid); this._tmpCtx.moveTo(xLeft, yTop);
this._tmpCtx.lineTo(xRight, yMid); this._tmpCtx.lineTo(xRight, yTop);
break; break;
} }
this._tmpCtx.stroke(); this._tmpCtx.stroke();
@@ -516,9 +534,17 @@ export class WebglCharAtlas implements IDisposable {
// text // text
if (!this._config.allowTransparency && chars !== ' ') { if (!this._config.allowTransparency && chars !== ' ') {
// This translates to 1/2 the line width in either direction // This translates to 1/2 the line width in either direction
this._tmpCtx.save();
// Clip the region to only draw in valid pixels near the underline to avoid a slight
// outline around the whole glyph, as well as additional pixels in the glyph at the top
// which would increase GPU memory demands
const clipRegion = new Path2D();
clipRegion.rect(xLeft, yTop - Math.ceil(lineWidth / 2), this._config.scaledCellWidth, yBot - yTop + Math.ceil(lineWidth / 2));
this._tmpCtx.clip(clipRegion);
this._tmpCtx.lineWidth = window.devicePixelRatio * 3; this._tmpCtx.lineWidth = window.devicePixelRatio * 3;
this._tmpCtx.strokeStyle = backgroundColor.css; this._tmpCtx.strokeStyle = backgroundColor.css;
this._tmpCtx.strokeText(chars, padding, padding + this._config.scaledCharHeight); this._tmpCtx.strokeText(chars, padding, padding + this._config.scaledCharHeight);
this._tmpCtx.restore();
} }
} }
} }
@@ -583,22 +609,66 @@ export class WebglCharAtlas implements IDisposable {
} }
const clippedImageData = this._clipImageData(imageData, this._workBoundingBox); const clippedImageData = this._clipImageData(imageData, this._workBoundingBox);
// Check if there is enough room in the current row and go to next if needed // Find the best atlas row to use
if (this._currentRowX + rasterizedGlyph.size.x > TEXTURE_WIDTH) { let activeRow: ICharAtlasActiveRow;
this._currentRowX = 0; while (true) {
this._currentRowY += this._currentRowHeight; // Select the ideal existing row, preferring fixed rows over the current row
this._currentRowHeight = 0; activeRow = this._currentRow;
for (const row of this._fixedRows) {
if ((activeRow === this._currentRow || row.height < activeRow.height) && rasterizedGlyph.size.y <= row.height) {
activeRow = row;
}
}
// Create a new one if vertical space would be wasted, fixing the previously active row in the
// process as it now has a fixed height
if (activeRow.height > rasterizedGlyph.size.y * 2) {
// Fix the current row as the new row is being added below
if (this._currentRow.height > 0) {
this._fixedRows.push(this._currentRow);
}
// Create the new fixed height row
activeRow = {
x: 0,
y: this._currentRow.y + this._currentRow.height,
height: rasterizedGlyph.size.y
};
this._fixedRows.push(activeRow);
// Create the new current row below the new fixed height row
this._currentRow = {
x: 0,
y: activeRow.y + activeRow.height,
height: 0
};
}
// Exit the loop if there is enough room in the row
if (activeRow.x + rasterizedGlyph.size.x <= TEXTURE_WIDTH) {
break;
}
// If there is enough room in the current row, finish it and try again
if (activeRow === this._currentRow) {
activeRow.x = 0;
activeRow.y += activeRow.height;
activeRow.height = 0;
} else {
this._fixedRows.splice(this._fixedRows.indexOf(activeRow), 1);
}
} }
// Record texture position // Record texture position
rasterizedGlyph.texturePosition.x = this._currentRowX; rasterizedGlyph.texturePosition.x = activeRow.x;
rasterizedGlyph.texturePosition.y = this._currentRowY; rasterizedGlyph.texturePosition.y = activeRow.y;
rasterizedGlyph.texturePositionClipSpace.x = this._currentRowX / TEXTURE_WIDTH; rasterizedGlyph.texturePositionClipSpace.x = activeRow.x / TEXTURE_WIDTH;
rasterizedGlyph.texturePositionClipSpace.y = this._currentRowY / TEXTURE_HEIGHT; rasterizedGlyph.texturePositionClipSpace.y = activeRow.y / TEXTURE_HEIGHT;
// Update atlas current row // Update atlas current row, for fixed rows the glyph height will never be larger than the row
this._currentRowHeight = Math.max(this._currentRowHeight, rasterizedGlyph.size.y); // height
this._currentRowX += rasterizedGlyph.size.x; activeRow.height = Math.max(activeRow.height, rasterizedGlyph.size.y);
activeRow.x += rasterizedGlyph.size.x;
// putImageData doesn't do any blending, so it will overwrite any existing cache entry for us // putImageData doesn't do any blending, so it will overwrite any existing cache entry for us
this._cacheCtx.putImageData(clippedImageData, rasterizedGlyph.texturePosition.x, rasterizedGlyph.texturePosition.y); this._cacheCtx.putImageData(clippedImageData, rasterizedGlyph.texturePosition.x, rasterizedGlyph.texturePosition.y);
@@ -139,7 +139,7 @@ describe('DomRendererRowFactory', () => {
lineData.setCell(0, cell); lineData.setCell(0, cell);
const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20); const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20);
assert.equal(getFragmentHtml(fragment), assert.equal(getFragmentHtml(fragment),
'<span class="xterm-underline-1" style="text-decoration-color: rgb(255,255,255);">a</span>' '<span class="xterm-underline-1">a</span>'
); );
}); });
it('should add class for double underline style', () => { it('should add class for double underline style', () => {
@@ -150,7 +150,7 @@ describe('DomRendererRowFactory', () => {
lineData.setCell(0, cell); lineData.setCell(0, cell);
const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20); const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20);
assert.equal(getFragmentHtml(fragment), assert.equal(getFragmentHtml(fragment),
'<span class="xterm-underline-2" style="text-decoration-color: rgb(255,255,255);">a</span>' '<span class="xterm-underline-2">a</span>'
); );
}); });
it('should add class for curly underline style', () => { it('should add class for curly underline style', () => {
@@ -161,7 +161,7 @@ describe('DomRendererRowFactory', () => {
lineData.setCell(0, cell); lineData.setCell(0, cell);
const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20); const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20);
assert.equal(getFragmentHtml(fragment), assert.equal(getFragmentHtml(fragment),
'<span class="xterm-underline-3" style="text-decoration-color: rgb(255,255,255);">a</span>' '<span class="xterm-underline-3">a</span>'
); );
}); });
it('should add class for double dotted style', () => { it('should add class for double dotted style', () => {
@@ -172,7 +172,7 @@ describe('DomRendererRowFactory', () => {
lineData.setCell(0, cell); lineData.setCell(0, cell);
const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20); const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20);
assert.equal(getFragmentHtml(fragment), assert.equal(getFragmentHtml(fragment),
'<span class="xterm-underline-4" style="text-decoration-color: rgb(255,255,255);">a</span>' '<span class="xterm-underline-4">a</span>'
); );
}); });
it('should add class for dashed underline style', () => { it('should add class for dashed underline style', () => {
@@ -183,7 +183,7 @@ describe('DomRendererRowFactory', () => {
lineData.setCell(0, cell); lineData.setCell(0, cell);
const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20); const fragment = rowFactory.createRow(lineData, 0, false, undefined, 0, false, 5, 20);
assert.equal(getFragmentHtml(fragment), assert.equal(getFragmentHtml(fragment),
'<span class="xterm-underline-5" style="text-decoration-color: rgb(255,255,255);">a</span>' '<span class="xterm-underline-5">a</span>'
); );
}); });
}); });
+1 -1
View File
@@ -149,7 +149,7 @@ export class ExtendedAttrs implements IExtendedAttrs {
constructor( constructor(
underlineStyle: UnderlineStyle = UnderlineStyle.NONE, underlineStyle: UnderlineStyle = UnderlineStyle.NONE,
underlineColor: number = -1 underlineColor: number = Attributes.CM_DEFAULT
) { ) {
this.underlineStyle = underlineStyle; this.underlineStyle = underlineStyle;
this.underlineColor = underlineColor; this.underlineColor = underlineColor;