JM9 XRCU Board 0.2.0a
Libraries API Reference
Loading...
Searching...
No Matches
Adafruit_GFX.h
1#ifndef _ADAFRUIT_GFX_H
2#define _ADAFRUIT_GFX_H
3
4#if ARDUINO >= 100
5#include "Arduino.h"
6#include "Print.h"
7#else
8#include "WProgram.h"
9#endif
10#include "gfxfont.h"
11
12#include "../Adafruit_BusIO/Adafruit_I2CDevice.h"
13#include "../Adafruit_BusIO/Adafruit_SPIDevice.h"
14
18class Adafruit_GFX : public Print {
19
20public:
21 Adafruit_GFX(int16_t w, int16_t h); // Constructor
22
23 /**********************************************************************/
31 /**********************************************************************/
32 virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;
33
34 // TRANSACTION API / CORE DRAW API
35 // These MAY be overridden by the subclass to provide device-specific
36 // optimized code. Otherwise 'generic' versions are used.
37 virtual void startWrite(void);
38 virtual void writePixel(int16_t x, int16_t y, uint16_t color);
39 virtual void writeFillRect(int16_t x, int16_t y, int16_t w, int16_t h,
40 uint16_t color);
41 virtual void writeFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
42 virtual void writeFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
43 virtual void writeLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1,
44 uint16_t color);
45 virtual void endWrite(void);
46
47 // CONTROL API
48 // These MAY be overridden by the subclass to provide device-specific
49 // optimized code. Otherwise 'generic' versions are used.
50 virtual void setRotation(uint8_t r);
51 virtual void invertDisplay(bool i);
52
53 // BASIC DRAW API
54 // These MAY be overridden by the subclass to provide device-specific
55 // optimized code. Otherwise 'generic' versions are used.
56
57 // It's good to implement those, even if using transaction API
58 virtual void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
59 virtual void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
60 virtual void fillRect(int16_t x, int16_t y, int16_t w, int16_t h,
61 uint16_t color);
62 virtual void fillScreen(uint16_t color);
63 // Optional and probably not necessary to change
64 virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1,
65 uint16_t color);
66 virtual void drawRect(int16_t x, int16_t y, int16_t w, int16_t h,
67 uint16_t color);
68
69 // These exist only with Adafruit_GFX (no subclass overrides)
70 void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
71 void drawCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,
72 uint16_t color);
73 void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
74 void fillCircleHelper(int16_t x0, int16_t y0, int16_t r, uint8_t cornername,
75 int16_t delta, uint16_t color);
76 void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2,
77 int16_t y2, uint16_t color);
78 void fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2,
79 int16_t y2, uint16_t color);
80 void drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h,
81 int16_t radius, uint16_t color);
82 void fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h,
83 int16_t radius, uint16_t color);
84 void drawBitmap(int16_t x, int16_t y, const uint8_t bitmap[], int16_t w,
85 int16_t h, uint16_t color);
86 void drawBitmap(int16_t x, int16_t y, const uint8_t bitmap[], int16_t w,
87 int16_t h, uint16_t color, uint16_t bg);
88 void drawBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h,
89 uint16_t color);
90 void drawBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h,
91 uint16_t color, uint16_t bg);
92 void drawXBitmap(int16_t x, int16_t y, const uint8_t bitmap[], int16_t w,
93 int16_t h, uint16_t color);
94 void drawGrayscaleBitmap(int16_t x, int16_t y, const uint8_t bitmap[],
95 int16_t w, int16_t h);
96 void drawGrayscaleBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w,
97 int16_t h);
98 void drawGrayscaleBitmap(int16_t x, int16_t y, const uint8_t bitmap[],
99 const uint8_t mask[], int16_t w, int16_t h);
100 void drawGrayscaleBitmap(int16_t x, int16_t y, uint8_t *bitmap, uint8_t *mask,
101 int16_t w, int16_t h);
102 void drawRGBBitmap(int16_t x, int16_t y, const uint16_t bitmap[], int16_t w,
103 int16_t h);
104 void drawRGBBitmap(int16_t x, int16_t y, uint16_t *bitmap, int16_t w,
105 int16_t h);
106 void drawRGBBitmap(int16_t x, int16_t y, const uint16_t bitmap[],
107 const uint8_t mask[], int16_t w, int16_t h);
108 void drawRGBBitmap(int16_t x, int16_t y, uint16_t *bitmap, uint8_t *mask,
109 int16_t w, int16_t h);
110 void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color,
111 uint16_t bg, uint8_t size);
112 void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color,
113 uint16_t bg, uint8_t size_x, uint8_t size_y);
114 void getTextBounds(const char *string, int16_t x, int16_t y, int16_t *x1,
115 int16_t *y1, uint16_t *w, uint16_t *h);
116 void getTextBounds(const __FlashStringHelper *s, int16_t x, int16_t y,
117 int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h);
118 void getTextBounds(const String &str, int16_t x, int16_t y, int16_t *x1,
119 int16_t *y1, uint16_t *w, uint16_t *h);
120 void setTextSize(uint8_t s);
121 void setTextSize(uint8_t sx, uint8_t sy);
122 void setFont(const GFXfont *f = NULL);
123
124 /**********************************************************************/
130 /**********************************************************************/
131 void setCursor(int16_t x, int16_t y) {
132 cursor_x = x;
133 cursor_y = y;
134 }
135
136 /**********************************************************************/
143 /**********************************************************************/
144 void setTextColor(uint16_t c) { textcolor = textbgcolor = c; }
145
146 /**********************************************************************/
152 /**********************************************************************/
153 void setTextColor(uint16_t c, uint16_t bg) {
154 textcolor = c;
155 textbgcolor = bg;
156 }
157
158 /**********************************************************************/
164 /**********************************************************************/
165 void setTextWrap(bool w) { wrap = w; }
166
167 /**********************************************************************/
180 /**********************************************************************/
181 void cp437(bool x = true) { _cp437 = x; }
182
183 using Print::write;
184#if ARDUINO >= 100
185 virtual size_t write(uint8_t);
186#else
187 virtual void write(uint8_t);
188#endif
189
190 /************************************************************************/
195 /************************************************************************/
196 int16_t width(void) const { return _width; };
197
198 /************************************************************************/
203 /************************************************************************/
204 int16_t height(void) const { return _height; }
205
206 /************************************************************************/
211 /************************************************************************/
212 uint8_t getRotation(void) const { return rotation; }
213
214 // get current cursor position (get rotation safe maximum values,
215 // using: width() for x, height() for y)
216 /************************************************************************/
221 /************************************************************************/
222 int16_t getCursorX(void) const { return cursor_x; }
223
224 /************************************************************************/
229 /************************************************************************/
230 int16_t getCursorY(void) const { return cursor_y; };
231
232protected:
233 void charBounds(unsigned char c, int16_t *x, int16_t *y, int16_t *minx,
234 int16_t *miny, int16_t *maxx, int16_t *maxy);
235 int16_t WIDTH;
236 int16_t HEIGHT;
237 int16_t _width;
238 int16_t _height;
239 int16_t cursor_x;
240 int16_t cursor_y;
241 uint16_t textcolor;
242 uint16_t textbgcolor;
243 uint8_t textsize_x;
244 uint8_t textsize_y;
245 uint8_t rotation;
246 bool wrap;
247 bool _cp437;
248 GFXfont *gfxFont;
249};
250
252class Adafruit_GFX_Button {
253
254public:
255 Adafruit_GFX_Button(void);
256 // "Classic" initButton() uses center & size
257 void initButton(Adafruit_GFX *gfx, int16_t x, int16_t y, uint16_t w,
258 uint16_t h, uint16_t outline, uint16_t fill,
259 uint16_t textcolor, char *label, uint8_t textsize);
260 void initButton(Adafruit_GFX *gfx, int16_t x, int16_t y, uint16_t w,
261 uint16_t h, uint16_t outline, uint16_t fill,
262 uint16_t textcolor, char *label, uint8_t textsize_x,
263 uint8_t textsize_y);
264 // New/alt initButton() uses upper-left corner & size
265 void initButtonUL(Adafruit_GFX *gfx, int16_t x1, int16_t y1, uint16_t w,
266 uint16_t h, uint16_t outline, uint16_t fill,
267 uint16_t textcolor, char *label, uint8_t textsize);
268 void initButtonUL(Adafruit_GFX *gfx, int16_t x1, int16_t y1, uint16_t w,
269 uint16_t h, uint16_t outline, uint16_t fill,
270 uint16_t textcolor, char *label, uint8_t textsize_x,
271 uint8_t textsize_y);
272 void drawButton(bool inverted = false);
273 bool contains(int16_t x, int16_t y);
274
275 /**********************************************************************/
280 /**********************************************************************/
281 void press(bool p) {
282 laststate = currstate;
283 currstate = p;
284 }
285
286 bool justPressed();
287 bool justReleased();
288
289 /**********************************************************************/
294 /**********************************************************************/
295 bool isPressed(void) { return currstate; };
296
297private:
298 Adafruit_GFX *_gfx;
299 int16_t _x1, _y1; // Coordinates of top-left corner
300 uint16_t _w, _h;
301 uint8_t _textsize_x;
302 uint8_t _textsize_y;
303 uint16_t _outlinecolor, _fillcolor, _textcolor;
304 char _label[10];
305
306 bool currstate, laststate;
307};
308
310class GFXcanvas1 : public Adafruit_GFX {
311public:
312 GFXcanvas1(uint16_t w, uint16_t h);
313 ~GFXcanvas1(void);
314 void drawPixel(int16_t x, int16_t y, uint16_t color);
315 void fillScreen(uint16_t color);
316 void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
317 void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
318 bool getPixel(int16_t x, int16_t y) const;
319 /**********************************************************************/
324 /**********************************************************************/
325 uint8_t *getBuffer(void) const { return buffer; }
326
327protected:
328 bool getRawPixel(int16_t x, int16_t y) const;
329 void drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
330 void drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
331 uint8_t *buffer;
332
333private:
334#ifdef __AVR__
335 // Bitmask tables of 0x80>>X and ~(0x80>>X), because X>>Y is slow on AVR
336 static const uint8_t PROGMEM GFXsetBit[], GFXclrBit[];
337#endif
338};
339
341class GFXcanvas8 : public Adafruit_GFX {
342public:
343 GFXcanvas8(uint16_t w, uint16_t h);
344 ~GFXcanvas8(void);
345 void drawPixel(int16_t x, int16_t y, uint16_t color);
346 void fillScreen(uint16_t color);
347 void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
348 void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
349 uint8_t getPixel(int16_t x, int16_t y) const;
350 /**********************************************************************/
355 /**********************************************************************/
356 uint8_t *getBuffer(void) const { return buffer; }
357
358protected:
359 uint8_t getRawPixel(int16_t x, int16_t y) const;
360 void drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
361 void drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
362 uint8_t *buffer;
363};
364
366class GFXcanvas16 : public Adafruit_GFX {
367public:
368 GFXcanvas16(uint16_t w, uint16_t h);
369 ~GFXcanvas16(void);
370 void drawPixel(int16_t x, int16_t y, uint16_t color);
371 void fillScreen(uint16_t color);
372 void byteSwap(void);
373 void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
374 void drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
375 uint16_t getPixel(int16_t x, int16_t y) const;
376 /**********************************************************************/
381 /**********************************************************************/
382 uint16_t *getBuffer(void) const { return buffer; }
383
384protected:
385 uint16_t getRawPixel(int16_t x, int16_t y) const;
386 void drawFastRawVLine(int16_t x, int16_t y, int16_t h, uint16_t color);
387 void drawFastRawHLine(int16_t x, int16_t y, int16_t w, uint16_t color);
388 uint16_t *buffer;
389};
390
391#endif // _ADAFRUIT_GFX_H
Adafruit_GFX_Button::press
void press(bool p)
Sets button state, should be done by some touch function.
Definition Adafruit_GFX.h:281
Adafruit_GFX_Button::isPressed
bool isPressed(void)
Query whether the button is currently pressed.
Definition Adafruit_GFX.h:295
Adafruit_GFX
Definition Adafruit_GFX.h:18
Adafruit_GFX::getCursorX
int16_t getCursorX(void) const
Get text cursor X location.
Definition Adafruit_GFX.h:222
Adafruit_GFX::textbgcolor
uint16_t textbgcolor
16-bit text color for print()
Definition Adafruit_GFX.h:242
Adafruit_GFX::HEIGHT
int16_t HEIGHT
This is the 'raw' display height - never changes.
Definition Adafruit_GFX.h:236
Adafruit_GFX::setTextWrap
void setTextWrap(bool w)
Set whether text that is too long for the screen width should automatically wrap around to the next l...
Definition Adafruit_GFX.h:165
Adafruit_GFX::width
int16_t width(void) const
Get width of the display, accounting for current rotation.
Definition Adafruit_GFX.h:196
Adafruit_GFX::rotation
uint8_t rotation
Display rotation (0 thru 3)
Definition Adafruit_GFX.h:245
Adafruit_GFX::height
int16_t height(void) const
Get height of the display, accounting for current rotation.
Definition Adafruit_GFX.h:204
Adafruit_GFX::setTextColor
void setTextColor(uint16_t c)
Set text font color with transparant background.
Definition Adafruit_GFX.h:144
Adafruit_GFX::_cp437
bool _cp437
If set, use correct CP437 charset (default is off)
Definition Adafruit_GFX.h:247
Adafruit_GFX::getCursorY
int16_t getCursorY(void) const
Get text cursor Y location.
Definition Adafruit_GFX.h:230
Adafruit_GFX::wrap
bool wrap
If set, 'wrap' text at right edge of display.
Definition Adafruit_GFX.h:246
Adafruit_GFX::textcolor
uint16_t textcolor
16-bit background color for print()
Definition Adafruit_GFX.h:241
Adafruit_GFX::cursor_x
int16_t cursor_x
x location to start print()ing text
Definition Adafruit_GFX.h:239
Adafruit_GFX::textsize_x
uint8_t textsize_x
Desired magnification in X-axis of text to print()
Definition Adafruit_GFX.h:243
Adafruit_GFX::textsize_y
uint8_t textsize_y
Desired magnification in Y-axis of text to print()
Definition Adafruit_GFX.h:244
Adafruit_GFX::setCursor
void setCursor(int16_t x, int16_t y)
Set text cursor location.
Definition Adafruit_GFX.h:131
Adafruit_GFX::_width
int16_t _width
Display width as modified by current rotation.
Definition Adafruit_GFX.h:237
Adafruit_GFX::setTextColor
void setTextColor(uint16_t c, uint16_t bg)
Set text font color with custom background color.
Definition Adafruit_GFX.h:153
Adafruit_GFX::drawPixel
virtual void drawPixel(int16_t x, int16_t y, uint16_t color)=0
Draw to the screen/framebuffer/etc. Must be overridden in subclass.
Adafruit_GFX::getRotation
uint8_t getRotation(void) const
Get rotation setting for display.
Definition Adafruit_GFX.h:212
Adafruit_GFX::_height
int16_t _height
Display height as modified by current rotation.
Definition Adafruit_GFX.h:238
Adafruit_GFX::cp437
void cp437(bool x=true)
Enable (or disable) Code Page 437-compatible charset. There was an error in glcdfont....
Definition Adafruit_GFX.h:181
Adafruit_GFX::WIDTH
int16_t WIDTH
This is the 'raw' display width - never changes.
Definition Adafruit_GFX.h:235
Adafruit_GFX::cursor_y
int16_t cursor_y
y location to start print()ing text
Definition Adafruit_GFX.h:240
Adafruit_GFX::gfxFont
GFXfont * gfxFont
Pointer to special font.
Definition Adafruit_GFX.h:248
GFXcanvas16::buffer
uint16_t * buffer
Raster data: no longer private, allow subclass access.
Definition Adafruit_GFX.h:388
GFXcanvas16::getBuffer
uint16_t * getBuffer(void) const
Get a pointer to the internal buffer memory.
Definition Adafruit_GFX.h:382
GFXcanvas16::drawPixel
void drawPixel(int16_t x, int16_t y, uint16_t color)
Draw to the screen/framebuffer/etc. Must be overridden in subclass.
GFXcanvas1::drawPixel
void drawPixel(int16_t x, int16_t y, uint16_t color)
Draw to the screen/framebuffer/etc. Must be overridden in subclass.
GFXcanvas1::buffer
uint8_t * buffer
Raster data: no longer private, allow subclass access.
Definition Adafruit_GFX.h:331
GFXcanvas1::getBuffer
uint8_t * getBuffer(void) const
Get a pointer to the internal buffer memory.
Definition Adafruit_GFX.h:325
GFXcanvas8::drawPixel
void drawPixel(int16_t x, int16_t y, uint16_t color)
Draw to the screen/framebuffer/etc. Must be overridden in subclass.
GFXcanvas8::getBuffer
uint8_t * getBuffer(void) const
Get a pointer to the internal buffer memory.
Definition Adafruit_GFX.h:356
GFXcanvas8::buffer
uint8_t * buffer
Raster data: no longer private, allow subclass access.
Definition Adafruit_GFX.h:362
GFXfont
Data stored for FONT AS A WHOLE.
Definition gfxfont.h:21