Module: core/screen

Screen Utilities

Summary

Terminal dimensions and centering utilities

Table of contents

Type Aliases

• Screen

Variables

• DEFAULT_HEIGHT
• DEFAULT_WIDTH
• TERM_HEIGHT
• TERM_WIDTH
• screen

Type Aliases

Screen

Ƭ Screen: typeof screen

Defined in

core/src/screen.ts:110

Variables

DEFAULT_HEIGHT

• Const DEFAULT_HEIGHT: 37

Defined in

core/src/screen.ts:13

---

DEFAULT_WIDTH

• Const DEFAULT_WIDTH: 132

Default Iniquity terminal dimensions

Defined in

core/src/screen.ts:12

---

TERM_HEIGHT

• Const TERM_HEIGHT: 37

Defined in

core/src/screen.ts:108

---

TERM_WIDTH

• Const TERM_WIDTH: 132

Defined in

core/src/screen.ts:107

---

screen

• Const screen: Object

Screen object providing terminal constants and positioning utilities

Type declaration

Name	Type
height	number
midX	number
midY	number
stackDepth	number
width	number
center	(width: number, height: number) => { x: number ; y: number }
centerX	(elementWidth: number) => number
centerY	(elementHeight: number) => number
clearBackground	() => void
clearStack	() => void
createBuffer	() => Graphic
getBackground	() => null | Graphic
getOutput	() => null | IQOutput
redraw	(x?: number, y?: number, width?: number, height?: number) => void
resetResolution	() => 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
setResolution	(width: number, height: number) => void

Defined in

core/src/screen.ts:22