Adafruit GFX Library
Public Member Functions | Protected Member Functions | List of all members
GFXcanvas16 Class Reference

A GFX 16-bit canvas context for graphics. More...

#include <Adafruit_GFX.h>

Inheritance diagram for GFXcanvas16:
Adafruit_GFX

Public Member Functions

 GFXcanvas16 (uint16_t w, uint16_t h)
 Instatiate a GFX 16-bit canvas context for graphics. More...
 
 ~GFXcanvas16 (void)
 Delete the canvas, free memory.
 
void drawPixel (int16_t x, int16_t y, uint16_t color)
 Draw a pixel to the canvas framebuffer. More...
 
void fillScreen (uint16_t color)
 Fill the framebuffer completely with one color. More...
 
void byteSwap (void)
 Reverses the "endian-ness" of each 16-bit pixel within the canvas; little-endian to big-endian, or big-endian to little. Most microcontrollers (such as SAMD) are little-endian, while most displays tend toward big-endianness. All the drawing functions (including RGB bitmap drawing) take care of this automatically, but some specialized code (usually involving DMA) can benefit from having pixel data already in the display-native order. Note that this does NOT convert to a SPECIFIC endian-ness, it just flips the bytes within each word.
 
void drawFastVLine (int16_t x, int16_t y, int16_t h, uint16_t color)
 Speed optimized vertical line drawing. More...
 
void drawFastHLine (int16_t x, int16_t y, int16_t w, uint16_t color)
 Speed optimized horizontal line drawing. More...
 
uint16_t getPixel (int16_t x, int16_t y) const
 Get the pixel color value at a given coordinate. More...
 
uint16_t * getBuffer (void) const
 Get a pointer to the internal buffer memory. More...
 
- Public Member Functions inherited from Adafruit_GFX
 Adafruit_GFX (int16_t w, int16_t h)
 Instatiate a GFX context for graphics! Can only be done by a superclass. More...
 
virtual void startWrite (void)
 Start a display-writing routine, overwrite in subclasses.
 
virtual void writePixel (int16_t x, int16_t y, uint16_t color)
 Write a pixel, overwrite in subclasses if startWrite is defined! More...
 
virtual void writeFillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Write a rectangle completely with one color, overwrite in subclasses if startWrite is defined! More...
 
virtual void writeFastVLine (int16_t x, int16_t y, int16_t h, uint16_t color)
 Write a perfectly vertical line, overwrite in subclasses if startWrite is defined! More...
 
virtual void writeFastHLine (int16_t x, int16_t y, int16_t w, uint16_t color)
 Write a perfectly horizontal line, overwrite in subclasses if startWrite is defined! More...
 
virtual void writeLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color)
 Write a line. Bresenham's algorithm - thx wikpedia. More...
 
virtual void endWrite (void)
 End a display-writing routine, overwrite in subclasses if startWrite is defined!
 
virtual void setRotation (uint8_t r)
 Set rotation setting for display. More...
 
virtual void invertDisplay (bool i)
 Invert the display (ideally using built-in hardware command) More...
 
virtual void fillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Fill a rectangle completely with one color. Update in subclasses if desired! More...
 
virtual void drawLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color)
 Draw a line. More...
 
virtual void drawRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Draw a rectangle with no fill color. More...
 
void drawCircle (int16_t x0, int16_t y0, int16_t r, uint16_t color)
 Draw a circle outline. More...
 
void drawCircleHelper (int16_t x0, int16_t y0, int16_t r, uint8_t cornername, uint16_t color)
 Quarter-circle drawer, used to do circles and roundrects. More...
 
void fillCircle (int16_t x0, int16_t y0, int16_t r, uint16_t color)
 Draw a circle with filled color. More...
 
void fillCircleHelper (int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color)
 Quarter-circle drawer with fill, used for circles and roundrects. More...
 
void drawTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
 Draw a triangle with no fill color. More...
 
void fillTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
 Draw a triangle with color-fill. More...
 
void drawRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
 Draw a rounded rectangle with no fill color. More...
 
void fillRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
 Draw a rounded rectangle with fill color. More...
 
void drawBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color)
 Draw a PROGMEM-resident 1-bit image at the specified (x,y) position, using the specified foreground color (unset bits are transparent). More...
 
void drawBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color, uint16_t bg)
 Draw a PROGMEM-resident 1-bit image at the specified (x,y) position, using the specified foreground (for set bits) and background (unset bits) colors. More...
 
void drawBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color)
 Draw a RAM-resident 1-bit image at the specified (x,y) position, using the specified foreground color (unset bits are transparent). More...
 
void drawBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color, uint16_t bg)
 Draw a RAM-resident 1-bit image at the specified (x,y) position, using the specified foreground (for set bits) and background (unset bits) colors. More...
 
void drawXBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color)
 Draw PROGMEM-resident XBitMap Files (*.xbm), exported from GIMP. Usage: Export from GIMP to *.xbm, rename *.xbm to *.c and open in editor. C Array can be directly used with this function. There is no RAM-resident version of this function; if generating bitmaps in RAM, use the format defined by drawBitmap() and call that instead. More...
 
void drawGrayscaleBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 8-bit image (grayscale) at the specified (x,y) pos. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed. More...
 
void drawGrayscaleBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h)
 Draw a RAM-resident 8-bit image (grayscale) at the specified (x,y) pos. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed. More...
 
void drawGrayscaleBitmap (int16_t x, int16_t y, const uint8_t bitmap[], const uint8_t mask[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 8-bit image (grayscale) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (grayscale and mask) must be PROGMEM-resident. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed. More...
 
void drawGrayscaleBitmap (int16_t x, int16_t y, uint8_t *bitmap, uint8_t *mask, int16_t w, int16_t h)
 Draw a RAM-resident 8-bit image (grayscale) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (grayscale and mask) must be RAM-residentt, no mix-and-match Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed. More...
 
void drawRGBBitmap (int16_t x, int16_t y, const uint16_t bitmap[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 16-bit image (RGB 5/6/5) at the specified (x,y) position. For 16-bit display devices; no color reduction performed. More...
 
void drawRGBBitmap (int16_t x, int16_t y, uint16_t *bitmap, int16_t w, int16_t h)
 Draw a RAM-resident 16-bit image (RGB 5/6/5) at the specified (x,y) position. For 16-bit display devices; no color reduction performed. More...
 
void drawRGBBitmap (int16_t x, int16_t y, const uint16_t bitmap[], const uint8_t mask[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 16-bit image (RGB 5/6/5) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (color and mask) must be PROGMEM-resident. For 16-bit display devices; no color reduction performed. More...
 
void drawRGBBitmap (int16_t x, int16_t y, uint16_t *bitmap, uint8_t *mask, int16_t w, int16_t h)
 Draw a RAM-resident 16-bit image (RGB 5/6/5) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (color and mask) must be RAM-resident. For 16-bit display devices; no color reduction performed. More...
 
void drawChar (int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size)
 Draw a single character. More...
 
void drawChar (int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size_x, uint8_t size_y)
 Draw a single character. More...
 
void getTextBounds (const char *string, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H. More...
 
void getTextBounds (const __FlashStringHelper *s, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a PROGMEM string with current font/size. Pass string and a cursor position, returns UL corner and W,H. More...
 
void getTextBounds (const String &str, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H. More...
 
void setTextSize (uint8_t s)
 Set text 'magnification' size. Each increase in s makes 1 pixel that much bigger. More...
 
void setTextSize (uint8_t sx, uint8_t sy)
 Set text 'magnification' size. Each increase in s makes 1 pixel that much bigger. More...
 
void setFont (const GFXfont *f=NULL)
 Set the font to display when print()ing, either custom or default. More...
 
void setCursor (int16_t x, int16_t y)
 Set text cursor location. More...
 
void setTextColor (uint16_t c)
 Set text font color with transparant background. More...
 
void setTextColor (uint16_t c, uint16_t bg)
 Set text font color with custom background color. More...
 
void setTextWrap (bool w)
 Set whether text that is too long for the screen width should automatically wrap around to the next line (else clip right). More...
 
void cp437 (bool x=true)
 Enable (or disable) Code Page 437-compatible charset. There was an error in glcdfont.c for the longest time – one character (#176, the 'light shade' block) was missing – this threw off the index of every character that followed it. But a TON of code has been written with the erroneous character indices. By default, the library uses the original 'wrong' behavior and old sketches will still work. Pass 'true' to this function to use correct CP437 character values in your code. More...
 
virtual void write (uint8_t)
 Print one byte/character of data, used to support print() More...
 
int16_t width (void) const
 Get width of the display, accounting for current rotation. More...
 
int16_t height (void) const
 Get height of the display, accounting for current rotation. More...
 
uint8_t getRotation (void) const
 Get rotation setting for display. More...
 
int16_t getCursorX (void) const
 Get text cursor X location. More...
 
int16_t getCursorY (void) const
 Get text cursor Y location. More...
 

Protected Member Functions

uint16_t getRawPixel (int16_t x, int16_t y) const
 Get the pixel color value at a given, unrotated coordinate. This method is intended for hardware drivers to get pixel value in physical coordinates. More...
 
void drawFastRawVLine (int16_t x, int16_t y, int16_t h, uint16_t color)
 Speed optimized vertical line drawing into the raw canvas buffer. More...
 
void drawFastRawHLine (int16_t x, int16_t y, int16_t w, uint16_t color)
 Speed optimized horizontal line drawing into the raw canvas buffer. More...
 
- Protected Member Functions inherited from Adafruit_GFX
void charBounds (unsigned char c, int16_t *x, int16_t *y, int16_t *minx, int16_t *miny, int16_t *maxx, int16_t *maxy)
 Helper to determine size of a character with current font/size. Broke this out as it's used by both the PROGMEM- and RAM-resident getTextBounds() functions. More...
 

Additional Inherited Members

- Protected Attributes inherited from Adafruit_GFX
int16_t WIDTH
 This is the 'raw' display width - never changes.
 
int16_t HEIGHT
 This is the 'raw' display height - never changes.
 
int16_t _width
 Display width as modified by current rotation.
 
int16_t _height
 Display height as modified by current rotation.
 
int16_t cursor_x
 x location to start print()ing text
 
int16_t cursor_y
 y location to start print()ing text
 
uint16_t textcolor
 16-bit background color for print()
 
uint16_t textbgcolor
 16-bit text color for print()
 
uint8_t textsize_x
 Desired magnification in X-axis of text to print()
 
uint8_t textsize_y
 Desired magnification in Y-axis of text to print()
 
uint8_t rotation
 Display rotation (0 thru 3)
 
bool wrap
 If set, 'wrap' text at right edge of display.
 
bool _cp437
 If set, use correct CP437 charset (default is off)
 
GFXfontgfxFont
 Pointer to special font.
 

Detailed Description

A GFX 16-bit canvas context for graphics.

Constructor & Destructor Documentation

◆ GFXcanvas16()

GFXcanvas16::GFXcanvas16 ( uint16_t  w,
uint16_t  h 
)

Instatiate a GFX 16-bit canvas context for graphics.

Parameters
wDisplay width, in pixels
hDisplay height, in pixels

Member Function Documentation

◆ drawPixel()

void GFXcanvas16::drawPixel ( int16_t  x,
int16_t  y,
uint16_t  color 
)
virtual

Draw a pixel to the canvas framebuffer.

Parameters
xx coordinate
yy coordinate
color16-bit 5-6-5 Color to fill with

Implements Adafruit_GFX.

◆ fillScreen()

void GFXcanvas16::fillScreen ( uint16_t  color)
virtual

Fill the framebuffer completely with one color.

Parameters
color16-bit 5-6-5 Color to fill with

Reimplemented from Adafruit_GFX.

◆ drawFastVLine()

void GFXcanvas16::drawFastVLine ( int16_t  x,
int16_t  y,
int16_t  h,
uint16_t  color 
)
virtual

Speed optimized vertical line drawing.

Parameters
xLine horizontal start point
yLine vertical start point
hlength of vertical line to be drawn, including first point
colorcolor 16-bit 5-6-5 Color to draw line with

Reimplemented from Adafruit_GFX.

◆ drawFastHLine()

void GFXcanvas16::drawFastHLine ( int16_t  x,
int16_t  y,
int16_t  w,
uint16_t  color 
)
virtual

Speed optimized horizontal line drawing.

Parameters
xLine horizontal start point
yLine vertical start point
wLength of horizontal line to be drawn, including 1st point
colorColor 16-bit 5-6-5 Color to draw line with

Reimplemented from Adafruit_GFX.

◆ getPixel()

uint16_t GFXcanvas16::getPixel ( int16_t  x,
int16_t  y 
) const

Get the pixel color value at a given coordinate.

Parameters
xx coordinate
yy coordinate
Returns
The desired pixel's 16-bit 5-6-5 color value

◆ getBuffer()

uint16_t* GFXcanvas16::getBuffer ( void  ) const
inline

Get a pointer to the internal buffer memory.

Returns
A pointer to the allocated buffer

◆ getRawPixel()

uint16_t GFXcanvas16::getRawPixel ( int16_t  x,
int16_t  y 
) const
protected

Get the pixel color value at a given, unrotated coordinate. This method is intended for hardware drivers to get pixel value in physical coordinates.

Parameters
xx coordinate
yy coordinate
Returns
The desired pixel's 16-bit 5-6-5 color value

◆ drawFastRawVLine()

void GFXcanvas16::drawFastRawVLine ( int16_t  x,
int16_t  y,
int16_t  h,
uint16_t  color 
)
protected

Speed optimized vertical line drawing into the raw canvas buffer.

Parameters
xLine horizontal start point
yLine vertical start point
hlength of vertical line to be drawn, including first point
colorcolor 16-bit 5-6-5 Color to draw line with

◆ drawFastRawHLine()

void GFXcanvas16::drawFastRawHLine ( int16_t  x,
int16_t  y,
int16_t  w,
uint16_t  color 
)
protected

Speed optimized horizontal line drawing into the raw canvas buffer.

Parameters
xLine horizontal start point
yLine vertical start point
wlength of horizontal line to be drawn, including first point
colorcolor 16-bit 5-6-5 Color to draw line with

The documentation for this class was generated from the following files: