API Guide Home (Online version only) |

# palmOneLcdOverlay.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /**
    00006  * @ingroup LcdOverlay
    00007  */
    00008
    00009 /**
    00010  *
    00011  * @file    palmOneLcdOverlay.h
    00012  * @version 1.0
    00013  *
    00014  * @brief   Public 68k include file for LCDOverlay API that can be used to display
    00015  *          YCbCr images directly on the screen.
    00016  */
    00017
    00018 #ifndef _PALMONELCDOVERLAY_H_
    00019 #define _PALMONELCDOVERLAY_H_
    00020
    00021 #include <PalmTypes.h>
    00022 #include <LibTraps.h>
    00023 #include <Common\Libraries\LcdOverlayLib\palmOneLcdOverlayCommon.h> // For LCD Overlay common data
    00024
    00025
    00026 /***********************************************************************
    00027  * API Prototypes
    00028  ***********************************************************************/
    00029
    00030 #ifdef __cplusplus
    00031 extern "C" {
    00032 #endif
    00033
    00034 /**
    00035  * Opens LcdOverlay library.
    00036  *
    00037  * This function should be called prior to calling the other LcdOverlay functions.
    00038  *
    00039  * @param   refNum: IN: Reference number of the LcdOverlay library.
    00040  * @retval  Err The error code returned from the library. If this is errNone, the
    00041  *          function was sucessful.
    00042  *
    00043  */
    00044 extern Err LcdOverlayLibOpen(UInt16 refNum)
    00045     SYS_TRAP(sysLibTrapOpen);
    00046
    00047 /**
    00048  * Closes LcdOverlay library.
    00049  *
    00050  *
    00051  * @param   refNum: IN: Reference number of the LcdOverlay library.
    00052  * @return  Err The error code returned from the library. If this is errNone, the
    00053  *          function was sucessful.
    00054  *
    00055  */
    00056 extern Err LcdOverlayLibClose(UInt16 refNum)
    00057     SYS_TRAP(sysLibTrapClose);
    00058
    00059
    00060 /**
    00061  * Returns version of the LcdOverlay Library.
    00062  *
    00063  * @param   refNum:         IN:  Reference number of the LcdOverlay library.
    00064  * @param   sdkVersion:     IN:  Expected version number.
    00065  * @param   libVersionP:    OUT: Pointer to version number returned.
    00066  *
    00067  * @retval  Err The error code returned from the library. If this is errNone, the
    00068  *          function was sucessful.
    00069  *
    00070  */
    00071 extern Err LcdOverlayLibGetVersion(UInt16 refNum, UInt32 sdkVersion, UInt32* libVersionP)
    00072     SYS_TRAP(kLcdOverlayLibTrapGetVersion);
    00073
    00074
    00075 /**
    00076  * Control the setting of the LcdOverlay Library.
    00077  *
    00078  *
    00079  * @param   refNum:     IN:  Reference number of the LcdOverlay library.
    00080  * @param   cmdId:      IN:  The commandId. One of the above stated control commands.
    00081  * @param   parameterP: OUT: Parameter associated with a command.
    00082  *
    00083  * @retval  Err The error code returned from the library. If this is errNone, the
    00084  *          function was sucessful.
    00085  *
    00086  */
    00087 extern Err LcdOverlayLibControl(UInt16 refNum, LcdOverlayLibControlType cmdId, void* parameterP)
    00088     SYS_TRAP(kLcdOverlayLibTrapControl);
    00089
    00090
    00091 #ifdef __cplusplus
    00092 }
    00093 #endif
    00094
    00095
    00096 #endif  // _PALMONELCDOVERLAY_H_

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