git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained_IAR_Keil/libboard_samv7-ek/include/lcd_font.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2011, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 /**\r
  31  * \file\r
  32  *\r
  33  * Interface for draw font on LCD.\r
  34  *\r
  35  */\r
  36 \r
  37 /**\r
  38  *\r
  39  * \section Purpose\r
  40  *\r
  41  * The font.h files declares a font structure and a LCDD_DrawChar function\r
  42  * that must be implemented by a font definition file to be used with the\r
  43  * LCDD_DrawString method of draw.h.\r
  44  *\r
  45  * The font10x14.c implements the necessary variable and function for a 10x14\r
  46  * font.\r
  47  *\r
  48  * \section Usage\r
  49  *\r
  50  * -# Declare a gFont global variable with the necessary Font information.\r
  51  * -# Implement an LCDD_DrawChar function which displays the specified\r
  52  *    character on the LCD.\r
  53  * -# Use the LCDD_DrawString method defined in draw.h to display a complete\r
  54  *    string.\r
  55  */\r
  56 \r
  57 #ifndef _LCD_FONT_\r
  58 #define _LCD_FONT_\r
  59 \r
  60 /*----------------------------------------------------------------------------\r
  61  *        Headers\r
  62  *----------------------------------------------------------------------------*/\r
  63 \r
  64 #include <stdint.h>\r
  65 \r
  66 /*----------------------------------------------------------------------------\r
  67  *        Types\r
  68  *----------------------------------------------------------------------------*/\r
  69 \r
  70 \r
  71 /** \brief Describes the font (width, height, supported characters, etc.) used by\r
  72  * the LCD driver draw API.\r
  73  */\r
  74 typedef struct _Font {\r
  75         /* Font width in pixels. */\r
  76         uint8_t width;\r
  77         /* Font height in pixels. */\r
  78         uint8_t height;\r
  79 } Font;\r
  80 \r
  81 /*----------------------------------------------------------------------------\r
  82  *        Variables\r
  83  *----------------------------------------------------------------------------*/\r
  84 \r
  85 /** Global variable describing the font being instancied. */\r
  86 extern const Font gFont;\r
  87 \r
  88 /*----------------------------------------------------------------------------\r
  89  *        Exported functions\r
  90  *----------------------------------------------------------------------------*/\r
  91 \r
  92 extern void LCDD_DrawChar( uint32_t x, uint32_t y, uint8_t c, uint32_t color ) ;\r
  93 \r
  94 extern void LCD_DrawString( uint32_t dwX, uint32_t dwY, const uint8_t *pString, uint32_t color );\r
  95 \r
  96 extern void LCDD_DrawCharWithBGColor( uint32_t x, uint32_t y, uint8_t c, uint32_t fontColor, uint32_t bgColor ) ;\r
  97 \r
  98 #endif /* #ifndef LCD_FONT_ */\r
  99 \r