Class: XBin

core/xbin.XBin

XBin class for reading and displaying XBin images

Table of contents

Constructors

• constructor

Properties

• FLAG_COMPRESS
• FLAG_FONT
• FLAG_FONT_512
• FLAG_NONBLINK
• FLAG_PALETTE
• ID
• ID_LENGTH

Methods

• cleanup
• create
• display
• getInfo
• isXBin
• isXBinData
• parse
• read

Constructors

constructor

• new XBin()

Properties

FLAG_COMPRESS

▪ Static Readonly FLAG_COMPRESS: 4

Defined in

core/src/xbin.ts:95

---

FLAG_FONT

▪ Static Readonly FLAG_FONT: 2

Defined in

core/src/xbin.ts:94

---

FLAG_FONT_512

▪ Static Readonly FLAG_FONT_512: 16

Defined in

core/src/xbin.ts:97

---

FLAG_NONBLINK

▪ Static Readonly FLAG_NONBLINK: 8

Defined in

core/src/xbin.ts:96

---

FLAG_PALETTE

▪ Static Readonly FLAG_PALETTE: 1

Flag constants

Defined in

core/src/xbin.ts:93

---

ID

▪ Static Readonly ID: "XBIN\u001a"

XBin file signature

Defined in

core/src/xbin.ts:87

---

ID_LENGTH

▪ Static Readonly ID_LENGTH: 5

Defined in

core/src/xbin.ts:88

Methods

cleanup

▸ Static cleanup(output): void

Clean up after displaying XBin (reset fonts and palette)

Parameters

Name	Type
output	IQOutput

Returns

void

Defined in

core/src/xbin.ts:458

---

create

▸ Static create(graphic, charHeight?, palette?, fonts?): Buffer

Create an XBin file from a Graphic

Parameters

Name	Type	Default value
graphic	Graphic	undefined
charHeight	number	16
palette?	XBinPalette	undefined
fonts?	Buffer[]	undefined

Returns

Buffer

Defined in

core/src/xbin.ts:387

---

display

▸ Static display(output, image, x?, y?, loadFonts?): boolean

Display an XBin image

Parameters

Name	Type	Default value
output	IQOutput	undefined
image	XBinImage	undefined
x	number	1
y	number	1
loadFonts	boolean	true

Returns

boolean

Defined in

core/src/xbin.ts:284

---

getInfo

▸ Static getInfo(filename): null | XBinHeader

Get info about an XBin file without fully parsing it

Parameters

Name	Type
filename	string

Returns

null | XBinHeader

Defined in

core/src/xbin.ts:355

---

isXBin

▸ Static isXBin(filename): boolean

Check if a file is an XBin file

Parameters

Name	Type
filename	string

Returns

boolean

Defined in

core/src/xbin.ts:332

---

isXBinData

▸ Static isXBinData(data): boolean

Check if buffer contains XBin data

Parameters

Name	Type
data	Buffer

Returns

boolean

Defined in

core/src/xbin.ts:347

---

parse

▸ Static parse(buffer): null | XBinImage

Parse XBin data from a buffer

Parameters

Name	Type
buffer	Buffer

Returns

null | XBinImage

Defined in

core/src/xbin.ts:114

---

read

▸ Static read(filename): null | XBinImage

Read an XBin file

Parameters

Name	Type
filename	string

Returns

null | XBinImage

Defined in

core/src/xbin.ts:102