SSD1306 OLED display driver  1.7.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-2018, 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 typedef void (*InitFunction)(void);
56 
58 typedef enum
59 {
60  STYLE_NORMAL,
61  STYLE_BOLD,
62  STYLE_ITALIC,
63 } EFontStyle;
64 
66 typedef enum
67 {
68  FONT_SIZE_NORMAL = 0,
69  FONT_SIZE_2X = 1,
70  FONT_SIZE_4X = 2,
71  FONT_SIZE_8X = 3,
72 } EFontSize;
73 
75 typedef struct
76 {
77  uint8_t width;
78  uint8_t height;
79  uint8_t pages;
80  uint8_t ascii_offset;
81  const uint8_t *data;
83 
85 typedef struct
86 {
87  uint8_t width;
88  uint8_t height;
89  const uint8_t *data;
90 } SCharInfo;
91 
95 typedef struct
96 {
98  uint8_t left;
100  uint8_t top;
102  uint8_t right;
104  uint8_t bottom;
105 } SSD1306_RECT;
106 
107 
112 typedef struct SPRITE
113 {
115  uint8_t x;
117  uint8_t y;
119  uint8_t w;
121  uint8_t lx;
123  uint8_t ly;
125  const uint8_t * data;
127  const uint8_t * transparentMask;
128 
129 #ifdef __cplusplus
130 
135  void setPos(uint8_t x, uint8_t y);
136 
141  void draw();
142 
146  void eraseTrace();
147 
151  void erase();
152 
157  inline bool isNearMove() const
158  {
159  /* We emulate abs function for unsigned vars here */
160  return (((uint8_t)(x-lx)<w) || ((uint8_t)(lx-x)<w)) &&
161  (((uint8_t)(y-ly)<8) || ((uint8_t)(ly-y)<8));
162  };
163 
172  inline SSD1306_RECT getRect() const
173  {
174  uint8_t right = ((x + w - 1)>>3);
175  uint8_t bottom = ((y + 7)>>3);
176  uint8_t left = x>>3; left = left < right ? left: 0;
177  uint8_t top = y>>3; top = top < bottom ? top: 0;
178  return (SSD1306_RECT){ left, top, right, bottom };
179  };
180 
188  inline SSD1306_RECT getLRect() const
189  {
190  uint8_t left = lx;
191  uint8_t top = ly;
192  uint8_t right = (uint8_t)(lx + w - 1);
193  uint8_t bottom = (uint8_t)(ly + 7);
194  left = left < right ? left: 0;
195  top = top < bottom ? top: 0;
196  return (SSD1306_RECT){ left, top, right, bottom };
197  };
198 
206  {
207  uint8_t left = min(x,lx);
208  uint8_t top = min(y,ly);
209  uint8_t right = max((uint8_t)(x + w - 1), (uint8_t)(lx + w - 1));
210  if (((uint8_t)(lx + w - 1) < w) && (right > 2*w))
211  {
212  right = (uint8_t)(lx + w - 1);
213  }
214  uint8_t bottom = max((uint8_t)(y + 7), (uint8_t)(ly + 7));
215  if (((uint8_t)(ly + 7) < 8) && (bottom > 16))
216  {
217  bottom = (uint8_t)(ly + 7);
218  }
219  if ( left > right ) left = 0;
220  if ( top > bottom ) top = 0;
221  return (SSD1306_RECT){ left, top, right, bottom };
222  };
223 #endif
224 } SPRITE;
225 
226 // ----------------------------------------------------------------------------
227 #endif // _NANO_GFX_TYPES_H_
const uint8_t * data
char data, located in progmem.
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 * transparentMask
Pointer to PROGMEM data, representing sprite transparencyMask (can be nullptr)
void eraseTrace()
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 width
char width in pixels
uint8_t width
width in pixels
SSD1306_RECT getUpdateRect() const
uint8_t x
draw position X on the screen
uint8_t w
sprite width
SSD1306_RECT getRect() const
uint8_t lx
last draw position X on the screen
const uint8_t * data
font chars bits
EFontStyle
bool isNearMove() const
EFontSize
uint8_t pages
height in pages (each page height is 8-pixels)
uint8_t right
right
uint8_t ly
last draw position Y on the screen
SSD1306_RECT getLRect() const
uint8_t height
height in pixels
uint8_t left
left