_CONSOLE_DEVICE Struct Reference

#include <console.h>

Data Fields
DEVICE	device
	The Device entry for this Console device.
uint32_t	consoleid
	Unique Id of this Console device in the Console device table.
uint32_t	consolestate
	Console device state (eg CONSOLE_STATE_OPEN).
uint32_t	consolemode
	Console device mode (eg CONSOLE_MODE_PIXEL).
console_device_open_proc	deviceopen
	A device specific DeviceOpen method implementing a standard console device interface (Mandatory).
console_device_close_proc	deviceclose
	A device specific DeviceClose method implementing a standard console device interface (Mandatory).
console_device_clear_proc	deviceclear
	A device specific DeviceClear method implementing a standard console device interface (Mandatory).
console_device_scroll_proc	devicescroll
	A device specific DeviceScroll method implementing a standard console device interface (Mandatory).
console_device_draw_box_proc	devicedrawbox
	A device specific DeviceDrawBox method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_draw_line_proc	devicedrawline
	A device specific DeviceDrawLine method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_plot_line_proc	deviceplotline
	A device specific DevicePlotLine method implementing a standard console device interface (Or nil if the default method is suitable).
console_device_draw_char_proc	devicedrawchar
	A device specific DeviceDrawChar method implementing a standard console device interface (Mandatory).
console_device_draw_text_proc	devicedrawtext
	A device specific DeviceDrawText method implementing a standard console device interface (Mandatory).
console_device_draw_pixel_proc	devicedrawpixel
	A device specific DeviceDrawPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_draw_block_proc	devicedrawblock
	A device specific DeviceDrawBlock method implementing a standard console device interface (Mandatory).
console_device_draw_circle_proc	devicedrawcircle
	A device specific DeviceDrawCircle method implementing a standard console device interface (Or nil if the default method is suitable).
console_device_draw_image_proc	devicedrawimage
	A device specific DeviceDrawImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_draw_window_proc	devicedrawwindow
	A device specific DeviceDrawWindow method implementing a standard console device interface (Mandatory).
console_device_get_pixel_proc	devicegetpixel
	A device specific DeviceGetPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_get_image_proc	devicegetimage
	A device specific DeviceGetImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_put_text_proc	deviceputtext
	A device specific DevicePutText method implementing a standard console device interface (Mandatory).
console_device_copy_image_proc	devicecopyimage
	A device specific DeviceCopyImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).
console_device_add_caret_proc	deviceaddcaret
	A device specific DeviceAddCaret method implementing a standard console device interface (Optional).
console_device_delete_caret_proc	devicedeletecaret
	A device specific DeviceDeleteCaret method implementing a standard console device interface (Optional).
console_device_update_caret_proc	deviceupdatecaret
	A device specific DeviceUpdateCaret method implementing a standard console device interface (Optional).
console_device_update_caret_ex_proc	deviceupdatecaretex
	A device specific DeviceUpdateCaretEx method implementing a standard console device interface (Optional).
console_device_set_cursor_proc	devicesetcursor
	A device specific DeviceSetCursor method implementing a standard console device interface (Or nil if the default method is suitable)(CONSOLE_MODE_CHARACTER only).
console_device_update_cursor_proc	deviceupdatecursor
	A device specific DeviceUpdateCursor method implementing a standard console device interface (Or nil if the default method is suitable)(CONSOLE_MODE_CHARACTER only).
console_device_get_position_proc	devicegetposition
	A device specific DeviceGetPosition method implementing a standard console device interface (Mandatory).
console_device_get_properties_proc	devicegetproperties
	A device specific DeviceGetProperties method implementing a standard console device interface (Or nil if the default method is suitable).
uint32_t	opencount
uint32_t	closecount
uint32_t	clearcount
uint32_t	scrollcount
uint32_t	drawcount
uint32_t	getcount
uint32_t	putcount
uint32_t	copycount
MUTEX_HANDLE	lock
	Device lock.
uint32_t	width
	Console Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	height
	Console Height (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	format
	Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL).
uint32_t	forecolor
	Foreground Color.
uint32_t	backcolor
	Background Color.
uint32_t	borderwidth
	Border Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	bordercolor
	Border Color.
FONT_HANDLE	font
	Console Font.
uint32_t	fontratio
	Font Characters to Pixels Ratio (Normally 1 for Pixel Console / 0 for Character Console).
LONGBOOL	cursorupdate
	Flag to indicate if cursor update (Show/Hide) is in progress (CONSOLE_MODE_CHARACTER only).
uint32_t	cursorx
	Cursor X (Characters)(CONSOLE_MODE_CHARACTER only).
uint32_t	cursory
	Cursor Y (Characters)(CONSOLE_MODE_CHARACTER only).
uint32_t	cursorwidth
	Cursor Width (Characters)(CONSOLE_MODE_CHARACTER only).
uint32_t	cursorheight
	Cursor Height (Characters)(CONSOLE_MODE_CHARACTER only).
LONGBOOL	cursorvisible
	Cursor Visible On/Off (CONSOLE_MODE_CHARACTER only).
char *	cursorchars
	Buffer for cursor characters (CONSOLE_MODE_CHARACTER only).
char *	cursorbuffer
	Buffer for characters currently under cursor (CONSOLE_MODE_CHARACTER only).
CONSOLE_CARET *	caretfirst
CRITICAL_SECTION_HANDLE	caretlock
uint32_t	caretcount
CONSOLE_WINDOW *	windowfirst
CRITICAL_SECTION_HANDLE	windowlock
uint32_t	windowcount
CONSOLE_WINDOW *	windowactive
	The active console Window (ie the Window that is shown as selected).
WINDOW_HANDLE	windowdefault
	The default console Window (ie the Window that receives standard output)(WINDOW_MODE_TEXT only).
CONSOLE_DEVICE *	prev
	Previous entry in Console device table.
CONSOLE_DEVICE *	next
	Next entry in Console device table.

Detailed Description

Console Device

Field Documentation

device

DEVICE device

The Device entry for this Console device.

consoleid

uint32_t consoleid

Unique Id of this Console device in the Console device table.

consolestate

uint32_t consolestate

Console device state (eg CONSOLE_STATE_OPEN).

consolemode

uint32_t consolemode

Console device mode (eg CONSOLE_MODE_PIXEL).

deviceopen

console_device_open_proc deviceopen

A device specific DeviceOpen method implementing a standard console device interface (Mandatory).

deviceclose

console_device_close_proc deviceclose

A device specific DeviceClose method implementing a standard console device interface (Mandatory).

deviceclear

console_device_clear_proc deviceclear

A device specific DeviceClear method implementing a standard console device interface (Mandatory).

devicescroll

console_device_scroll_proc devicescroll

A device specific DeviceScroll method implementing a standard console device interface (Mandatory).

devicedrawbox

console_device_draw_box_proc devicedrawbox

A device specific DeviceDrawBox method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

devicedrawline

console_device_draw_line_proc devicedrawline

A device specific DeviceDrawLine method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

deviceplotline

console_device_plot_line_proc deviceplotline

A device specific DevicePlotLine method implementing a standard console device interface (Or nil if the default method is suitable).

devicedrawchar

console_device_draw_char_proc devicedrawchar

A device specific DeviceDrawChar method implementing a standard console device interface (Mandatory).

devicedrawtext

console_device_draw_text_proc devicedrawtext

A device specific DeviceDrawText method implementing a standard console device interface (Mandatory).

devicedrawpixel

console_device_draw_pixel_proc devicedrawpixel

A device specific DeviceDrawPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

devicedrawblock

console_device_draw_block_proc devicedrawblock

A device specific DeviceDrawBlock method implementing a standard console device interface (Mandatory).

devicedrawcircle

console_device_draw_circle_proc devicedrawcircle

A device specific DeviceDrawCircle method implementing a standard console device interface (Or nil if the default method is suitable).

devicedrawimage

console_device_draw_image_proc devicedrawimage

A device specific DeviceDrawImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

devicedrawwindow

console_device_draw_window_proc devicedrawwindow

A device specific DeviceDrawWindow method implementing a standard console device interface (Mandatory).

devicegetpixel

console_device_get_pixel_proc devicegetpixel

A device specific DeviceGetPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

devicegetimage

console_device_get_image_proc devicegetimage

A device specific DeviceGetImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

deviceputtext

console_device_put_text_proc deviceputtext

A device specific DevicePutText method implementing a standard console device interface (Mandatory).

devicecopyimage

console_device_copy_image_proc devicecopyimage

A device specific DeviceCopyImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL).

deviceaddcaret

console_device_add_caret_proc deviceaddcaret

A device specific DeviceAddCaret method implementing a standard console device interface (Optional).

devicedeletecaret

console_device_delete_caret_proc devicedeletecaret

A device specific DeviceDeleteCaret method implementing a standard console device interface (Optional).

deviceupdatecaret

console_device_update_caret_proc deviceupdatecaret

A device specific DeviceUpdateCaret method implementing a standard console device interface (Optional).

deviceupdatecaretex

console_device_update_caret_ex_proc deviceupdatecaretex

A device specific DeviceUpdateCaretEx method implementing a standard console device interface (Optional).

devicesetcursor

console_device_set_cursor_proc devicesetcursor

A device specific DeviceSetCursor method implementing a standard console device interface (Or nil if the default method is suitable)(CONSOLE_MODE_CHARACTER only).

deviceupdatecursor

console_device_update_cursor_proc deviceupdatecursor

A device specific DeviceUpdateCursor method implementing a standard console device interface (Or nil if the default method is suitable)(CONSOLE_MODE_CHARACTER only).

devicegetposition

console_device_get_position_proc devicegetposition

A device specific DeviceGetPosition method implementing a standard console device interface (Mandatory).

devicegetproperties

console_device_get_properties_proc devicegetproperties

A device specific DeviceGetProperties method implementing a standard console device interface (Or nil if the default method is suitable).

opencount

uint32_t opencount

closecount

uint32_t closecount

clearcount

uint32_t clearcount

scrollcount

uint32_t scrollcount

drawcount

uint32_t drawcount

getcount

uint32_t getcount

putcount

uint32_t putcount

copycount

uint32_t copycount

lock

MUTEX_HANDLE lock

Device lock.

width

uint32_t width

Console Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

height

uint32_t height

Console Height (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

format

uint32_t format

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

forecolor

uint32_t forecolor

Foreground Color.

backcolor

uint32_t backcolor

Background Color.

borderwidth

uint32_t borderwidth

Border Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

bordercolor

uint32_t bordercolor

Border Color.

font

FONT_HANDLE font

Console Font.

fontratio

uint32_t fontratio

Font Characters to Pixels Ratio (Normally 1 for Pixel Console / 0 for Character Console).

cursorupdate

LONGBOOL cursorupdate

Flag to indicate if cursor update (Show/Hide) is in progress (CONSOLE_MODE_CHARACTER only).

cursorx

uint32_t cursorx

Cursor X (Characters)(CONSOLE_MODE_CHARACTER only).

cursory

uint32_t cursory

Cursor Y (Characters)(CONSOLE_MODE_CHARACTER only).

cursorwidth

uint32_t cursorwidth

Cursor Width (Characters)(CONSOLE_MODE_CHARACTER only).

cursorheight

uint32_t cursorheight

Cursor Height (Characters)(CONSOLE_MODE_CHARACTER only).

cursorvisible

LONGBOOL cursorvisible

Cursor Visible On/Off (CONSOLE_MODE_CHARACTER only).

cursorchars

char* cursorchars

Buffer for cursor characters (CONSOLE_MODE_CHARACTER only).

cursorbuffer

char* cursorbuffer

Buffer for characters currently under cursor (CONSOLE_MODE_CHARACTER only).

caretfirst

CONSOLE_CARET* caretfirst

caretlock

CRITICAL_SECTION_HANDLE caretlock

caretcount

uint32_t caretcount

windowfirst

CONSOLE_WINDOW* windowfirst

windowlock

CRITICAL_SECTION_HANDLE windowlock

windowcount

uint32_t windowcount

windowactive

CONSOLE_WINDOW* windowactive

The active console Window (ie the Window that is shown as selected).

windowdefault

WINDOW_HANDLE windowdefault

The default console Window (ie the Window that receives standard output)(WINDOW_MODE_TEXT only).

prev

CONSOLE_DEVICE* prev

Previous entry in Console device table.

next

CONSOLE_DEVICE* next

Next entry in Console device table.

---

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

• ultibo/console.h