24 lines
736 B
Markdown
24 lines
736 B
Markdown
|
## xterm-addon-webgl
|
||
|
|
|
||
|
|
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a WebGL-based renderer. This addon requires xterm.js v4+.
|
||
|
|
|
||
|
|
⚠️ This is an experimental addon that is [missing some features and may be unstable](https://github.com/xtermjs/xterm.js/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Faddon%2Fwebgl) ⚠️
|
||
|
|
|
||
|
|
### Install
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install --save xterm-addon-webgl
|
||
|
|
```
|
||
|
|
|
||
|
|
### Usage
|
||
|
|
|
||
|
|
```ts
|
||
|
|
import { Terminal } from 'xterm';
|
||
|
|
import { WebglAddon } from 'xterm-addon-webgl';
|
||
|
|
|
||
|
|
const terminal = new Terminal();
|
||
|
|
terminal.loadAddon(new WebglAddon());
|
||
|
|
```
|
||
|
|
|
||
|
|
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-webgl/typings/xterm-addon-webgl.d.ts) for more advanced usage.
|