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 #ifdef __cplusplus
43 extern "C"
44 {
45 #endif
46 extern uint8_t s_ssd1306_invertByte;
47 #ifdef __cplusplus
48 }
49 #endif
50 
55 template <class I>
57 {
58 public:
64  NanoDisplayBase(I& intf): m_intf( intf ) {}
65 
71  void setOffset(lcdint_t ox, lcdint_t oy) { };
72 
77  const NanoPoint offsetEnd() const
78  {
79  return (NanoPoint){ (lcdint_t)(m_w-1), (lcdint_t)(m_h-1) };
80  }
81 
86  const NanoRect rect() const
87  {
88  return { (NanoPoint){0,0}, offsetEnd() };
89  }
90 
94  lcduint_t width() { return m_w; }
95 
99  lcduint_t height() { return m_h; }
100 
105  {
106  lcduint_t t = m_w;
107  m_w = m_h;
108  m_h = t;
109  }
110 
115  void setColor(uint16_t color) { m_color = color; };
116 
121  void negativeMode() { s_ssd1306_invertByte = 0xFF; }
122 
127  void positiveMode() { s_ssd1306_invertByte = 0x00; }
128 
134  I& getInterface() { return m_intf; }
135 
144  void setFont( NanoFont &font ) { m_font = &font; }
145 
149  NanoFont &getFont() { return *m_font; }
150 
160  void setFixedFont( const uint8_t *progmemFont )
161  {
162  g_canvas_font.loadFixedFont( progmemFont );
163  setFont( g_canvas_font );
164  }
165 
166 #ifndef DOXYGEN_SHOULD_SKIP_THIS
167  void setFixedFont_oldStyle( const uint8_t *progmemFont )
168  {
169  g_canvas_font.loadFixedFont_oldStyle( progmemFont );
170  setFont( g_canvas_font );
171  }
172 #endif
173 
184  void setFixedFont( const uint8_t *progmemFont, const uint8_t *secondaryFont )
185  {
186  g_canvas_font.loadFixedFont( progmemFont );
187  if ( secondaryFont )
188  {
189  g_canvas_font.loadSecondaryFont( secondaryFont );
190  }
191  setFont( g_canvas_font );
192  }
193 
204  void setFreeFont( const uint8_t *progmemFont, const uint8_t *secondaryFont = nullptr )
205  {
206  g_canvas_font.loadFreeFont( progmemFont );
207  if ( secondaryFont )
208  {
209  g_canvas_font.loadSecondaryFont( secondaryFont );
210  }
211  setFont( g_canvas_font );
212  }
213 
214 protected:
220  uint8_t m_textMode = 0;
222  uint16_t m_color = 0xFFFF;
223  NanoFont *m_font = nullptr;
224 
225  I& m_intf;
226 };
227 
232 #endif
233 
EFontStyle m_fontStyle
currently active font style
Definition: display_base.h:221
lcdint_t m_cursorY
current Y cursor position for text output
Definition: display_base.h:219
uint8_t lcduint_t
Definition: canvas_types.h:81
struct _NanoPoint NanoPoint
Definition: rect.h:42
const NanoPoint offsetEnd() const
Definition: display_base.h:77
void swapDimensions()
Definition: display_base.h:104
void setOffset(lcdint_t ox, lcdint_t oy)
Definition: display_base.h:71
NanoFont * m_font
currently set font
Definition: display_base.h:223
lcduint_t m_w
width of NanoCanvas area in pixels
Definition: display_base.h:215
lcduint_t width()
Definition: display_base.h:94
int8_t lcdint_t
Definition: canvas_types.h:79
lcduint_t height()
Definition: display_base.h:99
void setFixedFont(const uint8_t *progmemFont, const uint8_t *secondaryFont)
Definition: display_base.h:184
void setFont(NanoFont &font)
Definition: display_base.h:144
void setColor(uint16_t color)
Definition: display_base.h:115
uint16_t m_color
current color for monochrome operations
Definition: display_base.h:222
Definition: font.h:45
void setFixedFont(const uint8_t *progmemFont)
Definition: display_base.h:160
NanoDisplayBase(I &intf)
Definition: display_base.h:64
const NanoRect rect() const
Definition: display_base.h:86
lcduint_t m_h
height of NanoCanvas area in pixels
Definition: display_base.h:216
uint8_t m_textMode
Flags for current NanoCanvas mode.
Definition: display_base.h:220
NanoFont & getFont()
Definition: display_base.h:149
void loadFixedFont(const uint8_t *progmemFont)
lcdint_t m_cursorX
current X cursor position for text output
Definition: display_base.h:218
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:204
I & m_intf
communication interface with the display
Definition: display_base.h:225
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:217