Cursor AgentandDaniel Imms
584954b4fb
Import shared core from ../../../out/common|browser in addons so tsc and runtime agree. Enable preserveConstEnums so const enums remain in compiled out/ for addon consumers. Build xterm esbuild before addons so out-esbuild exists for parallel addon jobs. Verified: npm run setup, esbuild-demo-client, package. Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
@xterm/addon-webgl
An addon for xterm.js that enables a WebGL2-based renderer. This addon requires xterm.js v4+.
Install
npm install --save @xterm/addon-webgl
Usage
import { Terminal } from '@xterm/xterm';
import { WebglAddon } from '@xterm/addon-webgl';
const terminal = new Terminal();
terminal.open(element);
terminal.loadAddon(new WebglAddon());
See the full API for more advanced usage.
Handling Context Loss
The browser may drop WebGL contexts for various reasons like OOM or after the system has been suspended. There is an API exposed that fires the webglcontextlost event fired on the canvas so embedders can handle it however they wish. An easy, but suboptimal way, to handle this is by disposing of WebglAddon when the event fires:
const terminal = new Terminal();
const addon = new WebglAddon();
addon.onContextLoss(e => {
addon.dispose();
});
terminal.loadAddon(addon);
Read more about handling WebGL context losses on the Khronos wiki.