#include <console.h>

Data Fields
uint32_t	signature
	Signature for entry validation.
uint32_t	x
	Caret X (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	y
	Caret Y (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).
uint32_t	width
	Caret Width (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).
uint32_t	height
	Caret Height (Pixels for CONSOLE_MODE_PIXEL / Always 1 for CONSOLE_MODE_CHARACTER).
uint32_t	offsetx
	Caret Offset X (Pixels for CONSOLE_MODE_PIXEL / Always 0 for CONSOLE_MODE_CHARACTER).
uint32_t	offsety
	Caret Offset Y (Pixels for CONSOLE_MODE_PIXEL / Always 0 for CONSOLE_MODE_CHARACTER).
LONGBOOL	visible
	Caret Visible On/Off.
LONGBOOL	blink
	Caret Blink On/Off.
LONGBOOL	reverse
	Caret Color Reverse or Inverse.
uint32_t	forecolor
	Caret Foreground Color.
uint32_t	backcolor
	Caret Background Color.
CONSOLE_DEVICE *	console
	Console device.
HANDLE	handle
	Device specific handle.
LONGBOOL	active
	Caret currently active (displayed) (Independent of Visible to account for Blink).
void *	image
	Device specific buffer for caret image.
void *	buffer
	Device specific buffer for area underneath caret.
void *	output
	Device specific buffer for curently displayed caret.
CONSOLE_CARET *	prev
	Previous entry in Console Caret table.
CONSOLE_CARET *	next
	Next entry in Console Caret table.

Detailed Description

Console Caret

Field Documentation

◆ signature

uint32_t signature

Signature for entry validation.

◆ x

uint32_t x

Caret X (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

◆ y

uint32_t y

Caret Y (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER).

◆ width

uint32_t width

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

◆ height

uint32_t height

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

◆ offsetx

uint32_t offsetx

Caret Offset X (Pixels for CONSOLE_MODE_PIXEL / Always 0 for CONSOLE_MODE_CHARACTER).

◆ offsety

uint32_t offsety

Caret Offset Y (Pixels for CONSOLE_MODE_PIXEL / Always 0 for CONSOLE_MODE_CHARACTER).

◆ visible

LONGBOOL visible

Caret Visible On/Off.

◆ blink

LONGBOOL blink

Caret Blink On/Off.

◆ reverse

LONGBOOL reverse

Caret Color Reverse or Inverse.

◆ forecolor

uint32_t forecolor

Caret Foreground Color.

◆ backcolor

uint32_t backcolor

Caret Background Color.

◆ console

CONSOLE_DEVICE* console

Console device.

◆ handle

HANDLE handle

Device specific handle.

◆ active

LONGBOOL active

Caret currently active (displayed) (Independent of Visible to account for Blink).

◆ image

void* image

Device specific buffer for caret image.

◆ buffer

void* buffer

Device specific buffer for area underneath caret.

◆ output

void* output

Device specific buffer for curently displayed caret.

◆ prev

CONSOLE_CARET* prev

Previous entry in Console Caret table.

◆ next

CONSOLE_CARET* next

Next entry in Console Caret table.

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

ultibo/console.h

Data Fields