aboutsummaryrefslogtreecommitdiff
path: root/libraries/TFT/utility/PImage.h
blob: d37bf71f3c91b8095f4d7d7b4e622b98f55b79f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
#ifndef _PIMAGE_H
#define _PIMAGE_H

class Adafruit_GFX;

#if defined(__SD_H__)  // Arduino SD library


/// This class mimics Processing's PImage, but with fewer
/// capabilities. It allows an image stored in the SD card to be
/// drawn to the display.
/// @author Enrico Gueli <enrico.gueli@gmail.com>
class PImage {
public:
  PImage() : 
    _valid(false), 
    _bmpWidth(0), 
    _bmpHeight(0) { }
  
  void draw(Adafruit_GFX & glcd, int16_t x, int16_t y);
  
  static PImage loadImage(const char * fileName);
  
  
  bool isValid() { return _valid; }
  
  int width() { return _bmpWidth; }
  int height() { return _bmpHeight; }
  
private:
  friend class Adafruit_GFX;
  
  File _bmpFile;
  int  _bmpWidth, _bmpHeight;   // W+H in pixels
  uint8_t  _bmpDepth;              // Bit depth (currently must be 24)
  uint32_t _bmpImageoffset;        // Start of image data in file
  uint32_t _rowSize;               // Not always = bmpWidth; may have padding
  bool     _flip; 
  
  bool     _valid;
  
  PImage(File & bmpFile, int bmpWidth, int bmpHeight, uint8_t  bmpDepth, uint32_t bmpImageoffset, uint32_t rowSize, bool     flip) : 
  _bmpFile(bmpFile),
  _bmpWidth(bmpWidth),
  _bmpHeight(bmpHeight),
  _bmpDepth(bmpDepth),
  _bmpImageoffset(bmpImageoffset),
  _rowSize(rowSize),
  _flip(flip),
  _valid(true) // since Adafruit_GFX is friend, we could just let it write the variables and save some CPU cycles
  { }
  
  static uint16_t read16(File f);
  static uint32_t read32(File f);
  
  // TODO close the file in ~PImage and PImage(const PImage&)

};

#endif

#endif // _PIMAGE_H