SSD1306 OLED display driver  1.8.2
This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
nano_gfx_types.h
Go to the documentation of this file.
1 /*
2  MIT License
3 
4  Copyright (c) 2017-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 _NANO_GFX_TYPES_H_
29 #define _NANO_GFX_TYPES_H_
30 
31 #include "ssd1306_hal/io.h"
32 
33 #ifndef min
34 
35 #define min(a,b) ((a)<(b)?(a):(b))
36 #endif
37 
38 #ifndef max
39 
40 #define max(a,b) ((a)>(b)?(a):(b))
41 #endif
42 
44 #define RGB_COLOR8(r,g,b) ( (r & 0xE0) | ((g >> 3)&0x1C) | (b>>6) )
45 
47 #define RGB_COLOR16(r,g,b) ( ((r<<8) & 0xF800) | ((g << 3)&0x07E0) | (b>>3) )
48 
50 #define RGB8_TO_RGB16(c) ( (((uint16_t)c & 0b11100000) << 8) | \
51  (((uint16_t)c & 0b00011100) << 6) | \
52  (((uint16_t)c & 0b00000011) << 3) )
53 
55 #define RGB8_TO_GRAY4(rgb) ( (rgb >> 6) + ((rgb >> 2) & 0x07) + (rgb & 0x03) )
56 
58 #define GRAY_COLOR4(gray) ( ((gray >> 4) & 0x0F) | (gray & 0xF0) )
59 
61 #define RGB16_TO_RGB8(c) ( ((uint16_t)(c >> 8) & 0b11100000) | \
62  ((uint16_t)(c >> 6) & 0b00011100) | \
63  ((uint16_t)(c >> 3) & 0b00000011) )
64 
66 typedef void (*InitFunction)(void);
67 
69 typedef enum
70 {
71  STYLE_NORMAL,
72  STYLE_BOLD,
73  STYLE_ITALIC,
74 } EFontStyle;
75 
77 typedef enum
78 {
79  FONT_SIZE_NORMAL = 0,
80  FONT_SIZE_2X = 1,
81  FONT_SIZE_4X = 2,
82  FONT_SIZE_8X = 3,
83 } EFontSize;
84 
85 #pragma pack(push, 1)
86 
87 typedef struct
88 {
89  uint8_t type;
90  uint8_t width;
91  uint8_t height;
92  uint8_t ascii_offset;
94 
96 typedef struct
97 {
98  uint16_t start_code;
99  uint8_t count;
101 
102 #pragma pack(pop)
103 
105 typedef struct
106 {
108  uint8_t count;
109  uint8_t pages;
110  uint8_t glyph_size;
111  const uint8_t *primary_table;
112 #ifdef CONFIG_SSD1306_UNICODE_ENABLE
113  const uint8_t *secondary_table;
114 #endif
116 
118 typedef struct
119 {
120  uint8_t width;
121  uint8_t height;
122  uint8_t spacing;
123  const uint8_t *glyph;
124 } SCharInfo;
125 
129 typedef struct
130 {
132  uint8_t left;
134  uint8_t top;
136  uint8_t right;
138  uint8_t bottom;
139 } SSD1306_RECT;
140 
141 
146 typedef struct SPRITE
147 {
149  uint8_t x;
151  uint8_t y;
153  uint8_t w;
155  uint8_t lx;
157  uint8_t ly;
159  const uint8_t * data;
161  const uint8_t * transparentMask;
162 
163 #ifdef __cplusplus
164 
169  void setPos(uint8_t x, uint8_t y);
170 
175  void draw();
176 
180  void eraseTrace();
181 
185  void erase();
186 
191  inline bool isNearMove() const
192  {
193  /* We emulate abs function for unsigned vars here */
194  return (((uint8_t)(x-lx)<w) || ((uint8_t)(lx-x)<w)) &&
195  (((uint8_t)(y-ly)<8) || ((uint8_t)(ly-y)<8));
196  };
197 
206  inline SSD1306_RECT getRect() const
207  {
208  uint8_t right = ((x + w - 1)>>3);
209  uint8_t bottom = ((y + 7)>>3);
210  uint8_t left = x>>3; left = left < right ? left: 0;
211  uint8_t top = y>>3; top = top < bottom ? top: 0;
212  return (SSD1306_RECT){ left, top, right, bottom };
213  };
214 
222  inline SSD1306_RECT getLRect() const
223  {
224  uint8_t left = lx;
225  uint8_t top = ly;
226  uint8_t right = (uint8_t)(lx + w - 1);
227  uint8_t bottom = (uint8_t)(ly + 7);
228  left = left < right ? left: 0;
229  top = top < bottom ? top: 0;
230  return (SSD1306_RECT){ left, top, right, bottom };
231  };
232 
240  {
241  uint8_t left = min(x,lx);
242  uint8_t top = min(y,ly);
243  uint8_t right = max((uint8_t)(x + w - 1), (uint8_t)(lx + w - 1));
244  if (((uint8_t)(lx + w - 1) < w) && (right > 2*w))
245  {
246  right = (uint8_t)(lx + w - 1);
247  }
248  uint8_t bottom = max((uint8_t)(y + 7), (uint8_t)(ly + 7));
249  if (((uint8_t)(ly + 7) < 8) && (bottom > 16))
250  {
251  bottom = (uint8_t)(ly + 7);
252  }
253  if ( left > right ) left = 0;
254  if ( top > bottom ) top = 0;
255  return (SSD1306_RECT){ left, top, right, bottom };
256  };
257 #endif
258 } SPRITE;
259 
260 // ----------------------------------------------------------------------------
261 #endif // _NANO_GFX_TYPES_H_
struct SPRITE SPRITE
uint8_t height
char height in pixels
uint8_t top
top
const uint8_t * data
Pointer to PROGMEM data, representing sprite image.
const uint8_t * primary_table
font chars bits
uint16_t start_code
unicode start code
uint8_t width
width in pixels
const uint8_t * transparentMask
Pointer to PROGMEM data, representing sprite transparencyMask (can be nullptr)
void eraseTrace()
uint8_t type
font type: 0 - Fixed Font
uint8_t height
height in pixels
void erase()
uint8_t ascii_offset
ascii offset
void(* InitFunction)(void)
void draw()
void setPos(uint8_t x, uint8_t y)
uint8_t bottom
bottom
#define max(a, b)
uint8_t y
draw position Y on the screen
#define min(a, b)
uint8_t count
count of unicode chars in block
uint8_t width
char width in pixels
const uint8_t * secondary_table
font chars bits
SSD1306_RECT getUpdateRect() const
SFontHeaderRecord h
record, containing information on font
uint8_t x
draw position X on the screen
const uint8_t * glyph
char data, located in progmem.
uint8_t w
sprite width
SSD1306_RECT getRect() const
uint8_t spacing
additional spaces after char in pixels
uint8_t lx
last draw position X on the screen
EFontStyle
bool isNearMove() const
EFontSize
uint8_t glyph_size
glyph size in bytes
uint8_t pages
height in pages (each page height is 8-pixels)
uint8_t right
right
uint8_t count
count of characters
uint8_t ly
last draw position Y on the screen
SSD1306_RECT getLRect() const
uint8_t left
left