inkustr.h File Reference

Classes
struct	BACKLIGHT_INFO
struct	LCD_POINT
struct	LCD_RECT
struct	INK_INFO
struct	VISIBILITY
struct	DISPLAY
struct	OPTIONS
struct	LCD_SCREEN
struct	LCD_BITMAP
struct	DISPLAY_CAL
struct	FILTER_CAL
struct	SYS_CAL
Defines
#define	WEDGE_VID   0x04df
#define	WEDGE_PID   0x0030
#define	LCD_WIDTH   320
#define	LCD_HEIGHT   240
#define	LCD_BITMAP_WIDTH   64
#define	LCD_BITMAP_HEIGHT   64
#define	N_SCREEN_ID   4
#define	BYTES_PER_SCREEN_ID   ( (INT32U)LCD_WIDTH*(INT32U)LCD_HEIGHT/8L/(INT32U)N_SCREEN_ID )
Typedefs
typedef unsigned char	PIXELDATA
typedef ON_OFF_AUTO	ON_OFF
typedef struct BACKLIGHT_INFO *	PBACKLIGHT_INFO
typedef struct LCD_POINT *	PLCD_POINT
typedef struct LCD_RECT *	PLCD_RECT
typedef struct INK_INFO *	PINK_INFO
typedef struct VISIBILITY *	PVISIBILITY
typedef struct DISPLAY *	PDISPLAY
typedef struct OPTIONS *	POPTIONS
typedef struct DISPLAY_CAL *	PDISPLAY_CAL
typedef struct FILTER_CAL *	PFILTER_CAL
typedef struct SYS_CAL *	PSYS_CAL
Enumerations
enum	ON_OFF_AUTO {   B_OFF = 0, B_ON = 1, B_AUTO = 2, B_OFF = 0,   B_ON = 1, B_AUTO = 2, B_OFF = 0, B_ON = 1,   B_AUTO = 2 }
enum	LCD_LAYER {   LAYER1 = 0x00, LAYER2 = 0x01, LAYER3 = 0x02, LAYER1 = 0x00,   LAYER2 = 0x01, LAYER3 = 0x02 }
enum	PEN_COLOR { PEN_BLACK = 1, PEN_WHITE = 0, PEN_BLACK = 1, PEN_WHITE = 0 }
enum	BRIGHTNESS {   BL_DIM = 0, BL_BRIGHT = 1, BL_DIM = 0, BL_BRIGHT = 1,   BL_DIM = 0, BL_BRIGHT = 1 }
enum	LAYER_CODE {   CURSOR_OFF = 0x00, LAYER_OFF = 0x00, LAYER_ON = 0x01, LAYER_FLASH = 0x02,   LAYER_HALF = 0x03, CURSOR_OFF = 0x00, LAYER_OFF = 0x00, LAYER_ON = 0x01,   LAYER_FLASH = 0x02, LAYER_HALF = 0x03 }
enum	MIX_CODE {   MIX_OR = 0x1C, MIX_XOR_OR = 0x1D, MIX_AND_OR = 0x1E, MIX_PRI_OR = 0x1F,   MIX_OR = 0x1C, MIX_XOR_OR = 0x1D, MIX_AND_OR = 0x1E, MIX_PRI_OR = 0x1F }
enum	TEST_RESULT { STATUS_IO_FAILURE = 0xff, STATUS_OK = 0, STATUS_IO_FAILURE = 0xff, STATUS_OK = 0 }

---

Define Documentation

#define BYTES_PER_SCREEN_ID   ( (INT32U)LCD_WIDTH*(INT32U)LCD_HEIGHT/8L/(INT32U)N_SCREEN_ID )

#define LCD_BITMAP_HEIGHT   64

#define LCD_BITMAP_WIDTH   64

#define LCD_HEIGHT   240

#define LCD_WIDTH   320

#define N_SCREEN_ID   4

#define WEDGE_PID   0x0030

#define WEDGE_VID   0x04df

---

Typedef Documentation

typedef ON_OFF_AUTO ON_OFF

typedef struct BACKLIGHT_INFO * PBACKLIGHT_INFO

typedef struct DISPLAY * PDISPLAY

typedef struct DISPLAY_CAL * PDISPLAY_CAL

typedef struct FILTER_CAL * PFILTER_CAL

typedef struct INK_INFO * PINK_INFO

typedef unsigned char PIXELDATA

This file is shared between the .idl files and .h files.

typedef struct LCD_POINT * PLCD_POINT

typedef struct LCD_RECT * PLCD_RECT

typedef struct OPTIONS * POPTIONS

typedef struct SYS_CAL * PSYS_CAL

typedef struct VISIBILITY * PVISIBILITY

---

Enumeration Type Documentation

enum BRIGHTNESS

Two brightness settings are available -- bright and dim. Note that if the device is configured for low-power operation attempting to enable a bright backlight will be ignored.

Enumerator:

BL_DIM
BL_BRIGHT
BL_DIM
BL_BRIGHT
BL_DIM
BL_BRIGHT

             {              // LCD Backlight intensity settings
    BL_DIM      = 0,
    BL_BRIGHT   = 1
} BRIGHTNESS;

enum LAYER_CODE

See also:

VISIBILITY

Enumerator:

CURSOR_OFF
LAYER_OFF
LAYER_ON
LAYER_FLASH
LAYER_HALF
CURSOR_OFF
LAYER_OFF
LAYER_ON
LAYER_FLASH
LAYER_HALF

             {          // visibility options for LCD layers
    CURSOR_OFF  = 0x00,
    LAYER_OFF   = 0x00,
    LAYER_ON    = 0x01,
    LAYER_FLASH = 0x02,
    LAYER_HALF  = 0x03
} LAYER_CODE;

enum LCD_LAYER

Describes the 3 layers of the LCD device.

Enumerator:

LAYER1
LAYER2
LAYER3
LAYER1
LAYER2
LAYER3

             {
    LAYER1 = 0x00,
    LAYER2 = 0x01,
    LAYER3 = 0x02
} LCD_LAYER;

enum MIX_CODE

Defines how layers are mixed in the LCD controller.

value	meaning
MIX_OR	all three layers OR-ed
MIX_XOR_OR	(L1 XOR L2) OR L3
MIX_AND_OR	(L1 AND L2) OR L3
MIX_PRI_OR	L1, L2, L3 priority OR

Enumerator:

MIX_OR
MIX_XOR_OR
MIX_AND_OR
MIX_PRI_OR
MIX_OR
MIX_XOR_OR
MIX_AND_OR
MIX_PRI_OR

             {
    MIX_OR      = 0x1C,
    MIX_XOR_OR  = 0x1D,
    MIX_AND_OR  = 0x1E,
    MIX_PRI_OR  = 0x1F
} MIX_CODE;

enum ON_OFF_AUTO

These are the preferred symbolic names used for all ON OFF and/or AUTO parameters. In some cases the variable 'type' for a given field may be INT8U but it is intended to use these symbolic names.

Enumerator:

B_OFF
B_ON
B_AUTO
B_OFF
B_ON
B_AUTO
B_OFF
B_ON
B_AUTO

             {
    B_OFF    = 0,
    B_ON     = 1,
    B_AUTO   = 2
} ON_OFF_AUTO;

enum PEN_COLOR

Available inking colors on the device.

Enumerator:

PEN_BLACK
PEN_WHITE
PEN_BLACK
PEN_WHITE

             {
    PEN_BLACK   = 1,
    PEN_WHITE   = 0
} PEN_COLOR;

enum TEST_RESULT

Enumerates possible test results.

Enumerator:

STATUS_IO_FAILURE
STATUS_OK
STATUS_IO_FAILURE
STATUS_OK

             {                      // self test code descriptions
    STATUS_IO_FAILURE = 0xff,       // Indicates we failed to do I/O to the device.
    STATUS_OK = 0
} TEST_RESULT;

---