Marijn Romeijn / Adafruit-GFX-Library-Mbed_Compatible

Fork of the latest Adafruit GFX Library as of 2017-12-13 to make it compatible with Mbed

README.md@0:cc4253367fc7, 2017-12-13 (annotated)

Committer:
mjromeijn
Date:
Wed Dec 13 20:24:59 2017 +0000
Revision:
0:cc4253367fc7
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjromeijn 0:cc4253367fc7 1 # Adafruit GFX Library
mjromeijn 0:cc4253367fc7 2
mjromeijn 0:cc4253367fc7 3 This is the core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.). It needs to be paired with a hardware-specific library for each display device we carry (to handle the lower-level functions).
mjromeijn 0:cc4253367fc7 4
mjromeijn 0:cc4253367fc7 5 Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!
mjromeijn 0:cc4253367fc7 6
mjromeijn 0:cc4253367fc7 7 Written by Limor Fried/Ladyada for Adafruit Industries.
mjromeijn 0:cc4253367fc7 8 BSD license, check license.txt for more information.
mjromeijn 0:cc4253367fc7 9 All text above must be included in any redistribution.
mjromeijn 0:cc4253367fc7 10
mjromeijn 0:cc4253367fc7 11 Recent Arduino IDE releases include the Library Manager for easy installation. Otherwise, to download, click the DOWNLOAD ZIP button, uncompress and rename the uncompressed folder Adafruit_GFX. Confirm that the Adafruit_GFX folder contains Adafruit_GFX.cpp and Adafruit_GFX.h. Place the Adafruit_GFX library folder your <arduinosketchfolder>/Libraries/ folder. You may need to create the Libraries subfolder if its your first library. Restart the IDE.
mjromeijn 0:cc4253367fc7 12
mjromeijn 0:cc4253367fc7 13 # Useful Resources
mjromeijn 0:cc4253367fc7 14
mjromeijn 0:cc4253367fc7 15 - Image2Code: This is a handy Java GUI utility to convert a BMP file into the array code necessary to display the image with the drawBitmap function. Check out the code at ehubin's GitHub repository: https://github.com/ehubin/Adafruit-GFX-Library/tree/master/Img2Code
mjromeijn 0:cc4253367fc7 16
mjromeijn 0:cc4253367fc7 17 - drawXBitmap function: You can use the GIMP photo editor to save a .xbm file and use the array saved in the file to draw a bitmap with the drawXBitmap function. See the pull request here for more details: https://github.com/adafruit/Adafruit-GFX-Library/pull/31
mjromeijn 0:cc4253367fc7 18
mjromeijn 0:cc4253367fc7 19 - 'Fonts' folder contains bitmap fonts for use with recent (1.1 and later) Adafruit_GFX. To use a font in your Arduino sketch, #include the corresponding .h file and pass address of GFXfont struct to setFont(). Pass NULL to revert to 'classic' fixed-space bitmap font.
mjromeijn 0:cc4253367fc7 20
mjromeijn 0:cc4253367fc7 21 - 'fontconvert' folder contains a command-line tool for converting TTF fonts to Adafruit_GFX .h format.