LCDGFX LCD display driver  2.0.1
This library is developed to control SSD1306/SSD1325/SSD1327/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
display_base.h
Go to the documentation of this file.
1 /*
2  MIT License
3 
4  Copyright (c) 2018-2019, 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 _DISPLAY_BASE_H_
29 #define _DISPLAY_BASE_H_
30 
31 #include "lcd_hal/io.h"
32 #include "nano_gfx_types.h"
33 #include "canvas/point.h"
34 #include "canvas/rect.h"
35 #include "canvas/font.h"
36 
42 extern uint8_t s_ssd1306_invertByte;
43 
48 template <class I>
50 {
51 public:
57  NanoDisplayBase(I& intf): m_intf( intf ) {}
58 
64  void setOffset(lcdint_t ox, lcdint_t oy) { };
65 
70  const NanoPoint offsetEnd() const
71  {
72  return (NanoPoint){ (lcdint_t)(m_w-1), (lcdint_t)(m_h-1) };
73  }
74 
79  const NanoRect rect() const
80  {
81  return { (NanoPoint){0,0}, offsetEnd() };
82  }
83 
87  lcduint_t width() { return m_w; }
88 
92  lcduint_t height() { return m_h; }
93 
98  {
99  lcduint_t t = m_w;
100  m_w = m_h;
101  m_h = t;
102  }
103 
108  void setColor(uint16_t color) { m_color = color; };
109 
114  void negativeMode() { s_ssd1306_invertByte = 0xFF; }
115 
120  void positiveMode() { s_ssd1306_invertByte = 0x00; }
121 
127  I& getInterface() { return m_intf; }
128 
137  void setFont( NanoFont &font ) { m_font = &font; }
138 
142  NanoFont &getFont() { return *m_font; }
143 
153  void setFixedFont( const uint8_t *progmemFont )
154  {
155  g_canvas_font.loadFixedFont( progmemFont );
156  setFont( g_canvas_font );
157  }
158 
159 #ifndef DOXYGEN_SHOULD_SKIP_THIS
160  void setFixedFont_oldStyle( const uint8_t *progmemFont )
161  {
162  g_canvas_font.loadFixedFont_oldStyle( progmemFont );
163  setFont( g_canvas_font );
164  }
165 #endif
166 
177  void setFixedFont( const uint8_t *progmemFont, const uint8_t *secondaryFont )
178  {
179  g_canvas_font.loadFixedFont( progmemFont );
180  if ( secondaryFont )
181  {
182  g_canvas_font.loadSecondaryFont( secondaryFont );
183  }
184  setFont( g_canvas_font );
185  }
186 
197  void setFreeFont( const uint8_t *progmemFont, const uint8_t *secondaryFont = nullptr )
198  {
199  g_canvas_font.loadFreeFont( progmemFont );
200  if ( secondaryFont )
201  {
202  g_canvas_font.loadSecondaryFont( secondaryFont );
203  }
204  setFont( g_canvas_font );
205  }
206 
207 protected:
213  uint8_t m_textMode = 0;
215  uint16_t m_color = 0xFFFF;
216  NanoFont *m_font = nullptr;
217 
218  I& m_intf;
219 };
220 
225 #endif
226 
EFontStyle m_fontStyle
currently active font style
Definition: display_base.h:214
lcdint_t m_cursorY
current Y cursor position for text output
Definition: display_base.h:212
uint8_t lcduint_t
Definition: canvas_types.h:81
struct _NanoPoint NanoPoint
Definition: rect.h:42
const NanoPoint offsetEnd() const
Definition: display_base.h:70
void swapDimensions()
Definition: display_base.h:97
void setOffset(lcdint_t ox, lcdint_t oy)
Definition: display_base.h:64
NanoFont * m_font
currently set font
Definition: display_base.h:216
lcduint_t m_w
width of NanoCanvas area in pixels
Definition: display_base.h:208
lcduint_t width()
Definition: display_base.h:87
int8_t lcdint_t
Definition: canvas_types.h:79
lcduint_t height()
Definition: display_base.h:92
void setFixedFont(const uint8_t *progmemFont, const uint8_t *secondaryFont)
Definition: display_base.h:177
void setFont(NanoFont &font)
Definition: display_base.h:137
void setColor(uint16_t color)
Definition: display_base.h:108
uint16_t m_color
current color for monochrome operations
Definition: display_base.h:215
Definition: font.h:45
void setFixedFont(const uint8_t *progmemFont)
Definition: display_base.h:153
NanoDisplayBase(I &intf)
Definition: display_base.h:57
const NanoRect rect() const
Definition: display_base.h:79
lcduint_t m_h
height of NanoCanvas area in pixels
Definition: display_base.h:209
uint8_t m_textMode
Flags for current NanoCanvas mode.
Definition: display_base.h:213
NanoFont & getFont()
Definition: display_base.h:142
void loadFixedFont(const uint8_t *progmemFont)
lcdint_t m_cursorX
current X cursor position for text output
Definition: display_base.h:211
EFontStyle
Definition: canvas_types.h:90
void loadSecondaryFont(const uint8_t *progmemUnicode)
void setFreeFont(const uint8_t *progmemFont, const uint8_t *secondaryFont=nullptr)
Definition: display_base.h:197
I & m_intf
communication interface with the display
Definition: display_base.h:218
void loadFreeFont(const uint8_t *progmemFont)
lcduint_t m_p
number of bits, used by width value: 3 equals to 8 pixels width
Definition: display_base.h:210