libPocuter 1.0 Support library for programming the Pocuter

PocuterDisplay.h
Go to the documentation of this file.
1 #ifndef POCUTERDISPLAY_H
2 #define POCUTERDISPLAY_H
3 #include <stdint.h>
8 class PocuterDisplay {
9 public:
10 enum BUFFER_MODE {
11 BUFFER_MODE_NO_BUFFER,
12 BUFFER_MODE_DOUBLE_BUFFER
13
14 };
22 virtual void getDisplaySize(uint16_t& sizeX, uint16_t& sizeY) = 0;
23
32 virtual void setPixel(int16_t x, int16_t y, uint32_t color) = 0;
33
44 virtual void drawLine(int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint32_t color) = 0;
45
58 virtual void drawScanLine(int16_t x, int16_t y, uint16_t width, uint32_t* colors) = 0;
59
72 virtual void draw16BitScanLine(int16_t x, int16_t y, uint16_t width, uint16_t* colors) = 0;
73
74
85 virtual void drawRectangle(int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint32_t color) = 0;
86
92 virtual void setBrightness(uint8_t brightness) = 0;
93
105 virtual void clearWindow(int16_t x, int16_t y, int16_t width, int16_t height) = 0;
106
112 virtual void clearScreen() = 0;
113
114
123 virtual void continuousScreenUpdate(bool on) = 0;
124
132 virtual void updateScreen() = 0;
133
134
142 virtual BUFFER_MODE getBufferMode() = 0;
143
144
149 virtual void doSleep() = 0;
150
155 virtual void doWakeUp() = 0;
156
157
158
159 private:
160
161 };
162
163 #endif /* POCUTERDISPLAY_H */
164
PocuterDisplay::clearWindow
virtual void clearWindow(int16_t x, int16_t y, int16_t width, int16_t height)=0
clear a rectangle
PocuterDisplay::setPixel
virtual void setPixel(int16_t x, int16_t y, uint32_t color)=0
set a Pixel on the display
PocuterDisplay::drawScanLine
virtual void drawScanLine(int16_t x, int16_t y, uint16_t width, uint32_t *colors)=0
draw a horizontal line
PocuterDisplay::setBrightness
virtual void setBrightness(uint8_t brightness)=0
set the display brightness
PocuterDisplay::doWakeUp
virtual void doWakeUp()=0
wake up the display
PocuterDisplay::getBufferMode
virtual BUFFER_MODE getBufferMode()=0
get the current buffer mode
PocuterDisplay::drawRectangle
virtual void drawRectangle(int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint32_t color)=0
draws a filled rectangle
PocuterDisplay::getDisplaySize
virtual void getDisplaySize(uint16_t &sizeX, uint16_t &sizeY)=0
get the Display size
PocuterDisplay::updateScreen
virtual void updateScreen()=0
update the screen. Only available in DOUBLE BUFFER mode
PocuterDisplay
this class has basic display operations only. If you want to write a GUI, consider to use ugui instea...
Definition: PocuterDisplay.h:8
PocuterDisplay::BUFFER_MODE
BUFFER_MODE
Definition: PocuterDisplay.h:10
PocuterDisplay::drawLine
virtual void drawLine(int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint32_t color)=0
draw a line
PocuterDisplay::continuousScreenUpdate
virtual void continuousScreenUpdate(bool on)=0
automatic screen update
PocuterDisplay::draw16BitScanLine
virtual void draw16BitScanLine(int16_t x, int16_t y, uint16_t width, uint16_t *colors)=0
draw a horizontal line with 16 bit color instead of 24 bit
PocuterDisplay::BUFFER_MODE_DOUBLE_BUFFER
@ BUFFER_MODE_DOUBLE_BUFFER
Definition: PocuterDisplay.h:12
PocuterDisplay::clearScreen
virtual void clearScreen()=0
clear the hole screen
PocuterDisplay::doSleep
virtual void doSleep()=0
let the display sleep
PocuterDisplay::BUFFER_MODE_NO_BUFFER
@ BUFFER_MODE_NO_BUFFER
Definition: PocuterDisplay.h:11