Hatef Dabbaghian / Adafruit-GFX-Library
Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers gfxfont.h Source File

gfxfont.h

00001 // Font structures for newer Adafruit_GFX (1.1 and later).
00002 // Example fonts are included in 'Fonts' directory.
00003 // To use a font in your Arduino sketch, #include the corresponding .h
00004 // file and pass address of GFXfont struct to setFont().  Pass NULL to
00005 // revert to 'classic' fixed-space bitmap font.
00006 
00007 #ifndef _GFXFONT_H_
00008 #define _GFXFONT_H_
00009 
00010 typedef struct { // Data stored PER GLYPH
00011     uint16_t bitmapOffset;     // Pointer into GFXfont->bitmap
00012     uint8_t  width, height;    // Bitmap dimensions in pixels
00013     uint8_t  xAdvance;         // Distance to advance cursor (x axis)
00014     int8_t   xOffset, yOffset; // Dist from cursor pos to UL corner
00015 } GFXglyph;
00016 
00017 typedef struct { // Data stored for FONT AS A WHOLE:
00018     uint8_t  *bitmap;      // Glyph bitmaps, concatenated
00019     GFXglyph *glyph;       // Glyph array
00020     uint8_t   first, last; // ASCII extents
00021     uint8_t   yAdvance;    // Newline distance (y axis)
00022 } GFXfont;
00023 
00024 #endif // _GFXFONT_H_