Skip to main content

Overlay Lib API

danger

this is a legacy library and thus not supported by Toradex anymore. We recommend that you use the new libraries for all Toradex modules. Please see the Toradex CE Libraries and Code Samples for up-to-date information.


Library of support functions for Overlays.

Data Structures

struct  XLLP_OVERLAY_T 

Macros

#define OVL_VER_MAJ   0
 
#define OVL_VER_MIN   2
 
#define OVL_VER_BUILD   1
 
#define FORMAT_RGB   0x0
 
#define FORMAT_PACKED_444   0x1
 
#define FORMAT_PLANAR_444   0x2
 
#define FORMAT_PLANAR_422   0x3
 
#define FORMAT_PLANAR_420   0x4
 
#define BPP_1   0x001
 
#define BPP_2   0x002
 
#define BPP_4   0x004
 
#define BPP_8   0x008
 
#define BPP_16   0x010
 
#define BPP_18   0x020
 
#define BPP_18_PACKED   0x040
 
#define BPP_19   0x080
 
#define BPP_19_PACKED   0x100
 
#define BPP_24   0x200
 
#define BPP_25   0x400
 
#define O_BPP_4   0x2
 
#define O_BPP_8   0x3
 
#define O_BPP_16   0x4
 
#define O_BPP_18   0x5
 
#define O_BPP_18_PACKED   0x6
 
#define O_BPP_19   0x7
 
#define O_BPP_19_PACKED   0x8
 
#define O_BPP_24   0x9
 
#define O_BPP_25   0xA
 

Typedefs

typedef struct XLLP_OVERLAY_T * P_XLLP_OVERLAY_T
 

Functions

void OVLGetLibVersion (DWORD *pVerMaj, DWORD *pVerMin, DWORD *pBuild)
 
BOOL LCDInit (void)
 
void LCDDeInit (void)
 
void LCDDegrade (BOOL degrade, DWORD color)
 
BOOL Overlay_Setup (P_XLLP_OVERLAY_T pXllpOverlay)
 
BOOL Overlay_Enable (P_XLLP_OVERLAY_T pXllpOverlay)
 
void Overlay_Disable (P_XLLP_OVERLAY_T pOv)
 
void Overlay_GetBuffer (P_XLLP_OVERLAY_T pOv)
 
void Overlay_Flip (P_XLLP_OVERLAY_T pOv)
 
BOOL Overlay_PosSizeFormat (P_XLLP_OVERLAY_T pOv)
 
void SetTransparencyFactor (DWORD n)
 
BOOL Overlay2_Setup (P_XLLP_OVERLAY_T pXllpOverlay)
 
void Overlay2_Flip (P_XLLP_OVERLAY_T pOv)
 
void Overlay2_GetBuffer (P_XLLP_OVERLAY_T pOv)
 
void Overlay2_Disable (P_XLLP_OVERLAY_T pXllpOverlay)
 
void Overlay2_Enable (P_XLLP_OVERLAY_T pXllpOverlay)
 

Macro Definition Documentation

#define BPP_1   0x001
 
#define BPP_16   0x010
 
#define BPP_18   0x020
 
#define BPP_18_PACKED   0x040
 
#define BPP_19   0x080
 
#define BPP_19_PACKED   0x100
 
#define BPP_2   0x002
 
#define BPP_24   0x200
 
#define BPP_25   0x400
 
#define BPP_4   0x004
 
#define BPP_8   0x008
 
#define FORMAT_PACKED_444   0x1
 
#define FORMAT_PLANAR_420   0x4
 
#define FORMAT_PLANAR_422   0x3
 
#define FORMAT_PLANAR_444   0x2
 
#define FORMAT_RGB   0x0
 
#define O_BPP_16   0x4
 
#define O_BPP_18   0x5
 
#define O_BPP_18_PACKED   0x6
 
#define O_BPP_19   0x7
 
#define O_BPP_19_PACKED   0x8
 
#define O_BPP_24   0x9
 
#define O_BPP_25   0xA
 
#define O_BPP_4   0x2
 
#define O_BPP_8   0x3
 
#define OVL_VER_BUILD   1
 
#define OVL_VER_MAJ   0
 
#define OVL_VER_MIN   2
 

Typedef Documentation

 

Function Documentation

void LCDDegrade(BOOL degrade,
  DWORD color 
 )  
Degrades the dispay to 1 bit per pixel (to save bandwidth)
Parameters
[in]degradeTRUE: Degrade, FALSE: Normal display
[in]colorPalette color entry
void LCDDeInit(void  ) 
Release the library - call when finished with the library
Return values
TRUE= Success
BOOL LCDInit(void  ) 
Initialise the library - call before using other functions
Return values
TRUE= Success
void Overlay2_Disable(P_XLLP_OVERLAY_T pXllpOverlay) 
Disable the overlay - deprecated
Parameters
[in]pXllpOverlayPointer to Overlay data structure
[out]pXllpOverlayPointer to Overlay data structure
Deprecated:
void Overlay2_Enable(P_XLLP_OVERLAY_T pXllpOverlay) 
Enable the overlay - deprecated
Parameters
[in]pXllpOverlayPointer to Overlay data structure
[out]pXllpOverlayPointer to Overlay data structure
Deprecated:
void Overlay2_Flip(P_XLLP_OVERLAY_T pOv) 
Flip the overlay - deprecated
Parameters
[in]pOvPointer to Overlay data structure
[out]pOvPointer to Overlay data structure
Deprecated:
void Overlay2_GetBuffer(P_XLLP_OVERLAY_T pOv) 
Get the overlay buffer - deprecated
Parameters
[in]pOvPointer to Overlay data structure
[out]pOvPointer to Overlay data structure
Deprecated:
BOOL Overlay2_Setup(P_XLLP_OVERLAY_T pXllpOverlay) 
Setup the overlay - deprecated
Parameters
[in]pXllpOverlayPointer to Overlay data structure
[out]pXllpOverlayPointer to Overlay data structure
Deprecated:
void Overlay_Disable(P_XLLP_OVERLAY_T pOv) 
Disable the overlay
Parameters
[in]pOvPointer to Overlay data structure
[out]pOvPointer to Overlay data structure
BOOL Overlay_Enable(P_XLLP_OVERLAY_T pXllpOverlay) 
Enable the overlay
Parameters
[in]pXllpOverlayPointer to Overlay data structure
[out]pXllpOverlayPointer to Overlay data structure
Return values
TRUE= Success
void Overlay_Flip(P_XLLP_OVERLAY_T pOv) 
Flip the overlay buffer
Parameters
[in]pOvPointer to Overlay data structure
[out]pOvPointer to Overlay data structure
void Overlay_GetBuffer(P_XLLP_OVERLAY_T pOv) 
Get the overlay buffer
Parameters
[in]pOvPointer to Overlay data structure
[out]pOvPointer to Overlay data structure
BOOL Overlay_PosSizeFormat(P_XLLP_OVERLAY_T pOv) 
Update the overlay Position, Size and Format
Parameters
[in]pOvPointer to Overlay data structure
Return values
TRUE= Success
BOOL Overlay_Setup(P_XLLP_OVERLAY_T pXllpOverlay) 
Setup the overlay
Parameters
[in]pXllpOverlayPointer to Overlay data structure
[out]pXllpOverlayPointer to Overlay data structure
Return values
TRUE= Success
void OVLGetLibVersion(DWORD * pVerMaj,
  DWORD * pVerMin,
  DWORD * pBuild 
 )  
Get the library Version.
Parameters
[out]pVerMajMajor version number.
[out]pVerMinMinor version number.
[out]pBuildBuild number.
void SetTransparencyFactor(DWORD n) 
Set the overlay transparency factor
Parameters
[in]nTransparency level, 0: very transparent, 7: fully opaque
Send Feedback!