ESP Emote GFX Documentation

Welcome to the ESP Emote GFX API documentation. This is a lightweight graphics framework for ESP-IDF with support for images, labels, animations, and fonts.

Contents:

• Overview
  • Architecture
  • Core Components
  • Widgets
  • Memory Management
  • Thread Safety
  • Dependencies
  • License
• Quick Start Guide
  • Installation
  • Basic Setup
  • Creating Your First Widget
  • Thread Safety
  • Complete Example
  • Next Steps
• Core API Reference
  • Core Graphics System (gfx_core)
  • Display (gfx_disp)
  • Object (gfx_obj)
  • Timer (gfx_timer)
  • Touch (gfx_touch)
  • Type (gfx_types)
  • Core Modules
• Widget API Reference
  • Animation (gfx_anim)
  • LVGL Font Compatibility (gfx_font_lvgl)
  • Image (gfx_img)
  • Label (gfx_label)
  • QR Code (gfx_qrcode)
  • Widget Modules
• Examples
  • Initialization (core + display + optional touch)
  • Basic Examples
  • Advanced Examples
  • Complete Application Example
• Changelog
  • [3.0.0] - 2026-01-22
  • [2.1.0] - 2026-01-28
  • [2.0.4] - 2026-01-22
  • [2.0.3] - 2026-01-08
  • [2.0.2] - 2025-12-26
  • [2.0.1] - 2025-12-05
  • [2.0.0] - 2025-12-01
  • [1.2.0] - 2025-09-0
  • [1.1.2] - 2025-09-29
  • [1.1.1] - 2025-09-23
  • [1.0.0] - 2025-08-01

Overview

ESP Emote GFX is a graphics framework designed for embedded systems, providing:

• Images: Display images in RGB565A8 format with alpha transparency

• Animations: GIF animations with ESP32 tools (EAF format)

• Fonts: LVGL fonts and FreeType TTF/OTF support

• Timers: Built-in timing system for smooth animations

• Memory Optimized: Designed for embedded systems with limited resources

Features

• Lightweight and memory-efficient

• Thread-safe operations with mutex locking

• Support for multiple object types (images, labels, animations, QR codes)

• Flexible buffer management (internal or external buffers)

• Rich text rendering with scrolling and wrapping

• Animation playback control with segments and loops

Quick Links

• Quick Start Guide

• Core API Reference

• Widget API Reference

• Examples

• Doxygen API Reference - Auto-generated C/C++ API documentation

Indices and tables

• Index

• Module Index

• Search Page