UTS6710/aps/include/middleware/common/gui_eng/gel_main.h

/** @file
 * Header file of APIs for initialing GUI engine. 
 *
 * @author mandy.wu 2010/12/06 (Add duplicate controls' core struct)
 * @version 0.1
 */
#ifndef __GEL_MAIN__
#define __GEL_MAIN__

#include "gui_eng/stddefs.h"
#include "gui_eng/gui_engine.h"

#define MAX_FONT_STYLE_NUM		(256)

/**
 * Initialize GUI engine.
 *
 * @param dWinWidth		Window width. 
 * @param dWinHeight	Window height. 
 * @return GUI_SUCCESS if succeed, error codes otherwise.
 */
GUIResult_e GEL_Open(UINT32 dWinWidth, UINT32 dWinHeight, BOOL bBMPCmpsd)__attribute__ ((warn_unused_result));

/**
 * Terminate GUI engine
 *
 * @return GUI_SUCCESS if succeed, error codes otherwise.
 */
GUIResult_e GEL_Close(void)__attribute__ ((warn_unused_result));

/**
 * Initialize the working buffer for GUI engine. 
 *
 * @param pAddr	The GPU working buffer address.  
 * @param dSize	The GPU working buffer size.
 * @param pAddr	The GUI control working buffer address.  
 * @param dSize	The GUI control working buffer size.
 * @return GUI_SUCCESS if succeed, error codes otherwise.
 */
GUIResult_e GEL_InitMem(UINT32 *pGPUBufAddr, UINT32 dGPUBufSize, UINT32 *pGUICtlBufAddr, UINT32 dGUICtlBufSize);

/**
 * Initialize the working buffer for vfont and freetype.
 *
 * @param pAddr The buffer address.
 * @param dSize The buffer size.
 * @return GUI_SUCCESS if succeed, error codes otherwise.
 */
GUIResult_e GEL_InitVFontMem(UINT32 *pAddr, UINT32 dSize);
#endif /* __GEL_REGION__ */