SSD1306 OLED display driver  1.4.10
This library is developed to control SSD1306/SSD1331 RGB i2c/spi OLED displays and spi PCD8544 LED display
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 "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 typedef void (*InitFunction)(void);
45 
47 typedef enum
48 {
49  STYLE_NORMAL,
50  STYLE_BOLD,
51  STYLE_ITALIC,
52 } EFontStyle;
53 
55 typedef enum
56 {
57  FONT_SIZE_NORMAL = 0,
58  FONT_SIZE_2X = 1,
59  FONT_SIZE_4X = 2,
60  FONT_SIZE_8X = 3,
61 } EFontSize;
62 
64 typedef struct
65 {
66  uint8_t width;
67  uint8_t pages;
68  uint8_t ascii_offset;
69  const uint8_t *data;
71 
75 typedef struct
76 {
78  uint8_t left;
80  uint8_t top;
82  uint8_t right;
84  uint8_t bottom;
85 } SSD1306_RECT;
86 
87 
91 typedef struct SPRITE
92 {
94  uint8_t x;
96  uint8_t y;
98  uint8_t w;
100  uint8_t lx;
102  uint8_t ly;
104  const uint8_t * data;
106  const uint8_t * transparentMask;
107 
108 #ifdef __cplusplus
109 
114  void setPos(uint8_t x, uint8_t y);
115 
120  void draw();
121 
125  void eraseTrace();
126 
130  void erase();
131 
136  inline bool isNearMove() const
137  {
138  /* We emulate abs function for unsigned vars here */
139  return (((uint8_t)(x-lx)<w) || ((uint8_t)(lx-x)<w)) &&
140  (((uint8_t)(y-ly)<8) || ((uint8_t)(ly-y)<8));
141  };
142 
151  inline SSD1306_RECT getRect() const
152  {
153  uint8_t right = ((x + w - 1)>>3);
154  uint8_t bottom = ((y + 7)>>3);
155  uint8_t left = x>>3; left = left < right ? left: 0;
156  uint8_t top = y>>3; top = top < bottom ? top: 0;
157  return (SSD1306_RECT){ left, top, right, bottom };
158  };
159 
167  inline SSD1306_RECT getLRect() const
168  {
169  uint8_t left = lx;
170  uint8_t top = ly;
171  uint8_t right = (uint8_t)(lx + w - 1);
172  uint8_t bottom = (uint8_t)(ly + 7);
173  left = left < right ? left: 0;
174  top = top < bottom ? top: 0;
175  return (SSD1306_RECT){ left, top, right, bottom };
176  };
177 
185  {
186  uint8_t left = min(x,lx);
187  uint8_t top = min(y,ly);
188  uint8_t right = max((uint8_t)(x + w - 1), (uint8_t)(lx + w - 1));
189  if (((uint8_t)(lx + w - 1) < w) && (right > 2*w))
190  {
191  right = (uint8_t)(lx + w - 1);
192  }
193  uint8_t bottom = max((uint8_t)(y + 7), (uint8_t)(ly + 7));
194  if (((uint8_t)(ly + 7) < 8) && (bottom > 16))
195  {
196  bottom = (uint8_t)(ly + 7);
197  }
198  if ( left > right ) left = 0;
199  if ( top > bottom ) top = 0;
200  return (SSD1306_RECT){ left, top, right, bottom };
201  };
202 #endif
203 } SPRITE;
204 
205 // ----------------------------------------------------------------------------
206 #endif // _NANO_GFX_TYPES_H_
struct SPRITE SPRITE
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
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
uint8_t right
right
uint8_t ly
last draw position Y on the screen
SSD1306_RECT getLRect() const
uint8_t left
left