/****************************************************************************
* 文件名：LCMDRV.H
* 功能：MG12864圖形液晶模塊驅動程序。使用LPC2131的GPIO口控制操作。(頭文件)
*       用于ZLG/GUI用戶圖形界面。
*  
*  作者：黃紹斌
*  日期：2005/3/7
****************************************************************************/
#ifndef  LCMDRV_H
#define  LCMDRV_H  

/* 定義顏色數據類型(可以是數據結構) */
#define  TCOLOR				uint32

/* 定義LCM像素數宏 */
#define  GUI_LCM_XMAX		240							/* 定義液晶x軸的像素數 */
#define  GUI_LCM_YMAX		160							/* 定義液晶y軸的像素數 */


/****************************************************************************
* 名稱：GUI_Initialize()
* 功能：初始化GUI，包括初始化顯示緩沖區，初始化LCM并清屏。
* 入口參數：無
* 出口參數：無
* 說明：用戶根據LCM的實際情況編寫此函數。
****************************************************************************/
extern void  GUI_Initialize(void);


/****************************************************************************
* 名稱：GUI_FillSCR()
* 功能：全屏填充。直接使用數據填充顯示緩沖區。
* 入口參數：dat		填充的數據
* 出口參數：無
* 說明：用戶根據LCM的實際情況編寫此函數。
****************************************************************************/
extern void  GUI_FillSCR(TCOLOR dat);


/****************************************************************************
* 名稱：GUI_ClearSCR()
* 功能：清屏。
* 入口參數：無
* 出口參數：無
* 說明：用戶根據LCM的實際情況編寫此函數。
****************************************************************************/
#define  GUI_ClearSCR()		GUI_FillSCR(WHITE)


/****************************************************************************
* 名稱：GUI_Point()
* 功能：在指定位置上畫點。
* 入口參數： x		指定點所在列的位置
*            y		指定點所在行的位置
*            color	顯示顏色(對于黑白色LCM，為0時滅，為1時顯示)
* 出口參數：返回值為1時表示操作成功，為0時表示操作失敗。(操作失敗原因是指定地址超出有
*          效范圍)
* 說明：用戶根據LCM的實際情況編寫此函數。
****************************************************************************/
extern uint8  GUI_Point(uint8 x, uint8 y, TCOLOR color);


/****************************************************************************
* 名稱：GUI_ReadPoint()
* 功能：讀取指定點的顏色。
* 入口參數：x		指定點所在列的位置
*           y		指定點所在行的位置
*           ret     保存顏色值的指針
* 出口參數：返回0表示指定地址超出緩沖區范圍
* 說明：對于單色，設置ret的d0位為1或0，4級灰度則為d0、d1有效，8位RGB則d0--d7有效，
*      RGB結構則R、G、B變量有效。
****************************************************************************/
extern uint8  GUI_ReadPoint(uint8 x, uint8 y, TCOLOR *ret);


/****************************************************************************
* 名稱：GUI_HLine()
* 功能：畫水平線。
* 入口參數： x0		水平線起點所在列的位置
*           y0		水平線起點所在行的位置
*           x1      水平線終點所在列的位置
*           color	顯示顏色(對于黑白色LCM，為0時滅，為1時顯示)
* 出口參數：無
* 說明：對于單色、4級灰度的液晶，可通過修改此函數作圖提高速度，如單色LCM，可以一次更
*      新8個點，而不需要一個點一個點的寫到LCM中。
****************************************************************************/
extern void  GUI_HLine(uint8 x0, uint8 y0, uint8 x1, TCOLOR color);


/****************************************************************************
* 名稱：GUI_RLine()
* 功能：畫垂直線。
* 入口參數： x0		垂直線起點所在列的位置
*           y0		垂直線起點所在行的位置
*           y1      垂直線終點所在行的位置
*           color	顯示顏色
* 出口參數：無
* 說明：對于單色、4級灰度的液晶，可通過修改此函數作圖提高速度，如單色LCM，可以一次更
*      新8個點，而不需要一個點一個點的寫到LCM中。
****************************************************************************/
extern void  GUI_RLine(uint8 x0, uint8 y0, uint8 y1, TCOLOR color);


/****************************************************************************
* 名稱：GUI_CmpColor()
* 功能：判斷顏色值是否一致。
* 入口參數：color1		顏色值1
*		   color2		顏色值2
* 出口參數：返回1表示相同，返回0表示不相同。
* 說明：由于顏色類型TCOLOR可以是結構類型，所以需要用戶編寫比較函數。
****************************************************************************/
#define  GUI_CmpColor(color1, color2)	( (color1) == (color2) )

/****************************************************************************
* 名稱：GUI_CopyColor()
* 功能：顏色值復制。
* 入口參數：color1		目標顏色變量
*		   color2		源顏色變量
* 出口參數：無
* 說明：由于顏色類型TCOLOR可以是結構類型，所以需要用戶編寫復制函數。
****************************************************************************/
#define  GUI_CopyColor(color1, color2) 	*color1 = color2


#endif