Skip to content

Commit 71f50b8

Browse files
TyriarTyriar
committed
Move webgl-specific types into addon
1 parent d70f2a4 commit 71f50b8

File tree

9 files changed

+106
-102
lines changed

9 files changed

+106
-102
lines changed

‎addons/addon-webgl/src/CharAtlasCache.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import { TextureAtlas } from './TextureAtlas';
77
import { ITerminalOptions, Terminal } from '@xterm/xterm';
88
import { ITerminal, ReadonlyColorSet } from 'browser/Types';
9-
import { ICharAtlasConfig, ITextureAtlas } from 'browser/renderer/shared/Types';
9+
import { ICharAtlasConfig, ITextureAtlas } from './Types';
1010
import { generateConfig, configEquals } from 'CharAtlasUtils';
1111

1212
interface ITextureAtlasCacheEntry {

‎addons/addon-webgl/src/CharAtlasUtils.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* @license MIT
44
*/
55

6-
import { ICharAtlasConfig } from '../../../src/browser/renderer/shared/Types';
6+
import { ICharAtlasConfig } from './Types';
77
import { Attributes } from 'common/buffer/Constants';
88
import { ITerminalOptions } from '@xterm/xterm';
99
import { IColorSet, ReadonlyColorSet } from 'browser/Types';

‎addons/addon-webgl/src/GlyphRenderer.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
* @license MIT
44
*/
55
import { TextureAtlas } from 'TextureAtlas';
6-
import { IRasterizedGlyph, IRenderDimensions, ITextureAtlas } from 'browser/renderer/shared/Types';
6+
import { IRenderDimensions } from 'browser/renderer/shared/Types';
77
import { NULL_CELL_CODE } from 'common/buffer/Constants';
88
import { Disposable, toDisposable } from 'vs/base/common/lifecycle';
99
import { Terminal } from '@xterm/xterm';
10-
import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject } from './Types';
10+
import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject, type IRasterizedGlyph, type ITextureAtlas } from './Types';
1111
import { createProgram, GLTexture, PROJECTION_MATRIX } from './WebglUtils';
1212
import type { IOptionsService } from 'common/services/Services';
1313
import { allowRescaling, throwIfFalsy } from 'browser/renderer/shared/RendererUtils';

‎addons/addon-webgl/src/TextureAtlas.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { IColorContrastCache } from 'browser/Types';
77
import { DIM_OPACITY, TEXT_BASELINE } from './Constants';
88
import { tryDrawCustomChar } from 'CustomGlyphs';
99
import { computeNextVariantOffset, treatGlyphAsBackgroundColor, isPowerlineGlyph, isRestrictedPowerlineGlyph, throwIfFalsy } from 'browser/renderer/shared/RendererUtils';
10-
import { IBoundingBox, ICharAtlasConfig, IRasterizedGlyph, ITextureAtlas } from 'browser/renderer/shared/Types';
10+
import { IBoundingBox, ICharAtlasConfig, IRasterizedGlyph, ITextureAtlas } from './Types';
1111
import { NULL_COLOR, channels, color, rgba } from 'common/Color';
1212
import { FourKeyMap } from 'common/MultiKeyMap';
1313
import { IdleTaskQueue } from 'common/TaskQueue';

‎addons/addon-webgl/src/Types.ts‎

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@
33
* @license MIT
44
*/
55

6+
import { FontWeight } from '@xterm/xterm';
7+
import { IColorSet } from 'browser/Types';
68
import { ISelectionRenderModel } from 'browser/renderer/shared/Types';
7-
import { CursorInactiveStyle, CursorStyle } from 'common/Types';
9+
import { CursorInactiveStyle, CursorStyle, type IDisposable } from 'common/Types';
10+
import type { Event } from 'vs/base/common/event';
811

912
export interface IRenderModel {
1013
cells: Uint32Array;
@@ -31,3 +34,93 @@ export interface IWebGL2RenderingContext extends WebGLRenderingContext {
3134

3235
export interface IWebGLVertexArrayObject {
3336
}
37+
38+
export interface ICharAtlasConfig {
39+
customGlyphs: boolean;
40+
devicePixelRatio: number;
41+
deviceMaxTextureSize: number;
42+
letterSpacing: number;
43+
lineHeight: number;
44+
fontSize: number;
45+
fontFamily: string;
46+
fontWeight: FontWeight;
47+
fontWeightBold: FontWeight;
48+
deviceCellWidth: number;
49+
deviceCellHeight: number;
50+
deviceCharWidth: number;
51+
deviceCharHeight: number;
52+
allowTransparency: boolean;
53+
drawBoldTextInBrightColors: boolean;
54+
minimumContrastRatio: number;
55+
colors: IColorSet;
56+
}
57+
58+
export interface ITextureAtlas extends IDisposable {
59+
readonly pages: { canvas: HTMLCanvasElement, version: number }[];
60+
61+
onAddTextureAtlasCanvas: Event<HTMLCanvasElement>;
62+
onRemoveTextureAtlasCanvas: Event<HTMLCanvasElement>;
63+
64+
/**
65+
* Warm up the texture atlas, adding common glyphs to avoid slowing early frame.
66+
*/
67+
warmUp(): void;
68+
69+
/**
70+
* Call when a frame is being drawn, this will return true if the atlas was cleared to make room
71+
* for a new set of glyphs.
72+
*/
73+
beginFrame(): boolean;
74+
75+
/**
76+
* Clear all glyphs from the texture atlas.
77+
*/
78+
clearTexture(): void;
79+
getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
80+
getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
81+
}
82+
83+
/**
84+
* Represents a rasterized glyph within a texture atlas. Some numbers are
85+
* tracked in CSS pixels as well in order to reduce calculations during the
86+
* render loop.
87+
*/
88+
export interface IRasterizedGlyph {
89+
/**
90+
* The x and y offset between the glyph's top/left and the top/left of a cell
91+
* in pixels.
92+
*/
93+
offset: IVector;
94+
/**
95+
* The index of the texture page that the glyph is on.
96+
*/
97+
texturePage: number;
98+
/**
99+
* the x and y position of the glyph in the texture in pixels.
100+
*/
101+
texturePosition: IVector;
102+
/**
103+
* the x and y position of the glyph in the texture in clip space coordinates.
104+
*/
105+
texturePositionClipSpace: IVector;
106+
/**
107+
* The width and height of the glyph in the texture in pixels.
108+
*/
109+
size: IVector;
110+
/**
111+
* The width and height of the glyph in the texture in clip space coordinates.
112+
*/
113+
sizeClipSpace: IVector;
114+
}
115+
116+
export interface IVector {
117+
x: number;
118+
y: number;
119+
}
120+
121+
export interface IBoundingBox {
122+
top: number;
123+
left: number;
124+
right: number;
125+
bottom: number;
126+
}

‎addons/addon-webgl/src/WebglRenderer.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { CellColorResolver } from 'CellColorResolver';
88
import { acquireTextureAtlas, removeTerminalFromCache } from 'CharAtlasCache';
99
import { CursorBlinkStateManager } from './CursorBlinkStateManager';
1010
import { observeDevicePixelDimensions } from 'DevicePixelObserver';
11-
import { IRenderDimensions, IRenderer, IRequestRedrawEvent, ITextureAtlas } from 'browser/renderer/shared/Types';
11+
import { IRenderDimensions, IRenderer, IRequestRedrawEvent } from 'browser/renderer/shared/Types';
1212
import { ICharSizeService, ICharacterJoinerService, ICoreBrowserService, IThemeService } from 'browser/services/Services';
1313
import { CharData, IBufferLine, ICellData } from 'common/Types';
1414
import { AttributeData } from 'common/buffer/AttributeData';
@@ -19,7 +19,7 @@ import { Terminal } from '@xterm/xterm';
1919
import { GlyphRenderer } from './GlyphRenderer';
2020
import { RectangleRenderer } from './RectangleRenderer';
2121
import { COMBINED_CHAR_BIT_MASK, RENDER_MODEL_BG_OFFSET, RENDER_MODEL_EXT_OFFSET, RENDER_MODEL_FG_OFFSET, RENDER_MODEL_INDICIES_PER_CELL, RenderModel } from './RenderModel';
22-
import { IWebGL2RenderingContext } from './Types';
22+
import { IWebGL2RenderingContext, type ITextureAtlas } from './Types';
2323
import { LinkRenderLayer } from './renderLayer/LinkRenderLayer';
2424
import { IRenderLayer } from './renderLayer/Types';
2525
import { Emitter, Event } from 'vs/base/common/event';

‎addons/addon-webgl/src/renderLayer/BaseRenderLayer.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import { ReadonlyColorSet } from 'browser/Types';
77
import { acquireTextureAtlas } from 'CharAtlasCache';
8-
import { IRenderDimensions, ITextureAtlas } from 'browser/renderer/shared/Types';
8+
import { IRenderDimensions } from 'browser/renderer/shared/Types';
99
import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
1010
import { Disposable, toDisposable } from 'vs/base/common/lifecycle';
1111
import { CellData } from 'common/buffer/CellData';
@@ -14,6 +14,7 @@ import { Terminal } from '@xterm/xterm';
1414
import { IRenderLayer } from './Types';
1515
import { throwIfFalsy } from 'browser/renderer/shared/RendererUtils';
1616
import { TEXT_BASELINE } from 'Constants';
17+
import type { ITextureAtlas } from '../Types';
1718

1819
export abstract class BaseRenderLayer extends Disposable implements IRenderLayer {
1920
private _canvas: HTMLCanvasElement;

‎src/browser/renderer/shared/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
This folder contains files that are shared between the renderer addons, but not necessarily bundled into the `xterm` module.
1+
This folder contains files that are shared between the renderers.

‎src/browser/renderer/shared/Types.ts‎

Lines changed: 2 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,11 @@
33
* @license MIT
44
*/
55

6-
import { FontWeight, Terminal } from '@xterm/xterm';
7-
import { IColorSet, ITerminal } from 'browser/Types';
6+
import { Terminal } from '@xterm/xterm';
7+
import { ITerminal } from 'browser/Types';
88
import { IDisposable } from 'common/Types';
99
import type { Event } from 'vs/base/common/event';
1010

11-
export interface ICharAtlasConfig {
12-
customGlyphs: boolean;
13-
devicePixelRatio: number;
14-
deviceMaxTextureSize: number;
15-
letterSpacing: number;
16-
lineHeight: number;
17-
fontSize: number;
18-
fontFamily: string;
19-
fontWeight: FontWeight;
20-
fontWeightBold: FontWeight;
21-
deviceCellWidth: number;
22-
deviceCellHeight: number;
23-
deviceCharWidth: number;
24-
deviceCharHeight: number;
25-
allowTransparency: boolean;
26-
drawBoldTextInBrightColors: boolean;
27-
minimumContrastRatio: number;
28-
colors: IColorSet;
29-
}
30-
3111
export interface IDimensions {
3212
width: number;
3313
height: number;
@@ -87,76 +67,6 @@ export interface IRenderer extends IDisposable {
8767
clearTextureAtlas?(): void;
8868
}
8969

90-
export interface ITextureAtlas extends IDisposable {
91-
readonly pages: { canvas: HTMLCanvasElement, version: number }[];
92-
93-
onAddTextureAtlasCanvas: Event<HTMLCanvasElement>;
94-
onRemoveTextureAtlasCanvas: Event<HTMLCanvasElement>;
95-
96-
/**
97-
* Warm up the texture atlas, adding common glyphs to avoid slowing early frame.
98-
*/
99-
warmUp(): void;
100-
101-
/**
102-
* Call when a frame is being drawn, this will return true if the atlas was cleared to make room
103-
* for a new set of glyphs.
104-
*/
105-
beginFrame(): boolean;
106-
107-
/**
108-
* Clear all glyphs from the texture atlas.
109-
*/
110-
clearTexture(): void;
111-
getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
112-
getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
113-
}
114-
115-
/**
116-
* Represents a rasterized glyph within a texture atlas. Some numbers are
117-
* tracked in CSS pixels as well in order to reduce calculations during the
118-
* render loop.
119-
*/
120-
export interface IRasterizedGlyph {
121-
/**
122-
* The x and y offset between the glyph's top/left and the top/left of a cell
123-
* in pixels.
124-
*/
125-
offset: IVector;
126-
/**
127-
* The index of the texture page that the glyph is on.
128-
*/
129-
texturePage: number;
130-
/**
131-
* the x and y position of the glyph in the texture in pixels.
132-
*/
133-
texturePosition: IVector;
134-
/**
135-
* the x and y position of the glyph in the texture in clip space coordinates.
136-
*/
137-
texturePositionClipSpace: IVector;
138-
/**
139-
* The width and height of the glyph in the texture in pixels.
140-
*/
141-
size: IVector;
142-
/**
143-
* The width and height of the glyph in the texture in clip space coordinates.
144-
*/
145-
sizeClipSpace: IVector;
146-
}
147-
148-
export interface IVector {
149-
x: number;
150-
y: number;
151-
}
152-
153-
export interface IBoundingBox {
154-
top: number;
155-
left: number;
156-
right: number;
157-
bottom: number;
158-
}
159-
16070
export interface ISelectionRenderModel {
16171
readonly hasSelection: boolean;
16272
readonly columnSelectMode: boolean;

0 commit comments

Comments
 (0)