SSD1306 OLED display driver 1.8.2 This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays

Classes | Macros
NANO_ENGINE: Nano Engine description

Nano Engine description. More...

## Classes
class | AdafruitCanvasOps< BPP >
struct | _NanoPoint
struct | _NanoRect
class | NanoSprite< T, E >
class | NanoEngine1_8

## Macros
#define | NanoEngine1 NanoEngine<TILE_16x16_MONO>
#define | NanoEngine8 NanoEngine<TILE_16x16_RGB8>
#define | NanoEngine16 NanoEngine<TILE_8x8_RGB16>
enum | { CANVAS_MODE_BASIC = 0x00, CANVAS_TEXT_WRAP = 0x01, CANVAS_MODE_TRANSPARENT = 0x02, CANVAS_TEXT_WRAP_LOCAL = 0x04 }
enum | { BLACK = 0x00, WHITE = 0xFF }
typedef uint8_t(* | TNanoEngineGetButtons) (void)
typedef struct _NanoPoint | NanoPoint
typedef struct _NanoRect | NanoRect
SFixedFontInfo | s_fixedFont

## Detailed Description

Nano Engine description.

This group contains API functions for developing Graphics engines.

## Macro Definition Documentation

## ◆ NanoEngine1

#define NanoEngine1 NanoEngine<TILE_16x16_MONO>

NanoEngine1 is simple graphics engine, that implements double buffering work for the systems with very low resources. That is, memory buffer for SSD1306 oled display needs at least 128x64/8 bytes (1024 bytes), and this is inacceptable for microcontrollers like attiny85 (it has only 512B of RAM). So, to workaround issue with low resources, NanoEngine1 uses small tile buffer (NE_TILE_SIZE x NE_TILE_SIZE) and updates only part of oled screen at once. It makes system slow, but it is possible to run NanoEngine1 on simple controllers. If tile size is 32x32, then 128x64 oled display is devided into 8 tiles:
[0,0] [1,0] [2,0], [3,0]
[0,1] [1,1] [2,1], [3,1]
In your application you can choose, if you want to refresh whole screen (refresh()), or you need to refresh only part of oled display.

Warning
  Works only in SSD1306 compatible mode

Definition at line 65 of file nano_engine.h.

## ◆ NanoEngine16

#define NanoEngine16 NanoEngine<TILE_8x8_RGB16>

NanoEngine16 is simple graphics engine, that implements double buffering work for the systems with very low resources. That is, memory buffer for SSD1351 oled display needs at least 128x128x2 bytes (32768 bytes), and this is inacceptable for microcontrollers like atmega328p (it has only 2KiB of RAM). So, to workaround issue with low resources, NanoEngine16 uses small tile buffer (NE_TILE_SIZE x NE_TILE_SIZE) and updates only part of oled screen at once. It makes system slow, but it is possible to run NanoEngine16 on simple controllers. If tile size is 16x16, then 128x128 oled display is devided into 64 tiles:
[0,0] [1,0] [2,0] [3,0] [4,0] [5,0] [6,0] [7,0]
[0,1] [1,1] [2,1] [3,1] [4,1] [5,1] [6,1] [7,1]
etc.
In your application you can choose, if you want to refresh whole screen (refresh()), or you need to refresh only part of oled display.

Definition at line 127 of file nano_engine.h.

## ◆ NanoEngine8

#define NanoEngine8 NanoEngine<TILE_16x16_RGB8>

NanoEngine8 is simple graphics engine, that implements double buffering work for the systems with very low resources. That is, memory buffer for SSD1331 oled display needs at least 96x64x1 bytes (6144 bytes), and this is inacceptable for microcontrollers like atmega328p (it has only 2KiB of RAM). So, to workaround issue with low resources, NanoEngine8 uses small tile buffer (NE_TILE_SIZE x NE_TILE_SIZE) and updates only part of oled screen at once. It makes system slow, but it is possible to run NanoEngine8 on simple controllers. If tile size is 32x32, then 96x64 oled display is devided into 6 tiles:
[0,0] [1,0] [2,0]
[0,1] [1,1] [2,1]
In your application you can choose, if you want to refresh whole screen (refresh()), or you need to refresh only part of oled display.

Definition at line 85 of file nano_engine.h.

## Typedef Documentation

## ◆ NanoPoint

typedef struct _NanoPoint NanoPoint

Describes point

## ◆ NanoRect

typedef struct _NanoRect NanoRect

NanoRect structure describes rectangle area.

## ◆ TNanoEngineGetButtons

typedef uint8_t(* TNanoEngineGetButtons) (void)

Type of user-specified keyboard callback

Definition at line 41 of file core.h.

## Enumeration Type Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
CANVAS_TEXT_WRAP | If the flag is specified, text cursor is moved to new line when end of screen is reached
CANVAS_MODE_TRANSPARENT | This flag make bitmaps transparent (Black color)
CANVAS_TEXT_WRAP_LOCAL | If the flag is specified, text cursor is moved to new line when end of canvas is reached

Definition at line 43 of file canvas.h.

## ◆ anonymous enum

anonymous enum

Enumerator
BLACK | Black color.
WHITE | White color.

Definition at line 368 of file canvas.h.

## Variable Documentation

## ◆ s_fixedFont

SFixedFontInfo s_fixedFont

Structure, holding currently set font.

Warning
  Only for internal use.

Definition at line 44 of file tiler.h.