NanoEngine1_8< D > Class Template Reference
NanoEngine1 is simple graphics engine, that implements double buffering work for the systems with very low resources. More...
#include <nano_engine_v2.h>
Inheritance diagram for NanoEngine1_8< D >:
Collaboration diagram for NanoEngine1_8< D >:
Additional Inherited Members | |
 Public Types inherited from NanoEngineTiler< C, D > | |
| typedef NanoEngineTiler< C, D > | TilerT |
| This type is template argument for all Nano Objects. | |
| Public Member Functions inherited from NanoEngine< TILE_16x16_MONO_8, D > | |
| NanoEngine (D &display) | |
| Initializes Nano Engine Base object. | |
| void | display () |
| refreshes content on oled display. More... | |
| void | begin () |
| Initializes internal timestamps, engine state, and switches oled display to required mode (see ssd1306_setMode()). | |
| void | notify (const char *str) |
| shows notification to a user for 1 seconds Shows notification to a user for 1 seconds More... | |
| Public Member Functions inherited from NanoEngineCore | |
| void | setFrameRate (uint8_t fps) |
| Sets working frame-rate for the engine. More... | |
| uint8_t | getFrameRate () |
| Returns current frame rate. | |
| uint8_t | getCpuLoad () |
| Returns cpu load in percents [0-255]. More... | |
| bool | nextFrame () |
| Returns true if it is time to render next frame. | |
| void | loopCallback (TLoopCallback callback) |
| Sets user-defined loop callback. More... | |
| Public Member Functions inherited from NanoEngineTiler< C, D > | |
| void | refresh () |
| Marks all tiles for update. More... | |
| void | refresh (const NanoRect &rect) |
| Mark specified area in pixels for redrawing by NanoEngine. More... | |
| void | refresh (const NanoPoint &point) __attribute__((noinline)) |
| Mark specified area in pixels for redrawing by NanoEngine. More... | |
| void | refresh (lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline)) |
| Mark specified area in pixels for redrawing by NanoEngine. More... | |
| void | refreshWorld (const NanoRect &rect) |
| Marks for refresh lcd area, which corresponds to specified rectangle in global (World) coordinates. More... | |
| void | refreshWorld (lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline)) |
| Marks for refresh lcd area, which corresponds to specified rectangle in global (World) coordinates. More... | |
| void | refreshWorld (const NanoPoint &point) |
| Marks specified pixel area for redrawing by NanoEngine. More... | |
| void | localCoordinates () |
| Switches engine canvas to local coordinates system. More... | |
| void | worldCoordinates () |
| Switches engine canvas to global (World) coordinates system. More... | |
| void | moveTo (const NanoPoint &position) |
| Moves engine coordinate to new position (this sets World coordinates offset). | |
| void | moveToAndRefresh (const NanoPoint &position) |
| Moves engine coordinate to new position and mark whole display for refresh (this sets World coordinates offset). | |
| const NanoPoint & | getPosition () const |
| Returns current World offset. | |
| void | drawCallback (TNanoEngineOnDraw callback) |
| Sets user-defined draw callback. More... | |
| bool | collision (const NanoPoint &p, const NanoRect &rect) |
| Returns true if point is inside the rectangle area. More... | |
| void | insert (NanoEngineObject< TilerT > &object) __attribute__((noinline)) |
| Inserts new NanoEngineObject. More... | |
| void | remove (NanoEngineObject< TilerT > &object) __attribute__((noinline)) |
| Removes NanoEngineObject from the list, but doesn't destroy the object. More... | |
| void | update () __attribute__((noinline)) |
| Updates all objects. More... | |
| C & | getCanvas () |
| Returns canvas, used by the NanoEngine. | |
| D & | getDisplay () |
| Returns reference to display object. | |
| Static Public Member Functions inherited from NanoEngineInputs | |
| static bool | pressed (uint8_t buttons) |
| Returns true if button or specific combination of buttons is pressed. More... | |
| static bool | notPressed (uint8_t buttons) |
| Returns true if button or specific combination of buttons is not pressed. More... | |
| static bool | clicked (uint8_t buttons) |
| Returns true if button was clicked and released. More... | |
| static uint8_t | buttonsState () |
| Returns bits of all pressed buttons. More... | |
| static void | connectCustomKeys (TNanoEngineGetButtons handler) |
| Configures NanoEngine8 to use custom key handler. More... | |
| static void | connectZKeypad (uint8_t analogPin) |
| Enables engine to use Z-Keypad. More... | |
| static void | connectArduboyKeys () |
| Configures NanoEngine8 to use Arduboy keys layout. More... | |
| static void | connectKY40encoder (uint8_t pina_clk, uint8_t pinb_dt, int8_t pinc_sw=-1) |
| Configures NanoEngine to use KY40 Rotary Encoder. More... | |
| static void | connectGpioKeypad (const uint8_t *gpioKeys) |
| Enables engine to use GPIO keys. More... | |
| static void | connectWioKeypad () |
| Connects Wio keys to NanoEngine. More... | |
| Protected Member Functions inherited from NanoEngineCore | |
| void | beginCore () |
| Initializes internal timestamps. | |
| Protected Member Functions inherited from NanoEngineInputs | |
| NanoEngineInputs () | |
| Initializes Nano Engine Inputs object. | |
| Protected Member Functions inherited from NanoEngineTiler< C, D > | |
| NanoEngineTiler (D &display) | |
| Only child classes can initialize the engine. | |
| void | displayBuffer () __attribute__((noinline)) |
| refreshes content on oled display. More... | |
| void | displayPopup (const char *msg) |
| prints popup message over display content prints popup message over display content More... | |
| Static Protected Member Functions inherited from NanoEngineInputs | |
| static void | resetButtonsCache () |
| resets buttons cache. More... | |
| Protected Attributes inherited from NanoEngineCore | |
| uint16_t | m_frameDurationMs = 1000 / ENGINE_DEFAULT_FPS |
| Duration between frames in milliseconds. | |
| uint8_t | m_fps = ENGINE_DEFAULT_FPS |
| Current fps. | |
| uint8_t | m_cpuLoad = 0 |
| Current cpu load in percents. | |
| uint32_t | m_lastFrameTs = 0 |
| Last timestamp in milliseconds the frame was updated on oled display. | |
| TLoopCallback | m_loop = {nullptr} |
| Callback to call before starting oled update. | |
| Protected Attributes inherited from NanoEngineTiler< C, D > | |
| D & | m_display |
| Reference to display object, used by NanoEngine. | |
| TNanoEngineOnDraw | m_onDraw |
| Callback to call if specific tile needs to be updated. | |
| uint16_t | m_refreshFlags [NE_MAX_TILE_ROWS] |
| Contains information on tiles to be updated. More... | |
| Static Protected Attributes inherited from NanoEngineInputs | |
| static TNanoEngineGetButtons | m_onButtons |
| Callback to call if buttons state needs to be updated. | |
| static uint8_t | m_lastButtons |
| State of last pressed buttons. | |
| static uint8_t | m_newButtons |
| State of last pressed buttons. | |
Detailed Description
template<class D>
class NanoEngine1_8< D >
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 RGB 8-bit color mode
Definition at line 116 of file nano_engine_v2.h.
The documentation for this class was generated from the following file:
- src/nano_engine_v2.h
