Module: core/screen-buffer
Screen Buffer Management
Summary
Screen buffer stack and background management for popup overlays
Table of contents
Type Aliases
Variables
Functions
Type Aliases
ScreenBuffer
Ƭ ScreenBuffer: typeof screenBuffer
Defined in
Variables
screenBuffer
• Const screenBuffer: Object
Screen buffer management object
Type declaration
| Name | Type |
|---|---|
get stackDepth() |
number |
clearBackground |
() => void |
clearStack |
() => void |
createBuffer |
() => Graphic |
getBackground |
() => null | Graphic |
getOutput |
() => null | IQOutput |
redraw |
(x?: number, y?: number, width?: number, height?: number) => void |
restoreRegion |
() => boolean |
saveRegion |
(x: number, y: number, width: number, height: number) => null | { graphic: Graphic ; x: number ; y: number } |
setBackground |
(graphic: string | Graphic, processMCI: boolean) => void |
setOutput |
(output: IQOutput) => void |
Defined in
Functions
setScreenDimensions
▸ setScreenDimensions(width, height): void
Update the current screen dimensions (called by screen module)
Parameters
| Name | Type |
|---|---|
width |
number |
height |
number |
Returns
void