Adafruit ImageReader Library
Public Member Functions | Friends | List of all members
Adafruit_Image_EPD Class Reference

Data bundle returned with an image loaded to RAM. Used by ImageReader.loadBMP() and Image.draw(), not ImageReader.drawBMP(). More...

#include <Adafruit_ImageReader_EPD.h>

Inheritance diagram for Adafruit_Image_EPD:
Adafruit_Image

Public Member Functions

void draw (Adafruit_EPD &epd, int16_t x, int16_t y)
 Draw image to an Adafruit ePaper-type display. More...
 
- Public Member Functions inherited from Adafruit_Image
 Adafruit_Image (void)
 Constructor. More...
 
 ~Adafruit_Image (void)
 Destructor. More...
 
int16_t width (void) const
 Get width of Adafruit_Image object. More...
 
int16_t height (void) const
 Get height of Adafruit_Image object. More...
 
void draw (Adafruit_SPITFT &tft, int16_t x, int16_t y)
 Draw image to an Adafruit_SPITFT-type display. More...
 
ImageFormat getFormat (void) const
 Return canvas image format. More...
 
void * getCanvas (void) const
 Return pointer to image's GFX canvas object. More...
 
uint16_t * getPalette (void) const
 Return pointer to color palette. More...
 
GFXcanvas1 * getMask (void) const
 Return pointer to 1bpp image mask canvas. More...
 

Friends

class Adafruit_ImageReader_EPD
 Loading occurs here.
 

Additional Inherited Members

- Protected Member Functions inherited from Adafruit_Image
void dealloc (void)
 Free/deinitialize variables. More...
 
- Protected Attributes inherited from Adafruit_Image
union {
   GFXcanvas1 *   canvas1
 Canvas object if 1bpp format.
 
   GFXcanvas8 *   canvas8
 Canvas object if 8bpp format.
 
   GFXcanvas16 *   canvas16
 Canvas object if 16bpp.
 
canvas
 Union of different GFXcanvas types.
 
GFXcanvas1 * mask
 1bpp image mask (or NULL)
 
uint16_t * palette
 Color palette for 8bpp image (or NULL)
 
uint8_t format
 Canvas bundle type in use.
 

Detailed Description

Data bundle returned with an image loaded to RAM. Used by ImageReader.loadBMP() and Image.draw(), not ImageReader.drawBMP().

Member Function Documentation

◆ draw()

void Adafruit_Image_EPD::draw ( Adafruit_EPD &  epd,
int16_t  x,
int16_t  y 
)

Draw image to an Adafruit ePaper-type display.

Parameters
epdScreen to draw to (any Adafruit_EPD-derived class).
xHorizontal offset in pixels; left edge = 0, positive = right. Value is signed, image will be clipped if all or part is off the screen edges. Screen rotation setting is observed.
yVertical offset in pixels; top edge = 0, positive = down.
Returns
None (void).

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