include/tpl_drv_terminal.h File Reference

---

Detailed Description

Terminal Driver Interface Definitions.

Go to the source code of this file.

Data Structures
struct	tTerm_IOCtl_Mode
	Virtual Terminal Mode Describes a VTerm mode to the caller of TERM_IOCTL_QUERYMODE. More...
Enumerations
enum	eTplTerminal_IOCtl {   TERM_IOCTL_MODETYPE = 4, TERM_IOCTL_WIDTH, TERM_IOCTL_HEIGHT, TERM_IOCTL_QUERYMODE,   TERM_IOCTL_FORCESHOW }
	Common Terminal IOCtl Calls. More...
enum	eTplTerminal_Modes {   TERM_MODE_TEXT, TERM_MODE_FB, TERM_MODE_2DACCEL, TERM_MODE_3D,   NUM_TERM_MODES }
	Terminal Modes. More...
enum	eTplTerminal_2D_Commands { TERM_2DCMD_NOP, TERM_2DCMD_PUSH }
	2D Command IDs More...

---

Enumeration Type Documentation

enum eTplTerminal_2D_Commands

2D Command IDs

Todo:

Complete this structure

Command IDs for when the terminal type is eTplTerminal_Modes.TERM_MODE_2DACCEL

Enumerator:

TERM_2DCMD_NOP	No Operation - Used for padding.
TERM_2DCMD_PUSH	Blits a bitmap to the display. (Uint16 X, Y, W, H, Uint32 Data[]) Parameters: X,Y  Coordinates of Top-Left corner W,H  Dimensions Data  32-bpp pixel data

enum eTplTerminal_IOCtl

Common Terminal IOCtl Calls.

Enumerator:

TERM_IOCTL_MODETYPE	Get/Set the current video mode type. ioctl(..., int *mode) Parameters: mode  Pointer to an integer with the new mode number (or NULL) If mode is non-NULL the current terminal mode is changed/updated to the mode indicated by *mode Note: See eTplTerminal_Modes Returns: Current/new terminal mode
TERM_IOCTL_WIDTH	Get/set the display width. ioctl(..., int *width) Parameters: width  Pointer to an integer containing the new width (or NULL) Returns: Current/new width If width is non-NULL the current width is updated (but is not applied until TERM_IOCTL_MODETYPE is called with mode non-NULL.
TERM_IOCTL_HEIGHT	Get/set the display height. ioctl(..., int *height) Parameters: height  Pointer to an integer containing the new height Returns: Current height If height is non-NULL the current height is updated (but is not applied until TERM_IOCTL_MODETYPE is called with a non-NULL mode.
TERM_IOCTL_QUERYMODE	Queries the current driver about it's native modes. ioctl(..., tTerm_IOCtl_Mode *info) Parameters: info  A pointer to a tTerm_IOCtl_Mode with ID set to the mode index (or NULL) Returns: Number of modes If info is NULL, the number of avaliable vative display modes is returned. These display modes will have sequential ID numbers from zero up to this value. Note: The id field of info is not for use with TERM_IOCTL_MODETYPE This field is just for indexing the mode to get its information.
TERM_IOCTL_FORCESHOW	Forces the current terminal to be shown. ioctl(...)

enum eTplTerminal_Modes

Terminal Modes.

Enumerator:

TERM_MODE_TEXT	UTF-8 Text Mode Any writes to the terminal file are treated as UTF-8 encoded strings and reads will also return UTF-8 strings.
TERM_MODE_FB	32bpp Framebuffer Writes to the terminal file will write to the framebuffer. Reads will return UTF-32 characters
TERM_MODE_2DACCEL	32bpp 2D Accellerated mode Writes to the terminal file will be read as a command stream defined in eTplTerminal_2D_Commands
TERM_MODE_3D	OpenGL 2D/3D Writes to the terminal file will send 3D commands Reads will return UTF-32 characters. Note: May or may not stay in the spec
NUM_TERM_MODES	Number of terminal modes.