inkustr.h File Reference

Go to the source code of this file.

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_INFOPBACKLIGHT_INFO
typedef struct LCD_POINTPLCD_POINT
typedef struct LCD_RECTPLCD_RECT
typedef struct INK_INFOPINK_INFO
typedef struct VISIBILITYPVISIBILITY
typedef struct DISPLAYPDISPLAY
typedef struct OPTIONSPOPTIONS
typedef struct DISPLAY_CALPDISPLAY_CAL
typedef struct FILTER_CALPFILTER_CAL
typedef struct SYS_CALPSYS_CAL

Enumerations

enum  ON_OFF_AUTO { B_OFF = 0, B_ON = 1, B_AUTO = 2 }
enum  LCD_LAYER { LAYER1 = 0x00, LAYER2 = 0x01, LAYER3 = 0x02 }
enum  PEN_COLOR { PEN_BLACK = 1, PEN_WHITE = 0 }
enum  BRIGHTNESS { BL_DIM = 0, BL_BRIGHT = 1 }
enum  LAYER_CODE {
  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 }
enum  TEST_RESULT { 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 )
 

Definition at line 21 of file inkustr.h.

#define LCD_BITMAP_HEIGHT   64
 

Definition at line 18 of file inkustr.h.

#define LCD_BITMAP_WIDTH   64
 

Definition at line 17 of file inkustr.h.

#define LCD_HEIGHT   240
 

Definition at line 15 of file inkustr.h.

#define LCD_WIDTH   320
 

Definition at line 14 of file inkustr.h.

#define N_SCREEN_ID   4
 

Definition at line 20 of file inkustr.h.

#define WEDGE_PID   0x0030
 

Definition at line 12 of file inkustr.h.

#define WEDGE_VID   0x04df
 

Definition at line 11 of file inkustr.h.


Typedef Documentation

typedef ON_OFF_AUTO ON_OFF
 

Definition at line 34 of file inkustr.h.

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.

Definition at line 8 of file inkustr.h.

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 

Definition at line 58 of file inkustr.h.

00058              {              // LCD Backlight intensity settings
00059     BL_DIM      = 0,
00060     BL_BRIGHT   = 1
00061 } BRIGHTNESS;

enum LAYER_CODE
 

See also:
VISIBILITY
Enumerator:
CURSOR_OFF 
LAYER_OFF 
LAYER_ON 
LAYER_FLASH 
LAYER_HALF 

Definition at line 155 of file inkustr.h.

00155              {          // visibility options for LCD layers
00156     CURSOR_OFF  = 0x00,
00157     LAYER_OFF   = 0x00,
00158     LAYER_ON    = 0x01,
00159     LAYER_FLASH = 0x02,
00160     LAYER_HALF  = 0x03
00161 } LAYER_CODE;

enum LCD_LAYER
 

Describes the 3 layers of the LCD device.

Enumerator:
LAYER1 
LAYER2 
LAYER3 

Definition at line 39 of file inkustr.h.

00039              {
00040     LAYER1 = 0x00,
00041     LAYER2 = 0x01,
00042     LAYER3 = 0x02
00043 } LCD_LAYER;

enum MIX_CODE
 

Defines how layers are mixed in the LCD controller.
valuemeaning
MIX_ORall three layers OR-ed
MIX_XOR_OR(L1 XOR L2) OR L3
MIX_AND_OR(L1 AND L2) OR L3
MIX_PRI_ORL1, L2, L3 priority OR

Enumerator:
MIX_OR 
MIX_XOR_OR 
MIX_AND_OR 
MIX_PRI_OR 

Definition at line 173 of file inkustr.h.

00173              {
00174     MIX_OR      = 0x1C,
00175     MIX_XOR_OR  = 0x1D,
00176     MIX_AND_OR  = 0x1E,
00177     MIX_PRI_OR  = 0x1F
00178 } 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 

Definition at line 28 of file inkustr.h.

00028              {
00029     B_OFF    = 0,
00030     B_ON     = 1,
00031     B_AUTO   = 2
00032 } ON_OFF_AUTO;

enum PEN_COLOR
 

Available inking colors on the device.

Enumerator:
PEN_BLACK 
PEN_WHITE 

Definition at line 48 of file inkustr.h.

00048              {
00049     PEN_BLACK   = 1,
00050     PEN_WHITE   = 0
00051 } PEN_COLOR;

enum TEST_RESULT
 

Enumerates possible test results.

Enumerator:
STATUS_IO_FAILURE 
STATUS_OK 

Definition at line 209 of file inkustr.h.

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


Generated on Tue Nov 21 11:11:28 2006 for ePadAPIs by  doxygen 1.4.6-NO