drivers/displays/tft/fonts/bitmapfonts.h

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