Adafruit_GFX.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. #ifndef _ADAFRUIT_GFX_H
  2. #define _ADAFRUIT_GFX_H
  3. #if ARDUINO >= 100
  4. #include "Arduino.h"
  5. #include "Print.h"
  6. #else
  7. #include "WProgram.h"
  8. #endif
  9. #include "gfxfont.h"
  10. class Adafruit_GFX : public Print {
  11. public:
  12. Adafruit_GFX(int16_t w, int16_t h); // Constructor
  13. // This MUST be defined by the subclass:
  14. virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
  15. // TRANSACTION API / CORE DRAW API
  16. // These MAY be overridden by the subclass to provide device-specific
  17. // optimized code. Otherwise 'generic' versions are used.
  18. virtual void startWrite(void);
  19. virtual void writePixel(int16_t x, int16_t y, uint16_t color);
  20. virtual void writeFillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
  21. virtual void writeFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
  22. virtual void writeFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
  23. virtual void writeLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
  24. virtual void endWrite(void);
  25. // CONTROL API
  26. // These MAY be overridden by the subclass to provide device-specific
  27. // optimized code. Otherwise 'generic' versions are used.
  28. virtual void setRotation(uint8_t r);
  29. virtual void invertDisplay(boolean i);
  30. // BASIC DRAW API
  31. // These MAY be overridden by the subclass to provide device-specific
  32. // optimized code. Otherwise 'generic' versions are used.
  33. virtual void
  34. // It's good to implement those, even if using transaction API
  35. drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color),
  36. drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color),
  37. fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color),
  38. fillScreen(uint16_t color),
  39. // Optional and probably not necessary to change
  40. drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color),
  41. drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
  42. // These exist only with Adafruit_GFX (no subclass overrides)
  43. void
  44. drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color),
  45. drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,
  46. uint16_t color),
  47. fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color),
  48. fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,
  49. int16_t delta, uint16_t color),
  50. drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1,
  51. int16_t x2, int16_t y2, uint16_t color),
  52. fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1,
  53. int16_t x2, int16_t y2, uint16_t color),
  54. drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h,
  55. int16_t radius, uint16_t color),
  56. fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h,
  57. int16_t radius, uint16_t color),
  58. drawBitmap(int16_t x, int16_t y, const uint8_t *bitmap,
  59. int16_t w, int16_t h, uint16_t color),
  60. drawBitmap(int16_t x, int16_t y, const uint8_t *bitmap,
  61. int16_t w, int16_t h, uint16_t color, uint16_t bg),
  62. drawBitmap(int16_t x, int16_t y, uint8_t *bitmap,
  63. int16_t w, int16_t h, uint16_t color),
  64. drawBitmap(int16_t x, int16_t y, uint8_t *bitmap,
  65. int16_t w, int16_t h, uint16_t color, uint16_t bg),
  66. drawXBitmap(int16_t x, int16_t y, const uint8_t *bitmap,
  67. int16_t w, int16_t h, uint16_t color),
  68. drawRGBBitmap(int16_t x, int16_t y, const uint16_t *bitmap,
  69. int16_t w, int16_t h,bool progmem=true),
  70. drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color,
  71. uint16_t bg, uint8_t size),
  72. setCursor(int16_t x, int16_t y),
  73. setTextColor(uint16_t c),
  74. setTextColor(uint16_t c, uint16_t bg),
  75. setTextSize(uint8_t s),
  76. setTextWrap(boolean w),
  77. cp437(boolean x=true),
  78. setFont(const GFXfont *f = NULL),
  79. getTextBounds(char *string, int16_t x, int16_t y,
  80. int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h),
  81. getTextBounds(const __FlashStringHelper *s, int16_t x, int16_t y,
  82. int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h);
  83. #if ARDUINO >= 100
  84. virtual size_t write(uint8_t);
  85. #else
  86. virtual void write(uint8_t);
  87. #endif
  88. int16_t height(void) const;
  89. int16_t width(void) const;
  90. uint8_t getRotation(void) const;
  91. // get current cursor position (get rotation safe maximum values, using: width() for x, height() for y)
  92. int16_t getCursorX(void) const;
  93. int16_t getCursorY(void) const;
  94. protected:
  95. const int16_t
  96. WIDTH, HEIGHT; // This is the 'raw' display w/h - never changes
  97. int16_t
  98. _width, _height, // Display w/h as modified by current rotation
  99. cursor_x, cursor_y;
  100. uint16_t
  101. textcolor, textbgcolor;
  102. uint8_t
  103. textsize,
  104. rotation;
  105. boolean
  106. wrap, // If set, 'wrap' text at right edge of display
  107. _cp437; // If set, use correct CP437 charset (default is off)
  108. GFXfont
  109. *gfxFont;
  110. };
  111. class Adafruit_GFX_Button {
  112. public:
  113. Adafruit_GFX_Button(void);
  114. // "Classic" initButton() uses center & size
  115. void initButton(Adafruit_GFX *gfx, int16_t x, int16_t y,
  116. uint16_t w, uint16_t h, uint16_t outline, uint16_t fill,
  117. uint16_t textcolor, char *label, uint8_t textsize);
  118. // New/alt initButton() uses upper-left corner & size
  119. void initButtonUL(Adafruit_GFX *gfx, int16_t x1, int16_t y1,
  120. uint16_t w, uint16_t h, uint16_t outline, uint16_t fill,
  121. uint16_t textcolor, char *label, uint8_t textsize);
  122. void drawButton(boolean inverted = false);
  123. boolean contains(int16_t x, int16_t y);
  124. void press(boolean p);
  125. boolean isPressed();
  126. boolean justPressed();
  127. boolean justReleased();
  128. private:
  129. Adafruit_GFX *_gfx;
  130. int16_t _x1, _y1; // Coordinates of top-left corner
  131. uint16_t _w, _h;
  132. uint8_t _textsize;
  133. uint16_t _outlinecolor, _fillcolor, _textcolor;
  134. char _label[10];
  135. boolean currstate, laststate;
  136. };
  137. class GFXcanvas1 : public Adafruit_GFX {
  138. public:
  139. GFXcanvas1(uint16_t w, uint16_t h);
  140. ~GFXcanvas1(void);
  141. void drawPixel(int16_t x, int16_t y, uint8_t color),
  142. fillScreen(uint8_t color);
  143. uint8_t *getBuffer(void);
  144. private:
  145. uint8_t *buffer;
  146. };
  147. class GFXcanvas8 : public Adafruit_GFX {
  148. public:
  149. GFXcanvas8(uint16_t w, uint16_t h);
  150. ~GFXcanvas8(void);
  151. void drawPixel(int16_t x, int16_t y, uint8_t color),
  152. fillScreen(uint8_t color);
  153. uint8_t *getBuffer(void);
  154. private:
  155. uint8_t *buffer;
  156. };
  157. class GFXcanvas16 : public Adafruit_GFX {
  158. public:
  159. GFXcanvas16(uint16_t w, uint16_t h);
  160. ~GFXcanvas16(void);
  161. void drawPixel(int16_t x, int16_t y, uint16_t color),
  162. fillScreen(uint16_t color);
  163. uint16_t *getBuffer(void);
  164. private:
  165. uint16_t *buffer;
  166. };
  167. #endif // _ADAFRUIT_GFX_H