#include <console.h>

Data Fields
uint32_t	signature
	Signature for entry validation.
uint32_t	position
	Console Window Position (eg CONSOLE_POSITION_TOP).
uint32_t	windowstate
	Console Window State (eg WINDOW_STATE_VISIBLE).
uint32_t	windowmode
	Console Window Mode (eg WINDOW_MODE_TEXT).
uint32_t	windowflags
	Console Window Flags (eg WINDOW_FLAG_LINE_WRAP).
uint32_t	x1
	Window X1.
uint32_t	y1
	Window Y1.
uint32_t	x2
	Window X2.
uint32_t	y2
	Window Y2.
uint32_t	width
	Window Width in Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).
uint32_t	height
	Window Height in Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).
uint32_t	offsetx
	Window X Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	offsety
	Window Y Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	minx
	Viewport X1.
uint32_t	miny
	Viewport Y1.
uint32_t	maxx
	Viewport X2.
uint32_t	maxy
	Viewport Y2.
uint32_t	x
	Current X.
uint32_t	y
	Current Y.
uint32_t	cols
	Viewport Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).
uint32_t	rows
	Viewport Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).
uint32_t	format
	Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL).
uint32_t	forecolor
	Current Foreground Color.
uint32_t	backcolor
	Current Background Color.
uint32_t	borderwidth
	Current Border Width.
uint32_t	bordercolor
	Current Border Color.
FONT_HANDLE	font
	Window Font.
uint32_t	fontwidth
	Font Width (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).
uint32_t	fontheight
	Font Height (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).
uint32_t	cursorx
	Cursor X.
uint32_t	cursory
	Cursor Y.
CURSOR_MODE	cursormode
	Cursor Mode Insert/Overwrite.
LONGBOOL	cursorblink
	Cursor Blink On/Off.
CURSOR_STATE	cursorstate
	Cursor State On/Off.
CURSOR_SHAPE	cursorshape
	Cursor Shape Line/Bar/Block.
LONGBOOL	cursorreverse
	Cursor Color Reverse or Inverse (WINDOW_MODE_TEXT only).
uint32_t	cursorforecolor
	Cursor Foreground Color (WINDOW_MODE_TEXT only).
uint32_t	cursorbackcolor
	Cursor Background Color (WINDOW_MODE_TEXT only).
uint32_t	caretx
	Caret X.
uint32_t	carety
	Caret Y.
HANDLE	carethandle
	Caret (Cursor) Handle (or INVALID_HANDLE_VALUE).
CONSOLE_HISTORY *	historyfirst
CONSOLE_HISTORY *	historylast
CONSOLE_HISTORY *	historycurrent
uint32_t	historycount
MUTEX_HANDLE	lock
	Window lock.
CONSOLE_DEVICE *	console
	Window console.
CONSOLE_WINDOW *	prev
	Previous entry in Console Window table.
CONSOLE_WINDOW *	next
	Next entry in Console Window table.

Detailed Description

Console Window

Field Documentation

◆ signature

uint32_t signature

Signature for entry validation.

◆ position

uint32_t position

Console Window Position (eg CONSOLE_POSITION_TOP).

◆ windowstate

uint32_t windowstate

Console Window State (eg WINDOW_STATE_VISIBLE).

◆ windowmode

uint32_t windowmode

Console Window Mode (eg WINDOW_MODE_TEXT).

◆ windowflags

uint32_t windowflags

Console Window Flags (eg WINDOW_FLAG_LINE_WRAP).

◆ x1

uint32_t x1

Window X1.

◆ y1

uint32_t y1

Window Y1.

◆ x2

uint32_t x2

Window X2.

◆ y2

uint32_t y2

Window Y2.

◆ width

uint32_t width

Window Width in Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).

◆ height

uint32_t height

Window Height in Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).

◆ offsetx

uint32_t offsetx

Window X Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

◆ offsety

uint32_t offsety

Window Y Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

◆ minx

uint32_t minx

Viewport X1.

◆ miny

uint32_t miny

Viewport Y1.

◆ maxx

uint32_t maxx

Viewport X2.

◆ maxy

uint32_t maxy

Viewport Y2.

◆ x

uint32_t x

Current X.

◆ y

uint32_t y

Current Y.

◆ cols

uint32_t cols

Viewport Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).

◆ rows

uint32_t rows

Viewport Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS).

◆ format

uint32_t format

Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL).

◆ forecolor

uint32_t forecolor

Current Foreground Color.

◆ backcolor

uint32_t backcolor

Current Background Color.

◆ borderwidth

uint32_t borderwidth

Current Border Width.

◆ bordercolor

uint32_t bordercolor

Current Border Color.

◆ font

FONT_HANDLE font

Window Font.

◆ fontwidth

uint32_t fontwidth

Font Width (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).

◆ fontheight

uint32_t fontheight

Font Height (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).

◆ cursorx

uint32_t cursorx

Cursor X.

◆ cursory

uint32_t cursory

Cursor Y.

◆ cursormode

CURSOR_MODE cursormode

Cursor Mode Insert/Overwrite.

◆ cursorblink

LONGBOOL cursorblink

Cursor Blink On/Off.

◆ cursorstate

CURSOR_STATE cursorstate

Cursor State On/Off.

◆ cursorshape

CURSOR_SHAPE cursorshape

Cursor Shape Line/Bar/Block.

◆ cursorreverse

LONGBOOL cursorreverse

Cursor Color Reverse or Inverse (WINDOW_MODE_TEXT only).

◆ cursorforecolor

uint32_t cursorforecolor

Cursor Foreground Color (WINDOW_MODE_TEXT only).

◆ cursorbackcolor

uint32_t cursorbackcolor

Cursor Background Color (WINDOW_MODE_TEXT only).

◆ caretx

uint32_t caretx

Caret X.

◆ carety

uint32_t carety

Caret Y.

◆ carethandle

HANDLE carethandle

Caret (Cursor) Handle (or INVALID_HANDLE_VALUE).

◆ historyfirst

CONSOLE_HISTORY* historyfirst

◆ historylast

CONSOLE_HISTORY* historylast

◆ historycurrent

CONSOLE_HISTORY* historycurrent

◆ historycount

uint32_t historycount

◆ lock

MUTEX_HANDLE lock

Window lock.

◆ console

CONSOLE_DEVICE* console

Window console.

◆ prev

CONSOLE_WINDOW* prev

Previous entry in Console Window table.

◆ next

CONSOLE_WINDOW* next

Next entry in Console Window table.

The documentation for this struct was generated from the following file:

ultibo/console.h

Data Fields