LCDGFX LCD display driver  1.2.0
Lightweight graphics library for SSD1306, SSD1325, SSD1327, SSD1331, SSD1351, SH1106, SH1107, IL9163, ST7735, ST7789, ILI9341, PCD8544 displays over I2C/SPI
display.h
1 /*
2  MIT License
3 
4  Copyright (c) 2018-2022, Alexey Dynda
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy
7  of this software and associated documentation files (the "Software"), to deal
8  in the Software without restriction, including without limitation the rights
9  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  copies of the Software, and to permit persons to whom the Software is
11  furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in all
14  copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  SOFTWARE.
23 */
28 #ifndef _NANO_DISPLAY_H_
29 #define _NANO_DISPLAY_H_
30 
31 #include "canvas/point.h"
32 #include "canvas/rect.h"
33 #include "canvas/canvas.h"
34 #include "canvas/font.h"
35 #include "lcd_hal/io.h"
36 #include "nano_gfx_types.h"
37 #include "display_base.h"
38 
47 template <class I> class NanoDisplayOps1: public NanoDisplayBase<I>
48 {
49 public:
51  static const uint8_t BITS_PER_PIXEL = 1;
52 
53  using NanoDisplayBase<I>::NanoDisplayBase;
54 
61  void putPixel(lcdint_t x, lcdint_t y) __attribute__((noinline));
62 
70  void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2);
71 
79  void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2);
80 
89  void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));
90 
101  void drawXBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
102 
117  void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
118 
129  void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf);
130 
140  void drawBitmap4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
141 
151  void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
152 
163  void drawBitmap16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
164 
181  void drawBuffer1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
182 
192  void drawBuffer1Fast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
193 
205  void drawBuffer4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
206 
218  void drawBuffer8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
219 
230  void drawBuffer16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *buffer)
231  __attribute__((noinline));
232 
236  void clear();
237 
243  void fill(uint16_t color);
244 
250  uint8_t printChar(uint8_t c);
251 
256  size_t write(uint8_t c) __attribute__((noinline));
257 
268  void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
269  __attribute__((noinline));
270 
271 #ifndef DOXYGEN_SHOULD_SKIP_THIS
272  void printFixed_oldStyle(uint8_t xpos, uint8_t y, const char *ch, EFontStyle style) __attribute__((noinline));
273 #endif
274 
291  void printFixedN(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style, uint8_t factor)
292  __attribute__((noinline));
293 
294 protected:
295 };
296 
300 template <class I> class NanoDisplayOps4: public NanoDisplayBase<I>
301 {
302 public:
304  static const uint8_t BITS_PER_PIXEL = 4;
305 
306  using NanoDisplayBase<I>::NanoDisplayBase;
307 
314  void putPixel(lcdint_t x, lcdint_t y) __attribute__((noinline));
315 
323  void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2);
324 
332  void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2);
333 
342  void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));
343 
354  void drawXBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
355 
370  void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
371 
381  void drawBitmap4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
382 
392  void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
393 
404  void drawBitmap16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
405 
422  void drawBuffer1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
423 
433  void drawBuffer1Fast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
434 
446  void drawBuffer4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
447 
459  void drawBuffer8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
460 
471  void drawBuffer16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *buffer)
472  __attribute__((noinline));
473 
477  void clear();
478 
484  void fill(uint16_t color);
485 
491  uint8_t printChar(uint8_t c);
492 
497  size_t write(uint8_t c) __attribute__((noinline));
498 
509  void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
510  __attribute__((noinline));
511 
512 protected:
513 private:
514  lcdint_t m_lastRow = 0;
515  lcdint_t m_lastColumn = 0;
516  uint8_t m_lastByte = 0;
517 };
518 
522 template <class I> class NanoDisplayOps8: public NanoDisplayBase<I>
523 {
524 public:
526  static const uint8_t BITS_PER_PIXEL = 8;
527 
528  using NanoDisplayBase<I>::NanoDisplayBase;
529 
536  void putPixel(lcdint_t x, lcdint_t y) __attribute__((noinline));
537 
545  void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2);
546 
554  void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2);
555 
564  void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));
565 
576  void drawXBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
577 
592  void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
593 
603  void drawBitmap4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
604 
614  void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
615 
626  void drawBitmap16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
627 
644  void drawBuffer1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
645 
655  void drawBuffer1Fast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
656 
668  void drawBuffer4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
669 
681  void drawBuffer8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
682 
693  void drawBuffer16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *buffer)
694  __attribute__((noinline));
695 
699  void clear();
700 
706  void fill(uint16_t color);
707 
713  uint8_t printChar(uint8_t c);
714 
719  size_t write(uint8_t c) __attribute__((noinline));
720 
731  void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
732  __attribute__((noinline));
733 
734 protected:
735 };
736 
740 template <class I> class NanoDisplayOps16: public NanoDisplayBase<I>
741 {
742 public:
744  static const uint8_t BITS_PER_PIXEL = 1;
745 
746  using NanoDisplayBase<I>::NanoDisplayBase;
747 
754  void putPixel(lcdint_t x, lcdint_t y) __attribute__((noinline));
755 
763  void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2);
764 
772  void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2);
773 
782  void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline));
783 
794  void drawXBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
795 
810  void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
811 
821  void drawBitmap4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline));
822 
832  void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
833 
844  void drawBitmap16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *bitmap);
845 
862  void drawBuffer1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
863 
873  void drawBuffer1Fast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
874 
886  void drawBuffer4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline));
887 
899  void drawBuffer8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer);
900 
911  void drawBuffer16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *buffer)
912  __attribute__((noinline));
913 
917  void clear();
918 
924  void fill(uint16_t color);
925 
931  uint8_t printChar(uint8_t c);
932 
937  size_t write(uint8_t c) __attribute__((noinline));
938 
949  void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
950  __attribute__((noinline));
951 
968  void printFixedN(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style, uint8_t factor)
969  __attribute__((noinline));
970 
971 protected:
972 };
973 
978 template <typename O, typename I> class NanoDisplayOps: public O
979 {
980 public:
981  using O::O;
982 
983  using O::putPixel;
984 
986  typedef NanoDisplayOps<O, I> T;
987 
993  void putPixel(const NanoPoint &p);
994 
1003  void drawLine(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2);
1004 
1010  void drawLine(const NanoRect &rect);
1011 
1020  void drawRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2);
1021 
1027  void drawRect(const NanoRect &rect);
1028 
1029  using O::fillRect;
1030 
1036  void fillRect(const NanoRect &rect);
1037 
1046  void clearRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2);
1047 
1053  void clearRect(const NanoRect &rect);
1054 
1062  void drawCircle(lcdint_t xc, lcdint_t yc, lcdint_t r, uint8_t options = 0x0F);
1063 
1071  void drawCanvas(lcdint_t x, lcdint_t y, NanoCanvasOps<1> &canvas) __attribute__((noinline));
1072 
1080  void drawCanvas(lcdint_t x, lcdint_t y, NanoCanvasOps<4> &canvas) __attribute__((noinline));
1081 
1089  void drawCanvas(lcdint_t x, lcdint_t y, NanoCanvasOps<8> &canvas) __attribute__((noinline));
1090 
1098  void drawCanvas(lcdint_t x, lcdint_t y, NanoCanvasOps<16> &canvas) __attribute__((noinline));
1099 
1110  void printFixedPgm(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style = STYLE_NORMAL)
1111  __attribute__((noinline));
1112 
1113  using O::write;
1114 
1121  void write(const char *str);
1122 
1129  void print(int number);
1130 
1137  void print(float number);
1138 
1145  void print(char c);
1146 
1157  void createMenu(SAppMenu *menu, const char **items, uint8_t count, const NanoRect &rect = {});
1158 
1165  void showMenu(SAppMenu *menu);
1166 
1174  void showMenuSmooth(SAppMenu *menu);
1175 
1182  void updateMenu(SAppMenu *menu);
1183 
1192  void updateMenuSmooth(SAppMenu *menu);
1193 
1201  uint8_t menuSelection(const SAppMenu *menu);
1202 
1210  void menuDown(SAppMenu *menu);
1211 
1219  void menuUp(SAppMenu *menu);
1220 
1226  void drawProgressBar(int8_t progress);
1227 
1238  void drawWindow(lcdint_t x, lcdint_t y, lcduint_t width, lcduint_t height, const char *caption, bool blank);
1239 
1240 protected:
1244  virtual void begin() = 0;
1245 
1249  virtual void end() = 0;
1250 };
1251 
1252 #include "ssd1306_1bit.inl"
1253 #include "ssd1306_4bit.inl"
1254 #include "ssd1306_8bit.inl"
1255 #include "ssd1306_16bit.inl"
1256 #include "ssd1306_common.inl"
1257 
1262 #endif
NanoDisplayOps1::drawBitmap8
void drawBitmap8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap)
Draws 8-bit color bitmap in color buffer.
Definition: ssd1306_1bit.inl:615
NanoDisplayOps1::fill
void fill(uint16_t color)
Fill screen content with specified color.
Definition: ssd1306_1bit.inl:722
NanoDisplayOps1::drawBitmap16
void drawBitmap16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *bitmap)
Draw 16-bit color bitmap, located in Flash, directly to OLED display GDRAM.
Definition: ssd1306_1bit.inl:621
lcduint_t
uint8_t lcduint_t
internal int type, used by the library.
Definition: canvas_types.h:79
_NanoPoint
Describes point.
Definition: point.h:39
NanoDisplayOps1::drawBitmap1
void drawBitmap1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap) __attribute__((noinline))
Draws monochrome bitmap in color buffer using color, specified via setColor() method Draws monochrome...
Definition: ssd1306_1bit.inl:476
NanoDisplayOps1::drawBuffer4
void drawBuffer4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline))
Draws 4-bit bitmap, located in RAM, on the display Each byte represents two pixels in 4-4 format: ref...
Definition: ssd1306_1bit.inl:705
NanoDisplayOps4
NanoDisplayOps4 is template class for 4-bit monochrome operations.
Definition: display.h:300
_NanoRect
NanoRect structure describes rectangle area.
Definition: rect.h:42
point.h
Point class.
NanoDisplayBase::width
lcduint_t width()
Returns width of the display in pixels.
Definition: display_base.h:98
lcdint_t
int8_t lcdint_t
internal int type, used by the library.
Definition: canvas_types.h:77
NanoDisplayBase::height
lcduint_t height()
Returns height of the display in pixels.
Definition: display_base.h:106
NanoDisplayOps1::fillRect
void fillRect(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline))
Fills rectangle area.
Definition: ssd1306_1bit.inl:386
NanoDisplayOps1::BITS_PER_PIXEL
static const uint8_t BITS_PER_PIXEL
number of bits per single pixel in buffer
Definition: display.h:51
io.h
SSD1306 HAL IO communication functions.
canvas.h
Drawing in memory buffer.
NanoDisplayOps::T
NanoDisplayOps< O, I > T
Base type for display operations class.
Definition: display.h:986
NanoCanvasOps
NanoCanvasOps provides operations for drawing in memory buffer.
Definition: canvas.h:53
NanoDisplayOps1::gfx_drawMonoBitmap
void gfx_drawMonoBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buf)
Draws bitmap, located in Flash, on the display.
Definition: ssd1306_1bit.inl:544
rect.h
Rectangle class.
NanoDisplayOps1::drawBuffer1
void drawBuffer1(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline))
Draws bitmap, located in RAM, on the display Each byte represents 8 vertical pixels.
Definition: ssd1306_1bit.inl:627
NanoDisplayOps1
NanoDisplayOps1 is template class for 1-bit operations.
Definition: display.h:47
NanoDisplayOps1::printChar
uint8_t printChar(uint8_t c)
Draws single character to canvas.
Definition: ssd1306_1bit.inl:119
NanoDisplayBase::rect
const NanoRect rect() const
Returns rectangle area, covered by canvas in offset terms.
Definition: display_base.h:90
nano_gfx_types.h
Basic structures of nano gfx library.
NanoDisplayOps1::drawBuffer1Fast
void drawBuffer1Fast(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer)
Implements the same behavior as drawBuffer1, but much faster.
Definition: ssd1306_1bit.inl:691
NanoDisplayOps1::drawXBitmap
void drawXBitmap(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap)
Draws bitmap, located in Flash, on the display The bitmap should be in XBMP format.
Definition: ssd1306_1bit.inl:442
NanoDisplayOps1::putPixel
void putPixel(lcdint_t x, lcdint_t y) __attribute__((noinline))
Draws pixel on specified position.
Definition: ssd1306_1bit.inl:345
display_base.h
Basic display capabilities implementation.
NanoDisplayOps1::printFixedN
void printFixedN(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style, uint8_t factor) __attribute__((noinline))
Prints text to screen using size fixed font, scaled by factor value.
Definition: ssd1306_1bit.inl:245
NanoDisplayOps1::drawBuffer8
void drawBuffer8(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline))
Draws 8-bit bitmap, located in RAM, on the display Each byte represents one pixel in 2-2-3 format: re...
Definition: ssd1306_1bit.inl:711
SAppMenu
Describes menu object.
Definition: canvas_types.h:152
NanoDisplayOps1::clear
void clear()
Clears canvas.
Definition: ssd1306_1bit.inl:426
NanoDisplayOps1::write
size_t write(uint8_t c) __attribute__((noinline))
Writes single character to canvas.
Definition: ssd1306_1bit.inl:150
NanoDisplayOps1::printFixed
void printFixed(lcdint_t xpos, lcdint_t y, const char *ch, EFontStyle style=STYLE_NORMAL) __attribute__((noinline))
Print text at specified position to canvas.
Definition: ssd1306_1bit.inl:37
NanoDisplayOps1::drawBitmap4
void drawBitmap4(lcdint_t x, lcdint_t y, lcduint_t w, lcduint_t h, const uint8_t *bitmap)
Draws 4-bit gray-color bitmap in color buffer.
Definition: ssd1306_1bit.inl:609
NanoDisplayOps
NanoCanvasOps provides operations for drawing in memory buffer.
Definition: display.h:978
NanoDisplayOps1::drawVLine
void drawVLine(lcdint_t x1, lcdint_t y1, lcdint_t y2)
Draws horizontal or vertical line.
Definition: ssd1306_1bit.inl:362
EFontStyle
EFontStyle
Supported font styles.
Definition: canvas_types.h:88
NanoDisplayBase
Class implements basic display operations for the library: It stores reference to communication inter...
Definition: display_base.h:55
NanoDisplayOps1::drawHLine
void drawHLine(lcdint_t x1, lcdint_t y1, lcdint_t x2)
Draws horizontal or vertical line.
Definition: ssd1306_1bit.inl:352
NanoDisplayOps1::drawBuffer16
void drawBuffer16(lcdint_t xpos, lcdint_t ypos, lcduint_t w, lcduint_t h, const uint8_t *buffer) __attribute__((noinline))
Draws 16-bit bitmap, located in RAM, on the display Each pixel occupies 2 bytes (5-6-5 format): refer...
Definition: ssd1306_1bit.inl:717
NanoDisplayOps16
NanoDisplayOps16 is template class for 16-bit operations.
Definition: display.h:740
font.h
Font class.
NanoDisplayOps8
NanoDisplayOps8 is template class for 8-bit operations.
Definition: display.h:522