Adafruit_GFX.h

00001 /***********************************
00002 This is a our graphics core library, for all our displays. 
00003 We'll be adapting all the
00004 existing libaries to use this core to make updating, support 
00005 and upgrading easier!
00006 
00007 Adafruit invests time and resources providing this open source code, 
00008 please support Adafruit and open-source hardware by purchasing 
00009 products from Adafruit!
00010 
00011 Written by Limor Fried/Ladyada  for Adafruit Industries.  
00012 BSD license, check license.txt for more information
00013 All text above must be included in any redistribution
00014 ****************************************/
00015 
00016 /*
00017  *  Modified by Neal Horman 7/14/2012 for use in mbed
00018  */
00019 
00020 #ifndef _ADAFRUIT_GFX_H_
00021 #define _ADAFRUIT_GFX_H_
00022 
00023 #include "Adafruit_GFX_Config.h"
00024 
00025 static inline void swap(int16_t &a, int16_t &b)
00026 {
00027     int16_t t = a;
00028     
00029     a = b;
00030     b = t;
00031 }
00032 
00033 #ifndef _BV
00034 #define _BV(bit) (1<<(bit))
00035 #endif
00036 
00037 #define BLACK 0
00038 #define WHITE 1
00039 
00040 /**
00041  * This is a Text and Graphics element drawing class.
00042  * These functions draw to the display buffer.
00043  *
00044  * Display drivers should be derived from here.
00045  * The Display drivers push the display buffer to the
00046  * hardware based on application control.
00047  
00048  * JojoS: added option to not derive from Stream
00049  *  this saves about 10k of code size for small targes
00050  *  without Stream class, printf must be replaced by writeChar(ch)
00051  */
00052 #if defined(USE_NO_IOSTREAM)
00053 class Adafruit_GFX
00054 #else
00055 class Adafruit_GFX : public Stream
00056 #endif
00057 {
00058  public:
00059     Adafruit_GFX(int16_t w, int16_t h)
00060         : _rawWidth(w)
00061         , _rawHeight(h)
00062         , _width(w)
00063         , _height(h)
00064         , cursor_x(0)
00065         , cursor_y(0)
00066         , textcolor(WHITE)
00067         , textbgcolor(BLACK)
00068         , textsize(1)
00069         , rotation(0)
00070         , wrap(true)
00071         {};
00072 
00073     /// Paint one BLACK or WHITE pixel in the display buffer
00074     // this must be defined by the subclass
00075     virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
00076     // this is optional
00077     virtual void invertDisplay(bool i) {};
00078     
00079     // Stream implementation - provides printf() interface
00080     // You would otherwise be forced to use writeChar()
00081     virtual int _putc(int value) { return writeChar(value); };
00082     virtual int _getc() { return -1; };
00083 
00084 #ifdef GFX_WANT_ABSTRACTS
00085     // these are 'generic' drawing functions, so we can share them!
00086     
00087     /** Draw a Horizontal Line
00088      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00089      */
00090     virtual void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
00091     /** Draw a rectangle
00092      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00093      */
00094     virtual void drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
00095     /** Fill the entire display
00096      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00097      */
00098     virtual void fillScreen(uint16_t color);
00099 
00100     /** Draw a circle
00101      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00102      */
00103     void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
00104     void drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, uint16_t color);
00105     
00106     /** Draw and fill a circle
00107      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00108      */
00109     void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
00110     void fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color);
00111 
00112     /** Draw a triangle
00113      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00114      */
00115     void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
00116     /** Draw and fill a triangle
00117      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00118      */
00119     void fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
00120     
00121     /** Draw a rounded rectangle
00122      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00123      */
00124     void drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
00125     /** Draw and fill a rounded rectangle
00126      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00127      */
00128     void fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
00129     /** Draw a bitmap
00130      * @note GFX_WANT_ABSTRACTS must be defined in Adafruit_GFX_config.h
00131      */
00132     void drawBitmap(int16_t x, int16_t y, const uint8_t *bitmap, int16_t w, int16_t h, uint16_t color);
00133 #endif
00134 
00135 #if defined(GFX_WANT_ABSTRACTS) || defined(GFX_SIZEABLE_TEXT)
00136     /** Draw a line
00137      * @note GFX_WANT_ABSTRACTS or GFX_SIZEABLE_TEXT must be defined in Adafruit_GFX_config.h
00138      */
00139     virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
00140     /** Draw a vertical line
00141      * @note GFX_WANT_ABSTRACTS or GFX_SIZEABLE_TEXT must be defined in Adafruit_GFX_config.h
00142      */
00143     virtual void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
00144     /** Draw and fill a rectangle
00145      * @note GFX_WANT_ABSTRACTS or GFX_SIZEABLE_TEXT must be defined in Adafruit_GFX_config.h
00146      */
00147     virtual void fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
00148 #endif
00149 
00150     /// Draw a text character at a specified pixel location
00151     void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size);
00152     /// Draw a text character at the text cursor location
00153     size_t writeChar(uint8_t);
00154 
00155     /// Get the width of the display in pixels
00156     inline int16_t width(void) { return _width; };
00157     /// Get the height of the display in pixels
00158     inline int16_t height(void) { return _height; };
00159 
00160     /// Set the text cursor location, based on the size of the text
00161     inline void setTextCursor(int16_t x, int16_t y) { cursor_x = x; cursor_y = y; };
00162 #if defined(GFX_WANT_ABSTRACTS) || defined(GFX_SIZEABLE_TEXT)
00163     /** Set the size of the text to be drawn
00164      * @note Make sure to enable either GFX_SIZEABLE_TEXT or GFX_WANT_ABSTRACTS
00165      */
00166     inline void setTextSize(uint8_t s) { textsize = (s > 0) ? s : 1; };
00167 #endif
00168     /// Set the text foreground and background colors to be the same
00169     inline void setTextColor(uint16_t c) { textcolor = c; textbgcolor = c; }
00170     /// Set the text foreground and background colors independantly
00171     inline void setTextColor(uint16_t c, uint16_t b) { textcolor = c; textbgcolor = b; };
00172     /// Set text wraping mode true or false
00173     inline void setTextWrap(bool w) { wrap = w; };
00174 
00175     /// Set the display rotation, 1, 2, 3, or 4
00176     void setRotation(uint8_t r);
00177     /// Get the current rotation
00178     inline uint8_t getRotation(void) { rotation %= 4; return rotation; };
00179 
00180 protected:
00181     int16_t  _rawWidth, _rawHeight;   // this is the 'raw' display w/h - never changes
00182     int16_t  _width, _height; // dependent on rotation
00183     int16_t  cursor_x, cursor_y;
00184     uint16_t textcolor, textbgcolor;
00185     uint8_t  textsize;
00186     uint8_t  rotation;
00187     bool  wrap; // If set, 'wrap' text at right edge of display
00188 };
00189 
00190 #endif