drivers/displays/tft/fonts.h

   1 /**************************************************************************/
   2 /*!
   3     @file     fonts.h
   4     @author   K. Townsend (microBuilder.eu)
   5
   6     @section LICENSE
   7
   8     Software License Agreement (BSD License)
   9
  10     Copyright (c) 2012, microBuilder SARL
  11     All rights reserved.
  12
  13     Redistribution and use in source and binary forms, with or without
  14     modification, are permitted provided that the following conditions are met:
  15     1. Redistributions of source code must retain the above copyright
  16     notice, this list of conditions and the following disclaimer.
  17     2. Redistributions in binary form must reproduce the above copyright
  18     notice, this list of conditions and the following disclaimer in the
  19     documentation and/or other materials provided with the distribution.
  20     3. Neither the name of the copyright holders nor the
  21     names of its contributors may be used to endorse or promote products
  22     derived from this software without specific prior written permission.
  23
  24     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  25     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  26     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  28     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  29     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  30     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  31     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34 */
  35 /**************************************************************************/
  36 #ifndef __FONTS_H__
  37 #define __FONTS_H__
  38
  39 #include "projectconfig.h"
  40
  41 /**************************************************************************/
  42 /*!
  43     @brief Describes a single character's display information
  44 */
  45 /**************************************************************************/
  46 typedef struct
  47 {
  48   const uint8_t widthBits;              // width, in bits (or pixels), of the character
  49   const uint16_t offset;                // offset of the character's bitmap, in bytes, into the the FONT_INFO's data array
  50 } FONT_CHAR_INFO;
  51
  52 /**************************************************************************/
  53 /*!
  54     @brief Describes a single font
  55 */
  56 /**************************************************************************/
  57 typedef struct
  58 {
  59   const uint8_t           height;       // height of the font's characters
  60   const uint8_t           startChar;    // the first character in the font (e.g. in charInfo and data)
  61   const uint8_t           endChar;      // the last character in the font (e.g. in charInfo and data)
  62   const FONT_CHAR_INFO*   charInfo;     // pointer to array of char information
  63   const uint8_t*          data;         // pointer to generated array of character visual representation
  64 } FONT_INFO;
  65
  66 void      fontsDrawString      ( uint16_t x, uint16_t y, uint16_t color, const FONT_INFO *fontInfo, char *str );
  67 uint16_t  fontsGetStringWidth  ( const FONT_INFO *fontInfo, char *str );
  68
  69 #endif