Adafruit-GFX-Library/README.md

22 lines
1.9 KiB
Markdown
Raw Normal View History

2015-12-22 15:02:43 -05:00
# Adafruit GFX Library
2015-12-22 15:05:19 -05:00
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).
2012-03-15 15:21:39 -04:00
2012-12-07 14:35:04 -05:00
Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!
2012-03-15 15:21:39 -04:00
2012-12-07 14:35:04 -05:00
Written by Limor Fried/Ladyada for Adafruit Industries.
BSD license, check license.txt for more information.
All text above must be included in any redistribution.
2012-03-15 15:21:39 -04:00
2015-12-22 15:05:19 -05:00
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.
2015-12-22 15:02:43 -05:00
# Useful Resources
2015-12-22 15:05:19 -05:00
- 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
2015-12-22 15:02:43 -05:00
- 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
2015-12-22 15:02:43 -05:00
- '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.
2014-09-21 21:20:31 -04:00
2015-12-22 15:02:43 -05:00
- 'fontconvert' folder contains a command-line tool for converting TTF fonts to Adafruit_GFX .h format.