API Guide Home (Online version only) |

# palmOneLcdOverlayCommon.h File Reference

## Detailed Description

Public 68k common header file for LCDOverlay API.

Version:
  1.0

This file contains the common constants and error codes for the LCDOverlay library.

Definition in file palmOneLcdOverlayCommon.h.

Include dependency graph for palmOneLcdOverlayCommon.h:

Go to the source code of this file.

## Data Structures

- struct LcdOverlayLibSettingTag
    Generic settings For settings without manual values, only type is used. More...

## Defines

- #define kLcdOverlayLibName "LcdOverlayManager"
- #define kLcdOverlayLibType 'libr'
- #define kLcdOverlayLibCreator 'Povl'
- #define kLcdOverlayLibVersion1 sysMakeROMVersion(1, 0, 0, sysROMStageRelease, 0)
- #define kLcdOverlayLibVersion kLcdOverlayLibVersion1

Function Traps

- #define kLcdOverlayLibTrapGetVersion (sysLibTrapCustom + 0)
- #define kLcdOverlayLibTrapControl (sysLibTrapCustom + 1)

Error Codes

- #define kLcdOverlayLibErrorClass (oemErrorClass + 0x200)
- #define kLcdOverlayLibErrBadParam (kLcdOverlayLibErrorClass | 0x01)
- #define kLcdOverlayLibErrNoMemory (kLcdOverlayLibErrorClass | 0x02)
- #define kLcdOverlayLibErrNotOpen (kLcdOverlayLibErrorClass | 0x03)
- #define kLcdOverlayLibErrStillOpen (kLcdOverlayLibErrorClass | 0x04)
- #define kLcdOverlayLibErrInternal (kLcdOverlayLibErrorClass | 0x05)
- #define kLcdOverlayLibErrNotSupported (kLcdOverlayLibErrorClass | 0x06)
- #define kLcdOverlayLibErrNotCompatible (kLcdOverlayLibErrorClass | 0x07)

Control Commands

- #define kLcdOverlayLibCtrlFormatSet 0x01
- #define kLcdOverlayLibCtrlFormatGet 0x02
- #define kLcdOverlayLibCtrlFormatQuery 0x03
- #define kLcdOverlayLibCtrlRectSet 0x04
- #define kLcdOverlayLibCtrlRectGet 0x05
- #define kLcdOverlayLibCtrlStart 0x06
- #define kLcdOverlayLibCtrlDraw 0x07
- #define kLcdOverlayLibCtrlStop 0x08

Data Formats
Format types for overlay.

Not all of the formats may be supported, please do a query to find the supported formats.

- #define kLcdOverlayLibDataFormatYCbCr444 0x02
- #define kLcdOverlayLibDataFormatYCbCr422 0x04
- #define kLcdOverlayLibDataFormatYCbCr420 0x08
- #define kLcdOverlayLibDataFormatYCbCr444Planar 0x10
- #define kLcdOverlayLibDataFormatYCbCr422Planar 0x20
- #define kLcdOverlayLibDataFormatYCbCr420Planar 0x40
- #define kLcdOverlayLibDataFormatRGB565 0x80

## Typedefs

- typedef UInt16 LcdOverlayLibControlType
- typedef LcdOverlayLibSettingTag LcdOverlayLibSettingType
    Structure used in LcdOverlayLibControl() for setting parameters Currently only type is used to specify the format type (seelist below) when used with kLcdOverlayLibCtrlFormatSet/Get/Query.
- typedef LcdOverlayLibSettingTag LcdOverlayLibFormatType
    Struct used in LcdOverlayLibControl() calls.

## Define Documentation

#define kLcdOverlayLibCreator 'Povl'

LcdOverlay Creator ID.

Definition at line 53 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlDraw 0x07

Draw picture using Overlay lib. void* pointer to image data

Definition at line 107 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlFormatGet 0x02

Parameter is LcdOverlayLibFormatType*. Get the format type of the overlay.

Definition at line 97 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlFormatQuery 0x03

Parameter is LcdOverlayLibFormatType*. Query the type of format types supported.

Definition at line 99 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlFormatSet 0x01

Parameter is LcdOverlayLibFormatType*. Set the format type of the overlay.

Definition at line 95 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlRectGet 0x05

Parameter is RectangleType* (low res coords). Get the overlay draw rectangle size

Definition at line 103 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlRectSet 0x04

Parameter is RectangleType* (low res coords). Set the overlay draw rectangle size

Definition at line 101 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlStart 0x06

Turn Overlay on before you do a draw. Takes no parameters

Definition at line 105 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibCtrlStop 0x08

Turn Overlay off usually after drawing is done. Takes no parameters

Definition at line 109 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatRGB565 0x80

This is actually RGB555 with 1 bit for transperancy, may change in future

Definition at line 151 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr420 0x08

Definition at line 147 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr420Planar 0x40

Definition at line 150 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr422 0x04

Definition at line 146 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr422Planar 0x20

Definition at line 149 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr444 0x02

Definition at line 145 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibDataFormatYCbCr444Planar 0x10

Definition at line 148 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrBadParam (kLcdOverlayLibErrorClass | 0x01)

invalid parameter

Definition at line 72 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrInternal (kLcdOverlayLibErrorClass | 0x05)

Internal error

Definition at line 80 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrNoMemory (kLcdOverlayLibErrorClass | 0x02)

Memory error

Definition at line 74 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrNotCompatible (kLcdOverlayLibErrorClass | 0x07)

Bad Version

Definition at line 84 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrNotOpen (kLcdOverlayLibErrorClass | 0x03)

library is not open

Definition at line 76 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrNotSupported (kLcdOverlayLibErrorClass | 0x06)

Unsupported function

Definition at line 82 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrorClass (oemErrorClass + 0x200)

Lcd Overlay error base number

Definition at line 70 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibErrStillOpen (kLcdOverlayLibErrorClass | 0x04)

returned from LcdOverlayLibClose() if the library is still open

Definition at line 78 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibName "LcdOverlayManager"

LcdOverlay library name.

Definition at line 51 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibTrapControl (sysLibTrapCustom + 1)

Definition at line 44 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibTrapGetVersion (sysLibTrapCustom + 0)

Definition at line 43 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibType 'libr'

LcdOverlay Type.

Definition at line 52 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibVersion kLcdOverlayLibVersion1

LcdOverlay lib version

Definition at line 60 of file palmOneLcdOverlayCommon.h.

#define kLcdOverlayLibVersion1 sysMakeROMVersion(1, 0, 0, sysROMStageRelease, 0)

LcdOverlay lib version

Definition at line 59 of file palmOneLcdOverlayCommon.h.

## Typedef Documentation

typedef UInt16 LcdOverlayLibControlType

Used with the kLcdOverlayLibCtrl defines

Definition at line 111 of file palmOneLcdOverlayCommon.h.

typedef struct LcdOverlayLibSettingTag LcdOverlayLibFormatType

Struct used in LcdOverlayLibControl() calls.

See also:
  LcdOverlayLibSettingTag

Definition at line 135 of file palmOneLcdOverlayCommon.h.

typedef struct LcdOverlayLibSettingTag LcdOverlayLibSettingType

Structure used in LcdOverlayLibControl() for setting parameters Currently only type is used to specify the format type (seelist below) when used with kLcdOverlayLibCtrlFormatSet/Get/Query.

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:51 2008 for Palm API Guide