STM32L476G_EVAL BSP User Manual: stm32l476g_eval_lcd.h Source File

STM32L476G_EVAL BSP

stm32l476g_eval_lcd.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l476g_eval_lcd.h
00004   * @author  MCD Application Team
00005   * @version $VERSION$
00006   * @date    $DATE$
00007   * @brief   Header file for stm32l476g_eval_lcd.c driver.
00008   ******************************************************************************
00009   * @attention
00010   *
00011   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00012   *
00013   * Redistribution and use in source and binary forms, with or without modification,
00014   * are permitted provided that the following conditions are met:
00015   *   1. Redistributions of source code must retain the above copyright notice,
00016   *      this list of conditions and the following disclaimer.
00017   *   2. Redistributions in binary form must reproduce the above copyright notice,
00018   *      this list of conditions and the following disclaimer in the documentation
00019   *      and/or other materials provided with the distribution.
00020   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021   *      may be used to endorse or promote products derived from this software
00022   *      without specific prior written permission.
00023   *
00024   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034   *
00035   ******************************************************************************
00036   */
00037 
00038 /* Define to prevent recursive inclusion -------------------------------------*/
00039 #ifndef __STM32L476G_EVAL_LCD_H
00040 #define __STM32L476G_EVAL_LCD_H
00041 
00042 #ifdef __cplusplus
00043  extern "C" {
00044 #endif
00045 
00046 /* Includes ------------------------------------------------------------------*/
00047 #include "stm32l476g_eval.h"
00048 #include "../Components/hx8347g/hx8347g.h"
00049 #include "../../../Utilities/Fonts/fonts.h"
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup STM32L476G_EVAL
00056   * @{
00057   */
00058 
00059 /** @addtogroup STM32L476G_EVAL_LCD
00060   * @{
00061   */
00062 
00063 /** @defgroup STM32L476G_EVAL_LCD_Exported_Types Exported Types
00064   * @{
00065   */
00066 
00067 typedef struct
00068 {
00069   uint32_t TextColor;
00070   uint32_t BackColor;
00071   sFONT    *pFont; 
00072 
00073 }LCD_DrawPropTypeDef;
00074 
00075 /**
00076   * @}
00077   */
00078 
00079 /** @defgroup STM32L476G_EVAL_LCD_Exported_Constants Exported Constants
00080   * @{
00081   */
00082 
00083 /**
00084   * @brief  LCD status structure definition
00085   */
00086 #define LCD_OK         0x00
00087 #define LCD_ERROR      0x01
00088 #define LCD_TIMEOUT    0x02
00089 
00090 typedef struct
00091 {
00092   int16_t X;
00093   int16_t Y;
00094 
00095 }Point, * pPoint;
00096 
00097 /**
00098   * @brief  Line mode structures definition
00099   */
00100 typedef enum
00101 {
00102   CENTER_MODE             = 0x01,    /*!< Center mode */
00103   RIGHT_MODE              = 0x02,    /*!< Right mode  */
00104   LEFT_MODE               = 0x03     /*!< Left mode   */
00105 
00106 }Line_ModeTypdef;
00107 
00108 /**
00109   * @brief  LCD color
00110   */
00111 #define LCD_COLOR_BLUE          0x001F
00112 #define LCD_COLOR_GREEN         0x07E0
00113 #define LCD_COLOR_RED           0xF800
00114 #define LCD_COLOR_CYAN          0x07FF
00115 #define LCD_COLOR_MAGENTA       0xF81F
00116 #define LCD_COLOR_YELLOW        0xFFE0
00117 #define LCD_COLOR_LIGHTBLUE     0x841F
00118 #define LCD_COLOR_LIGHTGREEN    0x87F0
00119 #define LCD_COLOR_LIGHTRED      0xFC10
00120 #define LCD_COLOR_LIGHTCYAN     0x87FF
00121 #define LCD_COLOR_LIGHTMAGENTA  0xFC1F
00122 #define LCD_COLOR_LIGHTYELLOW   0xFFF0
00123 #define LCD_COLOR_DARKBLUE      0x0010
00124 #define LCD_COLOR_DARKGREEN     0x0400
00125 #define LCD_COLOR_DARKRED       0x8000
00126 #define LCD_COLOR_DARKCYAN      0x0410
00127 #define LCD_COLOR_DARKMAGENTA   0x8010
00128 #define LCD_COLOR_DARKYELLOW    0x8400
00129 #define LCD_COLOR_WHITE         0xFFFF
00130 #define LCD_COLOR_LIGHTGRAY     0xD69A
00131 #define LCD_COLOR_GRAY          0x8410
00132 #define LCD_COLOR_DARKGRAY      0x4208
00133 #define LCD_COLOR_BLACK         0x0000
00134 #define LCD_COLOR_BROWN         0xA145
00135 #define LCD_COLOR_ORANGE        0xFD20
00136 
00137 /**
00138   * @brief LCD default font
00139   */
00140 #define LCD_DEFAULT_FONT         Font24
00141 
00142 /**
00143   * @}
00144   */
00145 
00146 /** @defgroup STM32L476G_EVAL_LCD_Exported_Functions Exported Functions
00147   * @{
00148   */
00149 uint8_t  BSP_LCD_Init(void);
00150 uint32_t BSP_LCD_GetXSize(void);
00151 uint32_t BSP_LCD_GetYSize(void);
00152  
00153 uint16_t BSP_LCD_GetTextColor(void);
00154 uint16_t BSP_LCD_GetBackColor(void);
00155 void     BSP_LCD_SetTextColor(__IO uint16_t Color);
00156 void     BSP_LCD_SetBackColor(__IO uint16_t Color);
00157 void     BSP_LCD_SetFont(sFONT *pFonts);
00158 sFONT    *BSP_LCD_GetFont(void);
00159 
00160 void     BSP_LCD_Clear(uint16_t Color);
00161 void     BSP_LCD_ClearStringLine(uint16_t Line);
00162 void     BSP_LCD_DisplayStringAtLine(uint16_t Line, uint8_t *pText);
00163 void     BSP_LCD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *pText, Line_ModeTypdef Mode);
00164 void     BSP_LCD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii);
00165 
00166 uint16_t BSP_LCD_ReadPixel(uint16_t Xpos, uint16_t Ypos);
00167 void     BSP_LCD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00168 void     BSP_LCD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00169 void     BSP_LCD_DrawLine(uint16_t X1, uint16_t Y1, uint16_t X2, uint16_t Y2);
00170 void     BSP_LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00171 void     BSP_LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00172 void     BSP_LCD_DrawPolygon(pPoint pPoints, uint16_t PointCount);
00173 void     BSP_LCD_FillTriangle(uint16_t X1, uint16_t X2, uint16_t X3, uint16_t Y1, uint16_t Y2, uint16_t Y3);
00174 void     BSP_LCD_FillPolygon(pPoint Points, uint16_t PointCount);
00175 void     BSP_LCD_DrawEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00176 void     BSP_LCD_DrawBitmap(uint16_t Xpos, uint16_t Ypos, uint8_t *pBmp);
00177 
00178 void     BSP_LCD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00179 void     BSP_LCD_FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00180 void     BSP_LCD_FillEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00181 
00182 void     BSP_LCD_DisplayOff(void);
00183 void     BSP_LCD_DisplayOn(void);
00184 
00185 /**
00186   * @}
00187   */
00188 
00189 /**
00190   * @}
00191   */
00192 
00193 /**
00194   * @}
00195   */
00196 
00197 /**
00198   * @}
00199   */
00200 
00201 #ifdef __cplusplus
00202 }
00203 #endif
00204 
00205 #endif /* __STM32L476G_EVAL_LCD_H */
00206 
00207 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Sun Jun 21 2015 23:46:41 for STM32L476G_EVAL BSP User Manual by   doxygen 1.7.6.1