bertos/gfx/font.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Font 8x6 IBM-PC 8bit
  34  *
  35  * \version $Id$
  36  *
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  *
  39  */
  40
  41 #ifndef GFX_FONT_H
  42 #define GFX_FONT_H
  43
  44 #include <cfg/compiler.h>  /* uint8_t */
  45 #include <cpu/pgm.h>     /* PROGMEM */
  46
  47 typedef struct Font
  48 {
  49         /**
  50          * Pointer to glyph data.
  51          *
  52          * Data is an array of at most 256 glyphs packed together.
  53          * Raster format must be the same of the bitmap.
  54          */
  55         const pgm_uint8_t *glyph;
  56
  57         uint8_t width;     /**< Pixel width of character cell. */
  58         uint8_t height;    /**< Pixel height of character cell. */
  59
  60         uint8_t first;     /**< First encoded character in glyph array. */
  61         uint8_t last;      /**< Last encoded character in glyph array (inclusive). */
  62
  63         /** Array of glyph offsets in bytes. NULL for fixed-width fonts. */
  64         const pgm_uint16_t *offset;
  65         const pgm_uint8_t  *widths;
  66
  67 } Font;
  68
  69
  70 /** Return true if glyph \a c is available in \a font. */
  71 #define FONT_HAS_GLYPH(font, c) ((c) >= (font)->first && (c) <= (font)->last)
  72
  73
  74 /** The default font. */
  75 #define default_font font_luBS14
  76 extern const struct Font default_font;
  77
  78 #endif /* GFX_FONT_H */