Add demo application.
[bertos.git] / gfx / font.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5  * This file is part of DevLib - See README.devlib for information.
6  * -->
7  *
8  * \version $Id$
9  *
10  * \author Stefano Fedrigo <aleph@develer.com>
11  *
12  * \brief Font 8x6 IBM-PC 8bit
13  */
14
15 /*#*
16  *#* $Log$
17  *#* Revision 1.5  2006/03/13 02:06:04  bernie
18  *#* FONT_HAS_GLYPH(): New macro.
19  *#*
20  *#* Revision 1.4  2006/02/15 09:10:15  bernie
21  *#* Implement prop fonts; Fix algo styles.
22  *#*
23  *#* Revision 1.3  2006/02/10 12:29:05  bernie
24  *#* Add multiple font support in bitmaps.
25  *#*
26  *#* Revision 1.2  2005/11/04 18:17:45  bernie
27  *#* Fix header guards and includes for new location of gfx module.
28  *#*
29  *#* Revision 1.1  2005/11/04 18:11:35  bernie
30  *#* Move graphics stuff from mware/ to gfx/.
31  *#*
32  *#* Revision 1.6  2005/04/11 19:10:28  bernie
33  *#* Include top-level headers from cfg/ subdir.
34  *#*
35  *#* Revision 1.5  2005/03/01 23:26:45  bernie
36  *#* Use new CPU-neutral program-memory API.
37  *#*
38  *#* Revision 1.4  2004/12/31 16:42:55  bernie
39  *#* Sanitize for non-Harvard processors.
40  *#*
41  *#* Revision 1.3  2004/08/25 14:12:09  rasky
42  *#* Aggiornato il comment block dei log RCS
43  *#*
44  *#* Revision 1.2  2004/06/03 11:27:09  bernie
45  *#* Add dual-license information.
46  *#*
47  *#* Revision 1.1  2004/05/23 15:43:16  bernie
48  *#* Import mware modules.
49  *#*
50  *#* Revision 1.2  2004/03/24 15:48:53  bernie
51  *#* Remove Copyright messages from Doxygen output
52  *#*
53  *#* Revision 1.1  2004/01/13 12:15:28  aleph
54  *#* Move font table in program memory; add font.h
55  *#*
56  *#*/
57 #ifndef GFX_FONT_H
58 #define GFX_FONT_H
59
60 #include <cfg/compiler.h> /* uint8_t */
61 #include <mware/pgm.h> /* PROGMEM */
62
63 typedef struct Font
64 {
65         /**
66          * Pointer to glyph data.
67          *
68          * Data is an array of at most 256 glyphs packed together.
69          * Raster format must be the same of the bitmap.
70          */
71         const PROGMEM uint8_t *glyph;
72
73         uint8_t width;     /**< Pixel width of character cell. */
74         uint8_t height;    /**< Pixel height of character cell. */
75
76         uint8_t first;     /**< First encoded character in glyph array. */
77         uint8_t last;      /**< Last encoded character in glyph array (inclusive). */
78
79         /** Array of glyph offsets in bytes. NULL for fixed-width fonts. */
80         const PROGMEM uint16_t *offset;
81         const PROGMEM uint8_t *widths;
82
83 } Font;
84
85
86 /** Return true if glyph \a c is available in \a font. */
87 #define FONT_HAS_GLYPH(font, c) ((c) >= (font)->first && (c) <= (font)->last)
88
89
90 /** The default font. */
91 #define default_font font_ncenB18
92 extern const struct Font default_font;
93
94 #endif /* GFX_FONT_H */