LVGL

LVGL Documentation 8.
LVGL community
Jan 10, 2022

CONTENTS
1 Introduction 2
1.1 Key features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4 Repository layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.5 Release policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.6 FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Get started 7
2.1 Quick overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Simulator on PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 STM32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.4 NXP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.5 Espressif (ESP32) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.6 Arduino . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.7 Micropython . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.8 NuttX RTOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3 Porting 29
3.1 Set-up a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.2 Display interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.3 Input device interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.4 Tick interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.5 Task Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.6 Sleep management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.7 Operating system and interrupts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
3.8 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4 Overview 53
4.1 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.2 Positions, sizes, and layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
4.3 Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4.4 Style properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
4.5 Scroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
4.6 Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
4.7 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
4.8 Input devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
4.9 Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
4.10 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
4.11 Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
i
4.12 Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
4.13 File system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
4.14 Animations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
4.15 Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
4.16 Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
4.17 New widget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5 Widgets 206
5.1 Base object (lv_obj) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
5.2 Core widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
5.3 Extra widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
6 Layouts 409
6.1 Flex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
6.2 Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
7 Contributing 431
7.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
7.2 Pull request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
7.3 Developer Certification of Origin (DCO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
7.4 Ways to contribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
8 Changelog 438
8.1 v8.0.2 (16.07.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
8.2 v8.0.1 (14.06.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
8.3 v8.0.0 (01.06.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
8.4 v7.11.0 (16.03.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
8.5 v7.10.1 (16.02.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
8.6 v7.10.0 (02.02.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
8.7 v7.9.1 (19.01.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
8.8 v7.9.0 (05.01.2021) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
8.9 v7.8.1 (15.12.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
8.10 v7.8.0 (01.12.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
8.11 v7.7.2 (17.11.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
8.12 v7.7.1 (03.11.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
8.13 v7.7.0 (20.10.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
8.14 v7.6.1 (06.10.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
8.15 v7.6.0 (22.09.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
8.16 v7.5.0 (15.09.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
8.17 v7.4.0 (01.09.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
8.18 v7.3.1 (18.08.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
8.19 v7.3.0 (04.08.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
8.20 v7.2.0 (21.07.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
8.21 v7.1.0 (07.07.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
8.22 v7.0.2 (16.06.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
8.23 v7.0.1 (01.06.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
8.24 v7.0.0 (18.05.2020) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
9 Roadmap 457
9.1 v8.X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
9.2 Ideas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
9.3 v8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Index 459
ii
LVGL Documentation 8.0
PDF version: LVGL.pdf
CONTENTS 1
CHAPTER
ONE
INTRODUCTION
LVGL (Light and Versatile Graphics Library) is a free and open-source graphics library providing everything you need
to create embedded GUI with easy-to-use graphical elements, beautiful visual effects and a low memory footprint.
1.1 Key features
• Powerful building blocks such as buttons, charts, lists, sliders, images, etc.
• Advanced graphics with animations, anti-aliasing, opacity, smooth scrolling
• Various input devices such as touchpad, mouse, keyboard, encoder, etc.
• Multi-language support with UTF-8 encoding
• Multi-display support, i.e. use multiple TFT, monochrome displays simultaneously
• Fully customizable graphic elements with CSS-like styles
• Hardware independent: use with any microcontroller or display
• Scalable: able to operate with little memory (64 kB Flash, 16 kB RAM)
• OS, external memory and GPU supported but not required
• Single frame buffer operation even with advanced graphic effects
• Written in C for maximal compatibility (C++ compatible)
• Simulator to start embedded GUI design on a PC without embedded hardware
• Binding to MicroPython
• Tutorials, examples, themes for rapid GUI design
• Documentation is available online and PDF
• Free and open-source under MIT license
2
1.2 Requirements
Basically, every modern controller (which is able to drive a display) is suitable to run LVGL. The minimal requirements
are:
1.3 License
The LVGL project (including all repositories) is licensed under MIT license. It means you can use it even in commercial
projects.
It's not mandatory but we highly appreciate it if you write a few words about your project in the My projects category of
the forum or a private message to lvgl.io.
Although you can get LVGL for free there is a massive amount of work behind it. It's created by a group of volunteers
who made it available for you in their free time.
To make the LVGL project sustainable, please consider contributing to the project. You can choose from many different
ways of contributing such as simply writing a tweet about you are using LVGL, fixing bugs, translating the documentation,
or even becoming a maintainer.
1.4 Repository layout
All repositories of the LVGL project are hosted on GitHub: https://github.com/lvgl

You will find these repositories there:
• lvgl The library itself with many examples.
• lv_demos Demos created with LVGL.
• lv_drivers Display and input device drivers
• blog Source of the blog's site (https://blog.lvgl.io)
• sim Source of the online simulator's site (https://sim.lvgl.io)
• lv_sim_... Simulator projects for various IDEs and platforms
• lv_port_... LVGL ports to development boards
• lv_binding_.. Bindings to other languages
• lv_... Ports to other platforms
1.5 Release policy
The core repositories follow the rules of Semantic versioning:

• Major versions for incompatible API changes. E.g. v5.0.0, v6.0.0
• Minor version for new but backward-compatible functionalities. E.g. v6.1.0, v6.2.0
• Patch version for backward-compatible bug fixes. E.g. v6.1.1, v6.1.2
Tags like vX.Y.Z are created for every release.
1.2. Requirements 3
1.5.1 Release cycle
• Bugfixes: Released on demand even weekly

• Minor releases: Every 3-4 months
• Major releases: Approximatelly yearly
1.5.2 Branches
The core repositories have at least the following branches:

• master latest version, patches are merged directly here.
• release/vX.Y stable versions of the minor releases
• fix/some-description temporal branches for bug fixes
• feat/some-description temporal branches for features
1.5.3 Changelog
The changes are recorded in CHANGELOG.md.
1.5.4 Version support
Before v8 every minor release of major releases is supported for 1 year. From v8 every minor release is supported for 1
year.
1.6 FAQ
1.6.1 Where can I ask questions?
You can ask questions in the forum: https://forum.lvgl.io/.

We use GitHub issues for development related discussion. So you should use them only if your question or issue is tightly
related to the development of the library.
1.6.2 Is my MCU/hardware supported?
Every MCU which is capable of driving a display via Parallel port, SPI, RGB interface or anything else and fulfills the
Requirements is supported by LLVGL.
This includes:
• "Common" MCUs like STM32F, STM32H, NXP Kinetis, LPC, iMX, dsPIC33, PIC32 etc.
• Bluetooth, GSM, WiFi modules like Nordic NRF and Espressif ESP32
• Linux with frame buffer device such as /dev/fb0. This includes Single-board computers like the Raspberry Pi
• And anything else with a strong enough MCU and a periphery to drive a display
1.6. FAQ 4
1.6.3 Is my display supported?
LVGL needs just one simple driver function to copy an array of pixels into a given area of the display. If you can do this
with your display then you can use that display with LVGL.
Some examples of the supported display types:
• TFTs with 16 or 24 bit color depth
• Monitors with HDMI port
• Small monochrome displays
• Gray-scale displays
• even LED matrices
• or any other display where you can control the color/state of the pixels
See the Porting section to learn more.
1.6.4 Nothing happens, my display driver is not called. What have I missed?
Be sure you are calling lv_tick_inc(x) in an interrupt and lv_timer_handler() in your main while(1).
Learn more in the Tick and Task handler section.
1.6.5 Why is the display driver called only once? Only the upper part of the display
is refreshed.
Be sure you are calling lv_disp_flush_ready(drv) at the end of your "display flush callback".
1.6.6 Why do I see only garbage on the screen?
Probably there a bug in your display driver. Try the following code without using LVGL. You should see a square with
red-blue gradient.
#define BUF_W 20
#define BUF_H 10
lv_color_t buf[BUF_W * BUF_H];

lv_color_t * buf_p = buf;
uint16_t x, y;
for(y = 0; y < BUF_H; y++) {
lv_color_t c = lv_color_mix(LV_COLOR_BLUE, LV_COLOR_RED, (y * 255) / BUF_H);
for(x = 0; x < BUF_W; x++){
(*buf_p) = c;
buf_p++;
}
}
lv_area_t a;
a.x1 = 10;
a.y1 = 40;
a.x2 = a.x1 + BUF_W - 1;
a.y2 = a.y1 + BUF_H - 1;
my_flush_cb(NULL, &a, buf);
1.6. FAQ 5
1.6.7 Why I see nonsense colors on the screen?
Probably LVGL's color format is not compatible with your displays color format. Check LV_COLOR_DEPTH in
lv_conf.h.
If you are using 16 bit colors with SPI (or other byte-oriented interface) probably you need to set LV_COLOR_16_SWAP
1 in lv_conf.h. It swaps the upper and lower bytes of the pixels.
1.6.8 How to speed up my UI?
• Turn on compiler optimization and enable cache if your MCU has

• Increase the size of the display buffer
• Use 2 display buffers and flush the buffer with DMA (or similar periphery) in the background
• Increase the clock speed of the SPI or Parallel port if you use them to drive the display
• If your display has SPI port consider changing to a model with parallel because it has much higher throughput
• Keep the display buffer in the internal RAM (not in external SRAM) because LVGL uses it a lot and it should have
a small access time
1.6.9 How to reduce flash/ROM usage?
You can disable all the unused features (such as animations, file system, GPU etc.) and object types in lv_conf.h.
If you are using GCC you can add
• -fdata-sections -ffunction-sections compiler flags
• --gc-sections linker flag
to remove unused functions and variables from the final binary
1.6.10 How to reduce the RAM usage
• Lower the size of the Display buffer

• Reduce LV_MEM_SIZE in lv_conf.h. This memory used when you create objects like buttons, labels, etc.
• To work with lower LV_MEM_SIZE you can create the objects only when required and deleted them when they
are not required anymore
1.6.11 How to work with an operating system?
To work with an operating system where tasks can interrupt each other (preemptive) you should protect LVGL related
function calls with a mutex. See the Operating system and interrupts section to learn more.
1.6. FAQ 6
CHAPTER
TWO
GET STARTED
There are several ways to get your feet wet with LVGL. Here is one recommended order of documents to read and things
to play with when you are learning to use LVGL:
1. Check the Online demos to see LVGL in action (3 minutes)
2. Read the Introduction page of the documentation (5 minutes)
3. Read the Quick overview page of the documentation (15 minutes)
4. Set up a Simulator (10 minutes)
5. Try out some Examples
6. Port LVGL to a board. See the Porting guide or check the ready to use Projects
7. Read the Overview page to get a better understanding of the library. (2-3 hours)
8. Check the documentation of the Widgets to see their features and usage
9. If you have questions got to the Forum
10. Read the Contributing guide to see how you can help to improve LVGL (15 minutes)
2.1 Quick overview
Here you can learn the most important things about LVGL. You should read this first to get a general impression and read
the detailed Porting and Overview sections after that.
2.1.1 Get started in a simulator
Instead of porting LVGL to embedded hardware straight away, it's highly recommended to get started in a simulator first.
LVGL is ported to many IDEs to be sure you will find your favorite one. Go to the Simulators section to get ready-to-use
projects that can be run on your PC. This way you can save the time of porting for now and get some experience with
LVGL immediately.
7
2.1.2 Add LVGL into your project
If you would rather try LVGL on your own project follow these steps:
• Download or clone the library from GitHub with git clone https://github.com/lvgl/lvgl.git.
• Copy the lvgl folder into your project.
• Copy lvgl/lv_conf_template.h as lv_conf.h next to the lvgl folder, change the first #if 0 to 1
to enable the file's content and set the LV_COLOR_DEPTH defines.
• Include lvgl/lvgl.h in files where you need to use LVGL related functions.
• Call lv_tick_inc(x) every x milliseconds in a Timer or Task (x should be between 1 and 10). It is required
for the internal timing of LVGL. Alternatively, configure LV_TICK_CUSTOM (see lv_conf.h) so that LVGL
can retrieve the current time directly.
• Call lv_init()
• Create a draw buffer: LVGL will render the graphics here first, and send the rendered image to the display. The
buffer size can be set freely but 1/10 screen size is a good starting point.
static lv_disp_draw_buf_t draw_buf;
static lv_color_t buf1[DISP_HOR_RES * DISP_VER_RES / 10]; /
,→*Declare a buffer for 1/10 screen size*/
lv_disp_draw_buf_init(&draw_buf, buf1, NULL, MY_DISP_HOR_RES * MY_DISP_VER_SER / 10);␣

,→ /*Initialize the display buffer.*/
• Implement and register a function which can copy the rendered image to an area of your display:
static lv_disp_drv_t disp_drv; /*Descriptor of a display driver*/
lv_disp_drv_init(&disp_drv); /*Basic initialization*/
disp_drv.flush_cb = my_disp_flush; /*Set your driver function*/
disp_drv.buffer = &draw_buf; /*Assign the buffer to the display*/
disp_drv.hor_res = MY_DISP_HOR_RES; /*Set the horizontal resolution of the display*/
disp_drv.ver_res = MY_DISP_VER_RES; /*Set the vertical resolution of the display*/
lv_disp_drv_register(&disp_drv); /*Finally register the driver*/
void my_disp_flush(lv_disp_drv_t * disp, const lv_area_t * area, lv_color_t * color_p)

{
int32_t x, y;
/*It's a very slow but simple implementation.
*`set_pixel` needs to be written by you to a set pixel on the screen*/
for(y = area->y1; y <= area->y2; y++) {
for(x = area->x1; x <= area->x2; x++) {
set_pixel(x, y, *color_p);
color_p++;
}
}
lv_disp_flush_ready(disp); /* Indicate you are ready with the flushing*/

}
• Implement and register a function which can read an input device. E.g. for a touch pad:
static lv_indev_drv_t indev_drv; /*Descriptor of a input device driver*/
lv_indev_drv_init(&indev_drv); /*Basic initialization*/
indev_drv.type = LV_INDEV_TYPE_POINTER; /*Touch pad is a pointer-like device*/
indev_drv.read_cb = my_touchpad_read; /*Set your driver function*/
lv_indev_drv_register(&indev_drv); /*Finally register the driver*/
(continues on next page)
2.1. Quick overview 8

(continued from previous page)
void my_touchpad_read(lv_indev_t * indev, lv_indev_data_t * data)

{
/*`touchpad_is_pressed` and `touchpad_get_xy` needs to be implemented by you*/
if(touchpad_is_pressed()) {
data->state = LV_INDEV_STATE_PRESSED;
touchpad_get_xy(&data->point.x, &data->point.y);
} else {
data->state = LV_INDEV_STATE_RELEASED;
}
• Call lv_timer_handler() periodically every few milliseconds in the main while(1) loop or in an oper-
ating system task. It will redraw the screen if required, handle input devices, animation etc.
For a more detailed guide go to the Porting section.
2.1.3 Learn the basics
Widgets
The graphical elements like Buttons, Labels, Sliders, Charts etc. are called objects or widgets. Go to Widgets to see the
full list of available widgets.
Every object has a parent object where it is created. For example if a label is created on a button, the button is the parent
of label.
The child object moves with the parent and if the parent is deleted the children will be deleted too.
Children can be visible only on their parent. It other words, the parts of the children outside of the parent are clipped.
A Screen is the "root" parent. You can have any number of screens.
To get the current screen call lv_scr_act(), and to load a screen use lv_scr_load(scr1).
You can create a new object with lv_<type>_create(parent). It will return an lv_obj_t * variable that can
be used as a reference to the object to set its parameters.
For example:
lv_obj_t * slider1 = lv_slider_create(lv_scr_act());
To set some basic attributes lv_obj_set_<parameter_name>(obj, <value>) functions can be used. For
example:
lv_obj_set_x(btn1, 30);
lv_obj_set_y(btn1, 10);
lv_obj_set_size(btn1, 200, 50);
The widgets have type specific parameters too which can be set by lv_<widget_type>_set_<parameter_name>(obj,
<value>) functions. For example:
lv_slider_set_value(slider1, 70, LV_ANIM_ON);
To see the full API visit the documentation of the widgets or the related header file (e.g. lvgl/src/widgets/lv_slider.h).

Events
Events are used to inform the user that something has happened with an object. You can assign one or more callbacks to
an object which will be called if the object is clicked, released, dragged, being deleted etc.
A callback is assigned like this:
lv_obj_add_event_cb(btn, btn_event_cb, LV_EVENT_CLICKED, NULL); /*Assign a callback␣

,→to the button*/
...
void btn_event_cb(lv_event_t * e)
{
printf("Clicked\n");
}
Instead of LV_EVENT_CLICKED LV_EVENT_ALL can be used too to call the callback for any event.
From lv_event_t * e the current event code can be get with
lv_event_code_t code = lv_event_get_code(e);
The object that triggered the event can be retrieved with
lv_obj_t * obj = lv_event_get_target(e);
To learn all features of the events go to the Event overview section.
Parts
Widgets might be built from one or more parts. For example a button has only one part called LV_PART_MAIN. However,
a Slider has LV_PART_MAIN, LV_PART_INDICATOR and LV_PART_KNOB.
By using parts you can apply different styles to different parts. (See below)
To learn which parts are used by which object read the widgets' documentation.
States
The objects can be in a combination of the following states:

• LV_STATE_DEFAULT Normal, released state
• LV_STATE_CHECKED Toggled or checked state
• LV_STATE_FOCUSED Focused via keypad or encoder or clicked via touchpad/mouse
• LV_STATE_FOCUS_KEY Focused via keypad or encoder but not via touchpad/mouse
• LV_STATE_EDITED Edit by an encoder
• LV_STATE_HOVERED Hovered by mouse (not supported now)
• LV_STATE_PRESSED Being pressed
• LV_STATE_SCROLLED Being scrolled
• LV_STATE_DISABLED Disabled

For example, if you press an object it will automatically go to LV_STATE_FOCUSED and LV_STATE_PRESSED state
and when you release it, the LV_STATE_PRESSED state will be removed.
To check if an object is in a given state use lv_obj_has_state(obj, LV_STATE_...). It will return true if
the object is in that state at that time.
To manually add or remove states use
lv_obj_add_state(obj, LV_STATE_...);
lv_obj_clear_state(obj, LV_STATE_...);
Styles
Styles contains properties such as background color, border width, font, etc to describe the appearance of the objects.
The styles are lv_style_t variables. Only their pointer is saved in the objects so they need to be static or global.
Before using a style it needs to be initialized with lv_style_init(&style1). After that properties can be added.
For example:
static lv_style_t style1;

lv_style_init(&style1);
lv_style_set_bg_color(&style1, lv_color_hex(0xa03080))
lv_style_set_border_width(&style1, 2))
See the full list of properties here.

The styles are assigned to an object's part and state. For example to "Use this style on the slider's indicator when the slider
is pressed":
lv_obj_add_style(slider1, &style1, LV_PART_INDICATOR | LV_STATE_PRESSED);
If the part is LV_PART_MAIN it can be omitted:
lv_obj_add_style(btn1, &style1, LV_STATE_PRESSED); /*Equal to LV_PART_MAIN | LV_STATE_

,→PRESSED*/
Similarly, LV_STATE_DEFAULT can be omitted too:
lv_obj_add_style(slider1, &style1, LV_PART_INDICATOR); /*Equal to LV_PART_INDICATOR |␣

,→LV_STATE_DEFAULT*/
For LV_STATE_DEFAULT and LV_PART_MAIN simply write 0:
lv_obj_add_style(btn1, &style1, 0); /*Equal to LV_PART_MAIN | LV_STATE_DEFAULT*/
The styles can be cascaded (similarly to CSS). It means you can add more styles to a part of an object. For example
style_btn can set a default button appearance, and style_btn_red can overwrite the background color to make
the button red:
lv_obj_add_style(btn1, &style_btn, 0);

lv_obj_add_style(btn1, &style1_btn_red, 0);
If a property is not set on for the current state the style with LV_STATE_DEFAULT will be used. If the property is not
defined even in the default state a default value is used.
Some properties (typically the text-related ones) can be inherited. It means if a property is not set in an object it will be
searched in its parents too. For example, you can set the font once in the screen's style and all text on that screen will
inherit it by default.

Local style properties also can be added to the objects. It creates a style which resides inside the object and which is used
only by the object:
lv_obj_set_style_bg_color(slider1, lv_color_hex(0x2080bb), LV_PART_INDICATOR | LV_

,→STATE_PRESSED);
To learn all the features of styles see the Style overview section.
Themes
Themes are the default styles of the objects. The styles from the themes are applied automatically when the objects are
created.
You can select the theme to use in lv_conf.h.
2.1.4 Examples
A button with a label and react on click event
#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_USE_BTN
static void btn_event_cb(lv_event_t * e)

{
lv_obj_t * btn = lv_event_get_target(e);
if(code == LV_EVENT_CLICKED) {
static uint8_t cnt = 0;
cnt++;
/*Get the first child of the button which is the label and change its text*/
lv_obj_t * label = lv_obj_get_child(btn, 0);
lv_label_set_text_fmt(label, "Button: %d", cnt);
}
}
/**
* Create a button with a label and react on click event.
*/
void lv_example_get_started_1(void)
{
lv_obj_t * btn = lv_btn_create(lv_scr_act()); /*Add a button the current␣
,→screen*/
lv_obj_set_pos(btn, 10, 10); /*Set its position*/

lv_obj_set_size(btn, 120, 50); /*Set its size*/
lv_obj_add_event_cb(btn, btn_event_cb, LV_EVENT_ALL, NULL); /*Assign a␣
,→callback to the button*/
lv_obj_t * label = lv_label_create(btn); /*Add a label to the button*/

lv_label_set_text(label, "Button"); /*Set the labels text*/
lv_obj_center(label);
}

#endif
Create styles from scratch for buttons
#if LV_USE_BTN && LV_BUILD_EXAMPLES
static lv_style_t style_btn;

static lv_style_t style_btn_pressed;
static lv_style_t style_btn_red;
static lv_color_t darken(const lv_color_filter_dsc_t * dsc, lv_color_t color, lv_opa_

,→t opa)
{
LV_UNUSED(dsc);
return lv_color_darken(color, opa);
}
static void style_init(void)

{
/*Create a simple button style*/
lv_style_init(&style_btn);
lv_style_set_radius(&style_btn, 10);
lv_style_set_bg_opa(&style_btn, LV_OPA_COVER);
lv_style_set_bg_color(&style_btn, lv_palette_lighten(LV_PALETTE_GREY, 3));
lv_style_set_bg_grad_color(&style_btn, lv_palette_main(LV_PALETTE_GREY));
lv_style_set_bg_grad_dir(&style_btn, LV_GRAD_DIR_VER);
lv_style_set_border_color(&style_btn, lv_color_black());
lv_style_set_border_opa(&style_btn, LV_OPA_20);
lv_style_set_border_width(&style_btn, 2);
lv_style_set_text_color(&style_btn, lv_color_black());
/*Create a style for the pressed state.

*Use a color filter to simply modify all colors in this state*/
static lv_color_filter_dsc_t color_filter;
lv_color_filter_dsc_init(&color_filter, darken);
lv_style_init(&style_btn_pressed);
lv_style_set_color_filter_dsc(&style_btn_pressed, &color_filter);
lv_style_set_color_filter_opa(&style_btn_pressed, LV_OPA_20);
/*Create a red style. Change only some colors.*/

lv_style_init(&style_btn_red);
lv_style_set_bg_color(&style_btn_red, lv_palette_main(LV_PALETTE_RED));
lv_style_set_bg_grad_color(&style_btn_red, lv_palette_lighten(LV_PALETTE_RED, 3));
}
/**
* Create styles from scratch for buttons.
*/


{
/*Initialize the style*/
style_init();
/*Create a button and use the new styles*/

lv_obj_t * btn = lv_btn_create(lv_scr_act());
/* Remove the styles coming from the theme
* Note that size and position are also stored as style properties
* so lv_obj_remove_style_all will remove the set size and position too */
lv_obj_remove_style_all(btn);
lv_obj_set_pos(btn, 10, 10);
lv_obj_set_size(btn, 120, 50);
lv_obj_add_style(btn, &style_btn, 0);
lv_obj_add_style(btn, &style_btn_pressed, LV_STATE_PRESSED);
/*Add a label to the button*/

lv_obj_t * label = lv_label_create(btn);
lv_label_set_text(label, "Button");
/*Create an other button and use the red style too*/

lv_obj_t * btn2 = lv_btn_create(lv_scr_act());
lv_obj_remove_style_all(btn2); /*Remove the styles coming␣
,→from the theme*/
lv_obj_set_pos(btn2, 10, 80);

lv_obj_set_size(btn2, 120, 50);
lv_obj_add_style(btn2, &style_btn, 0);
lv_obj_add_style(btn2, &style_btn_red, 0);
lv_obj_add_style(btn2, &style_btn_pressed, LV_STATE_PRESSED);
lv_obj_set_style_radius(btn2, LV_RADIUS_CIRCLE, 0); /*Add a local style too*/
label = lv_label_create(btn2);
lv_label_set_text(label, "Button 2");
}
#endif
Create a slider and write its value on a label
#if LV_BUILD_EXAMPLES && LV_USE_SLIDER
static lv_obj_t * label;
static void slider_event_cb(lv_event_t * e)

{
lv_obj_t * slider = lv_event_get_target(e);
/*Refresh the text*/

lv_label_set_text_fmt(label, "%d", lv_slider_get_value(slider));
lv_obj_align_to(label, slider, LV_ALIGN_OUT_TOP_MID, 0, -15); /*Align top of␣
,→the slider*/
}

/**
* Create a slider and write its value on a label.
*/
{
/*Create a slider in the center of the display*/
lv_obj_t * slider = lv_slider_create(lv_scr_act());
lv_obj_set_width(slider, 200); /*Set the width*/
lv_obj_center(slider); /*Align to the center of␣
,→the parent (screen)*/
lv_obj_add_event_cb(slider, slider_event_cb, LV_EVENT_VALUE_CHANGED, NULL); /

,→*Assign an event function*/
/*Create a label below the slider*/

label = lv_label_create(lv_scr_act());
lv_label_set_text(label, "0");
lv_obj_align_to(label, slider, LV_ALIGN_OUT_TOP_MID, 0, -15); /*Align top of␣
,→the slider*/
#endif
MicroPython
No examples yet.
2.1.5 Micropython
Learn more about Micropython.
# Create a Button and a Label

scr = lv.obj()
btn = lv.btn(scr)
btn.align(lv.scr_act(), lv.ALIGN.CENTER, 0, 0)
label = lv.label(btn)
label.set_text("Button")
# Load the screen

lv.scr_load(scr)
2.2 Simulator on PC
You can try out LVGL using only your PC (i.e. without any development boards). LVGL will run on a simulator
environment on the PC where anyone can write and experiment the real LVGL applications.
Using the simulator on the PC has the following advantages:
• Hardware independent - Write code, run it on the PC and see the result on the PC monitor.
• Cross-platform - Any Windows, Linux or MacOS system can run the PC simulator.
2.2. Simulator on PC 15
• Portability - the written code is portable, which means you can simply copy it when using an embedded hardware.
• Easy Validation - The simulator is also very useful to report bugs because it means common platform for every
user. So it's a good idea to reproduce a bug in the simulator and use the code snippet in the Forum.
2.2.1 Select an IDE
The simulator is ported to various IDEs (Integrated Development Environments). Choose your favorite IDE, read its
README on GitHub, download the project, and load it to the IDE.
• Eclipse with SDL driver: Recommended on Linux and Mac
• CodeBlocks: Recommended on Windows
• VisualStudio with SDL driver: For Windows
• VSCode with SDL driver: Recommended on Linux and Mac
• PlatformIO with SDL driver: Recommended on Linux and Mac
You can use any IDE for the development but, for simplicity, the configuration for Eclipse CDT is what we'll focus on in
this tutorial. The following section describes the set-up guide of Eclipse CDT in more details.
Note: If you are on Windows, it's usually better to use the Visual Studio or CodeBlocks projects instead. They
work out of the box without requiring extra steps.
2.2.2 Set-up Eclipse CDT
Install Eclipse CDT
Eclipse CDT is a C/C++ IDE.

Eclipse is a Java based software therefore be sure Java Runtime Environment is installed on your system.
On Debian-based distros (e.g. Ubuntu): sudo apt-get install default-jre
Note: If you are using other distros, then please refer and install 'Java Runtime Environment' suitable to your distro. Note:
If you are using macOS and get a "Failed to create the Java Virtual Machine" error, uninstall any other Java JDK installs
and install Java JDK 8u. This should fix the problem.
You can download Eclipse's CDT from: https://www.eclipse.org/cdt/downloads.php. Start the installer and choose
Eclipse CDT from the list.
Install SDL 2
The PC simulator uses the SDL 2 cross platform library to simulate a TFT display and a touch pad.
Linux
On Linux you can easily install SDL2 using a terminal:

1. Find the current version of SDL2: apt-cache search libsdl2 (e.g. libsdl2-2.0-0)
2. Install SDL2: sudo apt-get install libsdl2-2.0-0 (replace with the found version)
3. Install SDL2 development package: sudo apt-get install libsdl2-dev
4. If build essentials are not installed yet: sudo apt-get install build-essential
Windows
If you are using Windows firstly you need to install MinGW (64 bit version). After installing MinGW, do the following
steps to add SDL2:
1. Download the development libraries of SDL.Go to https://www.libsdl.org/download-2.0.php and download De-
velopment Libraries: SDL2-devel-2.0.5-mingw.tar.gz
2. Decompress the file and go to x86_64-w64-mingw32 directory (for 64 bit MinGW) or to i686-w64-mingw32 (for
32 bit MinGW)
3. Copy _...mingw32/include/SDL2 folder to C:/MinGW/.../x86_64-w64-mingw32/include
4. Copy _...mingw32/lib/ content to C:/MinGW/.../x86_64-w64-mingw32/lib
5. Copy _...mingw32/bin/SDL2.dll to {eclipse_worksapce}/pc_simulator/Debug/. Do it later when Eclipse is installed.
Note: If you are using Microsoft Visual Studio instead of Eclipse then you don't have to install MinGW.
OSX
On OSX you can easily install SDL2 with brew: brew install sdl2
If something is not working, then please refer this tutorial to get started with SDL.
Pre-configured project
A pre-configured graphics library project (based on the latest release) is always available to get started easily. You can
find the latest one on GitHub. (Please note that, the project is configured for Eclipse CDT).
Add the pre-configured project to Eclipse CDT
Run Eclipse CDT. It will show a dialogue about the workspace path. Before accepting the path, check that path and
copy (and unzip) the downloaded pre-configured project there. After that, you can accept the workspace path. Of course
you can modify this path but, in that case copy the project to the corresponding location.
Close the start up window and go to File->Import and choose General->Existing project into Workspace. Browse
the root directory of the project and click Finish
On Windows you have to do two additional things:
• Copy the SDL2.dll into the project's Debug folder
• Right click on the project -> Project properties -> C/C++ Build -> Settings -> Libraries -> Add ... and add mingw32
above SDLmain and SDL. (The order is important: mingw32, SDLmain, SDL)
Compile and Run
Now you are ready to run LVGL on your PC. Click on the Hammer Icon on the top menu bar to Build the project. If you
have done everything right, then you will not get any errors. Note that on some systems additional steps might be required
to "see" SDL 2 from Eclipse but, in most of cases the configurations in the downloaded project is enough.
After a success build, click on the Play button on the top menu bar to run the project. Now a window should appear in
the middle of your screen.
Now you are ready to use LVGL and begin development on your PC.
2.3 STM32
TODO
2.4 NXP
NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general purpose and crossover
microcontrollers, allowing easy evaluation and migration into your product design. Download an SDK for a supported
board today and get started with your next GUI application.
2.4.1 Creating new project with LVGL
Downloading the MCU SDK example project is recommended as a starting point. It comes fully configured with LVGL
(and with PXP support if module is present), no additional integration work is required.
2.4.2 Adding HW acceleration for NXP iMX RT platforms using PXP (PiXel Pipeline)
engine for existing projects
Several drawing features in LVGL can be offloaded to PXP engine. In order to use CPU time while PXP is running,
RTOS is required to block the LVGL drawing thread and switch to another task, or simply to idle task, where CPU could
be suspended to save power.
Features supported:
• RGB565 color format

• Area fill + optional transparency
• BLIT (BLock Image Transfer) + optional transparency
• Color keying + optional transparency
• Recoloring (color tint) + optional transparency
• RTOS integration layer
• Default FreeRTOS and bare metal code provided
2.3. STM32 18
Basic configuration:
• Select NXP PXP engine in lv_conf.h: Set LV_USE_GPU_NXP_PXP to 1

• Enable default implementation for interrupt handling, PXP start function and automatic initialization: Set
LV_USE_GPU_NXP_PXP_AUTO_INIT to 1
• If FSL_RTOS_FREE_RTOS symbol is defined, FreeRTOS implementation will be used, otherwise bare metal
code will be included
Basic initialization:
• If LV_USE_GPU_NXP_PXP_AUTO_INIT is enabled, no user code is required; PXP is initialized automatically

in lv_init()
• For manual PXP initialization, default configuration structure for callbacks can be used. Initialize PXP before
calling lv_init()
#if LV_USE_GPU_NXP_PXP
#include "lv_gpu/lv_gpu_nxp_pxp.h"
#include "lv_gpu/lv_gpu_nxp_pxp_osa.h"
#endif
. . .
#if LV_USE_GPU_NXP_PXP
if (lv_gpu_nxp_pxp_init(&pxp_default_cfg) != LV_RES_OK) {
PRINTF("PXP init error. STOP.\n");
for ( ; ; ) ;
}
#endif
Project setup:
• Add PXP related files to project:

– lv_gpu/lv_gpu_nxp.c, lv_gpu/lv_gpu_nxp.h: low level drawing calls for LVGL
– lv_gpu/lv_gpu_nxp_osa.c, lv_gpu/lv_gpu_osa.h: default implementation of OS-specific functions (bare metal
and FreeRTOS only)
∗ optional, required only if LV_USE_GPU_NXP_PXP_AUTO_INIT is set to 1
• PXP related code depends on two drivers provided by MCU SDK. These drivers need to be added to project:
– fsl_pxp.c, fsl_pxp.h: PXP driver
– fsl_cache.c, fsl_cache.h: CPU cache handling functions
2.4. NXP 19
Advanced configuration:
• Implementation depends on multiple OS-specific functions. Structure lv_nxp_pxp_cfg_t with callback point-
ers is used as a parameter for lv_gpu_nxp_pxp_init() function. Default implementation for FreeRTOS
and baremetal is provided in lv_gpu_nxp_osa.c
– pxp_interrupt_init(): Initialize PXP interrupt (HW setup, OS setup)
– pxp_interrupt_deinit(): Deinitialize PXP interrupt (HW setup, OS setup)
– pxp_run(): Start PXP job. Use OS-specific mechanism to block drawing thread. PXP must finish drawing
before leaving this function.
• There are configurable area thresholds which are used to decide whether the area will be processed by CPU,
or by PXP. Areas smaller than defined value will be processed by CPU, areas bigger than the threshold will
be processed by PXP. These thresholds may be defined as a preprocessor variables. Default values are defined
lv_gpu/lv_gpu_nxp_pxp.h
– GPU_NXP_PXP_BLIT_SIZE_LIMIT: size threshold for image BLIT, BLIT with color keying, and BLIT
with recolor (OPA > LV_OPA_MAX)
– GPU_NXP_PXP_BLIT_OPA_SIZE_LIMIT: size threshold for image BLIT and BLIT with color keying
with transparency (OPA < LV_OPA_MAX)
– GPU_NXP_PXP_FILL_SIZE_LIMIT: size threshold for fill operation (OPA > LV_OPA_MAX)
– GPU_NXP_PXP_FILL_OPA_SIZE_LIMIT: size threshold for fill operation with transparency (OPA <
LV_OPA_MAX)
2.5 Espressif (ESP32)
Since v7.7.1 LVGL includes a Kconfig file, so LVGL can be used as an ESP-IDF v4 component.
2.5.1 Get the LVGL demo project for ESP32
We've created lv_port_esp32, a project using ESP-IDF and LVGL to show one of the demos from lv_examples. You are
able to configure the project to use one of the many supported display controllers, see lvgl_esp32_drivers for a complete
list of supported display and indev (touch) controllers.
2.5.2 Use LVGL in your ESP32 project
Prerequisites
ESP-IDF v4 framework is the suggested version to use.
2.5. Espressif (ESP32) 20

Get LVGL
You are suggested to add LVGL as a "component". This component can be located inside a directory named "components"
on your project root directory.
When your project is a git repository you can include LVGL as a git submodule:
git submodule add https://github.com/lvgl/lvgl.git components/lvgl
The above command will clone LVGL's main repository into the components/lvgl directory. LVGL includes a
CMakeLists.txt file that sets some configuration options so you can use LVGL right away.
When you are ready to configure LVGL launch the configuration menu with idf.py menuconfig on your project
root directory, go to Component config and then LVGL configuration.
2.5.3 Use lvgl_esp32_drivers in your project
You are suggested to add lvgl_esp32_drivers as a "component". This component can be located inside a directory
named "components" on your project root directory.
When your project is a git repository you can include lvgl_esp32_drivers as a git submodule:
git submodule add https://github.com/lvgl/lvgl_esp32_drivers.git components/lvgl_

,→esp32_drivers
Support for ESP32-S2
Basic support for ESP32-S2 has been added into the lvgl_esp32_drivers repository.
2.6 Arduino
The core LVGL library and the examples are directly available as Arduino libraries.
Note that you need to choose a powerful enough board to run LVGL and your GUI. See the requirements of LVGL.
For example ESP32 is a good candidate to create your UI with LVGL.
2.6.1 Get the LVGL Ardunio library
LVGL can be installed via the Arduino IDE Library Manager or as a .ZIP library. It will also install lv_exmaples which
contains a lot of examples and demos to try LVGL.
2.6. Arduino 21
2.6.2 Set up drivers
To get started it's recommended to use TFT_eSPI library as a TFT driver to simplify testing. To make it work setup
TFT_eSPI according to your TFT display type via editing either
• User_Setup.h
• or by selecting a configuration in the User_Setup_Select.h
Both files are located in TFT_eSPI library's folder.
2.6.3 Configure LVGL
LVGL has its own configuration file called lv_conf.h. When LVGL is installed the followings needs to be done to
configure it:
1. Go to directory of the installed Arduino libraries
2. Go to lvgl and copy lv_conf_template.h as lv_conf.h into the Arduino Libraries directory next to
the lvgl library folder.
3. Open lv_conf.h and change the first #if 0 to #if 1
4. Set the resolution of your display in LV_HOR_RES_MAX and LV_VER_RES_MAX
5. Set the color depth of you display in LV_COLOR_DEPTH
6. Set LV_TICK_CUSTOM 1
2.6.4 Configure the examples
lv_examples can be configures similarly to LVGL but it's configuration file is called lv_ex_conf.h.
1. Go to directory of the installed Arduino libraries
2. Go to lv_examples and copy lv_ex_template.h as lv_ex_conf.h next to the lv_examples folder.
3. Open lv_ex_conf.h and change the first #if 0 to #if 1
4. Enable the demos you want to use. (The small examples starting with lv_ex_...() are always enabled.)
2.6.5 Initialize LVGL and run an example
Take a look at LVGL_Arduino.ino to see how to initialize LVGL. TFT_eSPI is used as the display driver.
In the INO file you can see how to register a display and a touch pad for LVGL and call an example.
Note that, there is no dedicated INO file for every example but you can call functions like lv_ex_btn1() or
lv_ex_slider1() to run an example. For the full list of examples see the README of lv_examples.
2.6. Arduino 22
2.6.6 Debugging and logging
In case of trouble LVGL can display debug information. In the LVGL_Arduino.ino example there is my_print
method, which allow to send this debug information to the serial interface. To enable this feature you have to edit
lv_conf.h file and enable logging in the section log settings:
/*Log settings*/
#define USE_LV_LOG 1 /*Enable/disable the log module*/
#if LV_USE_LOG
/* How important log should be added:
* LV_LOG_LEVEL_TRACE A lot of logs to give detailed information
* LV_LOG_LEVEL_INFO Log important events
* LV_LOG_LEVEL_WARN Log if something unwanted happened but didn't cause a␣
,→problem
* LV_LOG_LEVEL_ERROR Only critical issue, when the system may fail

* LV_LOG_LEVEL_NONE Do not log anything
*/
# define LV_LOG_LEVEL LV_LOG_LEVEL_WARN
After enabling the log module and setting LV_LOG_LEVEL accordingly the output log is sent to the Serial port @
115200 bps.
2.7 Micropython
2.7.1 What is Micropython?
Micropython is Python for microcontrollers.Using Micropython, you can write Python3 code and run it even on a bare
metal architecture with limited resources.
Highlights of Micropython
• Compact - Fits and runs within just 256k of code space and 16k of RAM. No OS is needed, although you can also
run it with an OS, if you want.
• Compatible - Strives to be as compatible as possible with normal Python (known as CPython).
• Versatile - Supports many architectures (x86, x86-64, ARM, ARM Thumb, Xtensa).
• Interactive - No need for the compile-flash-boot cycle. With the REPL (interactive prompt) you can type com-
mands and execute them immediately, run scripts etc.
• Popular - Many platforms are supported. The user base is growing bigger. Notable forks: MicroPython, Circuit-
Python, MicroPython_ESP32_psRAM_LoBo
• Embedded Oriented - Comes with modules specifically for embedded systems, such as the machine module for
accessing low-level hardware (I/O pins, ADC, UART, SPI, I2C, RTC, Timers etc.)
2.7. Micropython 23
2.7.2 Why Micropython + LVGL?
Currently, Micropython does not have a good high-level GUI library by default. LVGL is an Object Oriented Component
Based high-level GUI library, which seems to be a natural candidate to map into a higher level language, such as Python.
LVGL is implemented in C and its APIs are in C.
Here are some advantages of using LVGL in Micropython:
• Develop GUI in Python, a very popular high level language. Use paradigms such as Object Oriented Programming.
• Usually, GUI development requires multiple iterations to get things right. With C, each iteration consists of
Change code > Build > Flash > Run.In Micropython it's just Change code > Run ! You can even run
commands interactively using the REPL (the interactive prompt)
Micropython + LVGL could be used for:
• Fast prototyping GUI.

• Shortening the cycle of changing and fine-tuning the GUI.
• Modelling the GUI in a more abstract way by defining reusable composite objects, taking advantage of Python's
language features such as Inheritance, Closures, List Comprehension, Generators, Exception Handling, Arbitrary
Precision Integers and others.
• Make LVGL accessible to a larger audience. No need to know C in order to create a nice GUI on an embedded
system.This goes well with CircuitPython vision. CircuitPython was designed with education in mind, to make it
easier for new or unexperienced users to get started with embedded development.
• Creating tools to work with LVGL at a higher level (e.g. drag-and-drop designer).
2.7.3 So what does it look like?
TL;DR: It's very much like the C API, but Object Oriented for LVGL components.
Let's dive right into an example!
A simple example
import lvgl as lv
lv.init()
scr = lv.obj()
btn = lv.btn(scr)
btn.align(lv.scr_act(), lv.ALIGN.CENTER, 0, 0)
label = lv.label(btn)
label.set_text("Button")
lv.scr_load(scr)
2.7. Micropython 24
2.7.4 How can I use it?
Online Simulator
If you want to experiment with LVGL + Micropython without downloading anything - you can use our online simulator!It's
a fully functional LVGL + Micropython that runs entirely in the browser and allows you to edit a python script and run it.
Click here to experiment on the online simulator
Hello World
Note: the online simulator is available for lvgl v6 and v7.
PC Simulator
Micropython is ported to many platforms. One notable port is "unix", which allows you to build and run Micropython
(+LVGL) on a Linux machine. (On a Windows machine you might need Virtual Box or WSL or MinGW or Cygwin etc.)
Click here to know more information about building and running the unix port
Embedded platform
In the end, the goal is to run it all on an embedded platform.Both Micropython and LVGL can be used on many embedded
architectures, such as stm32, ESP32 etc.You would also need display and input drivers. We have some sample drivers
(ESP32+ILI9341, as well as some other examples), but chances are you would want to create your own input/display
drivers for your specific hardware. Drivers can be implemented either in C as a Micropython module, or in pure Mi-
cropython!
2.7.5 Where can I find more information?
• In this Blog Post

• lv_micropython README
• lv_binding_micropython README
• The LVGL micropython forum (Feel free to ask anything!)
• At Micropython: docs and forum
2.8 NuttX RTOS
2.8.1 What is NuttX?
NuttX is a mature and secure real-time operating system (RTOS) with an emphasis on technical standards compliance
and small size. It is scalable from 8-bit to 64-bit microcontrollers and microprocessors and compliant with the Portable
Operating System Interface (POSIX) and the American National Standards Institute (ANSI) standards and with many
Linux-like subsystems. The best way to think about NuttX is to think of it as a small Unix/Linux for microcontrollers.
2.8. NuttX RTOS 25

Highlights of NuttX
• Small - Fits and runs in microcontrollers as small as 32KB Flash and 8KB of RAM.
• Compliant - Strives to be as compatible as possible with POSIX and Linux.
• Versatile - Supports many architectures (ARM, ARM Thumb, AVR, MIPS, OpenRISC, RISC-V 32-bit and 64-bit,
RX65N, x86-64, Xtensa, Z80/Z180, etc).
• Modular - Its modular design allows developers to select only what really matters and use modules to include new
features.
• Popular - NuttX is used by many companies around the world. Probably you already used a product with NuttX
without knowing it was running NuttX.
• Predictable - NuttX is a preemptible Realtime kernel, so you can use it to create predictable applications for
realtime control.
2.8.2 Why NuttX + LVGL?
Although NuttX has its own graphic library called NX, LVGL is a good alternative because users could find more eye-
candy demos and they can reuse code from previous projects. LVGL is an Object Oriented Component Based high-level
GUI library, that could fit very well for a RTOS with advanced features like NuttX. LVGL is implemented in C and its
APIs are in C.
Here are some advantages of using LVGL in NuttX
• Develop GUI in Linux first and when it is done just compile it for NuttX. Nothing more, no wasting of time.
• Usually, GUI development for low level RTOS requires multiple iterations to get things right, where each iteration
consists of Change code > Build > Flash > Run. Using LVGL, Linux and NuttX you can reduce this
process and just test everything on your computer and when it is done, compile it on NuttX and that is it.
NuttX + LVGL could be used for
• GUI demos to demonstrate your board graphics capacities.

• Fast prototyping GUI for MVP (Minimum Viable Product) presentation.
• visualize sensor data directly and easily on the board without using a computer.
• Final products with a GUI without a touchscreen (i.e. 3D Printer Interface using Rotary Encoder to Input data).
• Final products with a touchscreen (and all sorts of bells and whistles).
2.8. NuttX RTOS 26

2.8.3 How to get started with NuttX and LVGL?
There are many boards in the NuttX mainline (https://github.com/apache/incubator-nuttx) with support for LVGL. Let's
use the STM32F429IDISCOVERY as example because it is a very popular board.
First you need to install the pre-requisite on your system
Let's use the Windows Subsystem for Linux
$ sudo apt-get install automake bison build-essential flex gcc-arm-none-eabi gperf␣

,→git libncurses5-dev libtool libusb-dev libusb-1.0.0-dev pkg-config kconfig-
,→frontends openocd
Now let's to create a workspace to save our files
$ mkdir ~/nuttxspace
$ cd ~/nuttxspace
Clone the NuttX and Apps repositories:
$ git clone https://github.com/apache/incubator-nuttx nuttx

$ git clone https://github.com/apache/incubator-nuttx-apps apps
Configure NuttX to use the stm32f429i-disco board and the LVGL Demo
$ ./tools/configure.sh stm32f429i-disco:lvgl
$ make
If everything went fine you should have now the file nuttx.bin to flash on your board:
$ ls -l nuttx.bin
-rwxrwxr-x 1 alan alan 287144 Jun 27 09:26 nuttx.bin
Flashing the firmware in the board using OpenOCD:
$ sudo openocd -f interface/stlink-v2.cfg -f target/stm32f4x.cfg -c init -c "reset␣

,→halt" -c "flash write_image erase nuttx.bin 0x08000000"
Reset the board and using the 'NSH>' terminal start the LVGL demo:
nsh> lvgldemo
2.8. NuttX RTOS 27

2.8.4 Where can I find more information?
• This blog post: LVGL on LPCXpresso54628

• NuttX mailing list: Apache NuttX Mailing List
2.8. NuttX RTOS 28

CHAPTER
THREE
PORTING
3.1 Set-up a project
3.1.1 Get the library
LVGL is available on GitHub: https://github.com/lvgl/lvgl.

You can clone it or download the latest version of the library from GitHub.
The graphics library itself is the lvgl directory which should be copied into your project.
3.1.2 Configuration file
There is a configuration header file for LVGL called lv_conf.h. In this you can set the library's basic behavior, disable
unused modules and features, adjust the size of memory buffers in compile-time, etc.
Copy lvgl/lv_conf_template.h next to the lvgl directory and rename it to lv_conf.h. Open the file and change the #if 0
at the beginning to #if 1 to enable its content.
lv_conf.h can be copied to another place as well but then you should add LV_CONF_INCLUDE_SIMPLE define to your
compiler options (e.g. -DLV_CONF_INCLUDE_SIMPLE for gcc compiler) and set the include path manually. In this
case LVGL will attempt to include lv_conf.h simply with #include "lv_conf.h".
In the config file comments explain the meaning of the options. Be sure to set at least LV_COLOR_DEPTH according to
your display's color depth.
3.1.3 Initialization
To use the graphics library you have to initialize it and the other components too. The order of the initialization is:
1. Call lv_init().
2. Initialize your drivers.
3. Register the display and input devices drivers in LVGL. Lear more about Display and Input device registration.
4. Call lv_tick_inc(x) every x milliseconds in an interrupt to tell the elapsed time. Learn more.
5. Call lv_timer_handler() every few milliseconds to handle LVGL related tasks. Learn more.
29
3.2 Display interface
To register a display for LVGL a lv_disp_draw_buf_t and a lv_disp_drv_t variable have to be initialized.
• lv_disp_draw_buf_t contains internal graphic buffer(s) called draw buffer(s).
• lv_disp_drv_t contains callback functions to interact with the display and manipulate drawing related things.
3.2.1 Draw buffer
Draw buffer(s) are simple array(s) that LVGL uses to render the content of the screen. Once rendering is ready the content
of the draw buffer is sent to the display using the flush_cb function set in the display driver (see below).
A draw draw buffer can be initialized via a lv_disp_draw_buf_t variable like this:
/*A static or global variable to store the buffers*/

static lv_disp_draw_buf_t disp_buf;
/*Static or global buffer(s). The second buffer is optional*/

static lv_color_t buf_1[MY_DISP_HOR_RES * 10];
static lv_color_t buf_2[MY_DISP_HOR_RES * 10];
/*Initialize `disp_buf` with the buffer(s). With only one buffer use NULL instead buf_
,→2 */
lv_disp_draw_buf_init(&disp_buf, buf_1, buf_2, MY_DISP_HOR_RES*10);
Note that lv_disp_draw_buf_t needs to be static, global or dynamically allocated and not a local variable destroyed
if goes out of the scope.
As you can see the draw buffer can be smaller than the screen. In this case, the larger areas will be redrawn in smaller
parts that fit into the draw buffer(s). If only a small area changes (e.g. a button is pressed) then only that area will be
refreshed.
A larger buffer results in better performance but above 1/10 screen sized buffer(s) there is no significant performance
improvement. Therefore it's recommended to choose the size of the draw buffer(s) to at least 1/10 screen sized.
If only one buffer is used LVGL draws the content of the screen into that draw buffer and sends it to the display. This
way LVGL needs to wait until the content of the buffer is sent to the display before drawing something new in it.
If two buffers are used LVGL can draw into one buffer while the content of the other buffer is sent to display in the
background. DMA or other hardware should be used to transfer the data to the display to let the MCU draw meanwhile.
This way, the rendering and refreshing of the display become parallel.
In the display driver (lv_disp_drv_t) the full_refresh bit can be enabled to force LVGL to always redraw the
whole screen. This works in both one buffer and two buffers modes.
If full_refresh is enabled and 2 screen sized draw buffers are provided, LVGL's display handling works like "tra-
ditional" double buffering. This means in flush_cb only the address of the frame buffer needs to be changed to the
provided pointer (color_p parameter). This configuration should be used if the MCU has LCD controller periphery
and not with an external display controller (e.g. ILI9341 or SSD1963).
You can measure the performance of different draw buffer configurations using the benchmark example.
3.2. Display interface 30

3.2.2 Display driver
Once the buffer initialization is ready a lv_disp_drv_t display driver needs to be

1. initialized with lv_disp_drv_init(&disp_drv)
2. its fields need to be set
3. it needs to be registered in LVGL with lv_disp_drv_register(&disp_drv)
Note that lv_disp_drv_t also needs to be static, global or dynamically allocated and not a local variable destroyed
if goes out of the scope.
Mandatory fields
In the most simple case only the following fields of lv_disp_drv_t need to be set:
• draw_buf pointer to an initialized lv_disp_draw_buf_t variable.
• hor_res horizontal resolution of the display in pixels.
• ver_res vertical resolution of the display in pixels.
• flush_cb a callback function to copy a buffer's content to a specific area of the display.
lv_disp_flush_ready(&disp_drv) needs to be called when flushing is ready. LVGL might ren-
der the screen in multiple chunks and therefore call flush_cb multiple times. To see if the current one is the
last chunk of rendering use lv_disp_flush_is_last(&disp_drv).
Optional fields
There are some optional data fields:

• color_chroma_key A color which will be drawn as transparent on chrome keyed images. Set to
LV_COLOR_CHROMA_KEY by default from lv_conf.h.
• anti_aliasing use anti-aliasing (edge smoothing). Enabled by default if LV_COLOR_DEPTH is set to at least
16 in lv_conf.h.
• rotated and sw_rotate See the Rotation section below.
• screen_transp if 1 the screen itself can have transparency as well. LV_COLOR_SCREEN_TRANSP needs
to enabled in lv_conf.h and requires LV_COLOR_DEPTH 32.
• user_data A custom void user data for the driver..
Some other optional callbacks to make easier and more optimal to work with monochrome, grayscale or other non-standard
RGB displays:
• rounder_cb Round the coordinates of areas to redraw. E.g. a 2x2 px can be converted to 2x8. It can be used
if the display controller can refresh only areas with specific height or width (usually 8 px height with monochrome
displays).
• set_px_cb a custom function to write the draw buffer. It can be used to store the pixels more compactly in the
draw buffer if the display has a special color format. (e.g. 1-bit monochrome, 2-bit grayscale etc.) This way the
buffers used in lv_disp_draw_buf_t can be smaller to hold only the required number of bits for the given
area size. Note that, rendering with set_px_cb is slower than normal rendering.
• monitor_cb A callback function that tells how many pixels were refreshed in how much time. Called when the
last chunk is rendered and sent to the display.
• clean_dcache_cb A callback for cleaning any caches related to the display.

LVGL has built-in support to several GPUs (see lv_conf.h) but if something else is required these functions can be
used to make LVGL use a GPU:
• gpu_fill_cb fill an area in the memory with a color.
• gpu_wait_cb if any GPU function returns while the GPU is still working, LVGL will use this function when
required to make sure GPU rendering is ready.
Examples
All together it looks like this:
static lv_disp_drv_t disp_drv; /*A variable to hold the drivers. Must be␣
,→static or global.*/
lv_disp_drv_init(&disp_drv); /*Basic initialization*/

disp_drv.draw_buf = &disp_buf; /*Set an initialized buffer*/
disp_drv.flush_cb = my_flush_cb; /*Set a flush callback to draw to the␣
,→display*/
disp_drv.hor_res = 320; /*Set the horizontal resolution in pixels*/

disp_drv.ver_res = 240; /*Set the vertical resolution in pixels*/
lv_disp_t * disp;
disp = lv_disp_drv_register(&disp_drv); /*Register the driver and save the created␣
,→display objects*/
Here are some simple examples of the callbacks:
void my_flush_cb(lv_disp_drv_t * disp_drv, const lv_area_t * area, lv_color_t * color_

,→p)
{
/*The most simple case (but also the slowest) to put all pixels to the screen one-
,→by-one
*`put_px` is just an example, it needs to implemented by you.*/

int32_t x, y;
for(y = area->y1; y <= area->y2; y++) {
for(x = area->x1; x <= area->x2; x++) {
put_px(x, y, *color_p)
color_p++;
}
}
/* IMPORTANT!!!
* Inform the graphics library that you are ready with the flushing*/
lv_disp_flush_ready(disp_drv);
}
void my_gpu_fill_cb(lv_disp_drv_t * disp_drv, lv_color_t * dest_buf, const lv_area_t␣

,→* dest_area, const lv_area_t * fill_area, lv_color_t color);
{
/*It's an example code which should be done by your GPU*/
uint32_t x, y;
dest_buf += dest_width * fill_area->y1; /*Go to the first line*/
for(y = fill_area->y1; y < fill_area->y2; y++) {

for(x = fill_area->x1; x < fill_area->x2; x++) {
dest_buf[x] = color;
}


dest_buf+=dest_width; /*Go to the next line*/
}
}
void my_rounder_cb(lv_disp_drv_t * disp_drv, lv_area_t * area)

{
/* Update the areas as needed.
* For example it makes the area to start only on 8th rows and have Nx8 pixel␣
,→height.*/
area->y1 = area->y1 & 0x07;

area->y2 = (area->y2 & 0x07) + 8;
}
void my_set_px_cb(lv_disp_drv_t * disp_drv, uint8_t * buf, lv_coord_t buf_w, lv_coord_

,→t x, lv_coord_t y, lv_color_t color, lv_opa_t opa)
{
/* Write to the buffer as required for the display.
* For example it writes only 1-bit for monochrome displays mapped vertically.*/
buf += buf_w * (y >> 3) + x;
if(lv_color_brightness(color) > 128) (*buf) |= (1 << (y % 8));
else (*buf) &= ~(1 << (y % 8));
}
void my_monitor_cb(lv_disp_drv_t * disp_drv, uint32_t time, uint32_t px)

{
printf("%d px refreshed in %d ms\n", time, ms);
}
void my_clean_dcache_cb(lv_disp_drv_t * disp_drv, uint32)

{
/* Example for Cortex-M (CMSIS) */
SCB_CleanInvalidateDCache();
}
3.2.3 Rotation
LVGL supports rotation of the display in 90 degree increments. You can select whether you'd like software rotation or
hardware rotation.
If you select software rotation (sw_rotate flag set to 1), LVGL will perform the rotation for you. Your driver can and
should assume that the screen width and height have not changed. Simply flush pixels to the display as normal. Software
rotation requires no additional logic in your flush_cb callback.
There is a noticeable amount of overhead to performing rotation in software, which is why hardware rotation is also
available. In this mode, LVGL draws into the buffer as though your screen now has the width and height inverted. You
are responsible for rotating the provided pixels yourself.
The default rotation of your display when it is initialized can be set using the rotated flag. The available options are
LV_DISP_ROT_NONE, LV_DISP_ROT_90, LV_DISP_ROT_180, or LV_DISP_ROT_270. The rotation values
are relative to how you would rotate the physical display in the clockwise direction. Thus, LV_DISP_ROT_90 means
you rotate the hardware 90 degrees clockwise, and the display rotates 90 degrees counterclockwise to compensate.
(Note for users upgrading from 7.10.0 and older: these new rotation enum values match up with the old 0/1 system for
rotating 90 degrees, so legacy code should continue to work as expected. Software rotation is also disabled by default for
compatibility.)

Display rotation can also be changed at runtime using the lv_disp_set_rotation(disp, rot) API.
Support for software rotation is a new feature, so there may be some glitches/bugs depending on your configuration. If
you encounter a problem please open an issue on GitHub.
3.2.4 Further reading
• lv_port_disp_template.c for a template for your own driver.

• Drawing to learn more about how rendering works in LVGL.
• Display features to learn more about higher level display features.
3.2.5 API
@description Display Driver HAL interface header file
Typedefs
typedef struct _lv_disp_draw_buf_t lv_disp_draw_buf_t

Structure for holding display buffer information.
typedef struct _lv_disp_drv_t lv_disp_drv_t

Display Driver structure to be registered by HAL. Only its pointer will be saved in lv_disp_t so it should be
declared as static lv_disp_drv_t my_drv or allocated dynamically.
typedef struct _lv_disp_t lv_disp_t

Display structure.
Note: lv_disp_drv_t should be the first member of the structure.
Enums
enum lv_disp_rot_t
Values:
enumerator LV_DISP_ROT_NONE
enumerator LV_DISP_ROT_90

Functions
void lv_disp_drv_init(lv_disp_drv_t *driver)

Initialize a display driver with default values. It is used to have known values in the fields and not junk in memory.
After it you can safely set only the fields you need.
Parameters driver -- pointer to driver variable to initialize
void lv_disp_draw_buf_init(lv_disp_draw_buf_t *draw_buf, void *buf1, void *buf2, uint32_t
size_in_px_cnt)
Initialize a display buffer
Parameters
• draw_buf -- pointer lv_disp_draw_buf_t variable to initialize
• buf1 -- A buffer to be used by LVGL to draw the image. Always has to specified and
can't be NULL. Can be an array allocated by the user. E.g. static lv_color_t
disp_buf1[1024 * 10] Or a memory address e.g. in external SRAM
• buf2 -- Optionally specify a second buffer to make image rendering and image flushing (send-
ing to the display) parallel. In the disp_drv->flush you should use DMA or similar hard-
ware to send the image to the display in the background. It lets LVGL to render next frame
into the other buffer while previous is being sent. Set to NULL if unused.
• size_in_px_cnt -- size of the buf1 and buf2 in pixel count.
lv_disp_t *lv_disp_drv_register(lv_disp_drv_t *driver)
Register an initialized display driver. Automatically set the first display as active.
Parameters driver -- pointer to an initialized 'lv_disp_drv_t' variable. Only its pointer is saved!
Returns pointer to the new display or NULL on error
void lv_disp_drv_update(lv_disp_t *disp, lv_disp_drv_t *new_drv)
Update the driver in run time.
Parameters
• disp -- pointer to a display. (return value of lv_disp_drv_register)
• new_drv -- pointer to the new driver
void lv_disp_remove(lv_disp_t *disp)
Remove a display
Parameters disp -- pointer to display
void lv_disp_set_default(lv_disp_t *disp)
Set a default display. The new screens will be created on it by default.
Parameters disp -- pointer to a display
lv_disp_t *lv_disp_get_default(void)
Get the default display
Returns pointer to the default display
lv_coord_t lv_disp_get_hor_res(lv_disp_t *disp)
Get the horizontal resolution of a display
Parameters disp -- pointer to a display (NULL to use the default display)
Returns the horizontal resolution of the display

lv_coord_t lv_disp_get_ver_res(lv_disp_t *disp)

Get the vertical resolution of a display
Returns the vertical resolution of the display
bool lv_disp_get_antialiasing(lv_disp_t *disp)
Get if anti-aliasing is enabled for a display or not
Returns true: anti-aliasing is enabled; false: disabled
lv_coord_t lv_disp_get_dpi(const lv_disp_t *disp)
Get the DPI of the display
Returns dpi of the display
void lv_disp_set_rotation(lv_disp_t *disp, lv_disp_rot_t rotation)
Set the rotation of this display.
Parameters
• disp -- pointer to a display (NULL to use the default display)
• rotation -- rotation angle
lv_disp_rot_t lv_disp_get_rotation(lv_disp_t *disp)
Get the current rotation of this display.
Returns rotation angle
lv_disp_t *lv_disp_get_next(lv_disp_t *disp)
Get the next display.
Parameters disp -- pointer to the current display. NULL to initialize.
Returns the next display or NULL if no more. Give the first display when the parameter is NULL
lv_disp_draw_buf_t *lv_disp_get_draw_buf(lv_disp_t *disp)
Get the internal buffer of a display
Returns pointer to the internal buffers
struct _lv_disp_draw_buf_t
#include <lv_hal_disp.h> Structure for holding display buffer information.

Public Members
void *buf1
First display buffer.
void *buf2
Second display buffer.
void *buf_act
uint32_t size
lv_area_t area
int flushing
int flushing_last
uint32_t last_area
uint32_t last_part
struct _lv_disp_drv_t
#include <lv_hal_disp.h> Display Driver structure to be registered by HAL. Only its pointer will be saved in
lv_disp_t so it should be declared as static lv_disp_drv_t my_drv or allocated dynamically.
Public Members
lv_coord_t hor_res
Horizontal resolution.
lv_coord_t ver_res
Vertical resolution.
lv_disp_draw_buf_t *draw_buf
Pointer to a buffer initialized with lv_disp_draw_buf_init(). LVGL will use this buffer(s) to draw
the screens contents
uint32_t full_refresh
1: Always make the whole screen redrawn
uint32_t sw_rotate
1: use software rotation (slower)
uint32_t antialiasing
1: anti-aliasing is enabled on this display.
uint32_t rotated
1: turn the display by 90 degree.
Warning: Does not update coordinates for you!

uint32_t screen_transp
uint32_t dpi
Handle if the screen doesn't have a solid (opa == LV_OPA_COVER) background. Use only if required
because it's slower.
void (*flush_cb)(struct _lv_disp_drv_t *disp_drv, const lv_area_t *area, lv_color_t *color_p)

DPI (dot per inch) of the display. Default value is LV_DPI_DEF. MANDATORY: Write the internal buffer
(draw_buf) to the display. 'lv_disp_flush_ready()' has to be called when finished
void (*rounder_cb)(struct _lv_disp_drv_t *disp_drv, lv_area_t *area)

OPTIONAL: Extend the invalidated areas to match with the display drivers requirements E.g. round y to, 8,
16 ..) on a monochrome display
void (*set_px_cb)(struct _lv_disp_drv_t *disp_drv, uint8_t *buf, lv_coord_t buf_w, lv_coord_t x, lv_coord_t
y, lv_color_t color, lv_opa_t opa)
OPTIONAL: Set a pixel in a buffer according to the special requirements of the display Can be used for color
format not supported in LittelvGL. E.g. 2 bit -> 4 gray scales
Note: Much slower then drawing with supported color formats.
void (*monitor_cb)(struct _lv_disp_drv_t *disp_drv, uint32_t time, uint32_t px)

OPTIONAL: Called after every refresh cycle to tell the rendering and flushing time + the number of flushed
pixels
void (*wait_cb)(struct _lv_disp_drv_t *disp_drv)

OPTIONAL: Called periodically while lvgl waits for operation to be completed. For example flushing or
GPU User can execute very simple tasks here or yield the task
void (*clean_dcache_cb)(struct _lv_disp_drv_t *disp_drv)

OPTIONAL: Called when lvgl needs any CPU cache that affects rendering to be cleaned
void (*gpu_wait_cb)(struct _lv_disp_drv_t *disp_drv)

OPTIONAL: called to wait while the gpu is working
void (*drv_update_cb)(struct _lv_disp_drv_t *disp_drv)

OPTIONAL: called when driver parameters are updated
void (*gpu_fill_cb)(struct _lv_disp_drv_t *disp_drv, lv_color_t *dest_buf, lv_coord_t dest_width, const

lv_area_t *fill_area, lv_color_t color)
OPTIONAL: Fill a memory with a color (GPU only)
lv_color_t color_chroma_key
On CHROMA_KEYED images this color will be transparent. LV_COLOR_CHROMA_KEY by default.
(lv_conf.h)
void *user_data
Custom display driver user data

struct _lv_disp_t
#include <lv_hal_disp.h> Display structure.
Note: lv_disp_drv_t should be the first member of the structure.
Public Members
struct _lv_disp_drv_t *driver

< Driver to the display A timer which periodically checks the dirty areas and refreshes them
lv_timer_t *refr_timer
The theme assigned to the screen
struct _lv_theme_t *theme

struct _lv_obj_t **screens
Screens of the display Array of screen objects.
struct _lv_obj_t *act_scr

Currently active screen on this display
struct _lv_obj_t *prev_scr

Previous screen. Used during screen animations
struct _lv_obj_t *scr_to_load

The screen prepared to load in lv_scr_load_anim
struct _lv_obj_t *top_layer

See lv_disp_get_layer_top
struct _lv_obj_t *sys_layer

See lv_disp_get_layer_sys
uint32_t screen_cnt
uint8_t del_prev
1: Automatically delete the previous screen when the screen load animation is ready
lv_opa_t bg_opa
Opacity of the background color or wallpaper
lv_color_t bg_color
Default display color when screens are transparent
const void *bg_img

An image source to display as wallpaper
lv_area_t inv_areas[LV_INV_BUF_SIZE]
Invalidated (marked to redraw) areas

uint8_t inv_area_joined[LV_INV_BUF_SIZE]
uint16_t inv_p
uint32_t last_activity_time
Last time when there was activity on this display
3.3 Input device interface
3.3.1 Types of input devices
To register an input device an lv_indev_drv_t variable has to be initialized:
lv_indev_drv_t indev_drv;
lv_indev_drv_init(&indev_drv); /*Basic initialization*/
indev_drv.type =... /*See below.*/
indev_drv.read_cb =... /*See below.*/
/*Register the driver in LVGL and save the created input device object*/
lv_indev_t * my_indev = lv_indev_drv_register(&indev_drv);
type can be
• LV_INDEV_TYPE_POINTER touchpad or mouse
• LV_INDEV_TYPE_KEYPAD keyboard or keypad
• LV_INDEV_TYPE_ENCODER encoder with left/right turn and push options
• LV_INDEV_TYPE_BUTTON external buttons virtually pressing the screen
read_cb is a function pointer which will be called periodically to report the current state of an input device.
Visit Input devices to learn more about input devices in general.
Touchpad, mouse or any pointer
Input devices that can click points on the screen belong to this category.
indev_drv.type = LV_INDEV_TYPE_POINTER;
indev_drv.read_cb = my_input_read;
...
void my_input_read(lv_indev_drv_t * drv, lv_indev_data_t*data)

{
if(touchpad_pressed) {
data->point.x = touchpad_x;
data->point.y = touchpad_y;
data->state = LV_INDEV_STATE_PRESSED;
} else {
}
}
To set a mouse cursor use lv_indev_set_cursor(my_indev, &img_cursor). (my_indev is the return

value of lv_indev_drv_register)
3.3. Input device interface 40

Keypad or keyboard
Full keyboards with all the letters or simple keypads with a few navigation buttons belong here.
To use a keyboard/keypad:
• Register a read_cb function with LV_INDEV_TYPE_KEYPAD type.
• An object group has to be created: lv_group_t * g = lv_group_create() and objects have to be
added to it with lv_group_add_obj(g, obj)
• The created group has to be assigned to an input device: lv_indev_set_group(my_indev, g)
(my_indev is the return value of lv_indev_drv_register)
• Use LV_KEY_... to navigate among the objects in the group. See lv_core/lv_group.h for the available
keys.
indev_drv.type = LV_INDEV_TYPE_KEYPAD;
indev_drv.read_cb = keyboard_read;
...
void keyboard_read(lv_indev_drv_t * drv, lv_indev_data_t*data){

data->key = last_key(); /*Get the last pressed or released key*/
if(key_pressed()) data->state = LV_INDEV_STATE_PRESSED;

else data->state = LV_INDEV_STATE_RELEASED;
}
Encoder
With an encoder you can do 4 things:

1. Press its button
2. Long-press its button
3. Turn left
4. Turn right
In short, the Encoder input devices work like this:
• By turning the encoder you can focus on the next/previous object.
• When you press the encoder on a simple object (like a button), it will be clicked.
• If you press the encoder on a complex object (like a list, message box, etc.) the object will go to edit mode whereby
turning the encoder you can navigate inside the object.
• To leave edit mode press long the button.
To use an Encoder (similarly to the Keypads) the objects should be added to groups.
indev_drv.type = LV_INDEV_TYPE_ENCODER;
indev_drv.read_cb = encoder_read;
...
void encoder_read(lv_indev_drv_t * drv, lv_indev_data_t*data){

data->enc_diff = enc_get_new_moves();

if(enc_pressed()) data->state = LV_INDEV_STATE_PRESSED;

else data->state = LV_INDEV_STATE_RELEASED;
}
Using buttons with Encoder logic
In addition to standard encoder behavior, you can also utilize its logic to navigate(focus) and edit widgets using buttons.
This is especially handy if you have only few buttons available, or you want to use other buttons in addition to encoder
wheel.
You need to have 3 buttons available:
• LV_KEY_ENTER will simulate press or pushing of the encoder button
• LV_KEY_LEFT will simulate turning encoder left
• LV_KEY_RIGHT will simulate turning encoder right
• other keys will be passed to the focused widget
If you hold the keys it will simulate encoder click with period specified in indev_drv.long_press_rep_time.
indev_drv.type = LV_INDEV_TYPE_ENCODER;
indev_drv.read_cb = encoder_with_keys_read;
...
bool encoder_with_keys_read(lv_indev_drv_t * drv, lv_indev_data_t*data){

data->key = last_key(); /*Get the last pressed or released key*/
/* use LV_KEY_ENTER for encoder press */
if(key_pressed()) data->state = LV_INDEV_STATE_PRESSED;
else {
/* Optionally you can also use enc_diff, if you have encoder*/
data->enc_diff = enc_get_new_moves();
}
return false; /*No buffering now so no more data read*/

}
Button
Buttons mean external "hardware" buttons next to the screen which are assigned to specific coordinates of the screen. If
a button is pressed it will simulate the pressing on the assigned coordinate. (Similarly to a touchpad)
To assign buttons to coordinates use lv_indev_set_button_points(my_indev,
points_array).points_array should look like const lv_point_t points_array[] = {
{12,30},{60,90}, ...}
Important: The points_array can't go out of scope. Either declare it as a global variable or as a static variable inside a
function.

indev_drv.type = LV_INDEV_TYPE_BUTTON;
indev_drv.read_cb = button_read;
...
void button_read(lv_indev_drv_t * drv, lv_indev_data_t*data){

static uint32_t last_btn = 0; /*Store the last pressed button*/
int btn_pr = my_btn_read(); /*Get the ID (0,1,2...) of the pressed button*/
if(btn_pr >= 0) { /*Is there a button press? (E.g. -1 indicated no␣
,→button was pressed)*/
last_btn = btn_pr; /*Save the ID of the pressed button*/

data->state = LV_INDEV_STATE_PRESSED; /*Set the pressed state*/
} else {
data->state = LV_INDEV_STATE_RELEASED; /*Set the released state*/
}
data->btn = last_btn; /*Save the last button*/

}
3.3.2 Other features
Parameters
The default value of the following parameters can changed in lv_indev_drv_t:

• scroll_limit Number of pixels to slide before actually scrolling the object.
• scroll_throw Scroll throw (momentum) slow-down in [%]. Greater value means faster slow-down.
• long_press_time Press time to send LV_EVENT_LONG_PRESSED (in milliseconds)
• long_press_rep_time Interval of sending LV_EVENT_LONG_PRESSED_REPEAT (in milliseconds)
• read_timer pointer to the lv_timer which reads the input device. Its parameters can be changed by
lv_timer_...() functions. LV_INDEV_DEF_READ_PERIOD in lv_conf.h sets the default read pe-
riod.
Feedback
Besides read_cb a feedback_cb callback can be also specified in lv_indev_drv_t. feedback_cb is called
when any type of event is sent by the input devices (independently from its type). This allows generating feedback for the
user, e.g. to play a sound on LV_EVENT_CLICKED.
Associating with a display
Every input device is associated with a display. By default, a new input device is added to the lastly created or the explicitly
selected (using lv_disp_set_default()) display. The associated display is stored and can be changed in disp
field of the driver.

Buffered reading
By default LVGL calls read_cb periodically. This way there is a chance that some user gestures are missed.
To solve this you can write an event driven driver for your input device that buffers measured data. In read_cb you can
set the buffered data instead of reading the input device. You can set the data->continue_reading flag to tell
that LVGL there is more data to read and it should call the read_cb again.
3.3.3 Further reading
• lv_port_indev_template.c for a template for your own driver.

• INdev features to learn more about higher level input device features.
3.3.4 API
@description Input Device HAL interface layer header file
Typedefs
typedef struct _lv_indev_drv_t lv_indev_drv_t

Initialized by the user and registered by 'lv_indev_add()'
typedef struct _lv_indev_proc_t _lv_indev_proc_t

Run time data of input devices Internally used by the library, you should not need to touch it.
typedef struct _lv_indev_t lv_indev_t

The main input device descriptor with driver, runtime data ('proc') and some additional information
Enums
enum lv_indev_type_t
Possible input device types
Values:
enumerator LV_INDEV_TYPE_NONE
Uninitialized state
enumerator LV_INDEV_TYPE_POINTER
Touch pad, mouse, external button
enumerator LV_INDEV_TYPE_KEYPAD
Keypad or keyboard
enumerator LV_INDEV_TYPE_BUTTON
External (hardware button) which is assigned to a specific point of the screen
enumerator LV_INDEV_TYPE_ENCODER
Encoder with only Left, Right turn and a Button

enum lv_indev_state_t
States for input devices
Values:
enumerator LV_INDEV_STATE_RELEASED
enumerator LV_INDEV_STATE_PRESSED
Functions
void lv_indev_drv_init(struct _lv_indev_drv_t *driver)

Initialize an input device driver with default values. It is used to surly have known values in the fields ant not
memory junk. After it you can set the fields.
Parameters driver -- pointer to driver variable to initialize
lv_indev_t *lv_indev_drv_register(struct _lv_indev_drv_t *driver)
Register an initialized input device driver.
Parameters driver -- pointer to an initialized 'lv_indev_drv_t' variable (can be local variable)
Returns pointer to the new input device or NULL on error
void lv_indev_drv_update(lv_indev_t *indev, struct _lv_indev_drv_t *new_drv)
Update the driver in run time.
Parameters
• indev -- pointer to a input device. (return value of lv_indev_drv_register)
• new_drv -- pointer to the new driver
lv_indev_t *lv_indev_get_next(lv_indev_t *indev)
Get the next input device.
Parameters indev -- pointer to the current input device. NULL to initialize.
Returns the next input devise or NULL if no more. Give the first input device when the parameter is
NULL
void _lv_indev_read(lv_indev_t *indev, lv_indev_data_t *data)
Read data from an input device.
Parameters
• indev -- pointer to an input device
• data -- input device will write its data here
struct lv_indev_data_t
#include <lv_hal_indev.h> Data structure passed to an input driver to fill

Public Members
lv_point_t point
For LV_INDEV_TYPE_POINTER the currently pressed point
uint32_t key
For LV_INDEV_TYPE_KEYPAD the currently pressed key
uint32_t btn_id
For LV_INDEV_TYPE_BUTTON the currently pressed button
int16_t enc_diff
For LV_INDEV_TYPE_ENCODER number of steps since the previous read
lv_indev_state_t state
LV_INDEV_STATE_REL or LV_INDEV_STATE_PR
bool continue_reading
Call the read callback until it's set to true
struct _lv_indev_drv_t
#include <lv_hal_indev.h> Initialized by the user and registered by 'lv_indev_add()'
Public Members
lv_indev_type_t type
< Input device type Function pointer to read input device data.
void (*read_cb)(struct _lv_indev_drv_t *indev_drv, lv_indev_data_t *data)

void (*feedback_cb)(struct _lv_indev_drv_t*, uint8_t)
Called when an action happened on the input device. The second parameter is the event from lv_event_t
void *user_data
struct _lv_disp_t *disp
< Pointer to the assigned display Timer to periodically read the input device
lv_timer_t *read_timer
Number of pixels to slide before actually drag the object
uint8_t scroll_limit
Drag throw slow-down in [%]. Greater value means faster slow-down
uint8_t scroll_throw
At least this difference should between two points to evaluate as gesture
uint8_t gesture_min_velocity
At least this difference should be to send a gesture

uint8_t gesture_limit
Long press time in milliseconds
uint16_t long_press_time
Repeated trigger period in long press [ms]
uint16_t long_press_repeat_time
struct _lv_indev_proc_t
#include <lv_hal_indev.h> Run time data of input devices Internally used by the library, you should not need to
touch it.
Public Members
lv_indev_state_t state
Current state of the input device.
uint8_t long_pr_sent
uint8_t reset_query
uint8_t disabled
uint8_t wait_until_release
lv_point_t act_point
Current point of input device.
lv_point_t last_point
Last point of input device.
lv_point_t last_raw_point
Last point read from read_cb.
lv_point_t vect
Difference between act_point and last_point.
lv_point_t scroll_sum
lv_point_t scroll_throw_vect
lv_point_t scroll_throw_vect_ori
struct _lv_obj_t *act_obj
struct _lv_obj_t *last_obj
struct _lv_obj_t *scroll_obj
struct _lv_obj_t *last_pressed
lv_area_t scroll_area
lv_point_t gesture_sum
lv_dir_t scroll_dir
lv_dir_t gesture_dir

uint8_t gesture_sent
struct _lv_indev_proc_t::[anonymous]::[anonymous] pointer
lv_indev_state_t last_state
uint32_t last_key
struct _lv_indev_proc_t::[anonymous]::[anonymous] keypad
union _lv_indev_proc_t::[anonymous] types
uint32_t pr_timestamp
Pressed time stamp
uint32_t longpr_rep_timestamp
Long press repeat time stamp
struct _lv_indev_t
#include <lv_hal_indev.h> The main input device descriptor with driver, runtime data ('proc') and some additional
information
Public Members
struct _lv_indev_drv_t *driver

_lv_indev_proc_t proc
struct _lv_obj_t *cursor
Cursor for LV_INPUT_TYPE_POINTER
struct _lv_group_t *group

Keypad destination group
const lv_point_t *btn_points

Array points assigned to the button ()screen will be pressed here by the buttons
3.4 Tick interface
LVGL needs a system tick to know elapsed time for animations and other tasks.
You need to call the lv_tick_inc(tick_period) function periodically and provide the call period in milliseconds.
For example, lv_tick_inc(1) when calling every millisecond.
lv_tick_inc should be called in a higher priority routine than lv_task_handler() (e.g. in an interrupt) to
precisely know the elapsed milliseconds even if the execution of lv_task_handler takes more time.
With FreeRTOS lv_tick_inc can be called in vApplicationTickHook.
On Linux based operating system (e.g. on Raspberry Pi) lv_tick_inc can be called in a thread like below:
void * tick_thread (void *args)

{
while(1) {
usleep(5*1000); /*Sleep for 5 millisecond*/
3.4. Tick interface 48


lv_tick_inc(5); /*Tell LVGL that 5 milliseconds were elapsed*/
}
}
3.4.1 API
Provide access to the system tick with 1 millisecond resolution
Functions
uint32_t lv_tick_get(void)
Get the elapsed milliseconds since start up
Returns the elapsed milliseconds
uint32_t lv_tick_elaps(uint32_t prev_tick)
Get the elapsed milliseconds since a previous time stamp
Parameters prev_tick -- a previous time stamp (return value of lv_tick_get() )
Returns the elapsed milliseconds since 'prev_tick'
3.5 Task Handler
To handle the tasks of LVGL you need to call lv_timer_handler() periodically in one of the following:
• while(1) of main() function
• timer interrupt periodically (lower priority than lv_tick_inc())
• an OS task periodically
The timing is not critical but it should be about 5 milliseconds to keep the system responsive.
Example:
while(1) {
lv_timer_handler();
my_delay_ms(5);
}
To learn more about timers visit the Timer section.
3.6 Sleep management
The MCU can go to sleep when no user input happens. In this case, the main while(1) should look like this:
while(1) {
/*Normal operation (no sleep) in < 1 sec inactivity*/
if(lv_disp_get_inactive_time(NULL) < 1000) {
lv_task_handler();
}
3.5. Task Handler 49


/*Sleep after 1 sec inactivity*/
else {
timer_stop(); /*Stop the timer where lv_tick_inc() is called*/
sleep(); /*Sleep the MCU*/
}
my_delay_ms(5);
}
You should also add the below lines to your input device read function to signal a wake-up (press, touch or click etc.)
happened:
lv_tick_inc(LV_DISP_DEF_REFR_PERIOD); /*Force task execution on wake-up*/

timer_start(); /*Restart the timer where lv_tick_inc() is␣
,→called*/
lv_task_handler(); /*Call `lv_task_handler()` manually to process␣

,→the wake-up event*/
In addition to lv_disp_get_inactive_time() you can check lv_anim_count_running() to see if all

animations have finished.
3.7 Operating system and interrupts
LVGL is not thread-safe by default.

However, in the following conditions it's valid to call LVGL related functions:
• In events. Learn more in Events.
• In lv_timer. Learn more in Timers.
3.7.1 Tasks and threads
If you need to use real tasks or threads, you need a mutex which should be invoked before the call of
lv_timer_handler and released after it. Also, you have to use the same mutex in other tasks and threads around
every LVGL (lv_...) related function call and code. This way you can use LVGL in a real multitasking environment.
Just make use of a mutex to avoid the concurrent calling of LVGL functions.
3.7.2 Interrupts
Try to avoid calling LVGL functions from interrupt handlers (except lv_tick_inc() and
lv_disp_flush_ready()). But if you need to do this you have to disable the interrupt which uses LVGL
functions while lv_timer_handler is running. It's a better approach to set a flag or some value and periodically
check it in an lv_timer.
3.7. Operating system and interrupts 50

3.8 Logging
LVGL has built-in Log module to inform the user about what is happening in the library.
3.8.1 Log level
To enable logging, set LV_USE_LOG 1 in lv_conf.h and set LV_LOG_LEVEL to one of the following values:
• LV_LOG_LEVEL_TRACE A lot of logs to give detailed information
• LV_LOG_LEVEL_INFO Log important events
• LV_LOG_LEVEL_WARN Log if something unwanted happened but didn't cause a problem
• LV_LOG_LEVEL_ERROR Only critical issues, where the system may fail
• LV_LOG_LEVEL_USER Only user messages
• LV_LOG_LEVEL_NONE Do not log anything
The events which have a higher level than the set log level will be logged too. E.g. if you LV_LOG_LEVEL_WARN,
errors will be also logged.
3.8.2 Printing logs
Logging with printf
If your system supports printf, you just need to enable LV_LOG_PRINTF in lv_conf.h to send the logs with
printf.
Custom log function
If you can't use printf or want to use a custom function to log, you can register a "logger" callback with
lv_log_register_print_cb().
For example:
void my_log_cb(const char * buf)

{
serial_send(buf, strlen(buf));
}
...
lv_log_register_print_cb(my_log_cb);
3.8. Logging 51
3.8.3 Add logs
You can also use the log module via the LV_LOG_TRACE/INFO/WARN/ERROR/USER(text) functions.
3.8. Logging 52
CHAPTER
FOUR
OVERVIEW
4.1 Objects
In LVGL the basic building blocks of a user interface are the objects, also called Widgets. For example a Button, Label,
Image, List, Chart or Text area.
You can see all the Object types here.
All objects are referenced using an lv_obj_t pointer as a handle. This pointer can later be used to set or get the
attributes of the object.
4.1.1 Attributes
Basic attributes
All object types share some basic attributes:

• Position
• Size
• Parent
• Styles
• Event handlers
• Etc
You can set/get these attributes with lv_obj_set_... and lv_obj_get_... functions. For example:
/*Set basic object attributes*/

lv_obj_set_size(btn1, 100, 50); /*Set a button's size*/
lv_obj_set_pos(btn1, 20,30); /*Set a button's position*/
To see all the available functions visit the Base object's documentation.
53
Specific attributes
The object types have special attributes too. For example, a slider has
• Minimum and maximum values
• Current value
For these special attributes, every object type may have unique API functions. For example for a slider:
/*Set slider specific attributes*/

lv_slider_set_range(slider1, 0, 100); /*Set␣
,→the min. and max. values*/
lv_slider_set_value(slider1, 40, LV_ANIM_ON); /*Set the current value␣

,→(position)*/
The API of the widgets is described in their Documentation but you can also check the respective header files (e.g.
widgets/lv_slider.h)
4.1.2 Working mechanisms
Parent-child structure
A parent object can be considered as the container of its children. Every object has exactly one parent object (except
screens), but a parent can have any number of children. There is no limitation for the type of the parent but, there are
typical parent (e.g. button) and typical child (e.g. label) objects.
Moving together
If the position of the parent changes the children will move with the parent. Therefore all positions are relative to the
parent.
4.1. Objects 54
lv_obj_t * parent = lv_obj_create(lv_scr_act()); /*Create a parent object on the␣

,→current screen*/
lv_obj_set_size(parent, 100, 80); /*Set the size of the␣

,→parent*/
lv_obj_t * obj1 = lv_obj_create(parent); /*Create an object on the␣

,→previously created parent object*/
lv_obj_set_pos(obj1, 10, 10); /*Set the position of the␣

,→new object*/
Modify the position of the parent:
lv_obj_set_pos(parent, 50, 50); /*Move the parent. The child will move with it.
,→*/
(For simplicity the adjusting of colors of the objects is not shown in the example.)
Visibility only on the parent
If a child is partially or fully out of its parent then the parts outside will not be visible.
4.1. Objects 55
lv_obj_set_x(obj1, -30); /*Move the child a little bit off the parent*/
Create and delete objects
In LVGL objects can be created and deleted dynamically in run time. It means only the currently created (existing) objects
consume RAM.
This allows for the creation of a screen just when a button is clicked to open it, and for deletion of screens when a new
screen is loaded.
UIs can be created based on the current environment of the device. For example one can create meters, charts, bars and
sliders based on the currently attached sensors.
Every widget has its own create function with a prototype like this:
lv_obj_t * lv_<widget>_create(lv_obj_t * parent, <other paramaters if any>);
In most of the cases the create functions have only a parent parameter that tells on which object create the new widget.
The return value is a pointer to the created object with lv_obj_t * type.
There is a common delete function for all object types. It deletes the object and all of its children.
void lv_obj_del(lv_obj_t * obj);
lv_obj_del will delete the object immediately. If for any reason you can't delete the object immediately you can use
lv_obj_del_async(obj) that will perform the deletion on the next call of lv_timer_handler(). This is
useful e.g. if you want to delete the parent of an object in the child's LV_EVENT_DELETE handler.
You can remove all the children of an object (but not the object itself) using lv_obj_clean(obj).
4.1. Objects 56
4.1.3 Screens
Create screens
The screens are special objects which have no parent object. So they can be created like:
lv_obj_t * scr1 = lv_obj_create(NULL);
Screens can be created with any object type. For example, a Base object or an image to make a wallpaper.
Get the active screen
There is always an active screen on each display. By default, the library creates and loads a "Base object" as a screen for
each display.
To get the currently active screen use the lv_scr_act() function.
Load screens
To load a new screen, use lv_scr_load(scr1).
Layers
There are two automatically generated layers:

• top layer
• system layer
They are independent of the screens and they will be shown on every screen. The top layer is above every object on the
screen and the system layer is above the top layer too. You can add any pop-up windows to the top layer freely. But, the
system layer is restricted to system-level things (e.g. mouse cursor will be placed here in lv_indev_set_cursor()).
The lv_layer_top() and lv_layer_sys() functions return pointers to the top and system layers respectively.
Read the Layer overview section to learn more about layers.
Load screen with animation
A new screen can be loaded with animation too using lv_scr_load_anim(scr, transition_type, time,
delay, auto_del). The following transition types exist:
• LV_SCR_LOAD_ANIM_NONE: switch immediately after delay milliseconds
• LV_SCR_LOAD_ANIM_OVER_LEFT/RIGHT/TOP/BOTTOM move the new screen over the current towards
the given direction
• LV_SCR_LOAD_ANIM_MOVE_LEFT/RIGHT/TOP/BOTTOM move both the current and new screens towards
the given direction
• LV_SCR_LOAD_ANIM_FADE_ON fade the new screen over the old screen
Setting auto_del to true will automatically delete the old screen when the animation is finished.
The new screen will become active (returned by lv_scr_act()) when the animations starts after delay time.
4.1. Objects 57
Handling multiple displays
Screens are created on the currently selected default display. The default display is the last regis-
tered display with lv_disp_drv_register or you can explicitly select a new default display using
lv_disp_set_default(disp).
lv_scr_act(), lv_scr_load() and lv_scr_load_anim() operate on the default screen.
Visit Multi-display support to learn more.
4.1.4 Parts
The widgets are built from multiple parts. For example a Base object uses the main and scrollbar parts but a Slider uses
the main, the indicator and the knob parts. Parts are similar to pseudo elements in CSS.
The following predefined parts exist in LVGL:
• LV_PART_MAIN A background like rectangle*/``
• LV_PART_SCROLLBAR The scrollbar(s)
• LV_PART_INDICATOR Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
• LV_PART_KNOB Like a handle to grab to adjust the value*/
• LV_PART_SELECTED Indicate the currently selected option or section
• LV_PART_ITEMS Used if the widget has multiple similar elements (e.g. tabel cells)*/
• LV_PART_TICKS Ticks on scales e.g. for a chart or meter
• LV_PART_CURSOR Mark a specific place e.g. text area's or chart's cursor
• LV_PART_CUSTOM_FIRST Custom parts can be added from here.
The main purpose of parts to allow styling the "components" of the widgets. Therefore the parts are described in more
detail in the Style overview section.
4.1.5 States
The object can be in a combination of the following states:

• LV_STATE_DEFAULT Normal, released state
• LV_STATE_CHECKED Toggled or checked state
• LV_STATE_FOCUSED Focused via keypad or encoder or clicked via touchpad/mouse
• LV_STATE_FOCUS_KEY Focused via keypad or encoder but not via touchpad/mouse
• LV_STATE_EDITED Edit by an encoder
• LV_STATE_HOVERED Hovered by mouse (not supported now)
• LV_STATE_PRESSED Being pressed
• LV_STATE_SCROLLED Being scrolled
• LV_STATE_DISABLED Disabled state
• LV_STATE_USER_1 Custom state
4.1. Objects 58

The states are usually automatically changed by the library as the user presses, releases, focuses etc an object. How-
ever, the states can be changed manually too. To set or clear given state (but leave the other states untouched) use
lv_obj_add/clear_state(obj, LV_STATE_...) In both cases ORed state values can be used as well. E.g.
lv_obj_add_state(obj, part, LV_STATE_PRESSED | LV_PRESSED_CHECKED).
To learn more about the states read the related section of the Style overview.
4.2 Positions, sizes, and layouts
4.2.1 Overview
Similarly to many other parts of LVGL, the concept of setting the coordinates was inspired by CSS. By no means a
complete implementation of the standard but subsets of CSS were implemented (sometimes with minor adjustments). In
shorts this means:
• the set coordinates (size, position, layouts, etc) are stored in styles
• support min-width, max-width, min-height, max-height
• have pixel, percentage, and "content" units
• x=0; y=0 coordinate means the to top-left corner of the parent plus the left/top padding plus border width
• width/height means the full size, the "content area" is smaller with padding and border width
• a subset of flexbox and grid layouts are supported
Units
• pixel: Simply a position in pixels. A simple integer always means pixel. E.g. lv_obj_set_x(btn, 10)
• percentage: The percentage of the size of the object or its parent (depending on the property). The
lv_pct(value) converts a value to percentage. E.g. lv_obj_set_width(btn, lv_pct(50))
• LV_SIZE_CONTENT: Special value to set the width/height of an object to involve all the children. Its similar to
auto in CSS. E.g. lv_obj_set_width(btn, LV_SIZE_CONTENT).
Boxing model
LVGL follows CSS's border-box model. An object's "box" is built from the following parts:
• bounding box: the width/height of the elements.
• border width: the width of the border.
• padding: space between the sides of the object and its children.
• content: the content area which size if the bounding box reduced by the border width and the size of the paddings.
4.2. Positions, sizes, and layouts 59

The border is drawn inside the bounding box. Inside the border LVGL keeps "padding size" to place the children.
The outline is drawn outside of the bounding box.
Important notes
This section describes special cases in which LVGL's behavior might be unexpected.
Postponed coordinate calculation
LVGL doesn't recalculate all the coordinate changes immediately. This is done to improve performance. Instead, the
objects are marked as "dirty" and before redrawing the screen LVGL checks if there are any "dirty" objects. If so it
refreshes their position, size and layout.
In other words, if you need to get the any coordinate of an object and it the coordinates were just changed LVGL's needs
to be forced to recalculate the coordinates. To do this call lv_obj_update_layout(obj).
The size and position might depend on the parent or layout. Therefore lv_obj_update_layout recalculates the
coordinates of all objects on the screen of obj.
Removing styles
As it's described in the Using styles section the coordinates can be set via style properties too. To be more precise under
the hood every style coordinate related property is stored as style a property. If you use lv_obj_set_x(obj, 20)
LVGL saves x=20 in the local style of the object.
It's an internal mechanism and doesn't matter much as you use LVGL. However, there is one case in which you need to
aware of that. If the style(s) of an object are removed by
lv_obj_remove_style_all(obj)
or
lv_obj_remove_style(obj, NULL, LV_PART_MAIN);

the earlier set coordinates will be removed as well.

For example:
/*The size of obj1 will be set back to the default in the end*/
lv_obj_set_size(obj1, 200, 100); /*Now obj1 has 200;100 size*/
lv_obj_remove_style_all(obj1); /*It removes the set sizes*/
/*obj2 will have 200;100 size in the end */

lv_obj_remove_style_all(obj2);
lv_obj_set_size(obj2, 200, 100);
4.2.2 Position
Simple way
To simple set the x and y coordinates of an object use
lv_obj_set_x(obj, 10);
lv_obj_set_y(obj, 20);
lv_obj_set_pos(obj, 10, 20); //Or in one function
By default the the x and y coordinates are measured from the top left corner of the parent's content area. For example if
the parent has 5 pixels padding on every side, the above code will place obj at (15, 25) because the content area starts
after the padding.
If percentage values are calculated from the parents content area size.
lv_obj_set_x(btn, lv_pct(10)); //x = 10 % of parant content area width
Align
In some cases it's convenient to change the origin of the positioning from the the default top left. If the origin is changed
e.g. to bottom-right, the (0,0) position means: align to the bottom-right corner. To change the origin use:
lv_obj_set_align(obj, align);
To change the alignment and set new coordinates:
lv_obj_align(obj, align, x, y);
The following alignment options can be used:

• LV_ALIGN_TOP_LEFT
• LV_ALIGN_TOP_MID
• LV_ALIGN_TOP_RIGHT
• LV_ALIGN_BOTTOM_LEFT
• LV_ALIGN_BOTTOM_MID
• LV_ALIGN_BOTTOM_RIGHT
• LV_ALIGN_LEFT_MID

• LV_ALIGN_RIGHT_MID
• LV_ALIGN_CENTER
It quite common to align a children to the center of its parent, there fore is a dedicated function for it:
lv_obj_center(obj);
//Has the same effect

lv_obj_align(obj, LV_ALIGN_CENTER, 0, 0);
If the parent's size changes the set alignment and position of the children is applied again automatically.
The functions introduced above aligns the object to its parent. However it's also possible to align an object to an arbitrary
object.
lv_obj_align_to(obj_to_align, reference_obj, align, x, y);
Besides the alignments options above the following can be used to align the object outside of the reference object:
• LV_ALIGN_OUT_TOP_LEFT
• LV_ALIGN_OUT_TOP_MID
• LV_ALIGN_OUT_TOP_RIGHT
• LV_ALIGN_OUT_BOTTOM_LEFT
• LV_ALIGN_OUT_BOTTOM_MID
• LV_ALIGN_OUT_BOTTOM_RIGHT
• LV_ALIGN_OUT_LEFT_TOP
• LV_ALIGN_OUT_LEFT_MID
• LV_ALIGN_OUT_LEFT_BOTTOM
• LV_ALIGN_OUT_RIGHT_TOP
• LV_ALIGN_OUT_RIGHT_MID
• LV_ALIGN_OUT_RIGHT_BOTTOM
For example to align a label above a button and center the label horizontally:
lv_obj_align_to(label, btn, LV_ALIGN_OUT_TOP_MID, 0, -10);
Note that - unlike with lv_obj_align() - lv_obj_align_to() can not realign the object if its coordinates or
the reference object's coordinates changes.
4.2.3 Size
Simple way
The width and the height of an object can be set easily as well:
lv_obj_set_width(obj, 200);
lv_obj_set_height(obj, 100);
lv_obj_set_size(obj, 200, 100); //Or in one function

Percentage values are calculated based on the parent's content area size. For example to set the object's height to the
screen height:
lv_obj_set_height(obj, lv_pct(100));
Size setting supports a value: LV_SIZE_CONTENT. It means the object's size in the respective direction will be set to
the size of its children. Note that only children on the right and bottom will be considered and children on the top and
left remain cropped. This limitation makes the behavior more predictable.
Objects with LV_OBJ_FLAG_HIDDEN or LV_OBJ_FLAG_FLOATING will be ignored by the LV_SIZE_CONTENT
calculation.
The above functions set the size of the bounding box of the object but the size of the content area can be set as well. It
means the object's bounding box will be larger with the paddings than the set size.
lv_obj_set_content_width(obj, 50); //The actual width: padding left + 50 + padding␣

,→right
lv_obj_set_content_height(obj, 30); //The actual width: padding top + 30 + padding␣

,→bottom
The size of the bounding box and the content area can be get with the following functions:
lv_coord_t w = lv_obj_get_width(obj);
lv_coord_t h = lv_obj_get_height(obj);
lv_coord_t content_w = lv_obj_get_content_width(obj);
lv_coord_t content_h = lv_obj_get_content_height(obj);
4.2.4 Using styles
Under the hood the position, size and alignment properties are style properties. The above described "simple functions"
hide the style related code for the sake of simplicity and set the position, size, and alignment properties in the local styles
of the obejct.
However, using styles as to set the coordinates has some great advantages:
• It makes it easy to set the width/height/etc for several objects together. E.g. make all the sliders 100x10 pixels
sized.
• It also makes possible to modify the values in one place.
• The values can be overwritten by other styles. For example style_btn makes the object 100x50 by default but
adding style_full_width overwrites only the width of the object.
• The object can have different position or size in different state. E.g. 100 px wide in LV_STATE_DEFAULT but
120 px in LV_STATE_PRESSED.
• Style transitions can be used to make the coordinate changes smooth.
Here are some examples to set an object's size using a style:
static lv_style_t style;

lv_style_init(&style);
lv_style_set_width(&style, 100);

lv_obj_add_style(btn, &style, LV_PART_MAIN);

As you will see below there are some other great features of size and position setting. However, to keep the LVGL's API
lean only the most common coordinate setting features have a "simple" version and the more complex features can be
used via styles.
4.2.5 Translation
Let's say the there are 3 buttons next to each other. Their position is set as described above. Now you want to move a
buttons up a little when it's pressed.
One way to achieve this is setting a new Y coordinate for pressed state:
static lv_style_t style_normal;

lv_style_init(&style_normal);
lv_style_set_y(&style_normal, 100);
static lv_style_t style_pressed;

lv_style_init(&style_pressed);
lv_style_set_y(&style_pressed, 80);
lv_obj_add_style(btn1, &style_normal, LV_STATE_DEFAULT);

lv_obj_add_style(btn1, &style_pressed, LV_STATE_PRESSED);


It works but it's not really flexible because the pressed coordinate is hard-coded. If the buttons are not at y=100
style_pressed won't work as expected. To solve this translations can be used:
static lv_style_t style_normal;

lv_style_init(&style_normal);
lv_style_set_y(&style_normal, 100);

lv_style_set_translate_y(&style_pressed, -20);



Translation is applied from the current position of the object.

Percentage values can be used in translations as well. The percentage is relative to the size of the object (and not to the
size of the parent). For example lv_pct(50) will move the object with half of its width/height.
The translation is applied after the layouts are calculated. Therefore, even the layouted objects' position can be translated.
The translation actually moves the object. It means it makes the scrollbars and LV_SIZE_CONTENT sized objects react
to the position change.

4.2.6 Transformation
Similarly to the position the size can be changed relative to the current size as well. The transformed width and height
are added on both sides of the object. This means 10 px transformed width makes the object 2x10 pixel wider.
Unlike position translation, the size transformation doesn't make the object "really" larger. In other words scrollbars,
layouts, LV_SIZE_CONTENT will not consider the transformed size. Hence size transformation if "only" a visual effect.
This code makes the a button larger when it's pressed:

lv_style_set_transform_width(&style_pressed, 10);
lv_style_set_transform_height(&style_pressed, 10);
lv_obj_add_style(btn, &style_pressed, LV_STATE_PRESSED);
Min and Max size
Similarly to CSS, LVGL also support min-width, max-width, min-height and max-height. These are limits
preventing an object's size to be smaller/larger then these values. They are especially useful if the size is set by percentage
or LV_SIZE_CONTENT.
static lv_style_t style_max_height;

lv_style_init(&style_max_height);
lv_style_set_y(&style_max_height, 200);
lv_obj_add_style(obj, &style_max_height, LV_STATE_DEFAULT); //Limit the height to␣
,→200 px
Percentage values can be used as well which are relative to the size of the parent's content area size.
static lv_style_t style_max_height;

lv_style_init(&style_max_height);
lv_style_set_y(&style_max_height, lv_pct(50));
lv_obj_add_style(obj, &style_max_height, LV_STATE_DEFAULT); //Limit the height to␣
,→half parent height
4.2.7 Layout
Overview
Layouts can update the position and size of an object's children. They can be used to automatically arrange the children
into a line or column, or in much more complicated forms.
The position and size set by the layout overwrites the "normal" x, y, width, and height settings.
There is only one function that is the same for every layout: lv_obj_set_layout(obj, <LAYOUT_NAME>) sets
the layout on an object.For the further settings of the parent and children see the documentations of the given layout.

Built-in layout
LVGL comes with two very powerful layouts:

• Flexbox
• Grid
Both are heavily inspired by the CSS layouts with the same name.
Flags
There are some flags that can be used on object to affect how they behave with layouts:
• LV_OBJ_FLAG_HIDDEN Hidden object are ignored from layout calculations.
• LV_OBJ_FLAG_IGNORE_LAYOUT The object is simply ignored by the layouts. Its coordinates can be set as
usual.
• LV_OBJ_FLAG_FLOATING Same as LV_OBJ_FLAG_IGNORE_LAYOUT but the object with
LV_OBJ_FLAG_FLOATING will be ignored from LV_SIZE_CONTENT calculations.
These flags can be added/removed with lv_obj_add/clear_flag(obj, FLAG);
Adding new layouts
LVGL can be freely extended by a custom layouts like this:
uint32_t MY_LAYOUT;
...
MY_LAYOUT = lv_layout_register(my_layout_update, &user_data);
...
void my_layout_update(lv_obj_t * obj, void * user_data)

{
/*Will be called automatically if required to reposition/resize the children␣
,→of "obj" */
Custom style properties can be added too that can be get and used in the update callback. For example:
uint32_t MY_PROP;
...
LV_STYLE_MY_PROP = lv_style_register_prop();
...
static inline void lv_style_set_my_prop(lv_style_t * style, uint32_t value)
{
lv_style_value_t v = {
.num = (int32_t)value
};
lv_style_set_prop(style, LV_STYLE_MY_PROP, v);
}

4.2.8 Examples
4.3 Styles
Styles are used to set the appearance of the objects. Styles in lvgl are heavily inspired by CSS. The concept in nutshell is
as follows:
• A style is an lv_style_t variable which can hold properties like border width, text color and so on. It's similar
to a class in CSS.
• Styles can be assigned to objects to change their appearance. During the assignment the target part (pseudo element
in CSS) and target state (pseudo class) can be specified. For example one can add style_blue to the knob of a
slider when it's in pressed state.
• The same style can be used by any number of objects.
• Styles can be cascaded which means multiple styles can be assigned to an object and each style can have different
properties. Therefore not all properties have to be specified in style. LVLG will look for a property until a style
defines it or use a default if it's not spefied by any of the styles. For example style_btn can result in a default
gray button and style_btn_red can add only a background-color=red to overwrite the background
color.
• Later added styles have higher precedence. It means if a property is specified in two styles the later added will be
used.
• Some properties (e.g. text color) can be inherited from the parent(s) if it's not specified in the object.
• Objects can have local styles that have higher precedence than "normal" styles.
• Unlike CSS (where pseudo-classes describe different states, e.g. :focus), in LVGL a property is assigned to a
given state.
• Transitions can be applied when the object changes state.
4.3.1 States
The objects can be in the combination of the following states:

• LV_STATE_DEFAULT (0x0000) Normal, released state
• LV_STATE_CHECKED (0x0001) Toggled or checked state
• LV_STATE_FOCUSED (0x0002) Focused via keypad or encoder or clicked via touchpad/mouse
• LV_STATE_FOCUS_KEY (0x0004) Focused via keypad or encoder but not via touchpad/mouse
• LV_STATE_EDITED (0x0008) Edit by an encoder
• LV_STATE_HOVERED (0x0010) Hovered by mouse (not supported now)
• LV_STATE_PRESSED (0x0020) Being pressed
• LV_STATE_SCROLLED (0x0040) Being scrolled
• LV_STATE_DISABLED (0x0080) Disabled state
• LV_STATE_USER_1 (0x1000) Custom state
4.3. Styles 67
The combination states the object can be focused and pressed at the same time. This is represented as
LV_STATE_FOCUSED | LV_STATE_PRESSED.
The style can be added to any state and state combination. For example, setting a different background color for default
and pressed state. If a property is not defined in a state the best matching state's property will be used. Typically this
means the property with LV_STATE_DEFAULT is used.˛ If the property is not set even for the default state the default
value will be used. (See later)
But what does the "best matching state's property" really mean? States have a precedence which is shown by their value
(see in the above list). A higher value means higher precedence. To determine which state's property to use let's take an
example. Imagine the background color is defined like this:
• LV_STATE_DEFAULT: white
• LV_STATE_PRESSED: gray
• LV_STATE_FOCUSED: red
1. By the default the object is in default state, so it's a simple case: the property is perfectly defined in the object's
current state as white.
2. When the object is pressed there are 2 related properties: default with white (default is related to every state)
and pressed with gray. The pressed state has 0x0020 precedence which is higher than the default state's 0x0000
precedence, so gray color will be used.
3. When the object is focused the same thing happens as in pressed state and red color will be used. (Focused state
has higher precedence than default state).
4. When the object is focused and pressed both gray and red would work, but the pressed state has higher precedence
than focused so gray color will be used.
5. It's possible to set e.g rose color for LV_STATE_PRESSED | LV_STATE_FOCUSED. In this case, this com-
bined state has 0x0020 + 0x0002 = 0x0022 precedence, which is higher than the pressed state's precedence so rose
color would be used.
6. When the object is in checked state there is no property to set the background color for this state. So for lack of a
better option, the object remains white from the default state's property.
Some practical notes:
• The precedence (value) of states is quite intuitive and it's something the user would expect naturally. E.g. if an
object is focused the user will still want to see if it's pressed, therefore pressed state has a higher precedence. If the
focused state had a higher precedence it would overwrite the pressed color.
• If you want to set a property for all states (e.g. red background color) just set it for the default state. If the object
can't find a property for its current state it will fall back to the default state's property.
• Use ORed states to describe the properties for complex cases. (E.g. pressed + checked + focused)
• It might be a good idea to use different style elements for different states. For example, finding background colors
for released, pressed, checked + pressed, focused, focused + pressed, focused + pressed + checked, etc states is
quite difficult. Instead, for example, use the background color for pressed and checked states and indicate the
focused state with a different border color.
4.3. Styles 68
4.3.2 Cascading styles
It's not required to set all the properties in one style. It's possible to add more styles to an object and let the later added
style to modify or extend appearance. For example, create a general gray button style and create a new for red buttons
where only the new background color is set.
This is much like in CSS when used classes are listed like <div class=".btn .btn-red">.
Styles added later have precedence over ones set earlier. So in the gray/red button example above, the normal button style
should be added first and the red style second. However, the precedence coming from states are still taken into account.
So let's examine the following case:
• the basic button style defines dark-gray color for default state and light-gray color pressed state
• the red button style defines the background color as red only in the default state
In this case, when the button is released (it's in default state) it will be red because a perfect match is found in the most
recently added style (red). When the button is pressed the light-gray color is a better match because it describes the current
state perfectly, so the button will be light-gray.
4.3.3 Inheritance
Some properties (typically that are related to texts) can be inherited from the parent object's styles. Inheritance is applied
only if the given property is not set in the object's styles (even in default state). In this case, if the property is inheritable,
the property's value will be searched in the parents too until an object specifies a value for the property. The parents will
use their own state to detemine the value. So if a button is pressed, and the text color comes from here, the pressed text
color will be used.
4.3.4 Parts
Objects can have parts which can have their own styles.
The following predefined parts exist in LVGL:
• LV_PART_MAIN A background like rectangle*/
• LV_PART_SCROLLBAR The scrollbar(s)
• LV_PART_INDICATOR Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
• LV_PART_KNOB Like a handle to grab to adjust the value*/
• LV_PART_SELECTED Indicate the currently selected option or section
• LV_PART_ITEMS Used if the widget has multiple similar elements (e.g. table cells)*/
• LV_PART_TICKS Ticks on scales e.g. for a chart or meter
• LV_PART_CURSOR Mark a specific place e.g. text area's or chart's cursor
• LV_PART_CUSTOM_FIRST Custom parts can be added from here.
For example a Slider has three parts:
• Background
• Indiactor
• Knob
It means the all three parts of the slider can have their own styles. See later how to add style styles to objects and parts.
4.3. Styles 69
4.3.5 Initialize styles and set/get properties
Styles are stored in lv_style_t variables. Style variables should be static, global or dynamically allocated. In
other words they can not be local variables in functions which are destroyed when the function exists. Before using a
style it should be initialized with lv_style_init(&my_style). After initializing the style properties can be set or
added to it.
Property set functions looks like this: lv_style_set_<property_name>(&style, <value>); For exam-
ple:

lv_style_set_bg_color(&style_btn, lv_color_grey());
lv_style_set_bg_opa(&style_btn, LV_OPA_50);
lv_style_set_border_color(&style_btn, lv_color_black());
static lv_style_t style_btn_red;

lv_style_init(&style_btn_red);
lv_style_set_bg_color(&style_btn_red, lv_color_red());
lv_style_set_bg_opa(&style_btn_red, LV_OPA_COVER);
To remove a property use:
lv_style_remove_prop(&style, LV_STYLE_BG_COLOR);
To get a property's value from a style:
lv_style_value_t v;
lv_res_t res = lv_style_rget_prop(&style, LV_STYLE_BG_COLOR, &v);
if(res == LV_RES_OK) { /*Found*/
do_something(v.color);
}
lv_style_value_t has 3 fields:

• num for integer, boolean and opacity properties
• color for color properties
• ptr for pointer properties
To reset a style (free all its data) use
lv_style_reset(&style);
4.3.6 Add and remove styles to a widget
A style on its own is not that useful, it needs to be assigned to an object to take effect.
4.3. Styles 70
Add styles
To add a style to an object use lv_obj_add_style(obj, &style, <selector>). <selector> is an

OR-ed value of parts and state to which the style should be added. Some examples:
• LV_PART_MAIN | LV_STATE_DEFAULT
• LV_STATE_PRESSED: The main part in pressed state. LV_PART_MAIN can be omitted
• LV_PART_SCROLLBAR: The scrollbar part in the default state. LV_STATE_DEFAULT can be omitted.
• LV_PART_SCROLLBAR | LV_STATE_SCROLLED: The scrollbar part when the object is being scrolled
• 0 Same as LV_PART_MAIN | LV_STATE_DEFAULT.
• LV_PART_INDICATOR | LV_STATE_PRESSED | LV_STATE_CHECKED The indicator part when the
object is pressed and checked at the same time.
Using lv_obj_add_style:
lv_obj_add_style(btn, &style_btn, 0); /

,→*Default button style*/
lv_obj_add_style(btn, &btn_red, LV_STATE_PRESSED); /*Overwrite only a some colors to␣

,→red when pressed*/
Remove styles
To remove all styles from an object use lv_obj_remove_style_all(obj).

To remove specific styles use lv_obj_remove_style(obj, style, selector). This function will remove
style only if the selector matches with the selector used in lv_obj_add_style. style can be NULL
to check only the selector and remove all matching styles. The selector can use the LV_STATE_ANY and
LV_PART_ANY values to remove the style with any state or part.
Report style changes
If a style which is already assigned to object changes (i.e. a property is added or changed) the objects using that style
should be notified. There are 3 options to do this:
1. If you know that the changed properties can be applied by a simple redraw (e.g. color or opacity changes) just call
lv_obj_invalidate(obj) or lv_obj_invalideate(lv_scr_act()).
2. If more complex style properties were changed or added, and you know which object(s) are affected by that
style call lv_obj_refresh_style(obj, part, property). To refresh all parts and properties use
lv_obj_refresh_style(obj, LV_PART_ANY, LV_STYLE_PROP_ANY).
3. To make LVGL check all objects to see whether they use the style and refresh them when needed call
lv_obj_report_style_change(&style). If style is NULL all objects will be notified about the style
change.
4.3. Styles 71
Get a property's value on an object
To get a final value of property - considering cascading, inheritance, local styles and transitions (see below) - get functions
like this can be used: lv_obj_get_style_<property_name>(obj, <part>). These functions uses the
object's current state and if no better candidate returns a default value. For example:
lv_color_t color = lv_obj_get_style_bg_color(btn, LV_PART_MAIN);
4.3.7 Local styles
Besides "normal" styles, the objects can store local styles too. This concept is similar to inline styles in CSS (e.g. <div
style="color:red">) with some modification.
So local styles are like normal styles but they can't be shared among other objects. If used, local styles are allocated
automatically, and freed when the object is deleted. They are useful to add local customization to the object.
Unlike in CSS, in LVGL local styles can be assigned to states (pseudo-classes) and parts (pseudo-elements).
To set a local property use functions like lv_obj_set_style_local_<property_name>(obj, <value>,
<selector>); For example:
lv_obj_set_style_local_bg_color(slider, lv_color_red(), LV_PART_INDICATOR | LV_STATE_

,→FOCUSED);
4.3.8 Properties
For the full list of style properties click here.
Typical background properties
In the documentation of the widgets you will see sentences like "The widget use the typical background properties". The
"typical background properties" are the ones related to:
• Background
• Border
• Outline
• Shadow
• Padding
• Width and height transformation
• X and Y translation
4.3. Styles 72
4.3.9 Transitions
By default, when an object changes state (e.g. it's pressed) the new properties from the new state are set immediately.
However, with transitions it's possible to play an animation on state change. For example, on pressing a button its back-
ground color can be animated to the pressed color over 300 ms.
The parameters of the transitions are stored in the styles. It's possible to set
• the time of the transition
• the delay before starting the transition
• the animation path (also known as timing or easing function)
• the properties to animate
The transition properties can be defined for each state. For example, setting 500 ms transition time in default state will
mean that when the object goes to the default state a 500 ms transition time will be applied. Setting 100 ms transition
time in the pressed state will mean a 100 ms transition time when going to pressed state. So this example configuration
will result in going to pressed state quickly and then going back to default slowly.
To describe a transition an lv_transition_dsc_t variable needs to initialized and added to a style:
/*Only its pointer is saved so must static, global or dynamically allocated */

static const lv_style_prop_t trans_props[] = {
LV_
,→ STYLE_BG_OPA, LV_STYLE_BG_COLOR,
0,
,→ /*End marker*/
};
static lv_style_transition_dsc_t trans1;

lv_style_transition_dsc_init(&trans1, trans_props, lv_anim_path_ease_out, duration_ms,
,→ delay_ms);
lv_style_set_transition(&style1, &trans1);
4.3.10 Color filter
TODO
4.3.11 Themes
Themes are a collection of styles. If there is an active theme LVGL applies it on every created widget. This will give a
default appearance to the UI which can then be modified by adding further styles.
Every display can have a different theme. For example you could have a colorful theme on a TFT and monochrome theme
on a secondary monochrome display.
To set a theme for a display, 2 steps are required:
1. Initialize a theme
2. Assign the initialized theme to a display.
Theme initialization functions can have different prototype. This example shows how to set the "default" theme:
4.3. Styles 73
lv_theme_t * th = lv_theme_default_init(display, /*Use the DPI, size, etc from this␣

,→display*/
LV_COLOR_PALETTE_BLUE, LV_COLOR_PALETTE_CYAN,␣
,→ /*Primary and secondary palette*/
false, /*Light or dark mode*/
&lv_font_montserrat_10, &lv_font_montserrat_
,→14, &lv_font_montserrat_18); /*Small, normal, large fonts*/
lv_disp_set_theme(display, th); /*Assign the theme to the display*/
The themes can be enabled in lv_conf.h. If the default theme is enabled by LV_USE_THEME_DEFAULT 1 LVGL
automatically initializes and sets it when a display is created.
Extending themes
Built-in themes can be extended. If a custom theme is created a parent theme can be selected. The parent theme's styles
will be added before the custom theme's styles. Any number of themes can be chained this way. E.g. default theme ->
custom theme -> dark theme.
lv_theme_set_parent(new_theme, base_theme) extends the base_theme with the new_theme.
There is an example for it below.
4.3.12 Examples
Size styles
#if LV_BUILD_EXAMPLES && LV_USE_IMG
/**
* Using the Size, Position and Padding style properties
*/
void lv_example_style_1(void)
{
lv_style_set_radius(&style, 5);
/*Make a gradient*/
lv_style_set_width(&style, 150);
lv_style_set_height(&style, LV_SIZE_CONTENT);
lv_style_set_pad_ver(&style, 20);
lv_style_set_pad_left(&style, 5);
lv_style_set_x(&style, lv_pct(50));
lv_style_set_y(&style, 80);
/*Create an object with the new style*/

lv_obj_t * obj = lv_obj_create(lv_scr_act());
lv_obj_add_style(obj, &style, 0);
4.3. Styles 74
lv_obj_t * label = lv_label_create(obj);

lv_label_set_text(label, "Hello");
}
#endif
Background styles
#if LV_BUILD_EXAMPLES
/**
* Using the background style properties
*/
{
/*Make a gradient*/
lv_style_set_bg_opa(&style, LV_OPA_COVER);
lv_style_set_bg_color(&style, lv_palette_lighten(LV_PALETTE_GREY, 1));
lv_style_set_bg_grad_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_bg_grad_dir(&style, LV_GRAD_DIR_VER);
/*Shift the gradient to the bottom*/

lv_style_set_bg_main_stop(&style, 128);
lv_style_set_bg_grad_stop(&style, 192);

lv_obj_center(obj);
}
#endif
Border styles
/**
* Using the border style properties
*/
{
4.3. Styles 75

/*Set a background color and a radius*/
/*Add border to the bottom+right*/

lv_style_set_border_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_border_width(&style, 5);
lv_style_set_border_opa(&style, LV_OPA_50);
lv_style_set_border_side(&style, LV_BORDER_SIDE_BOTTOM | LV_BORDER_SIDE_RIGHT);

lv_obj_center(obj);
}
#endif
Outline styles
/**
* Using the outline style properties
*/
{

/*Add outline*/
lv_style_set_outline_width(&style, 2);
lv_style_set_outline_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_outline_pad(&style, 8);

lv_obj_center(obj);
}
#endif
4.3. Styles 76
Shadow styles
/**
* Using the Shadow style properties
*/
{

/*Add a shadow*/
lv_style_set_shadow_width(&style, 25);
lv_style_set_shadow_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_shadow_ofs_x(&style, 10);
lv_style_set_shadow_ofs_y(&style, 20);

lv_obj_center(obj);
}
#endif
Image styles
/**
* Using the Image style properties
*/
{

lv_style_set_img_recolor(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_img_recolor_opa(&style, LV_OPA_50);
lv_style_set_transform_angle(&style, 300);
4.3. Styles 77

lv_obj_t * obj = lv_img_create(lv_scr_act());
LV_IMG_DECLARE(img_cogwheel_argb);
lv_img_set_src(obj, &img_cogwheel_argb);
lv_obj_center(obj);
}
#endif
Arc styles
Error encountered while trying to open /home/runner/work/lvgl/lvgl/examples/style/lv_

,→example_style_7.c
Text styles
#if LV_BUILD_EXAMPLES && LV_USE_LABEL
/**
* Using the text style properties
*/
{
lv_style_set_pad_all(&style, 10);
lv_style_set_text_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_text_letter_space(&style, 5);
lv_style_set_text_line_space(&style, 20);
lv_style_set_text_decor(&style, LV_TEXT_DECOR_UNDERLINE);

lv_obj_t * obj = lv_label_create(lv_scr_act());
lv_label_set_text(obj, "Text of\n"
"a label");
lv_obj_center(obj);
}
#endif
4.3. Styles 78
Line styles
#if LV_BUILD_EXAMPLES && LV_USE_LINE
/**
* Using the line style properties
*/
{
lv_style_set_line_color(&style, lv_palette_main(LV_PALETTE_GREY));
lv_style_set_line_width(&style, 6);
lv_style_set_line_rounded(&style, true);

lv_obj_t * obj = lv_line_create(lv_scr_act());
static lv_point_t p[] = {{10, 30}, {30, 50}, {100, 0}};

lv_line_set_points(obj, p, 3);
lv_obj_center(obj);
}
#endif
Transition
/**
* Creating a transition
*/
{
static const lv_style_prop_t props[] = {LV_STYLE_BG_COLOR, LV_STYLE_BORDER_COLOR,␣
,→LV_STYLE_BORDER_WIDTH, 0};
/* A default transition
* Make it fast (100ms) and start with some delay (200 ms)*/
static lv_style_transition_dsc_t trans_def;
lv_style_transition_dsc_init(&trans_def, props, lv_anim_path_linear, 100, 200,␣
,→NULL);
/* A special transition when going to pressed state

* Make it slow (500 ms) but start without delay*/
static lv_style_transition_dsc_t trans_pr;
lv_style_transition_dsc_init(&trans_pr, props, lv_anim_path_linear, 500, 0, NULL);
static lv_style_t style_def;

lv_style_init(&style_def);
4.3. Styles 79

lv_style_set_transition(&style_def, &trans_def);
static lv_style_t style_pr;

lv_style_init(&style_pr);
lv_style_set_bg_color(&style_pr, lv_palette_main(LV_PALETTE_RED));
lv_style_set_border_width(&style_pr, 6);
lv_style_set_border_color(&style_pr, lv_palette_darken(LV_PALETTE_RED, 3));
lv_style_set_transition(&style_pr, &trans_pr);
/*Create an object with the new style_pr*/

lv_obj_add_style(obj, &style_def, 0);
lv_obj_add_style(obj, &style_pr, LV_STATE_PRESSED);
lv_obj_center(obj);
}
#endif
Using multiple styles
/**
* Using multiple styles
*/
{
/*A base style*/
static lv_style_t style_base;
lv_style_init(&style_base);
lv_style_set_bg_color(&style_base, lv_palette_main(LV_PALETTE_LIGHT_BLUE));
lv_style_set_border_color(&style_base, lv_palette_darken(LV_PALETTE_LIGHT_BLUE,␣
,→3));
lv_style_set_border_width(&style_base, 2);
lv_style_set_radius(&style_base, 10);
lv_style_set_shadow_width(&style_base, 10);
lv_style_set_shadow_ofs_y(&style_base, 5);
lv_style_set_shadow_opa(&style_base, LV_OPA_50);
lv_style_set_text_color(&style_base, lv_color_white());
lv_style_set_width(&style_base, 100);
lv_style_set_height(&style_base, LV_SIZE_CONTENT);
/*Set only the properties that should be different*/

static lv_style_t style_warning;
lv_style_init(&style_warning);
lv_style_set_bg_color(&style_warning, lv_palette_main(LV_PALETTE_YELLOW));
lv_style_set_border_color(&style_warning, lv_palette_darken(LV_PALETTE_YELLOW,␣
,→3));
lv_style_set_text_color(&style_warning, lv_palette_darken(LV_PALETTE_YELLOW, 4));
/*Create an object with the base style only*/

lv_obj_t * obj_base = lv_obj_create(lv_scr_act());
4.3. Styles 80

lv_obj_add_style(obj_base, &style_base, 0);
lv_obj_align(obj_base, LV_ALIGN_LEFT_MID, 20, 0);
lv_obj_t * label = lv_label_create(obj_base);

lv_label_set_text(label, "Base");
/*Create an other object with the base style and earnings style too*/
lv_obj_t * obj_warning = lv_obj_create(lv_scr_act());
lv_obj_add_style(obj_warning, &style_base, 0);
lv_obj_add_style(obj_warning, &style_warning, 0);
lv_obj_align(obj_warning, LV_ALIGN_RIGHT_MID, -20, 0);
label = lv_label_create(obj_warning);
lv_label_set_text(label, "Warning");
}
#endif
Local styles
/**
* Local styles
*/
{
lv_style_set_bg_color(&style, lv_palette_main(LV_PALETTE_GREEN));
lv_style_set_border_color(&style, lv_palette_lighten(LV_PALETTE_GREEN, 3));

/*Overwrite the background color locally*/

lv_obj_set_style_bg_color(obj,lv_palette_main(LV_PALETTE_ORANGE), LV_PART_MAIN);
lv_obj_center(obj);
}
#endif
4.3. Styles 81
Add styles to parts and states
/**
* Add styles to parts and states
*/
{
static lv_style_t style_indic;
lv_style_init(&style_indic);
lv_style_set_bg_color(&style_indic, lv_palette_lighten(LV_PALETTE_RED, 3));
lv_style_set_bg_grad_color(&style_indic, lv_palette_main(LV_PALETTE_RED));
lv_style_set_bg_grad_dir(&style_indic, LV_GRAD_DIR_HOR);
static lv_style_t style_indic_pr;

lv_style_init(&style_indic_pr);
lv_style_set_shadow_color(&style_indic_pr, lv_palette_main(LV_PALETTE_RED));
lv_style_set_shadow_width(&style_indic_pr, 10);
lv_style_set_shadow_spread(&style_indic_pr, 3);
/*Create an object with the new style_pr*/

lv_obj_t * obj = lv_slider_create(lv_scr_act());
lv_obj_add_style(obj, &style_indic, LV_PART_INDICATOR);
lv_obj_add_style(obj, &style_indic_pr, LV_PART_INDICATOR | LV_STATE_PRESSED);
lv_slider_set_value(obj, 70, LV_ANIM_OFF);
lv_obj_center(obj);
}
#endif
Extending the current theme
/*Will be called when the styles of the base theme are already added
to add new styles*/
static void new_theme_apply_cb(lv_theme_t * th, lv_obj_t * obj)
{
LV_UNUSED(th);
if(lv_obj_check_type(obj, &lv_btn_class)) {
lv_obj_add_style(obj, &style_btn, 0);
}
}
static void new_theme_init_and_set(void)

{
/*Initialize the styles*/
4.3. Styles 82

lv_style_set_bg_color(&style_btn, lv_palette_main(LV_PALETTE_GREEN));
lv_style_set_border_color(&style_btn, lv_palette_darken(LV_PALETTE_GREEN, 3));
/*Initialize the new theme from the current theme*/

lv_theme_t * th_act = lv_disp_get_theme(NULL);
static lv_theme_t th_new;
th_new = *th_act;
/*Set the parent theme ans the style applay callback for the new theme*/
lv_theme_set_parent(&th_new, th_act);
lv_theme_set_apply_cb(&th_new, new_theme_apply_cb);
/*Assign the new theme the the current display*/

lv_disp_set_theme(NULL, &th_new);
}
/**
* Extending the current theme
*/
{
lv_obj_t * btn;
lv_obj_t * label;
btn = lv_btn_create(lv_scr_act());
lv_obj_align(btn, LV_ALIGN_TOP_MID, 0, 20);
label = lv_label_create(btn);
lv_label_set_text(label, "Original theme");
new_theme_init_and_set();
lv_obj_align(btn, LV_ALIGN_BOTTOM_MID, 0, -20);
lv_label_set_text(label, "New theme");
#endif
4.3. Styles 83
MicroPython
No examples yet.
4.3.13 API
Typedefs
typedef uint8_t lv_blend_mode_t

typedef uint8_t lv_text_decor_t
typedef uint8_t lv_border_side_t
typedef uint8_t lv_grad_dir_t
Enums
enum [anonymous]
Possible options how to blend opaque drawings
Values:
enumerator LV_BLEND_MODE_NORMAL
Simply mix according to the opacity value
enumerator LV_BLEND_MODE_ADDITIVE
Add the respective color channels
enumerator LV_BLEND_MODE_SUBTRACTIVE
Subtract the foreground from the background
enum [anonymous]
Some options to apply decorations on texts. 'OR'ed values can be used.
Values:
enumerator LV_TEXT_DECOR_NONE
enumerator LV_TEXT_DECOR_UNDERLINE
enumerator LV_TEXT_DECOR_STRIKETHROUGH
enum [anonymous]
Selects on which sides border should be drawn 'OR'ed values can be used.
Values:
enumerator LV_BORDER_SIDE_NONE
enumerator LV_BORDER_SIDE_BOTTOM
enumerator LV_BORDER_SIDE_TOP
enumerator LV_BORDER_SIDE_LEFT
4.3. Styles 84
enumerator LV_BORDER_SIDE_RIGHT
enumerator LV_BORDER_SIDE_FULL
enumerator LV_BORDER_SIDE_INTERNAL
FOR matrix-like objects (e.g. Button matrix)
enum [anonymous]
The direction of the gradient.
Values:
enumerator LV_GRAD_DIR_NONE
No gradient (the grad_color property is ignored)
enumerator LV_GRAD_DIR_VER
Vertical (top to bottom) gradient
enumerator LV_GRAD_DIR_HOR
Horizontal (left to right) gradient
enum lv_style_prop_t
Enumeration of all built in style properties
Values:
enumerator LV_STYLE_PROP_INV
enumerator LV_STYLE_WIDTH
enumerator LV_STYLE_MIN_WIDTH
enumerator LV_STYLE_MAX_WIDTH
enumerator LV_STYLE_HEIGHT
enumerator LV_STYLE_MIN_HEIGHT
enumerator LV_STYLE_MAX_HEIGHT
enumerator LV_STYLE_X
enumerator LV_STYLE_Y
enumerator LV_STYLE_ALIGN
enumerator LV_STYLE_TRANSFORM_WIDTH
enumerator LV_STYLE_TRANSFORM_HEIGHT
enumerator LV_STYLE_TRANSLATE_X
enumerator LV_STYLE_TRANSLATE_Y
enumerator LV_STYLE_TRANSFORM_ZOOM
enumerator LV_STYLE_TRANSFORM_ANGLE
enumerator LV_STYLE_PAD_TOP
enumerator LV_STYLE_PAD_BOTTOM
enumerator LV_STYLE_PAD_LEFT
4.3. Styles 85
enumerator LV_STYLE_PAD_RIGHT
enumerator LV_STYLE_PAD_ROW
enumerator LV_STYLE_PAD_COLUMN
enumerator LV_STYLE_BG_COLOR
enumerator LV_STYLE_BG_COLOR_FILTERED
enumerator LV_STYLE_BG_OPA
enumerator LV_STYLE_BG_GRAD_COLOR
enumerator LV_STYLE_BG_GRAD_COLOR_FILTERED
enumerator LV_STYLE_BG_GRAD_DIR
enumerator LV_STYLE_BG_MAIN_STOP
enumerator LV_STYLE_BG_GRAD_STOP
enumerator LV_STYLE_BG_IMG_SRC
enumerator LV_STYLE_BG_IMG_OPA
enumerator LV_STYLE_BG_IMG_RECOLOR
enumerator LV_STYLE_BG_IMG_RECOLOR_FILTERED
enumerator LV_STYLE_BG_IMG_RECOLOR_OPA
enumerator LV_STYLE_BG_IMG_TILED
enumerator LV_STYLE_BORDER_COLOR
enumerator LV_STYLE_BORDER_COLOR_FILTERED
enumerator LV_STYLE_BORDER_OPA
enumerator LV_STYLE_BORDER_WIDTH
enumerator LV_STYLE_BORDER_SIDE
enumerator LV_STYLE_BORDER_POST
enumerator LV_STYLE_OUTLINE_WIDTH
enumerator LV_STYLE_OUTLINE_COLOR
enumerator LV_STYLE_OUTLINE_COLOR_FILTERED
enumerator LV_STYLE_OUTLINE_OPA
enumerator LV_STYLE_OUTLINE_PAD
enumerator LV_STYLE_SHADOW_WIDTH
enumerator LV_STYLE_SHADOW_OFS_X
enumerator LV_STYLE_SHADOW_OFS_Y
enumerator LV_STYLE_SHADOW_SPREAD
enumerator LV_STYLE_SHADOW_COLOR
enumerator LV_STYLE_SHADOW_COLOR_FILTERED
enumerator LV_STYLE_SHADOW_OPA
enumerator LV_STYLE_IMG_OPA
4.3. Styles 86
enumerator LV_STYLE_IMG_RECOLOR
enumerator LV_STYLE_IMG_RECOLOR_FILTERED
enumerator LV_STYLE_IMG_RECOLOR_OPA
enumerator LV_STYLE_LINE_WIDTH
enumerator LV_STYLE_LINE_DASH_WIDTH
enumerator LV_STYLE_LINE_DASH_GAP
enumerator LV_STYLE_LINE_ROUNDED
enumerator LV_STYLE_LINE_COLOR
enumerator LV_STYLE_LINE_COLOR_FILTERED
enumerator LV_STYLE_LINE_OPA
enumerator LV_STYLE_ARC_WIDTH
enumerator LV_STYLE_ARC_ROUNDED
enumerator LV_STYLE_ARC_COLOR
enumerator LV_STYLE_ARC_COLOR_FILTERED
enumerator LV_STYLE_ARC_OPA
enumerator LV_STYLE_ARC_IMG_SRC
enumerator LV_STYLE_TEXT_COLOR
enumerator LV_STYLE_TEXT_COLOR_FILTERED
enumerator LV_STYLE_TEXT_OPA
enumerator LV_STYLE_TEXT_FONT
enumerator LV_STYLE_TEXT_LETTER_SPACE
enumerator LV_STYLE_TEXT_LINE_SPACE
enumerator LV_STYLE_TEXT_DECOR
enumerator LV_STYLE_TEXT_ALIGN
enumerator LV_STYLE_RADIUS
enumerator LV_STYLE_CLIP_CORNER
enumerator LV_STYLE_OPA
enumerator LV_STYLE_COLOR_FILTER_DSC
enumerator LV_STYLE_COLOR_FILTER_OPA
enumerator LV_STYLE_ANIM_TIME
enumerator LV_STYLE_ANIM_SPEED
enumerator LV_STYLE_TRANSITION
enumerator LV_STYLE_BLEND_MODE
enumerator LV_STYLE_LAYOUT
enumerator LV_STYLE_BASE_DIR
enumerator _LV_STYLE_LAST_BUILT_IN_PROP
4.3. Styles 87
enumerator LV_STYLE_PROP_ANY
Functions
LV_EXPORT_CONST_INT(LV_IMG_ZOOM_NONE)
void lv_style_init(lv_style_t *style)

Initialize a style
Note: Do not call lv_style_init on styles that are already have some properties because this function won't
free the used memory just set a default state for the style. In other words be sure to initialize styles only once!
Parameters style -- pointer to a style to initialize
void lv_style_reset(lv_style_t *style)

Clear all properties from a style and free all allocated memories.
Parameters style -- pointer to a style
lv_style_prop_t lv_style_register_prop(void)
bool lv_style_remove_prop(lv_style_t *style, lv_style_prop_t prop)

Remove a property from a style
Parameters
• style -- pointer to a style
• prop -- a style property ORed with a state.
Returns true: the property was found and removed; false: the property wasn't found
void lv_style_set_prop(lv_style_t *style, lv_style_prop_t prop, lv_style_value_t value)
Set the value of property in a style. This function shouldn't be used directly by the user. Instead use
lv_style_set_<prop_name>(). E.g. lv_style_set_bg_color()
Parameters
• style -- pointer to style
• prop -- the ID of a property (e.g. LV_STLYE_BG_COLOR)
• value -- lv_style_value_t variable in which a filed is set according to the type of
prop
lv_res_t lv_style_get_prop(lv_style_t *style, lv_style_prop_t prop, lv_style_value_t *value)
Get the value of a property
Note: For performance reasons there are no sanity check on style
Parameters
• prop -- the ID of a property
4.3. Styles 88
• value -- pointer to a lv_style_value_t variable to store the value

Returns LV_RES_INV: the property wsn't found in the style (value is unchanged) LV_RES_OK:
the property was fond, and value is set accordingly
static inline lv_res_t lv_style_get_prop_inlined(lv_style_t *style, lv_style_prop_t prop, lv_style_value_t

*value)
Get the value of a property
Note: For performance reasons there are no sanity check on style
Note: This function is the same as lv_style_get_prop but inlined. Use it only on performance critical places
Parameters
• prop -- the ID of a property
• value -- pointer to a lv_style_value_t variable to store the value
Returns LV_RES_INV: the property wsn't found in the style (value is unchanged) LV_RES_OK:
the property was fond, and value is set accordingly
void lv_style_transition_dsc_init(lv_style_transition_dsc_t *tr, const lv_style_prop_t props[],

lv_anim_path_cb_t path_cb, uint32_t time, uint32_t delay, void
*user_data)
lv_style_value_t lv_style_prop_get_default(lv_style_prop_t prop)

Get the default value of a property
Parameters prop -- the ID of a property
Returns the default value
bool lv_style_is_empty(const lv_style_t *style)
Checks if a style is empty (has no properties)
Parameters style -- pointer to a style
Returns
uint8_t _lv_style_get_prop_group(lv_style_prop_t prop)
Tell the group of a property. If the a property from a group is set in a style the (1 << group) bit of style->has_group
is set. It allows early skipping the style if the property is not exists in the style at all.
Parameters prop -- a style property
Returns the group [0..7] 7 means all the custom properties with index > 112
static inline void lv_style_set_pad_all(lv_style_t *style, lv_coord_t value)
static inline void lv_style_set_pad_hor(lv_style_t *style, lv_coord_t value)
static inline void lv_style_set_pad_ver(lv_style_t *style, lv_coord_t value)
4.3. Styles 89
static inline void lv_style_set_pad_gap(lv_style_t *style, lv_coord_t value)
static inline void lv_style_set_size(lv_style_t *style, lv_coord_t value)
union lv_style_value_t
#include <lv_style.h> A common type to handle all the property types in the same way.
Public Members
int32_t num
Number integer number (opacity, enums, booleans or "normal" numbers)
const void *ptr

Constant pointers (font, cone text, etc)
lv_color_t color
Colors
struct lv_style_transition_dsc_t
#include <lv_style.h> Descriptor for style transitions
Public Members
const lv_style_prop_t *props

An array with the properties to animate.
void *user_data
A custom user data that will be passed to the animation's user_data
lv_anim_path_cb_t path_xcb
A path for the animation.
uint32_t time
Duration of the transition in [ms]
uint32_t delay
Delay before the transition in [ms]
struct lv_style_const_prop_t
#include <lv_style.h> Descriptor of a constant style property.
4.3. Styles 90
Public Members
lv_style_prop_t prop
lv_style_value_t value
struct lv_style_t
#include <lv_style.h> Descriptor of a style (a collection of properties and values).
Public Members
uint32_t sentinel
lv_style_value_t value1
uint8_t *values_and_props
const lv_style_const_prop_t *const_props
union lv_style_t::[anonymous] v_p
uint16_t prop1
uint16_t is_const
uint8_t has_group
uint8_t prop_cnt
Typedefs
typedef void (*lv_theme_apply_cb_t)(struct _lv_theme_t*, lv_obj_t*)

typedef struct _lv_theme_t lv_theme_t
Functions
lv_theme_t *lv_theme_get_from_obj(lv_obj_t *obj)

Get the theme assigned to the display of the object
Parameters obj -- pointer to object
Returns the theme of the object's display (can be NULL)
void lv_theme_apply(lv_obj_t *obj)
Apply the active theme on an object
Parameters obj -- pointer to an object
void lv_theme_set_parent(lv_theme_t *new_theme, lv_theme_t *parent)
Set a base theme for a theme. The styles from the base them will be added before the styles of the current theme.
Arbitrary long chain of themes can be created by setting base themes.
Parameters
• new_theme -- pointer to theme which base should be set
• parent -- pointer to the base theme
4.3. Styles 91
void lv_theme_set_apply_cb(lv_theme_t *theme, lv_theme_apply_cb_t apply_cb)

Set an apply callback for a theme. The apply callback is used to add styles to different objects
Parameters
• theme -- pointer to theme which callback should be set
• apply_cb -- pointer to the callback
const lv_font_t *lv_theme_get_font_small(lv_obj_t *obj)
Get the small font of the theme
Returns pointer to the font
const lv_font_t *lv_theme_get_font_normal(lv_obj_t *obj)
Get the normal font of the theme
const lv_font_t *lv_theme_get_font_large(lv_obj_t *obj)
Get the subtitle font of the theme
lv_color_t lv_theme_get_color_primary(lv_obj_t *obj)
Get the primary color of the theme
Returns the color
lv_color_t lv_theme_get_color_secondary(lv_obj_t *obj)
Get the secondary color of the theme
Returns the color
struct _lv_theme_t
Public Members
lv_theme_apply_cb_t apply_cb
struct _lv_theme_t *parent
Apply the current theme's style on top of this theme.
void *user_data
struct _lv_disp_t *disp
lv_color_t color_primary
lv_color_t color_secondary
const lv_font_t *font_small
const lv_font_t *font_normal
const lv_font_t *font_large
uint32_t flags
4.3. Styles 92
Functions
static inline lv_coord_t lv_obj_get_style_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_min_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_max_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_height(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_min_height(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_max_height(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_x(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_y(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_align_t lv_obj_get_style_align(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_transform_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_transform_height(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_translate_x(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_translate_y(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_transform_zoom(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_transform_angle(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_top(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_bottom(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_left(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_right(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_row(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_pad_column(const struct _lv_obj_t *obj, uint32_t part)
4.3. Styles 93
static inline lv_coord_t lv_obj_get_style_radius(const struct _lv_obj_t *obj, uint32_t part)
static inline bool lv_obj_get_style_clip_corner(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_opa_t lv_obj_get_style_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline const lv_color_filter_dsc_t *lv_obj_get_style_color_filter_dsc(const struct _lv_obj_t *obj,

uint32_t part)
static inline lv_opa_t lv_obj_get_style_color_filter_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline uint32_t lv_obj_get_style_anim_time(const struct _lv_obj_t *obj, uint32_t part)
static inline uint32_t lv_obj_get_style_anim_speed(const struct _lv_obj_t *obj, uint32_t part)
static inline const lv_style_transition_dsc_t *lv_obj_get_style_transition(const struct _lv_obj_t *obj,

uint32_t part)
static inline lv_blend_mode_t lv_obj_get_style_blend_mode(const struct _lv_obj_t *obj, uint32_t part)
static inline uint16_t lv_obj_get_style_layout(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_base_dir_t lv_obj_get_style_base_dir(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_color_filtered(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_opa_t lv_obj_get_style_bg_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_grad_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_grad_color_filtered(const struct _lv_obj_t *obj,

uint32_t part)
static inline lv_grad_dir_t lv_obj_get_style_bg_grad_dir(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_bg_main_stop(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_bg_grad_stop(const struct _lv_obj_t *obj, uint32_t part)
static inline const void *lv_obj_get_style_bg_img_src(const struct _lv_obj_t *obj, uint32_t part)
4.3. Styles 94
static inline lv_opa_t lv_obj_get_style_bg_img_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_img_recolor(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_bg_img_recolor_filtered(const struct _lv_obj_t *obj,

uint32_t part)
static inline lv_opa_t lv_obj_get_style_bg_img_recolor_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline bool lv_obj_get_style_bg_img_tiled(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_border_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_border_color_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_border_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_border_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_border_side_t lv_obj_get_style_border_side(const struct _lv_obj_t *obj, uint32_t part)
static inline bool lv_obj_get_style_border_post(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_text_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_text_color_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_text_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline const lv_font_t *lv_obj_get_style_text_font(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_text_letter_space(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_text_line_space(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_text_decor_t lv_obj_get_style_text_decor(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_text_align_t lv_obj_get_style_text_align(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_opa_t lv_obj_get_style_img_opa(const struct _lv_obj_t *obj, uint32_t part)
4.3. Styles 95
static inline lv_color_t lv_obj_get_style_img_recolor(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_img_recolor_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_img_recolor_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_outline_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_outline_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_outline_color_filtered(const struct _lv_obj_t *obj,

uint32_t part)
static inline lv_opa_t lv_obj_get_style_outline_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_outline_pad(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_shadow_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_shadow_ofs_x(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_shadow_ofs_y(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_shadow_spread(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_shadow_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_shadow_color_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_shadow_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_line_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_line_dash_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_line_dash_gap(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_line_rounded(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_line_color(const struct _lv_obj_t *obj, uint32_t part)
4.3. Styles 96
static inline lv_color_t lv_obj_get_style_line_color_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_line_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_arc_width(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_arc_rounded(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_arc_color(const struct _lv_obj_t *obj, uint32_t part)
static inline lv_color_t lv_obj_get_style_arc_color_filtered(const struct _lv_obj_t *obj, uint32_t

part)
static inline lv_opa_t lv_obj_get_style_arc_opa(const struct _lv_obj_t *obj, uint32_t part)
static inline const void *lv_obj_get_style_arc_img_src(const struct _lv_obj_t *obj, uint32_t part)
void lv_obj_set_style_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_min_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_max_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_height(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_min_height(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_max_height(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_x(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_y(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_align(struct _lv_obj_t *obj, lv_align_t value, lv_style_selector_t selector)
void lv_obj_set_style_transform_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_transform_height(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_translate_x(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
4.3. Styles 97
void lv_obj_set_style_translate_y(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_transform_zoom(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_transform_angle(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_pad_top(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_pad_bottom(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_pad_left(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_pad_right(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_pad_row(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_pad_column(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_radius(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_clip_corner(struct _lv_obj_t *obj, bool value, lv_style_selector_t selector)
void lv_obj_set_style_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_color_filter_dsc(struct _lv_obj_t *obj, const lv_color_filter_dsc_t *value,

lv_style_selector_t selector)
void lv_obj_set_style_color_filter_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t

selector)
void lv_obj_set_style_anim_time(struct _lv_obj_t *obj, uint32_t value, lv_style_selector_t selector)
void lv_obj_set_style_anim_speed(struct _lv_obj_t *obj, uint32_t value, lv_style_selector_t selector)
void lv_obj_set_style_transition(struct _lv_obj_t *obj, const lv_style_transition_dsc_t *value,

void lv_obj_set_style_blend_mode(struct _lv_obj_t *obj, lv_blend_mode_t value, lv_style_selector_t

selector)
void lv_obj_set_style_layout(struct _lv_obj_t *obj, uint16_t value, lv_style_selector_t selector)
4.3. Styles 98
void lv_obj_set_style_base_dir(struct _lv_obj_t *obj, lv_base_dir_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_color_filtered(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t

selector)
void lv_obj_set_style_bg_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_grad_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_grad_color_filtered(struct _lv_obj_t *obj, lv_color_t value,

void lv_obj_set_style_bg_grad_dir(struct _lv_obj_t *obj, lv_grad_dir_t value, lv_style_selector_t

selector)
void lv_obj_set_style_bg_main_stop(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_grad_stop(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_img_src(struct _lv_obj_t *obj, const void *value, lv_style_selector_t selector)
void lv_obj_set_style_bg_img_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_bg_img_recolor(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t

selector)
void lv_obj_set_style_bg_img_recolor_filtered(struct _lv_obj_t *obj, lv_color_t value,

void lv_obj_set_style_bg_img_recolor_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t

selector)
void lv_obj_set_style_bg_img_tiled(struct _lv_obj_t *obj, bool value, lv_style_selector_t selector)
void lv_obj_set_style_border_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_border_color_filtered(struct _lv_obj_t *obj, lv_color_t value,

void lv_obj_set_style_border_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_border_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
4.3. Styles 99
void lv_obj_set_style_border_side(struct _lv_obj_t *obj, lv_border_side_t value, lv_style_selector_t

selector)
void lv_obj_set_style_border_post(struct _lv_obj_t *obj, bool value, lv_style_selector_t selector)
void lv_obj_set_style_text_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_text_color_filtered(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t

selector)
void lv_obj_set_style_text_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_text_font(struct _lv_obj_t *obj, const lv_font_t *value, lv_style_selector_t selector)
void lv_obj_set_style_text_letter_space(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_text_line_space(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_text_decor(struct _lv_obj_t *obj, lv_text_decor_t value, lv_style_selector_t

selector)
void lv_obj_set_style_text_align(struct _lv_obj_t *obj, lv_text_align_t value, lv_style_selector_t

selector)
void lv_obj_set_style_img_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_img_recolor(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_img_recolor_filtered(struct _lv_obj_t *obj, lv_color_t value,

void lv_obj_set_style_img_recolor_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t

selector)
void lv_obj_set_style_outline_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_outline_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_outline_color_filtered(struct _lv_obj_t *obj, lv_color_t value,

4.3. Styles 100

void lv_obj_set_style_outline_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_outline_pad(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_shadow_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_shadow_ofs_x(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_shadow_ofs_y(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_shadow_spread(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_shadow_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_shadow_color_filtered(struct _lv_obj_t *obj, lv_color_t value,

void lv_obj_set_style_shadow_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_line_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_line_dash_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_line_dash_gap(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_line_rounded(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_line_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
void lv_obj_set_style_line_color_filtered(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t

selector)
void lv_obj_set_style_line_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_arc_width(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_arc_rounded(struct _lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_arc_color(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t selector)
4.3. Styles 101

void lv_obj_set_style_arc_color_filtered(struct _lv_obj_t *obj, lv_color_t value, lv_style_selector_t

selector)
void lv_obj_set_style_arc_opa(struct _lv_obj_t *obj, lv_opa_t value, lv_style_selector_t selector)
void lv_obj_set_style_arc_img_src(struct _lv_obj_t *obj, const void *value, lv_style_selector_t selector)
Functions
void lv_style_set_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_min_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_max_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_height(lv_style_t *style, lv_coord_t value)
void lv_style_set_min_height(lv_style_t *style, lv_coord_t value)
void lv_style_set_max_height(lv_style_t *style, lv_coord_t value)
void lv_style_set_x(lv_style_t *style, lv_coord_t value)
void lv_style_set_y(lv_style_t *style, lv_coord_t value)
void lv_style_set_align(lv_style_t *style, lv_align_t value)
void lv_style_set_transform_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_transform_height(lv_style_t *style, lv_coord_t value)
void lv_style_set_translate_x(lv_style_t *style, lv_coord_t value)
void lv_style_set_translate_y(lv_style_t *style, lv_coord_t value)
void lv_style_set_transform_zoom(lv_style_t *style, lv_coord_t value)
void lv_style_set_transform_angle(lv_style_t *style, lv_coord_t value)
void lv_style_set_pad_top(lv_style_t *style, lv_coord_t value)
void lv_style_set_pad_bottom(lv_style_t *style, lv_coord_t value)
4.3. Styles 102

void lv_style_set_pad_left(lv_style_t *style, lv_coord_t value)
void lv_style_set_pad_right(lv_style_t *style, lv_coord_t value)
void lv_style_set_pad_row(lv_style_t *style, lv_coord_t value)
void lv_style_set_pad_column(lv_style_t *style, lv_coord_t value)
void lv_style_set_radius(lv_style_t *style, lv_coord_t value)
void lv_style_set_clip_corner(lv_style_t *style, bool value)
void lv_style_set_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_color_filter_dsc(lv_style_t *style, const lv_color_filter_dsc_t *value)
void lv_style_set_color_filter_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_anim_time(lv_style_t *style, uint32_t value)
void lv_style_set_anim_speed(lv_style_t *style, uint32_t value)
void lv_style_set_transition(lv_style_t *style, const lv_style_transition_dsc_t *value)
void lv_style_set_blend_mode(lv_style_t *style, lv_blend_mode_t value)
void lv_style_set_layout(lv_style_t *style, uint16_t value)
void lv_style_set_base_dir(lv_style_t *style, lv_base_dir_t value)
void lv_style_set_bg_color(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_bg_grad_color(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_grad_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_grad_dir(lv_style_t *style, lv_grad_dir_t value)
4.3. Styles 103

void lv_style_set_bg_main_stop(lv_style_t *style, lv_coord_t value)
void lv_style_set_bg_grad_stop(lv_style_t *style, lv_coord_t value)
void lv_style_set_bg_img_src(lv_style_t *style, const void *value)
void lv_style_set_bg_img_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_bg_img_recolor(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_img_recolor_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_bg_img_recolor_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_bg_img_tiled(lv_style_t *style, bool value)
void lv_style_set_border_color(lv_style_t *style, lv_color_t value)
void lv_style_set_border_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_border_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_border_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_border_side(lv_style_t *style, lv_border_side_t value)
void lv_style_set_border_post(lv_style_t *style, bool value)
void lv_style_set_text_color(lv_style_t *style, lv_color_t value)
void lv_style_set_text_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_text_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_text_font(lv_style_t *style, const lv_font_t *value)
void lv_style_set_text_letter_space(lv_style_t *style, lv_coord_t value)
void lv_style_set_text_line_space(lv_style_t *style, lv_coord_t value)
void lv_style_set_text_decor(lv_style_t *style, lv_text_decor_t value)
4.3. Styles 104

void lv_style_set_text_align(lv_style_t *style, lv_text_align_t value)
void lv_style_set_img_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_img_recolor(lv_style_t *style, lv_color_t value)
void lv_style_set_img_recolor_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_img_recolor_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_outline_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_outline_color(lv_style_t *style, lv_color_t value)
void lv_style_set_outline_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_outline_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_outline_pad(lv_style_t *style, lv_coord_t value)
void lv_style_set_shadow_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_shadow_ofs_x(lv_style_t *style, lv_coord_t value)
void lv_style_set_shadow_ofs_y(lv_style_t *style, lv_coord_t value)
void lv_style_set_shadow_spread(lv_style_t *style, lv_coord_t value)
void lv_style_set_shadow_color(lv_style_t *style, lv_color_t value)
void lv_style_set_shadow_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_shadow_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_line_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_line_dash_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_line_dash_gap(lv_style_t *style, lv_coord_t value)
void lv_style_set_line_rounded(lv_style_t *style, lv_coord_t value)
4.3. Styles 105

void lv_style_set_line_color(lv_style_t *style, lv_color_t value)
void lv_style_set_line_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_line_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_arc_width(lv_style_t *style, lv_coord_t value)
void lv_style_set_arc_rounded(lv_style_t *style, lv_coord_t value)
void lv_style_set_arc_color(lv_style_t *style, lv_color_t value)
void lv_style_set_arc_color_filtered(lv_style_t *style, lv_color_t value)
void lv_style_set_arc_opa(lv_style_t *style, lv_opa_t value)
void lv_style_set_arc_img_src(lv_style_t *style, const void *value)
4.4 Style properties
4.4.1 Size and position
TODO
width
Sets the width of object. Pixel, percentage and LV_SIZE_CONTENT values can be used. Percentage values are relative
to the width of the parent's content area.
min_width
Sets a minimal width. Pixel and percentage values can be used. Percentage values are relative to the width of the parent's
content area.
max_width
Sets a maximal width. Pixel and percentage values can be used. Percentage values are relative to the width of the parent's
content area.
4.4. Style properties 106

height
Sets the height of object. Pixel, percentage and LV_SIZE_CONTENT can be used. Percentage values are relative to the
height of the parent's content area.
min_height
Sets a minimal height. Pixel and percentage values can be used. Percentage values are relative to the width of the parent's
content area.
max_height
Sets a maximal height. Pixel and percentage values can be used. Percentage values are relative to the height of the parent's
content area.
Set the X coordinate of the object considering the set align. Pixel and percentage values can be used. Percentage values
are relative to the width of the parent's content area.
Set the Y coordinate of the object considering the set align. Pixel and percentage values can be used. Percentage values
are relative to the height of the parent's content area.
align
Set the alignment which determines from which point of the parent the X and Y coordinates should be inter-
preted. The possible values are: LV_ALIGN_TOP_LEFT/MID/RIGHT, LV_ALIGN_BOTTOM_LEFT/MID/
RIGHT, LV_ALIGN_LEFT/RIGHT_MID, LV_ALIGN_CENTER
transform_width
Make the object wider on both sides with this value. Pixel and percentage (with lv_pct(x)) values can be used.
Percentage values are relative to the object's width.
transform_height
Make the object higher on both sides with this value. Pixel and percentage (with lv_pct(x)) values can be used.
Percentage values are relative to the object's height.

translate_x
Move the object with this value in X direction. Applied after layouts, aligns and other positioning. Pixel and percentage
(with lv_pct(x)) values can be used. Percentage values are relative to the object's width.
translate_y
Move the object with this value in Y direction. Applied after layouts, aligns and other positioning. Pixel and percentage
(with lv_pct(x)) values can be used. Percentage values are relative to the object's height.
transform_zoom
Zoom image-like objects. Multiplied with the zoom set on the object. The value 256 (or LV_IMG_ZOOM_NONE) means
normal size, 128 half size, 512 double size, and so on
transform_angle
Rotate image-like objects. Added to the rotation set on the object. The value is interpreted in 0.1 degree unit. E.g. 45
deg. = 450
4.4.2 Padding
TODO
pad_top
Sets the padding on the top. It makes the content area smaller in this direction.
pad_bottom
Sets the padding on the bottom. It makes the content area smaller in this direction.
pad_left
Sets the padding on the left. It makes the content area smaller in this direction.
pad_right
Sets the padding on the right. It makes the content area smaller in this direction.

pad_row
Sets the padding between the rows. Used by the layouts.
pad_column
Sets the padding between the columns. Used by the layouts.
4.4.3 Miscellaneous
TODO
radius
Set the radius on every corner. The value is interpreted in pixel (>= 0) or LV_RADIUS_CIRCLE for max. radius
clip_corner
Enable to clip the overflowed content on the rounded corner. Can be true or false.
opa
Scale down all opacity values of the object by this factor. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully
transparent, 256, LV_OPA_100 or LV_OPA_COVER means fully covering, other values or LV_OPA_10, LV_OPA_20,
etc indicate semi-transparency.
color_filter_dsc
Mix a color to all colors of the object.
color_filter_opa
The intensity of mixing of color filter.
anim_time
The animation time in milliseconds. Its meaning is widget specific. E.g. blink time of the cursor on the text area or scroll
time of a roller. See the widgets' documentation to learn more.

anim_speed
The animation speed in pixel/sec. Its meaning is widget specific. E.g. scroll speed of label. See the widgets' documentation
to learn more.
transition
An initialized lv_style_transition_dsc_t to describe a transition.
blend_mode
Describes how to blend the colors to the background. The possible values are LV_BLEND_MODE_NORMAL/
ADDITIVE/SUBTRACTIVE
layout
Set the layout if the object. The children will be repositioned and resized according to the policies set for the layout. For
the possible values see the documentation of the layouts.
base_dir
Set the base direction of the object. The possible values are LV_BIDI_DIR_LTR/RTL/AUTO.
4.4.4 Background
TODO
bg_color
Set the background color of the object.
bg_opa
Set the opacity of the background. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256,
LV_OPA_100 or LV_OPA_COVER means fully covering, other values or LV_OPA_10, LV_OPA_20, etc indicate
semi-transparency.
bg_grad_color
Set the gradient color of the background. Used only if grad_dir is not LV_GRAD_DIR_NONE

bg_grad_dir
Set the direction of the gradient of the background. The possible values are LV_GRAD_DIR_NONE/HOR/VER.
bg_main_stop
Set the point from which the background color should start for gradients. 0 means to top/left side, 255 the bottom/right
side, 128 the center, and so on
bg_grad_stop
Set the point from which the background's gradient color should start. 0 means to top/left side, 255 the bottom/right side,
128 the center, and so on
bg_img_src
Set a background image. Can be a pointer to lv_img_dsc_t, a path to a file or an LV_SYMBOL_...
bg_img_opa
Set the opacity of the background image. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256,
semi-transparency.
bg_img_recolor
Set a color to mix to the background image.
bg_img_recolor_opa
Set the intensity of background image recoloring. Value 0, LV_OPA_0 or LV_OPA_TRANSP means no mixing, 256,
LV_OPA_100 or LV_OPA_COVER means full recoloring, other values or LV_OPA_10, LV_OPA_20, etc are inter-
preted proportionally.
bg_img_tiled
If enabled the background image will be tiled. The possible values are true or false.
4.4.5 Border
TODO

border_color
Set the color of the border
border_opa
Set the opcitiy of the border. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256, LV_OPA_100
or LV_OPA_COVER means fully covering, other values or LV_OPA_10, LV_OPA_20, etc indicate semi-transparency.
border_width
Set the width of the border. Only pixel values can be used.
border_side
Set which side(s) the border should be drawn. The possible values are LV_BORDER_SIDE_NONE/TOP/
BOTTOM/LEFT/RIGHT/INTERNAL. OR-ed calues an be used as well, e.g. LV_BORDER_SIDE_TOP |
LV_BORDER_SIDE_LEFT.
border_post
Sets wheter the border should be drawn before or after the children ar drawn. true: after children, false: before
children
4.4.6 Text
TODO
text_color
Sets the color of the text.
text_opa
Set the opacity of the text. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256, LV_OPA_100 or
LV_OPA_COVER means fully covering, other values or LV_OPA_10, LV_OPA_20, etc indicate semi-transparency.
text_font
Set the font of the text (a pointer lv_font_t *).

text_letter_space
Set the letter space in pixels
text_line_space
Set the line space in pixels.
text_decor
Set decoration for the text. The possible values are LV_TEXT_DECOR_NONE/UNDERLINE/STRIKETHROUGH.
OR-ed values can be used as well.
text_align
Set how to align the lines of the text. Note that it doesn't align the object itself, only the lines inside the object. The
possible values are LV_TEXT_ALIGN_LEFT/CENTER/RIGHT/AUTO. LV_TEXT_ALIGN_AUTO detect the text
base direction and uses left or right alignment accordingly
4.4.7 Image
TODO
img_opa
Set the opacity of an image. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256, LV_OPA_100
img_recolor
Set color to mix to the image.
img_recolor_opa
Set the intensity of the color mixing. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256,
semi-transparency.
4.4.8 Outline
TODO

outline_width
Set the width of the outline in pixels.
outline_color
Set the color of the outline.
outline_opa
Set the opacity of the outline. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256, LV_OPA_100
outline_pad
Set the padding of the outline, i.e. the gap between object and the outline.
4.4.9 Shadow
TODO
shadow_width
Set the width of the shadow in pixels. The value should be >= 0.
shadow_ofs_x
Set an offset on the shadow in pixels in X direction.
shadow_ofs_y
Set an offset on the shadow in pixels in Y direction.
shadow_spread
Make the shadow calculation to use a larger or smaller rectangle as base. The value can be in pixel to make the area
larger/smaller

shadow_color
Set the color of the shadow
shadow_opa
Set the opacity of the shadow. Value 0, LV_OPA_0 or LV_OPA_TRANSP means fully transparent, 256, LV_OPA_100
4.4.10 Line
TODO
line_width
Set the width of the lines in pixel.
line_dash_width
Set the width of dashes in pixel. Note that dash works only on horizontal and vertical lines
line_dash_gap
Set the gap between dashes in pixel. Note that dash works only on horizontal and vertical lines
line_rounded
Make the end points of the lines rounded. true: rounded, false: perpendicular line ending
line_color
Set the color fo the lines.
line_opa
Set the opacity of the lines.
4.4.11 Arc
TODO

arc_width
Set the width (thickness) of the arcs in pixel.
arc_rounded
Make the end points of the arcs rounded. true: rounded, false: perpendicular line ending
arc_color
Set the color of the arc.
arc_opa
Set the opacity of the arcs.
arc_img_src
Set an image from which the arc will be masked out. It's useful to display complex effects on the arcs. Can be a pointer
to lv_img_dsc_t or a path to a file
4.5 Scroll
4.5.1 Overview
In LVGL scrolling works very intuitively: if an object is out of its parent content area (the size without paddings), the
parent becomes scrollable and scrollbar(s) will appear. That's it.
Any object can be scrollable including lv_obj_t, lv_img, lv_btn, lv_meter, etc
The object can either be scrolled either horizontally or vertically in one stroke; diagonal scrolling is not possible.
Scrollbar
Mode
The scrollbars are displayed according to the set mode. The following modes exist:
• LV_SCROLLBAR_MODE_OFF Never show the scrollbars
• LV_SCROLLBAR_MODE_ON Always show the scrollbars
• LV_SCROLLBAR_MODE_ACTIVE Show scroll bars while object is being scrolled
• LV_SCROLLBAR_MODE_AUTO Show scroll bars when the content is large enough to be scrolled
lv_obj_set_scrollbar_mode(obj, LV_SCROLLBAR_MODE_...) set the scrollbar mode on an object.
4.5. Scroll 116

Styling
The scrollbars have their own dedicated part, called LV_PART_SCROLLBAR. For example a scrollbar can turned to red
like this:
static lv_style_t style_red;

lv_style_init(&style_red);
lv_style_set_bg_color(&style_red, lv_color_red());
...
lv_obj_add_style(obj, &style_red, LV_PART_SCROLLBAR);
The object goes to LV_STATE_SCROLLED state while it's being scrolled. It allows adding different style to the scrollbar
or the object itself when scrolled. This code makes the scrollbar blue when the object is scrolled:
static lv_style_t style_blue;

lv_style_init(&style_blue);
lv_style_set_bg_color(&style_red, lv_color_blue());
...
lv_obj_add_style(obj, &style_blue, LV_STATE_SCROLLED | LV_PART_SCROLLBAR);
Events
The following events are related to scrolling:

• LV_EVENT_SCROLL_BEGIN Scrolling begins
• LV_EVENT_SCROLL_END Scrolling ends
• LV_EVENT_SCROLL Scroll happened. Triggered on every position change. Scroll events
4.5.2 Basic example
TODO
4.5.3 Features of scrolling
Besides managing "normal" scrolling there are many interesting and useful additional features too.
Scrollable
It's possible to make an object non-scrollable with lv_obj_clear_flag(obj, LV_OBJ_FLAG_SCROLLABLE).

Non-scrollable object can still propagate the scrolling (chain) to the parents.
The direction in which scrolling can happen can be controlled by lv_obj_set_scroll_dir(obj, LV_DIR_.
..). The following values are possible for the direction:
• LV_DIR_TOP only scroll up
• LV_DIR_LEFT only scroll left
4.5. Scroll 117

• LV_DIR_BOTTOM only scroll down

• LV_DIR_RIGHT only scroll right
• LV_DIR_HOR only scroll horizontally
• LV_DIR_TOP only scroll vertically
• LV_DIR_ALL scroll any directions
OR-ed values are also possible. E.g. LV_DIR_TOP | LV_DIR_LEFT.
Scroll chain
If an object can't be scrolled further (e.g. it's content has reached the bottom most position) the scrolling is propagated
to it's parent. If the parent an be scrolled in that direction than it will be scrolled instead. It propagets to the grandparent
and grand-grandparents too.
The propagation on scrolling is called "scroll chaining" and it can be enabled/disabled with the
LV_OBJ_FLAG_SCROLL_CHAIN flag. If chaining is disabled the propagation stops on the object and the
parent(s) won't be scrolled.
Scroll momentum
When the user scrolls an object and releases it, LVGL can emulate a momentum for the scrolling. It's like the object was
thrown and scrolling slows down smoothly.
The scroll momentum can be enabled/disabled with the LV_OBJ_FLAG_SCROLL_MOMENTUM flag.
Elastic scroll
Normally the content can't be scrolled inside the object. That is the top side of the content can't be below the top side of
the object.
However, with LV_OBJ_FLAG_SCROLL_ELASTIC a fancy effect can be added when the user "over-scrolls" the con-
tent. The scrolling slows down, and the content can be scrolled inside the object. When the object is released the content
scrolled in it will be animated back to the valid position.
Snapping
The children of an object can be snapped according to specific rules when scrolling ends. Children can be made snappable
individually with the LV_OBJ_FLAG_SNAPABLE flag. (Note misspelling of the flag name: your code needs to spell it
with one P.) The object can align the snapped children in 4 ways:
• LV_SCROLL_SNAP_NONE Snapping is disabled. (default)
• LV_SCROLL_SNAP_START Align the children to the left/top side of the scrolled object
• LV_SCROLL_SNAP_END Align the children to the right/bottom side of the scrolled object
• LV_SCROLL_SNAP_CENTER Align the children to the center of the scrolled object
The alignment can be set with lv_obj_set_scroll_snap_x/y(obj, LV_SCROLL_SNAP_...):
Under the hood the following happens:
1. User scrolls an object and releases the screen
2. LVGL calculates where the scroll would end considering scroll momentum
4.5. Scroll 118

3. LVGL finds the nearest scroll point

4. LVGL scrolls to the snap point with an animation
Scroll one
The "scroll one" feature tells LVGL to allow scrolling only one snappable child at a time. So this requires to make
the children snappable (LV_OBJ_FLAG_SNAPABLE spelled with one P in code) and and set a scroll snap alignment
different from LV_SCROLL_SNAP_NONE.
This feature can be enabled by the LV_OBJ_FLAG_SCROLL_ONE flag.
Scroll on focus
Imagine that there a lot of objects in a group that are on scrollable object. Pressing the "Tab" button focuses the next
object but it might be out of the visible area of the scrollable object. If the "scroll on focus" features is enabled LVGL will
automatically scroll to the objects to bring the children into the view. The scrolling happens recursively therefore even
nested scrollable object are handled properly. The object will be scrolled to the view even if it's on a different page of a
tabview.
4.5.4 Scroll manually
The following API functions allow to manually scroll objects:

• lv_obj_scroll_by(obj, x, y, LV_ANIM_ON/OFF) scroll by x and y values
• lv_obj_scroll_to(obj, x, y, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the top
left corner
• lv_obj_scroll_to_x(obj, x, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the left side
• lv_obj_scroll_to_y(obj, y, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the left side
4.5.5 Self size
Self size is a property of an object. Normally, the user shouldn't use this parameter but if a custom widget is created it
might be useful.
In short, self size tell the size of the content. To understand it better take the example of a table. Let's say it has 10 rows
each with 50 px height. So the total height of the content is 500 px. In other words the "self height" is 500 px. If the user
sets only 200 px height for the table LVGL will see that the self size is larger and make the table scrollable.
It means not only the children can make an object scrollable but a larger self size too.
LVGL uses the LV_EVENT_GET_SELF_SIZE event to get the self size of an object. Here is an example to see how
to handle the event
if(event_code == LV_EVENT_GET_SELF_SIZE) {
lv_point_t * p = lv_event_get_param(e);
//If x or y < 0 then it doesn't neesd to be calculated now

if(p->x >= 0) {
p->x = 200; //Set or calculate the self width
}
4.5. Scroll 119


if(p->y >= 0) {
p->y = 50; //Set or calculate the self height
}
}
4.5.6 Examples
Nested scrolling
/**
* Demonstrate how scrolling appears automatically
*/
void lv_example_scroll_1(void)
{
lv_obj_t * panel = lv_obj_create(lv_scr_act());
lv_obj_set_size(panel, 200, 200);
lv_obj_center(panel);
lv_obj_t * child;
lv_obj_t * label;
child = lv_obj_create(panel);
lv_obj_set_pos(child, 0, 0);
lv_obj_set_size(child, 70, 70);
label = lv_label_create(child);
lv_label_set_text(label, "Zero");
lv_obj_t * child2 = lv_btn_create(child);

lv_obj_set_size(child2, 100, 50);
label = lv_label_create(child2);
lv_label_set_text(label, "Right");
label = lv_label_create(child);
lv_label_set_text(label, "Bottom");
}
#endif
4.5. Scroll 120

Snapping
#if LV_BUILD_EXAMPLES && LV_USE_FLEX
static void sw_event_cb(lv_event_t * e)

{
lv_obj_t * sw = lv_event_get_target(e);
if(code == LV_EVENT_VALUE_CHANGED) {
lv_obj_t * list = lv_event_get_user_data(e);
if(lv_obj_has_state(sw, LV_STATE_CHECKED)) lv_obj_add_flag(list, LV_OBJ_FLAG_

,→ SCROLL_ONE);
else lv_obj_clear_flag(list, LV_OBJ_FLAG_SCROLL_ONE);
}
}
/**
* Show an example to scroll snap
*/
{
lv_obj_t * panel = lv_obj_create(lv_scr_act());
lv_obj_set_size(panel, 280, 120);
lv_obj_set_scroll_snap_x(panel, LV_SCROLL_SNAP_CENTER);
lv_obj_set_flex_flow(panel, LV_FLEX_FLOW_ROW);
lv_obj_align(panel, LV_ALIGN_CENTER, 0, 20);
uint32_t i;
for(i = 0; i < 10; i++) {
lv_obj_t * btn = lv_btn_create(panel);
lv_obj_set_size(btn, 150, lv_pct(100));

if(i == 3) {
lv_label_set_text_fmt(label, "Panel %d\nno snap", i);
lv_obj_clear_flag(btn, LV_OBJ_FLAG_SNAPABLE);
} else {
lv_label_set_text_fmt(label, "Panel %d", i);
}
}
lv_obj_update_snap(panel, LV_ANIM_ON);
#if LV_USE_SWITCH
/*Switch between "One scroll" and "Normal scroll" mode*/
lv_obj_t * sw = lv_switch_create(lv_scr_act());
lv_obj_align(sw, LV_ALIGN_TOP_RIGHT, -20, 10);
lv_obj_add_event_cb(sw, sw_event_cb, LV_EVENT_ALL, panel);
lv_obj_t * label = lv_label_create(lv_scr_act());
lv_label_set_text(label, "One scroll");
lv_obj_align_to(label, sw, LV_ALIGN_OUT_BOTTOM_MID, 0, 5);
#endif
}
4.5. Scroll 121

#endif
Floating button
#if LV_BUILD_EXAMPLES && LV_USE_LIST
static uint32_t btn_cnt = 1;
static void float_btn_event_cb(lv_event_t * e)

{
lv_obj_t * float_btn = lv_event_get_target(e);
lv_obj_t * list = lv_event_get_user_data(e);
char buf[32];
lv_snprintf(buf, sizeof(buf), "Track %d", btn_cnt);
lv_obj_t * list_btn = lv_list_add_btn(list, LV_SYMBOL_AUDIO, buf);
btn_cnt++;
lv_obj_move_foreground(float_btn);
lv_obj_scroll_to_view(list_btn, LV_ANIM_ON);
}
}
/**
* Create a list a with a floating button
*/
{
lv_obj_t * list = lv_list_create(lv_scr_act());
lv_obj_set_size(list, 280, 220);
lv_obj_center(list);
for(btn_cnt = 1; btn_cnt <= 2; btn_cnt++) {

char buf[32];
lv_snprintf(buf, sizeof(buf), "Track %d", btn_cnt);
lv_list_add_btn(list, LV_SYMBOL_AUDIO, buf);
}
lv_obj_t * float_btn = lv_btn_create(list);

lv_obj_set_size(float_btn, 50, 50);
lv_obj_add_flag(float_btn, LV_OBJ_FLAG_FLOATING);
lv_obj_align(float_btn, LV_ALIGN_BOTTOM_RIGHT, 0, -lv_obj_get_style_pad_
,→right(list, LV_PART_MAIN));
lv_obj_add_event_cb(float_btn, float_btn_event_cb, LV_EVENT_ALL, list);

lv_obj_set_style_radius(float_btn, LV_RADIUS_CIRCLE, 0);
lv_obj_set_style_bg_img_src(float_btn, LV_SYMBOL_PLUS, 0);
lv_obj_set_style_text_font(float_btn, lv_theme_get_font_large(float_btn), 0);
}
#endif
4.5. Scroll 122

Styling the scrollbars
#if LV_BUILD_EXAMPLES && LV_USE_LIST
/**
* Styling the scrollbars
*/
{
lv_obj_set_size(obj, 200, 100);
lv_obj_center(obj);

lv_label_set_text(label,
"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
"Etiam dictum, tortor vestibulum lacinia laoreet, mi neque consectetur␣
,→neque, vel mattis odio dolor egestas ligula. \n"
"Sed vestibulum sapien nulla, id convallis ex porttitor nec. \n"

"Duis et massa eu libero accumsan faucibus a in arcu. \n"
"Ut pulvinar odio lorem, vel tempus turpis condimentum quis. Nam␣
,→consectetur condimentum sem in auctor. \n"
"Sed nisl augue, venenatis in blandit et, gravida ac tortor. \n"

"Etiam dapibus elementum suscipit. \n"
"Proin mollis sollicitudin convallis. \n"
"Integer dapibus tempus arcu nec viverra. \n"
"Donec molestie nulla enim, eu interdum velit placerat quis. \n"
"Donec id efficitur risus, at molestie turpis. \n"
"Suspendisse vestibulum consectetur nunc ut commodo. \n"
"Fusce molestie rhoncus nisi sit amet tincidunt. \n"
"Suspendisse a nunc ut magna ornare volutpat.");
/*Remove the style of scrollbar to have clean start*/

lv_obj_remove_style(obj, NULL, LV_PART_SCROLLBAR | LV_STATE_ANY);
/*Create a transition the animate the some properties on state change*/

static const lv_style_prop_t props[] = {LV_STYLE_BG_OPA, LV_STYLE_WIDTH, 0};
static lv_style_transition_dsc_t trans;
lv_style_transition_dsc_init(&trans, props, lv_anim_path_linear, 200, 0, NULL);
/*Create a style for the scrollbars*/

lv_style_set_width(&style, 4); /*Width of the scrollbar*/
lv_style_set_pad_right(&style, 5); /*Space from the parallel side*/
lv_style_set_pad_top(&style, 5); /*Space from the perpendicular side*/
lv_style_set_bg_opa(&style, LV_OPA_70);
lv_style_set_bg_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_border_color(&style, lv_palette_darken(LV_PALETTE_BLUE, 3));
lv_style_set_shadow_spread(&style, 2);
4.5. Scroll 123


lv_style_set_shadow_color(&style, lv_palette_darken(LV_PALETTE_BLUE, 1));
lv_style_set_transition(&style, &trans);
/*Make the scrollbars wider and use 100% opacity when scrolled*/
static lv_style_t style_scrolled;
lv_style_init(&style_scrolled);
lv_style_set_width(&style_scrolled, 8);
lv_style_set_bg_opa(&style_scrolled, LV_OPA_COVER);
lv_obj_add_style(obj, &style, LV_PART_SCROLLBAR);

lv_obj_add_style(obj, &style_scrolled, LV_PART_SCROLLBAR | LV_STATE_SCROLLED);
}
#endif
Right to left scrolling
#if LV_BUILD_EXAMPLES && LV_FONT_DEJAVU_16_PERSIAN_HEBREW
/**
* Scrolling with Right To Left base direction
*/
{
lv_obj_set_style_base_dir(obj, LV_BASE_DIR_RTL, 0);
lv_obj_center(obj);

lv_label_set_text(label,"‫ُکنترولر‬
‫ )به میکرو‬:‫ انگلیسی‬Microcontroller) ‫␣گونهای‬
,→‫ٔه دارای که است ریزپردازنده‬
‫( تصادفی دسترسی حافظ‬RAM) ‫ٔه و‬
‫( فقطخواندنی حافظ‬ROM)، ،‫␣تایمر‬
,→‫( خروجی و ورودی پورتهای‬I/O) ‫( ترتیبی درگاه و‬Serial Port ‫ پورت‬،(‫␣تراشه خود درون سریال‬
,→،‫ کنترل را دیگر ابزارهای تنهایی به میتواند و است‬.‫ یک دیگر عبارت به کند‬،‫␣میکروکنترلر‬
,→‫ یک از که است کوچکی مجتمع مدار‬CPU ‫ مانند دیگری اجزای و کوچک‬،‫␣و ورودی درگاههای تایمر‬
,→‫ تشکیل حافظه و دیجیتال و آنالوگ خروجی‬.‫;)"شدهاست‬
lv_obj_set_width(label, 400);
lv_obj_set_style_text_font(label, &lv_font_dejavu_16_persian_hebrew, 0);
#endif
4.5. Scroll 124

Translate on scroll
static void scroll_event_cb(lv_event_t * e)

{
lv_obj_t * cont = lv_event_get_target(e);
lv_area_t cont_a;
lv_obj_get_coords(cont, &cont_a);
lv_coord_t cont_y_center = cont_a.y1 + lv_area_get_height(&cont_a) / 2;
lv_coord_t r = lv_obj_get_height(cont) * 7 / 10;

uint32_t i;
uint32_t child_cnt = lv_obj_get_child_cnt(cont);
for(i = 0; i < child_cnt; i++) {
lv_obj_t * child = lv_obj_get_child(cont, i);
lv_area_t child_a;
lv_obj_get_coords(child, &child_a);
lv_coord_t child_y_center = child_a.y1 + lv_area_get_height(&child_a) / 2;
lv_coord_t diff_y = child_y_center - cont_y_center;

diff_y = LV_ABS(diff_y);
/*Get the x of diff_y on a circle.*/

lv_coord_t x;
/*If diff_y is out of the circle use the last point of the circle (the␣
,→radius)*/
if(diff_y >= r) {
x = r;
} else {
/*Use Pythagoras theorem to get x from radius and y*/
lv_coord_t x_sqr = r * r - diff_y * diff_y;
lv_sqrt_res_t res;
lv_sqrt(x_sqr, &res, 0x8000); /*Use lvgl's built in sqrt root function*/
x = r - res.i;
}
/*Translate the item by the calculated X coordinate*/

lv_obj_set_style_translate_x(child, x, 0);
/*Use some opacity with larger translations*/

lv_opa_t opa = lv_map(x, 0, r, LV_OPA_TRANSP, LV_OPA_COVER);
lv_obj_set_style_opa(child, LV_OPA_COVER - opa, 0);
}
}
/**
* Translate the object as they scroll
*/
{
lv_obj_t * cont = lv_obj_create(lv_scr_act());
lv_obj_set_size(cont, 200, 200);
lv_obj_center(cont);
4.5. Scroll 125


lv_obj_set_flex_flow(cont, LV_FLEX_FLOW_COLUMN);
lv_obj_add_event_cb(cont, scroll_event_cb, LV_EVENT_SCROLL, NULL);
lv_obj_set_style_radius(cont, LV_RADIUS_CIRCLE, 0);
lv_obj_set_style_clip_corner(cont, true, 0);
lv_obj_set_scroll_dir(cont, LV_DIR_VER);
lv_obj_set_scroll_snap_y(cont, LV_SCROLL_SNAP_CENTER);
lv_obj_set_scrollbar_mode(cont, LV_SCROLLBAR_MODE_OFF);
uint32_t i;
for(i = 0; i < 20; i++) {
lv_obj_t * btn = lv_btn_create(cont);
lv_obj_set_width(btn, lv_pct(100));

lv_label_set_text_fmt(label, "Button %d", i);
}
/*Update the buttons position manually for first*/

lv_event_send(cont, LV_EVENT_SCROLL, NULL);
/*Be sure the fist button is in the middle*/

lv_obj_scroll_to_view(lv_obj_get_child(cont, 0), LV_ANIM_OFF);
}
#endif
MicroPython
No examples yet.
4.6 Layers
4.6.1 Order of creation
By default, LVGL draws new objects on top of old objects.

For example, assume we added a button to a parent object named button1 and then another button named button2. Then
button1 (with its child object(s)) will be in the background and can be covered by button2 and its children.
4.6. Layers 126

/*Create a screen*/
lv_obj_t * scr = lv_obj_create(NULL, NULL);
lv_scr_load(scr); /*Load the screen*/
/*Create 2 buttons*/
lv_obj_t * btn1 = lv_btn_create(scr, NULL); /*Create a button on the screen*/
lv_btn_set_fit(btn1, true, true); /*Enable to automatically set the␣
,→size according to the content*/
lv_obj_set_pos(btn1, 60, 40); /*Set the position of the␣

,→button*/
lv_obj_t * btn2 = lv_btn_create(scr, btn1); /*Copy the first button*/

lv_obj_set_pos(btn2, 180, 80); /*Set the position of the button*/
/*Add labels to the buttons*/

lv_obj_t * label1 = lv_label_create(btn1, NULL); /*Create a label on the first␣
,→button*/
lv_label_set_text(label1, "Button 1"); /*Set the text of the label*/
lv_obj_t * label2 = lv_label_create(btn2, NULL); /*Create a label on the␣

,→second button*/
lv_label_set_text(label2, "Button 2"); /*Set the text of the␣

,→label*/
/*Delete the second label*/

lv_obj_del(label2);
4.6. Layers 127

4.6.2 Bring to the foreground
There are several ways to bring an object to the foreground:

• Use lv_obj_set_top(obj, true). If obj or any of its children is clicked, then LVGL will automatically
bring the object to the foreground. It works similarly to a typical GUI on a PC. When a window in the background
is clicked, it will come to the foreground automatically.
• Use lv_obj_move_foreground(obj) to explicitly tell the library to bring an object to the foreground.
Similarly, use lv_obj_move_background(obj) to move to the background.
• When lv_obj_set_parent(obj, new_parent) is used, obj will be on the foreground on the
new_parent.
4.6.3 Top and sys layers
LVGL uses two special layers named as layer_top and layer_sys. Both are visible and common on all screens of
a display. They are not, however, shared among multiple physical displays. The layer_top is always on top of
the default screen (lv_scr_act()), and layer_sys is on top of layer_top.
The layer_top can be used by the user to create some content visible everywhere. For example, a menu bar, a pop-up,
etc. If the click attribute is enabled, then layer_top will absorb all user click and acts as a modal.
lv_obj_set_click(lv_layer_top(), true);
The layer_sys is also used for similar purposes on LVGL. For example, it places the mouse cursor above all layers to
be sure it's always visible.
4.7 Events
Events are triggered in LVGL when something happens which might be interesting to the user, e.g. when an object
• is clicked
• is scrolled
• has its value changed
• is redrawn, etc.
4.7.1 Add events to the object
The user can assign callback functions to an object to see its events. In practice, it looks like this:

lv_obj_add_event_cb(btn, my_event_cb, LV_EVENT_CLICKED, NULL); /*Assign an event␣
,→callback*/
...
static void my_event_cb(lv_event_t * event)

{
printf("Clicked\n");
}
4.7. Events 128

In the example LV_EVENT_CLICKED means that only the click event will call my_event_cb. See the list of event
codes for all the options. LV_EVENT_ALL can be used to receive all the events.
The last parameter of lv_obj_add_event_cb is a pointer to any custom data that will be available in the event. It
will be described later in more detail.
More events can be added to an object, like this:
lv_obj_add_event_cb(obj, my_event_cb_1, LV_EVENT_CLICKED, NULL);

lv_obj_add_event_cb(obj, my_event_cb_2, LV_EVENT_PRESSED, NULL);
lv_obj_add_event_cb(obj, my_event_cb_3, LV_EVENT_ALL, NULL); /*No␣
,→filtering, receive all events*/
Even the same event callback can be used on an object with different user_data. For example:
lv_obj_add_event_cb(obj, increment_on_click, LV_EVENT_CLICKED, &num1);

lv_obj_add_event_cb(obj, increment_on_click, LV_EVENT_CLICKED, &num2);
The events will be called in the order as they were added.

More objects can use the same event callback.
4.7.2 Remove event(s) from an object
Events can be removed from an object with the lv_obj_remove_event_cb(obj, event_cb) func-
tion or lv_obj_remove_event_dsc(obj, event_dsc). event_dsc is a pointer returned by
lv_obj_add_event_cb.
4.7.3 Event codes
The event codes can be grouped into these categories:

• Input device events
• Drawing events
• Other events
• Special events
• Custom events
All objects (such as Buttons/Labels/Sliders etc.) regardless their type receive the Input device, Drawing and Other events.
However the Special events are specific to a particular widget type. See the widgets' documentation to learn when they are
sent,
Custom events are added by the user and therefore these are never sent by LVGL.
The following event codes exist:
4.7. Events 129

Input device events
• LV_EVENT_PRESSED The object has been pressed

• LV_EVENT_PRESSING The object is being pressed (called continuously while pressing)
• LV_EVENT_PRESS_LOST The object is still being pressed but slid cursor/finger off of the object
• LV_EVENT_SHORT_CLICKED The object was pressed for a short period of time, then released it. Not called if
scrolled.
• LV_EVENT_LONG_PRESSED Object has been pressed for at least the long_press_time specified in the
input device driver. Not called if scrolled.
• LV_EVENT_LONG_PRESSED_REPEAT Called after long_press_time in every
long_press_repeat_time ms. Not called if scrolled.
• LV_EVENT_CLICKED Called on release if the object did not scroll (regardless of long press)
• LV_EVENT_RELEASED Called in every case when the object has been released
• LV_EVENT_SCROLL_BEGIN Scrolling begins. The event paramter is NULL or an lv_anim_t * with the
scroll animation descriptor to modify if required.
• LV_EVENT_SCROLL_END Scrolling ends.
• LV_EVENT_SCROLL The object was scrolled
• LV_EVENT_GESTURE A gesture is detected. Get the gesture with
lv_indev_get_gesture_dir(lv_indev_get_act());
• LV_EVENT_KEY A key is sent to the object. Get the key with
lv_indev_get_key(lv_indev_get_act());
• LV_EVENT_FOCUSED The object is focused
• LV_EVENT_DEFOCUSED The object is defocused
• LV_EVENT_LEAVE The object is defocused but still selected
• LV_EVENT_HIT_TEST Perform advanced hit-testing. Use lv_hit_test_info_t * a =
lv_event_get_hit_test_info(e) and check if a->point can click the object or not. If not set a-
>res = false
Drawing events
• LV_EVENT_COVER_CHECK Check if the object fully covers an area. The event parameter is
lv_cover_check_info_t *.
• LV_EVENT_REFR_EXT_DRAW_SIZE Get the required extra draw area around the object (e.g. for shadow).
The event parameter is lv_coord_t * to store the size. Overwrite it only with a larger value.
• LV_EVENT_DRAW_MAIN_BEGIN Starting the main drawing phase.
• LV_EVENT_DRAW_MAIN Perform the main drawing
• LV_EVENT_DRAW_MAIN_END Finishing the main drawing phase
• LV_EVENT_DRAW_POST_BEGIN Starting the post draw phase (when all children are drawn)
• LV_EVENT_DRAW_POST Perform the post draw phase (when all children are drawn)
• LV_EVENT_DRAW_POST_END Finishing the post draw phase (when all children are drawn)
4.7. Events 130

• LV_EVENT_DRAW_PART_BEGIN Starting to draw a part. The event parameter is lv_obj_draw_dsc_t *.

Learn more here.
• LV_EVENT_DRAW_PART_END Finishing to draw a part. The event parameter is lv_obj_draw_dsc_t *.
Learn more here.
Other events
• LV_EVENT_DELETE Object is being deleted

• LV_EVENT_CHILD_CHANGED Child was removed/added
• LV_EVENT_SIZE_CHANGED Object coordinates/size have changed
• LV_EVENT_STYLE_CHANGED Object's style has changed
• LV_EVENT_BASE_DIR_CHANGED The base dir has changed
• LV_EVENT_GET_SELF_SIZE Get the internal size of a widget
Special events
• LV_EVENT_VALUE_CHANGED The object's value has changed (i.e. slider moved)

• LV_EVENT_INSERT A text is being inserted to the object. The event data is char * being inserted.
• LV_EVENT_REFRESH Notify the object to refresh something on it (for the user)
• LV_EVENT_READY A process has finished
• LV_EVENT_CANCEL A process has been canceled
Custom events
Any custom event codes can be registered by uint32_t MY_EVENT_1 = lv_event_register_id();

And can be sent to any object with lv_event_send(obj, MY_EVENT_1, &some_data)
4.7.4 Sending events
To manually send events to an object, use lv_event_send(obj, <EVENT_CODE> &some_data).

For example, this can be used to manually close a message box by simulating a button press (although there are simpler
ways to do this):
/*Simulate the press of the first button (indexes start from zero)*/
uint32_t btn_id = 0;
lv_event_send(mbox, LV_EVENT_VALUE_CHANGED, &btn_id);
4.7. Events 131

Refresh event
LV_EVENT_REFRESH is special event because it's designed to be used by the user to notify an object to refresh itself.
Some examples:
• notify a label to refresh its text according to one or more variables (e.g. current time)
• refresh a label when the language changes
• enable a button if some conditions are met (e.g. the correct PIN is entered)
• add/remove styles to/from an object if a limit is exceeded, etc
4.7.5 Fields of lv_event_t
lv_event_t is the only parameter passed to event callback and it contains all the data about the event. The following
values can be gotten from it:
• lv_event_get_code(e) get the event code
• lv_event_get_target(e) get the object to which the event is sent
• lv_event_get_original_target(e) get the object to which the event is sent originally sent (different
from lv_event_get_target if event bubbling is enabled)
• lv_event_get_user_data(e) get the pointer passed as the last parameter of lv_obj_add_event_cb.
• lv_event_get_param(e) get the parameter passed as the last parameter of lv_event_send
4.7.6 Event bubbling
If lv_obj_add_flag(obj, LV_OBJ_FLAG_EVENT_BUBBLE) is enabled all events will be sent to the object's

parent too. If the parent also has LV_OBJ_FLAG_EVENT_BUBBLE enabled the event will be sent to its parent too, and
so on.
The target parameter of the event is always the current target object, not the original object. To get the original target call
lv_event_get_original_target(e) in the event handler.
4.7.7 Examples
Button click event
#if LV_BUILD_EXAMPLES && LV_USE_SWITCH
static void event_cb(lv_event_t * e)

{
LV_LOG_USER("Clicked");

lv_obj_t * btn = lv_event_get_target(e);
lv_obj_t * label = lv_obj_get_child(btn, 0);
lv_label_set_text_fmt(label, "%d", cnt);
4.7. Events 132


cnt++;
}
/**
* Add click event to a button
*/
void lv_example_event_1(void)
{
lv_obj_center(btn);
lv_obj_add_event_cb(btn, event_cb, LV_EVENT_CLICKED, NULL);

lv_label_set_text(label, "Click me!");
}
#endif
Handle multiple events

{
lv_obj_t * label = lv_event_get_user_data(e);
switch(code) {
case LV_EVENT_PRESSED:
lv_label_set_text(label, "The last button event:\nLV_EVENT_PRESSED");
break;
case LV_EVENT_CLICKED:
lv_label_set_text(label, "The last button event:\nLV_EVENT_CLICKED");
break;
case LV_EVENT_LONG_PRESSED:
lv_label_set_text(label, "The last button event:\nLV_EVENT_LONG_PRESSED");
break;
case LV_EVENT_LONG_PRESSED_REPEAT:
lv_label_set_text(label, "The last button event:\nLV_EVENT_LONG_PRESSED_REPEAT
,→");
break;
default:
break;
}
}
/**
* Handle multiple events
*/
{
4.7. Events 133


lv_obj_center(btn);
lv_obj_t * btn_label = lv_label_create(btn);

lv_label_set_text(btn_label, "Click me!");
lv_obj_center(btn_label);
lv_obj_t * info_label = lv_label_create(lv_scr_act());

lv_label_set_text(info_label, "The last button event:\nNone");
lv_obj_add_event_cb(btn, event_cb, LV_EVENT_ALL, info_label);

}
#endif
Event bubbling
#if LV_BUILD_EXAMPLES && LV_USE_FLEX

{
/*The original target of the event. Can be the buttons or the container*/
lv_obj_t * target = lv_event_get_target(e);
/*The current target is always the container as the event is added to it*/
lv_obj_t * cont = lv_event_get_current_target(e);
/*If container was clicked do nothing*/

if(target == cont) return;
/*Make the clicked buttons red*/

lv_obj_set_style_bg_color(target, lv_palette_main(LV_PALETTE_RED), 0);
}
/**
* Demonstrate event bubbling
*/
{

lv_obj_set_flex_flow(cont, LV_FLEX_FLOW_ROW_WRAP);
uint32_t i;
for(i = 0; i < 30; i++) {
lv_obj_t * btn = lv_btn_create(cont);
lv_obj_add_flag(btn, LV_OBJ_FLAG_EVENT_BUBBLE);

4.7. Events 134


lv_label_set_text_fmt(label, "%d", i);
}
lv_obj_add_event_cb(cont, event_cb, LV_EVENT_CLICKED, NULL);

}
#endif
MicroPython
No examples yet.
4.8 Input devices
An input device usually means:

• Pointer-like input device like touchpad or mouse
• Keypads like a normal keyboard or simple numeric keypad
• Encoders with left/right turn and push options
• External hardware buttons which are assigned to specific points on the screen
Important: Before reading further, please read the [Porting](/porting/indev) section of Input devices
4.8.1 Pointers
Pointer input devices (like a mouse) can have a cursor.
...
lv_indev_t * mouse_indev = lv_indev_drv_register(&indev_drv);
LV_IMG_DECLARE(mouse_cursor_icon); /*Declare the image file.

,→*/
lv_obj_t * cursor_obj = lv_img_create(lv_scr_act(), NULL); /*Create an image object␣

,→for the cursor */
lv_img_set_src(cursor_obj, &mouse_cursor_icon); /*Set the image source*/

lv_indev_set_cursor(mouse_indev, cursor_obj); /*Connect the image ␣
,→object to the driver*/
Note that the cursor object should have lv_obj_set_click(cursor_obj, false). For images, clicking is
disabled by default.
4.8. Input devices 135

4.8.2 Keypad and encoder
You can fully control the user interface without touchpad or mouse using a keypad or encoder(s). It works similar to the
TAB key on the PC to select the element in an application or a web page.
Groups
The objects, you want to control with keypad or encoder, needs to be added to a Group. In every group, there is exactly
one focused object which receives the pressed keys or the encoder actions. For example, if a Text area is focused and you
press some letter on a keyboard, the keys will be sent and inserted into the text area. Similarly, if a Slider is focused and
you press the left or right arrows, the slider's value will be changed.
You need to associate an input device with a group. An input device can send the keys to only one group but, a group can
receive data from more than one input device too.
To create a group use lv_group_t * g = lv_group_create() and to add an object to the group use
lv_group_add_obj(g, obj).
To associate a group with an input device use lv_indev_set_group(indev, g), where indev is the return
value of lv_indev_drv_register()
Keys
There are some predefined keys which have special meaning:

• LV_KEY_NEXT Focus on the next object
• LV_KEY_PREV Focus on the previous object
• LV_KEY_ENTER Triggers LV_EVENT_PRESSED/CLICKED/LONG_PRESSED etc. events
• LV_KEY_UP Increase value or move upwards
• LV_KEY_DOWN Decrease value or move downwards
• LV_KEY_RIGHT Increase value or move the the right
• LV_KEY_LEFT Decrease value or move the the left
• LV_KEY_ESC Close or exit (E.g. close a Drop down list)
• LV_KEY_DEL Delete (E.g. a character on the right in a Text area)
• LV_KEY_BACKSPACE Delete a character on the left (E.g. in a Text area)
• LV_KEY_HOME Go to the beginning/top (E.g. in a Text area)
• LV_KEY_END Go to the end (E.g. in a Text area))
The most important special keys are LV_KEY_NEXT/PREV, LV_KEY_ENTER and LV_KEY_UP/DOWN/LEFT/
RIGHT. In your read_cb function, you should translate some of your keys to these special keys to navigate in the
group and interact with the selected object.
Usually, it's enough to use only LV_KEY_LEFT/RIGHT because most of the objects can be fully controlled with them.
With an encoder, you should use only LV_KEY_LEFT, LV_KEY_RIGHT, and LV_KEY_ENTER.

Edit and navigate mode
Since a keypad has plenty of keys, it's easy to navigate between the objects and edit them using the keypad. But the
encoders have a limited number of "keys" and hence it is difficult to navigate using the default options. Navigate and Edit
are created to avoid this problem with the encoders.
In Navigate mode, the encoders LV_KEY_LEFT/RIGHT is translated to LV_KEY_NEXT/PREV. Therefore the next
or previous object will be selected by turning the encoder. Pressing LV_KEY_ENTER will change to Edit mode.
In Edit mode, LV_KEY_NEXT/PREV is usually used to edit the object. Depending on the object's type, a short or long
press of LV_KEY_ENTER changes back to Navigate mode. Usually, an object which can not be pressed (like a Slider)
leaves Edit mode on short click. But with objects where short click has meaning (e.g. Button), a long press is required.
Default group
Interactive widgets - such as buttons, checkboxes, sliders, etc - can be automatically added to a default group.
Just create a group with lv_group_t * g = lv_group_create(); and set the default group with
lv_group_set_default(g);
Don't forget to assign the input device(s) to the default group with lv_indev_set_group(my_indev, g);.
Styling
If an object is focused either by clicking it via touchpad, or focused via an encoder or keypad it goes to
LV_STATE_FOCUSED. Hence focused styles will be applied on it.
If the object goes to edit mode it goes to LV_STATE_FOCUSED | LV_STATE_EDITED state so these style properties
will be shown.
For a more detaild description read the Style section.
4.8.3 API
Input device
Functions
void lv_indev_read_timer_cb(lv_timer_t *timer)

Called periodically to read the input devices
Parameters param -- pointer to and input device to read
void lv_indev_enable(lv_indev_t *indev, bool en)
lv_indev_t *lv_indev_get_act(void)
Get the currently processed input device. Can be used in action functions too.
Returns pointer to the currently processed input device or NULL if no input device processing right
now
lv_indev_type_t lv_indev_get_type(const lv_indev_t *indev)
Get the type of an input device
Parameters indev -- pointer to an input device
Returns the type of the input device from lv_hal_indev_type_t (LV_INDEV_TYPE_...)

void lv_indev_reset(lv_indev_t *indev, lv_obj_t *obj)

Reset one or all input devices
Parameters
• indev -- pointer to an input device to reset or NULL to reset all of them
• obj -- pointer to an object which triggers the reset.
void lv_indev_reset_long_press(lv_indev_t *indev)
Reset the long press state of an input device
void lv_indev_set_cursor(lv_indev_t *indev, lv_obj_t *cur_obj)
Set a cursor for a pointer input device (for LV_INPUT_TYPE_POINTER and LV_INPUT_TYPE_BUTTON)
Parameters
• cur_obj -- pointer to an object to be used as cursor
void lv_indev_set_group(lv_indev_t *indev, lv_group_t *group)
Set a destination group for a keypad input device (for LV_INDEV_TYPE_KEYPAD)
Parameters
• group -- point to a group
void lv_indev_set_button_points(lv_indev_t *indev, const lv_point_t points[])
Set the an array of points for LV_INDEV_TYPE_BUTTON. These points will be assigned to the buttons to press
a specific point on the screen
Parameters
• group -- point to a group
void lv_indev_get_point(const lv_indev_t *indev, lv_point_t *point)
Get the last point of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Parameters
• point -- pointer to a point to store the result
lv_dir_t lv_indev_get_gesture_dir(const lv_indev_t *indev)
Get the current gesture direct
Returns current gesture direct
uint32_t lv_indev_get_key(const lv_indev_t *indev)
Get the last pressed key of an input device (for LV_INDEV_TYPE_KEYPAD)
Returns the last pressed key (0 on error)
lv_dir_t lv_indev_get_scroll_dir(const lv_indev_t *indev)
Check the current scroll direction of an input device (for LV_INDEV_TYPE_POINTER and
LV_INDEV_TYPE_BUTTON)


Returns LV_DIR_NONE: no scrolling now LV_DIR_HOR/VER
lv_obj_t *lv_indev_get_scroll_obj(const lv_indev_t *indev)
Get the currently scrolled object (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Returns pointer to the currently scrolled object or NULL if no scrolling by this indev
void lv_indev_get_vect(const lv_indev_t *indev, lv_point_t *point)
Get the movement vector of an input device (for LV_INDEV_TYPE_POINTER and
LV_INDEV_TYPE_BUTTON)
Parameters
• point -- pointer to a point to store the types.pointer.vector
void lv_indev_wait_release(lv_indev_t *indev)
Do nothing until the next release
lv_obj_t *lv_indev_get_obj_act(void)
Gets a pointer to the currently active object in the currently processed input device.
Returns pointer to currently active object or NULL if no active object
lv_timer_t *lv_indev_get_read_timer(lv_disp_t *indev)
Get a pointer to the indev read timer to modify its parameters with lv_timer_... functions.
Returns pointer to the indev read refresher timer. (NULL on error)
lv_obj_t *lv_indev_search_obj(lv_obj_t *obj, lv_point_t *point)
Search the most top, clickable object by a point
Parameters
• obj -- pointer to a start object, typically the screen
• point -- pointer to a point for searching the most top child
Returns pointer to the found object or NULL if there was no suitable object
Groups
Typedefs
typedef uint8_t lv_key_t

typedef void (*lv_group_focus_cb_t)(struct _lv_group_t*)
typedef struct _lv_group_t lv_group_t
Groups can be used to logically hold objects so that they can be individually focused. They are NOT for laying out
objects on a screen (try lv_cont for that).

Enums
enum [anonymous]
Values:
enumerator LV_KEY_UP
enumerator LV_KEY_DOWN
enumerator LV_KEY_RIGHT
enumerator LV_KEY_LEFT
enumerator LV_KEY_ESC
enumerator LV_KEY_DEL
enumerator LV_KEY_BACKSPACE
enumerator LV_KEY_ENTER
enumerator LV_KEY_NEXT
enumerator LV_KEY_PREV
enumerator LV_KEY_HOME
enumerator LV_KEY_END
enum lv_group_refocus_policy_t
Values:
enumerator LV_GROUP_REFOCUS_POLICY_NEXT
enumerator LV_GROUP_REFOCUS_POLICY_PREV
Functions
void _lv_group_init(void)
Init. the group module
Remark Internal function, do not call directly.
lv_group_t *lv_group_create(void)
Create a new object group
Returns pointer to the new object group
void lv_group_del(lv_group_t *group)
Delete a group object
Parameters group -- pointer to a group
void lv_group_set_default(lv_group_t *group)
Set a default group. New object are added to this group if it's enabled in their class with add_to_def_group
= true
Parameters group -- pointer to a group (can be NULL)
lv_group_t *lv_group_get_default(void)
Get the default group
Returns pointer to the default group

void lv_group_add_obj(lv_group_t *group, struct _lv_obj_t *obj)

Add an object to a group
Parameters
• group -- pointer to a group
• obj -- pointer to an object to add
void lv_group_remove_obj(struct _lv_obj_t *obj)
Remove an object from its group
Parameters obj -- pointer to an object to remove
void lv_group_remove_all_objs(lv_group_t *group)
Remove all objects from a group
void lv_group_focus_obj(struct _lv_obj_t *obj)
Focus on an object (defocus the current)
Parameters obj -- pointer to an object to focus on
void lv_group_focus_next(lv_group_t *group)
Focus the next object in a group (defocus the current)
void lv_group_focus_prev(lv_group_t *group)
Focus the previous object in a group (defocus the current)
void lv_group_focus_freeze(lv_group_t *group, bool en)
Do not let to change the focus from the current object
Parameters
• en -- true: freeze, false: release freezing (normal mode)
lv_res_t lv_group_send_data(lv_group_t *group, uint32_t c)
Send a control character to the focuses object of a group
Parameters
• c -- a character (use LV_KEY_.. to navigate)
Returns result of focused object in group.
void lv_group_set_focus_cb(lv_group_t *group, lv_group_focus_cb_t focus_cb)
Set a function for a group which will be called when a new object is focused
Parameters
• focus_cb -- the call back function or NULL if unused
void lv_group_set_refocus_policy(lv_group_t *group, lv_group_refocus_policy_t policy)
Set whether the next or previous item in a group is focused if the currently focused obj is deleted.
Parameters


• policy -- new refocus policy enum
void lv_group_set_editing(lv_group_t *group, bool edit)
Manually set the current mode (edit or navigate).
Parameters
• group -- pointer to group
• edit -- true: edit mode; false: navigate mode
void lv_group_set_wrap(lv_group_t *group, bool en)
Set whether focus next/prev will allow wrapping from first->last or last->first object.
Parameters
• en -- true: wrapping enabled; false: wrapping disabled
struct _lv_obj_t *lv_group_get_focused(const lv_group_t *group)
Get the focused object or NULL if there isn't one
Returns pointer to the focused object
lv_group_focus_cb_t lv_group_get_focus_cb(const lv_group_t *group)
Get the focus callback function of a group
Returns the call back function or NULL if not set
bool lv_group_get_editing(const lv_group_t *group)
Get the current mode (edit or navigate).
Parameters group -- pointer to group
Returns true: edit mode; false: navigate mode
bool lv_group_get_wrap(lv_group_t *group)
Get whether focus next/prev will allow wrapping from first->last or last->first object.
Parameters
• en -- true: wrapping enabled; false: wrapping disabled
uint32_t lv_group_get_obj_count(lv_group_t *group)
Get the number of object in the group
Returns number of objects in the group
struct _lv_group_t
#include <lv_group.h> Groups can be used to logically hold objects so that they can be individually focused. They
are NOT for laying out objects on a screen (try lv_cont for that).

Public Members
lv_ll_t obj_ll
Linked list to store the objects in the group
struct _lv_obj_t **obj_focus

The object in focus
lv_group_focus_cb_t focus_cb
A function to call when a new object is focused (optional)
void *user_data
uint8_t frozen
1: can't focus to new object
uint8_t editing
1: Edit mode, 0: Navigate mode
uint8_t refocus_policy
1: Focus prev if focused on deletion. 0: Focus next if focused on deletion.
uint8_t wrap
1: Focus next/prev can wrap at end of list. 0: Focus next/prev stops at end of list.
4.9 Displays
Important: The basic concept of display in LVGL is explained in the [Porting](/porting/display) section. So before
reading further, please read the [Porting](/porting/display) section first.
4.9.1 Multiple display support
In LVGL, you can have multiple displays, each with their own driver and objects. The only limitation is that every display
needs to be have same color depth (as defined in LV_COLOR_DEPTH). If the displays are different in this regard the
rendered image can be converted to the correct format in the drivers flush_cb.
Creating more displays is easy: just initialize more display buffers and register another driver for every display. When
you create the UI, use lv_disp_set_default(disp) to tell the library on which display to create objects.
Why would you want multi-display support? Here are some examples:
• Have a "normal" TFT display with local UI and create "virtual" screens on VNC on demand. (You need to add
your VNC driver).
• Have a large TFT display and a small monochrome display.
• Have some smaller and simple displays in a large instrument or technology.
• Have two large TFT displays: one for a customer and one for the shop assistant.
4.9. Displays 143

Using only one display
Using more displays can be useful but in most cases it's not required. Therefore, the whole concept of multi-display is
completely hidden if you register only one display. By default, the lastly created (and only) display is used.
lv_scr_act(), lv_scr_load(scr), lv_layer_top(), lv_layer_sys(), LV_HOR_RES and
LV_VER_RES are always applied on the most recently created (default) screen. If you pass NULL as disp parameter
to display related function, usually the default display will be used. E.g. lv_disp_trig_activity(NULL) will
trigger a user activity on the default screen. (See below in Inactivity).
Mirror display
To mirror the image of the display to another display, you don't need to use the multi-display support. Just transfer the
buffer received in drv.flush_cb to the other display too.
Split image
You can create a larger display from smaller ones. You can create it as below:
1. Set the resolution of the displays to the large display's resolution.
2. In drv.flush_cb, truncate and modify the area parameter for each display.
3. Send the buffer's content to each display with the truncated area.
4.9.2 Screens
Every display has each set of Screens and the object on the screens.
Be sure not to confuse displays and screens:
• Displays are the physical hardware drawing the pixels.
• Screens are the high-level root objects associated with a particular display. One display can have multiple screens
associated with it, but not vice versa.
Screens can be considered the highest level containers which have no parent. The screen's size is always equal to its
display and size their position is (0;0). Therefore, the screens coordinates can't be changed, i.e. lv_obj_set_pos(),
lv_obj_set_size() or similar functions can't be used on screens.
A screen can be created from any object type but the two most typical types are the Base object and the Image (to create
a wallpaper).
To create a screen, use lv_obj_t * scr = lv_<type>_create(NULL, copy). copy can be an other
screen to copy it.
To load a screen, use lv_scr_load(scr). To get the active screen, use lv_scr_act(). These functions works
on the default display. If you want to to specify which display to work on, use lv_disp_get_scr_act(disp) and
lv_disp_load_scr(disp, scr). Screen can be loaded with animations too. Read more here.
Screens can be deleted with lv_obj_del(scr), but ensure that you do not delete the currently loaded screen.
4.9. Displays 144

Transparent screens
Usually, the opacity of the screen is LV_OPA_COVER to provide a solid background for its children. If it's not the case
(opacity < 100%) the display's background color or image will be visible. See the Display background section for more
details. If the display's background opacity is also not LV_OPA_COVER LVGL has no solid background to draw.
This configuration (transparent screen and display) could be used to create for example OSD menus where a video is
played on a lower layer, and a menu is overlayed on an upper layer.
To handle transparent displays special (slower) color mixing algorithms need to be used by LVGL so this feature needs
to enabled with LV_COLOR_SCREEN_TRANSP in lv_conf.h. As this mode operates on the Alpha channel of the
pixels LV_COLOR_DEPTH = 32 is also required. The Alpha channel of 32-bit colors will be 0 where there are no
objects and 255 where there are solid objects.
In summary, to enable transparent screen and displays to create OSD menu-like UIs:
• Enable LV_COLOR_SCREEN_TRANSP in lv_conf.h
• Be sure to use LV_COLOR_DEPTH 32
• Set the screens opacity to LV_OPA_TRANSP e.g. with lv_obj_set_style_local_bg_opa(lv_scr_act(),
LV_OBJMASK_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_TRANSP)
• Set the display opacity to LV_OPA_TRANSP with lv_disp_set_bg_opa(NULL, LV_OPA_TRANSP);
4.9.3 Features of displays
Inactivity
The user's inactivity is measured on each display. Every use of an Input device (if associated with the display) counts as
an activity. To get time elapsed since the last activity, use lv_disp_get_inactive_time(disp). If NULL is
passed, the overall smallest inactivity time will be returned from all displays (not the default display).
You can manually trigger an activity using lv_disp_trig_activity(disp). If disp is NULL, the default screen
will be used (and not all displays).
Background
Every display has background color, a background image and background opacity properties. They become visible when
the current screen is transparent or not positioned to cover the whole display.
Background color is a simple color to fill the display. It can be adjusted with lv_disp_set_bg_color(disp,
color);
Background image is a path to a file or a pointer to an lv_img_dsc_t variable (converted image) to be used as
wallpaper. It can be set with lv_disp_set_bg_color(disp, &my_img); If the background image is set (not
NULL) the background won't be filled with bg_color.
The opacity of the background color or image can be adjusted with lv_disp_set_bg_opa(disp, opa).
The disp parameter of these functions can be NULL to refer it to the default display.
4.9. Displays 145

4.9.4 API
Enums
enum lv_scr_load_anim_t
Values:
enumerator LV_SCR_LOAD_ANIM_NONE
enumerator LV_SCR_LOAD_ANIM_OVER_LEFT
enumerator LV_SCR_LOAD_ANIM_OVER_RIGHT
enumerator LV_SCR_LOAD_ANIM_OVER_TOP
enumerator LV_SCR_LOAD_ANIM_OVER_BOTTOM
enumerator LV_SCR_LOAD_ANIM_MOVE_LEFT
enumerator LV_SCR_LOAD_ANIM_MOVE_RIGHT
enumerator LV_SCR_LOAD_ANIM_MOVE_TOP
enumerator LV_SCR_LOAD_ANIM_MOVE_BOTTOM
enumerator LV_SCR_LOAD_ANIM_FADE_ON
Functions
lv_obj_t *lv_disp_get_scr_act(lv_disp_t *disp)

Return with a pointer to the active screen
Parameters disp -- pointer to display which active screen should be get. (NULL to use the default
screen)
Returns pointer to the active screen object (loaded by 'lv_scr_load()')
lv_obj_t *lv_disp_get_scr_prev(lv_disp_t *disp)
Return with a pointer to the previous screen. Only used during screen transitions.
Parameters disp -- pointer to display which previous screen should be get. (NULL to use the default
screen)
Returns pointer to the previous screen object or NULL if not used now
void lv_disp_load_scr(lv_obj_t *scr)
Make a screen active
Parameters scr -- pointer to a screen
lv_obj_t *lv_disp_get_layer_top(lv_disp_t *disp)
Return with the top layer. (Same on every screen and it is above the normal screen layer)
Parameters disp -- pointer to display which top layer should be get. (NULL to use the default screen)
Returns pointer to the top layer object (transparent screen sized lv_obj)
lv_obj_t *lv_disp_get_layer_sys(lv_disp_t *disp)
Return with the sys. layer. (Same on every screen and it is above the normal screen and the top layer)
Parameters disp -- pointer to display which sys. layer should be get. (NULL to use the default
screen)
4.9. Displays 146

Returns pointer to the sys layer object (transparent screen sized lv_obj)
void lv_disp_set_theme(lv_disp_t *disp, lv_theme_t *th)
Get the theme of a display
Returns the display's theme (can be NULL)
lv_theme_t *lv_disp_get_theme(lv_disp_t *disp)
Get the theme of a display
Returns the display's theme (can be NULL)
void lv_disp_set_bg_color(lv_disp_t *disp, lv_color_t color)
Set the background color of a display
Parameters
• disp -- pointer to a display
• color -- color of the background
void lv_disp_set_bg_image(lv_disp_t *disp, const void *img_src)
Set the background image of a display
Parameters
• img_src -- path to file or pointer to an lv_img_dsc_t variable
void lv_disp_set_bg_opa(lv_disp_t *disp, lv_opa_t opa)
Opacity of the background
Parameters
• opa -- opacity (0..255)
void lv_scr_load_anim(lv_obj_t *scr, lv_scr_load_anim_t anim_type, uint32_t time, uint32_t delay, bool
auto_del)
Switch screen with animation
Parameters
• scr -- pointer to the new screen to load
• anim_type -- type of the animation from lv_scr_load_anim_t. E.g.
LV_SCR_LOAD_ANIM_MOVE_LEFT
• time -- time of the animation
• delay -- delay before the transition
• auto_del -- true: automatically delete the old screen
uint32_t lv_disp_get_inactive_time(const lv_disp_t *disp)
Get elapsed time since last user activity on a display (e.g. click)
Parameters disp -- pointer to an display (NULL to get the overall smallest inactivity)
Returns elapsed ticks (milliseconds) since the last activity
4.9. Displays 147

void lv_disp_trig_activity(lv_disp_t *disp)

Manually trigger an activity on a display
Parameters disp -- pointer to an display (NULL to use the default display)
void lv_disp_clean_dcache(lv_disp_t *disp)
Clean any CPU cache that is related to the display.
Parameters disp -- pointer to an display (NULL to use the default display)
lv_timer_t *_lv_disp_get_refr_timer(lv_disp_t *disp)
Get a pointer to the screen refresher timer to modify its parameters with lv_timer_... functions.
Returns pointer to the display refresher timer. (NULL on error)
static inline lv_obj_t *lv_scr_act(void)
Get the active screen of the default display
Returns pointer to the active screen
static inline lv_obj_t *lv_layer_top(void)
Get the top layer of the default display
Returns pointer to the top layer
static inline lv_obj_t *lv_layer_sys(void)
Get the active screen of the default display
Returns pointer to the sys layer
static inline void lv_scr_load(lv_obj_t *scr)
static inline lv_coord_t lv_dpx(lv_coord_t n)

Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the default
display. It ensures that e.g. lv_dpx(100) will have the same physical size regardless to the DPI of the display.
Parameters n -- the number of pixels to scale
Returns n x current_dpi/160
static inline lv_coord_t lv_disp_dpx(const lv_disp_t *disp, lv_coord_t n)
Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the given
Parameters
• obj -- an display whose dpi should be considered
• n -- the number of pixels to scale
4.9. Displays 148

4.10 Colors
The color module handles all color-related functions like changing color depth, creating colors from hex code, converting
between color depths, mixing colors, etc.
lv_color_t is used to store a color, its fileds are set according to LV_COLOR_DEPTH in lv_conf.h. (See below)
You may set LV_COLOR_16_SWAP in lv_conf.h to swap the bytes of RGB565 colors. You may need this to send
the 16-bit colors via a byte-oriented interface like SPI. As 16-bit numbers are stored in Little Endian format (lower byte
on the lower address), the interface will send the lower byte first. However, displays usually need the higher byte first. A
mismatch in the byte order will result in highly distorted colors.
4.10.1 Creating colors
RGB
Create colors from Red, Green and Blue channel values
//All channels are 0-255

lv_color_t c = lv_color_make(red, green, blue);
//From hex code 0x000000..0xFFFFFF interpreted as RED + GREEN + BLUE

lv_color_t c = lv_color_hex(0x123456);
//From 3 digits. Same as lv_color_hex(0x112233)

lv_color_t c = lv_color_hex3(0x123);
HSV
Create colors from Hue, Saturation and Value values
//h = 0..359, s = 0..100, v = 0..100

lv_color_t c = lv_color_hsv_to_rgb(h, s, v);
//All channels are 0-255

lv_color_hsv_t c_hsv = lv_color_rgb_to_hsv(r, g, b);
//From lv_color_t variable

lv_color_hsv_t c_hsv = lv_color_to_hsv(color);
Palette
LVGL includes material design's palette. In this all color have a main as well as four darker and five lighter variants.
The names of the colors are as follows:
• LV_PALETTE_RED
• LV_PALETTE_PINK
• LV_PALETTE_PURPLE
• LV_PALETTE_DEEP_PURPLE
4.10. Colors 149

• LV_PALETTE_INDIGO
• LV_PALETTE_BLUE
• LV_PALETTE_LIGHT_BLUE
• LV_PALETTE_CYAN
• LV_PALETTE_TEAL
• LV_PALETTE_GREEN
• LV_PALETTE_LIGHT_GREEN
• LV_PALETTE_LIME
• LV_PALETTE_YELLOW
• LV_PALETTE_AMBER
• LV_PALETTE_ORANGE
• LV_PALETTE_DEEP_ORANGE
• LV_PALETTE_BROWN
• LV_PALETTE_BLUE_GREY
• LV_PALETTE_GREY
To get the main color use lv_color_t c = lv_palette_main(LV_PALETTE_...).
For the lighter variants of a palette color use lv_color_t c = lv_palette_lighten(LV_PALETTE_.
.., v). v can be 1..5. For the darker variants of a palette color use lv_color_t c =
lv_palette_darken(LV_PALETTE_..., v). v can be 1..4.
Modify and mix colors
The following functions can modify a color:
// Lighten a color. 0: no change, 255: white

lv_color_t c = lv_color_lighten(c, lvl);
// Darken a color. 0: no change, 255: black

lv_color_t c = lv_color_darken(lv_color_t c, lv_opa_t lvl);
// Lighten or darken a color. 0: black, 128: no change 255: black

lv_color_t c = lv_color_change_lightness(lv_color_t c, lv_opa_t lvl);
// Mix 2 colors with a given ratio 0: full c2, 255: full c1, 128: half c1 and half c2
lv_color_t c = lv_color_mix(c1, c2, ratio);
4.10. Colors 150

Built-in colors
lv_color_white() and lv_color_black() return 0xFFFFFF and 0x000000 respectively.
4.10.2 Opacity
To describe opacity the lv_opa_t type is created as a wrapper to uint8_t. Some defines are also introduced:
• LV_OPA_TRANSP Value: 0, means the opacity makes the color completely transparent
• LV_OPA_10 Value: 25, means the color covers only a little
• LV_OPA_20 ... OPA_80 come logically
• LV_OPA_90 Value: 229, means the color near completely covers
• LV_OPA_COVER Value: 255, means the color completely covers
You can also use the LV_OPA_* defines in lv_color_mix() as a ratio.
4.10.3 Color types
The following variable types are defined by the color module:

• lv_color1_t Monochrome color. Also has R, G, B fields for compatibility but they are always the same value
(1 byte)
• lv_color8_t A structure to store R (3 bit),G (3 bit),B (2 bit) components for 8-bit colors (1 byte)
• lv_color16_t A structure to store R (5 bit),G (6 bit),B (5 bit) components for 16-bit colors (2 byte)
• lv_color32_t A structure to store R (8 bit),G (8 bit), B (8 bit) components for 24-bit colors (4 byte)
• lv_color_t Equal to lv_color1/8/16/24_t depending on current color depth setting
• lv_color_int_t uint8_t, uint16_t or uint32_t depending on color depth setting. Used to build
color arrays from plain numbers.
• lv_opa_t A simple uint8_t type to describe opacity.
The lv_color_t, lv_color1_t, lv_color8_t, lv_color16_t and lv_color32_t types have four fields:
• ch.red red channel
• ch.green green channel
• ch.blue blue channel
• full* red + green + blue as one number
You can set the current color depth in lv_conf.h, by setting the LV_COLOR_DEPTH define to 1 (monochrome), 8, 16 or
32.
4.10. Colors 151

Convert color
You can convert a color from the current color depth to another. The converter functions return with a number, so you
have to use the full field:
lv_color_t c;
c.red = 0x38;
c.green = 0x70;
c.blue = 0xCC;
lv_color1_t c1;
c1.full = lv_color_to1(c); /*Return 1 for light colors, 0 for dark colors*/
lv_color8_t c8;
c8.full = lv_color_to8(c); /*Give a 8 bit number with the converted color*/
lv_color16_t c16;
lv_color32_t c24;
4.10.4 API
Typedefs
typedef lv_color_t (*lv_color_filter_cb_t)(const struct _lv_color_filter_dsc_t*, lv_color_t, lv_opa_t)

typedef struct _lv_color_filter_dsc_t lv_color_filter_dsc_t
Enums
enum [anonymous]
Opacity percentages.
Values:
enumerator LV_OPA_TRANSP
enumerator LV_OPA_0
enumerator LV_OPA_10
4.10. Colors 152

enumerator LV_OPA_COVER
enum lv_palette_t
Values:
enumerator LV_PALETTE_RED
enumerator LV_PALETTE_PINK
enumerator LV_PALETTE_PURPLE
enumerator LV_PALETTE_DEEP_PURPLE
enumerator LV_PALETTE_INDIGO
enumerator LV_PALETTE_BLUE
enumerator LV_PALETTE_LIGHT_BLUE
enumerator LV_PALETTE_CYAN
enumerator LV_PALETTE_TEAL
enumerator LV_PALETTE_GREEN
enumerator LV_PALETTE_LIGHT_GREEN
enumerator LV_PALETTE_LIME
enumerator LV_PALETTE_YELLOW
enumerator LV_PALETTE_AMBER
enumerator LV_PALETTE_ORANGE
enumerator LV_PALETTE_DEEP_ORANGE
enumerator LV_PALETTE_BROWN
enumerator LV_PALETTE_BLUE_GREY
enumerator LV_PALETTE_GREY
enumerator _LV_PALETTE_LAST
enumerator LV_PALETTE_NONE
Functions
typedef LV_CONCAT3 (uint, LV_COLOR_SIZE, _t) lv_color_int_t

typedef LV_CONCAT3 (lv_color, LV_COLOR_DEPTH, _t) lv_color_t
static inline uint8_t lv_color_to1(lv_color_t color)
4.10. Colors 153

static inline uint8_t lv_color_brightness(lv_color_t color)

Get the brightness of a color
Parameters color -- a color
Returns the brightness [0..255]
static inline lv_color_t lv_color_make(uint8_t r, uint8_t g, uint8_t b)
static inline lv_color_t lv_color_hex(uint32_t c)
static inline lv_color_t lv_color_hex3(uint32_t c)
static inline void lv_color_filter_dsc_init(lv_color_filter_dsc_t *dsc, lv_color_filter_cb_t cb)
lv_color_t lv_color_lighten(lv_color_t c, lv_opa_t lvl)
lv_color_t lv_color_darken(lv_color_t c, lv_opa_t lvl)
lv_color_t lv_color_change_lightness(lv_color_t c, lv_opa_t lvl)
lv_color_t lv_color_hsv_to_rgb(uint16_t h, uint8_t s, uint8_t v)

Convert a HSV color to RGB
Parameters
• h -- hue [0..359]
• s -- saturation [0..100]
• v -- value [0..100]
Returns the given RGB color in RGB (with LV_COLOR_DEPTH depth)
lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r8, uint8_t g8, uint8_t b8)
Convert a 32-bit RGB color to HSV
Parameters
• r8 -- 8-bit red
• g8 -- 8-bit green
• b8 -- 8-bit blue
Returns the given RGB color in HSV
lv_color_hsv_t lv_color_to_hsv(lv_color_t color)
Convert a color to HSV
Parameters color -- color
Returns the given color in HSV
static inline lv_color_t lv_color_chroma_key(void)
Just a wrapper around LV_COLOR_CHROMA_KEY because it might be more convenient to use a function is
some cases
4.10. Colors 154

Returns LV_COLOR_CHROMA_KEY
lv_color_t lv_palette_main(lv_palette_t p)
static inline lv_color_t lv_color_white(void)
static inline lv_color_t lv_color_black(void)
lv_color_t lv_palette_lighten(lv_palette_t p, uint8_t lvl)
lv_color_t lv_palette_darken(lv_palette_t p, uint8_t lvl)
union lv_color1_t
Public Members
uint8_t full
uint8_t blue
uint8_t green
uint8_t red
union lv_color1_t::[anonymous] ch
union lv_color8_t
Public Members
uint8_t blue
uint8_t green
uint8_t red
struct lv_color8_t::[anonymous] ch
uint8_t full
union lv_color16_t
Public Members
uint16_t blue
uint16_t green
uint16_t red
uint16_t green_h
uint16_t green_l
4.10. Colors 155

uint16_t full
union lv_color32_t
Public Members
uint8_t blue
uint8_t green
uint8_t red
uint8_t alpha
uint32_t full
struct lv_color_hsv_t
Public Members
uint16_t h
uint8_t s
uint8_t v
struct _lv_color_filter_dsc_t
Public Members
lv_color_filter_cb_t filter_cb
void *user_data
4.11 Fonts
In LVGL fonts are collections of bitmaps and other information required to render the images of the letters (glyph). A
font is stored in a lv_font_t variable and can be set in a style's text_font field. For example:
lv_style_set_text_font(&my_style, LV_STATE_DEFAULT, &lv_font_montserrat_28); /*Set a␣

,→larger font*/
The fonts have a bpp (bits per pixel) property. It shows how many bits are used to describe a pixel in the font. The value
stored for a pixel determines the pixel's opacity. This way, with higher bpp, the edges of the letter can be smoother. The
possible bpp values are 1, 2, 4 and 8 (higher value means better quality).
The bpp also affects the required memory size to store the font. For example, bpp = 4 makes the font nearly 4 times larger
compared to bpp = 1.
4.11. Fonts 156

4.11.1 Unicode support
LVGL supports UTF-8 encoded Unicode characters. Your editor needs to be configureed to save your code/text as UTF-8
(usually this the default) and be sure that, LV_TXT_ENC is set to LV_TXT_ENC_UTF8 in lv_conf.h. (This is the default
value)
To test it try
lv_obj_t * label1 = lv_label_create(lv_scr_act(), NULL);

lv_label_set_text(label1, LV_SYMBOL_OK);
If all works well, a ✓ character should be displayed.
4.11.2 Built-in fonts
There are several built-in fonts in different sizes, which can be enabled in lv_conf.h by LV_FONT_... defines.
Normal fonts
Containing all the ASCII characters, the degree symbol (U+00B0), the bullet symbol (U+2022) and the built-in symbols
(see below).
• LV_FONT_MONTSERRAT_12 12 px font
4.11. Fonts 157

Special fonts
• LV_FONT_MONTSERRAT_12_SUBPX Same as normal 12 px font but with subpixel rendering

• LV_FONT_MONTSERRAT_28_COMPRESSED Same as normal 28 px font but compressed font with 3 bpp
• LV_FONT_DEJAVU_16_PERSIAN_HEBREW 16 px font with normal range + Hebrew, Arabic, Persian letters
and all their forms
• LV_FONT_SIMSUN_16_CJK16 px font with normal range + 1000 most common CJK radicals
• LV_FONT_UNSCII_8 8 px pixel perfect font with only ASCII characters
• LV_FONT_UNSCII_16 16 px pixel perfect font with only ASCII characters
The built-in fonts are global variables with names like lv_font_montserrat_16 for a 16 px hight font. To use
them in a style, just add a pointer to a font variable like shown above.
The built-in fonts with bpp = 4 contain the ASCII characters and use the Montserrat font.
In addition to the ASCII range, the following symbols are also added to the built-in fonts from the FontAwesome font.
4.11. Fonts 158

The symbols can be used as:
lv_label_set_text(my_label, LV_SYMBOL_OK);
Or with together with strings:
lv_label_set_text(my_label, LV_SYMBOL_OK "Apply");
Or more symbols together:
lv_label_set_text(my_label, LV_SYMBOL_OK LV_SYMBOL_WIFI LV_SYMBOL_PLAY);
4.11. Fonts 159

4.11.3 Special features
Bidirectional support
Most of the languages use Left-to-Right (LTR for short) writing direction, however some languages (such as Hebrew,
Persian or Arabic) uses Right-to-Left (RTL for short) direction.
LVGL not only supports RTL texts but supports mixed (a.k.a. bidirectional, BiDi) text rendering too. Some examples:
BiDi support is enabled by LV_USE_BIDI in lv_conf.h

All texts have a base direction (LTR or RTL) which determines some rendering rules and the default alignment of the
text (Left or Right). However, in LVGL, base direction is applied not only for labels. It's a general property which can
be set for every object. If unset then it will be inherited from the parent. So it's enough to set the base direction of the
screen and every object will inherit it.
The default base direction of screen can be set by LV_BIDI_BASE_DIR_DEF in lv_conf.h and other objects inherit
the base direction from their parent.
To set an object's base direction use lv_obj_set_base_dir(obj, base_dir). The possible base direction
are:
• LV_BIDI_DIR_LTR: Left to Right base direction
• LV_BIDI_DIR_RTL: Right to Left base direction
• LV_BIDI_DIR_AUTO: Auto detect base direction
• LV_BIDI_DIR_INHERIT: Inherit the base direction from the parent (default for non-screen objects)
This list summarizes the effect of RTL base direction on objects:
• Create objects by default on the right
• lv_tabview: displays tabs from right to left
• lv_checkbox: Show the box on the right
• lv_btnmatrix: Show buttons from right to left
• lv_list: Show the icon on the right
• lv_dropdown: Align the options to the right
• The texts in lv_table, lv_btnmatrix, lv_keyboard, lv_tabview, lv_dropdown, lv_roller
are "BiDi processed" to be displayed correctly
4.11. Fonts 160

Arabic and Persian support
There are some special rules to display Arabic and Persian characters: the form of the character depends on their position
in the text. A different form of the same letter needs to be used if it isolated, start, middle or end position. Besides these
some conjunction rules also should be taken into account.
LVGL supports to apply these rules if LV_USE_ARABIC_PERSIAN_CHARS is enabled.
However, there some limitations:
• Only displaying texts is supported (e.g. on labels), text inputs (e.g. text area) don't support this feature.
• Static text (i.e. const) is not processed. E.g. texts set by lv_label_set_text() will be "Arabic processed"
but lv_lable_set_text_static() won't.
• Text get functions (e.g. lv_label_get_text()) will return the processed text.
Subpixel rendering
Subpixel rendering allows for tripling the horizontal resolution by rendering on Red, Green and Blue channel instead of
pixel level. This takes advantage of the position of physical color channels of each pixel, resulting in higher quality letter
anti-aliasing. Learn more here.
For subpixel rendering the fonts need to be generated with special settings:
• In the online converter tick the Subpixel box
• In the command line tool use --lcd flag. Note that the generated font needs about 3 times more memory.
Subpixel rendering works only if the color channels of the pixels have a horizontal layout. That is the R, G, B channels
are next each other and not above each other. The order of color channels also needs to match with the library settings.
By default LVGL assumes RGB order, however this can be swapped by setting LV_SUBPX_BGR 1 in lv_conf.h.
Compress fonts
The bitmaps of the fonts can be compressed by

• ticking the Compressed check box in the online converter
• not passing --no-compress flag to the offline converter (compression is applied by default)
The compression is more effective with larger fonts and higher bpp. However, it's about 30% slower to render the com-
pressed fonts. Therefore it's recommended to compress only the largest fonts of user interface, because
• they need the most memory
• they can be compressed better
• and probably they are used less frequently then the medium sized fonts, so the performance cost is smaller.
4.11. Fonts 161

4.11.4 Add new font
There are several ways to add a new font to your project:

1. The simplest method is to use the Online font converter. Just set the parameters, click the Convert button, copy
the font to your project and use it. Be sure to carefully read the steps provided on that site or you will get an
error while converting.
2. Use the Offline font converter. (Requires Node.js to be installed)
3. If you want to create something like the built-in fonts (Roboto font and symbols) but in different size and/or ranges,
you can use the built_in_font_gen.py script in lvgl/scripts/built_in_font folder. (This re-
quires Python and lv_font_conv to be installed)
To declare the font in a file, use LV_FONT_DECLARE(my_font_name).
To make the fonts globally available (like the builtin fonts), add them to LV_FONT_CUSTOM_DECLARE in lv_conf.h.
4.11.5 Add new symbols
The built-in symbols are created from the FontAwesome font.

1. Search symbol on https://fontawesome.com. For example the USB symbol. Copy it's Unicode ID which is 0xf287
in this case.
2. Open the Online font converter. Add Add FontAwesome.woff. .
3. Set the parameters such as Name, Size, BPP. You'll use this name to declare and use the font in your code.
4. Add the Unicode ID of the symbol to the range field. E.g. 0xf287 for the USB symbol. More symbols can be
enumerated with ,.
5. Convert the font and copy it to your project. Make sure to compile the .c file of your font.
6. Declare the font using extern lv_font_t my_font_name; or simply
LV_FONT_DECLARE(my_font_name);.
Using the symbol
1. Convert the Unicode value to UTF8, for example on this site. For 0xf287 the Hex UTF-8 bytes are EF 8A 87.
2. Create a define from the UTF8 values: #define MY_USB_SYMBOL "\xEF\x8A\x87"
3. Create a label and set the text. Eg. lv_label_set_text(label, MY_USB_SYMBOL)
Note - lv_label_set_text(label, MY_USB_SYMBOL) searches for this symbol in the font defined in style.
text.font properties. To use the symbol you may need to change it. Eg style.text.font = my_font_name
4.11.6 Load font at run-time
lv_font_load can be used to load a font from a file. The font to load needs to have a special binary format. (Not
TTF or WOFF). Use lv_font_conv with --format bin option to generate an LVGL compatible font file.
Note that to load a font LVGL's filesystem needs to be enabled and a driver needs to be added.
Example
lv_font_t * my_font;
my_font = lv_font_load(X/path/to/my_font.bin);
/*Use the font*/

4.11. Fonts 162

/*Free the font if not required anymore*/

lv_font_free(my_font);
4.11.7 Add a new font engine
LVGL's font interface is designed to be very flexible. But even so you don't need to use LVGL's internal font engine: you
can add your own. For example, use FreeType to real-time render glyphs from TTF fonts or use an external flash to store
the font's bitmap and read them when the library needs them.
A ready to use FreeType can be found in lv_freetype repository.
To do this a custom lv_font_t variable needs to be created:
/*Describe the properties of a font*/

lv_font_t my_font;
my_font.get_glyph_dsc = my_get_glyph_dsc_cb; /*Set a callback to get info␣
,→about gylphs*/
my_font.get_glyph_bitmap = my_get_glyph_bitmap_cb; /*Set a callback to get bitmap of␣

,→a glyp*/
my_font.line_height = height; /*The real line height where any␣

,→text fits*/
my_font.base_line = base_line; /*Base line measured from the top␣

,→of line_height*/
my_font.dsc = something_required; /*Store any implementation␣

,→specific data here*/
my_font.user_data = user_data; /*Optionally some extra user␣

,→data*/
...
/* Get info about glyph of ùnicode_letter` in `font` font.

* Store the result in `dsc_out`.
* The next letter (ùnicode_letter_next`) might be used to calculate the width␣
,→required by this glyph (kerning)
*/
bool my_get_glyph_dsc_cb(const lv_font_t * font, lv_font_glyph_dsc_t * dsc_out,␣
,→uint32_t unicode_letter, uint32_t unicode_letter_next)
{
/*Your code here*/
/* Store the result.

* For example ...
*/
dsc_out->adv_w = 12; /*Horizontal space required by the glyph in [px]*/
dsc_out->box_h = 8; /*Height of the bitmap in [px]*/
dsc_out->box_w = 6; /*Width of the bitmap in [px]*/
dsc_out->ofs_x = 0; /*X offset of the bitmap in [pf]*/
dsc_out->ofs_y = 3; /*Y offset of the bitmap measured from the as line*/
dsc_out->bpp = 2; /*Bits per pixel: 1/2/4/8*/
return true; /*true: glyph found; false: glyph was not found*/
}
4.11. Fonts 163


/* Get the bitmap of ùnicode_letter` from `font`. */
const uint8_t * my_get_glyph_bitmap_cb(const lv_font_t * font, uint32_t unicode_
,→letter)
{
/* Your code here */
/* The bitmap should be a continuous bitstream where

* each pixel is represented by `bpp` bits */
return bitmap; /*Or NULL if not found*/

}
4.12 Images
An image can be a file or variable which stores the bitmap itself and some metadata.
4.12.1 Store images
You can store images in two places

• as a variable in the internal memory (RAM or ROM)
• as a file
Variables
The images stored internally in a variable are composed mainly of an lv_img_dsc_t structure with the following
fields:
• header
– cf Color format. See below
– w width in pixels (<= 2048)
– h height in pixels (<= 2048)
– always zero 3 bits which need to be always zero
– reserved reserved for future use
• data pointer to an array where the image itself is stored
• data_size length of data in bytes
These are usually stored within a project as C files. They are linked into the resulting executable like any other constant
data.
4.12. Images 164

Files
To deal with files you need to add a Drive to LVGL. In short, a Drive is a collection of functions (open, read, close, etc.)
registered in LVGL to make file operations. You can add an interface to a standard file system (FAT32 on SD card) or
you create your simple file system to read data from an SPI Flash memory. In every case, a Drive is just an abstraction to
read and/or write data to memory. See the File system section to learn more.
Images stored as files are not linked into the resulting executable, and must be read to RAM before being drawn. As
a result, they are not as resource-friendly as variable images. However, they are easier to replace without needing to
recompile the main program.
4.12.2 Color formats
Various built-in color formats are supported:

• LV_IMG_CF_TRUE_COLOR Simply stores the RGB colors (in whatever color depth LVGL is configured for).
• LV_IMG_CF_TRUE_COLOR_ALPHA Like LV_IMG_CF_TRUE_COLOR but it also adds an alpha (trans-
parency) byte for every pixel.
• LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED Like LV_IMG_CF_TRUE_COLOR but if a pixel has
LV_COLOR_TRANSP (set in lv_conf.h) color the pixel will be transparent.
• LV_IMG_CF_INDEXED_1/2/4/8BIT Uses a palette with 2, 4, 16 or 256 colors and stores each pixel in 1, 2, 4
or 8 bits.
• LV_IMG_CF_ALPHA_1/2/4/8BIT Only stores the Alpha value on 1, 2, 4 or 8 bits. The pixels take the color
of style.image.color and the set opacity. The source image has to be an alpha channel. This is ideal for
bitmaps similar to fonts (where the whole image is one color but you'd like to be able to change it).
The bytes of the LV_IMG_CF_TRUE_COLOR images are stored in the following order.
For 32-bit color depth:
• Byte 0: Blue
• Byte 1: Green
• Byte 2: Red
• Byte 3: Alpha
• Byte 0: Green 3 lower bit, Blue 5 bit
• Byte 1: Red 5 bit, Green 3 higher bit
• Byte 2: Alpha byte (only with LV_IMG_CF_TRUE_COLOR_ALPHA)
• Byte 0: Red 3 bit, Green 3 bit, Blue 2 bit
• Byte 2: Alpha byte (only with LV_IMG_CF_TRUE_COLOR_ALPHA)
You can store images in a Raw format to indicate that it's not encoded with one of the built-in color formats and an
external Image decoder needs to be used to decode the image.
• LV_IMG_CF_RAW Indicates a basic raw image (e.g. a PNG or JPG image).
• LV_IMG_CF_RAW_ALPHA Indicates that the image has alpha and an alpha byte is added for every pixel.
4.12. Images 165

• LV_IMG_CF_RAW_CHROME_KEYED Indicates that the image is chroma-keyed as described in

LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED above.
4.12.3 Add and use images
You can add images to LVGL in two ways:

• using the online converter
• manually create images
Online converter
The online Image converter is available here: https://lvgl.io/tools/imageconverter

Adding an image to LVGL via online converter is easy.
1. You need to select a BMP, PNG or JPG image first.
2. Give the image a name that will be used within LVGL.
3. Select the Color format.
4. Select the type of image you want. Choosing a binary will generate a .bin file that must be stored separately and
read using the file support. Choosing a variable will generate a standard C file that can be linked into your project.
5. Hit the Convert button. Once the conversion is finished, your browser will automatically download the resulting
file.
In the converter C arrays (variables), the bitmaps for all the color depths (1, 8, 16 or 32) are included in the C file, but
only the color depth that matches LV_COLOR_DEPTH in lv_conf.h will actually be linked into the resulting executable.
In case of binary files, you need to specify the color format you want:
• RGB332 for 8-bit color depth
• RGB565 Swap for 16-bit color depth (two bytes are swapped)
Manually create an image
If you are generating an image at run-time, you can craft an image variable to display it using LVGL. For example:
uint8_t my_img_data[] = {0x00, 0x01, 0x02, ...};
static lv_img_dsc_t my_img_dsc = {

.header.always_zero = 0,
.header.w = 80,
.header.h = 60,
.data_size = 80 * 60 * LV_COLOR_DEPTH / 8,
.header.cf = LV_IMG_CF_TRUE_COLOR, /*Set the color format*/
.data = my_img_data,
};
4.12. Images 166

If the color format is LV_IMG_CF_TRUE_COLOR_ALPHA you can set data_size like 80 * 60 *

LV_IMG_PX_SIZE_ALPHA_BYTE.
Another (possibly simpler) option to create and display an image at run-time is to use the Canvas object.
Use images
The simplest way to use an image in LVGL is to display it with an lv_img object:
lv_obj_t * icon = lv_img_create(lv_scr_act(), NULL);
/*From variable*/
lv_img_set_src(icon, &my_icon_dsc);
/*From file*/
lv_img_set_src(icon, "S:my_icon.bin");
If the image was converted with the online converter, you should use LV_IMG_DECLARE(my_icon_dsc) to declare
the image in the file where you want to use it.
4.12.4 Image decoder
As you can see in the Color formats section, LVGL supports several built-in image formats. In many cases, these will be
all you need. LVGL doesn't directly support, however, generic image formats like PNG or JPG.
To handle non-built-in image formats, you need to use external libraries and attach them to LVGL via the Image decoder
interface.
The image decoder consists of 4 callbacks:
• info get some basic info about the image (width, height and color format).
• open open the image: either store the decoded image or set it to NULL to indicate the image can be read line-by-line.
• read if open didn't fully open the image this function should give some decoded data (max 1 line) from a given
position.
• close close the opened image, free the allocated resources.
You can add any number of image decoders. When an image needs to be drawn, the library will try all the registered
image decoders until it finds one which can open the image, i.e. one which knows that format.
The LV_IMG_CF_TRUE_COLOR_..., LV_IMG_INDEXED_... and LV_IMG_ALPHA_... formats (essentially,
all non-RAW formats) are understood by the built-in decoder.
Custom image formats
The easiest way to create a custom image is to use the online image converter and set Raw, Raw with alpha or Raw
with chroma-keyed format. It will just take every byte of the binary file you uploaded and write it as the image
"bitmap". You then need to attach an image decoder that will parse that bitmap and generate the real, renderable bitmap.
header.cf will be LV_IMG_CF_RAW, LV_IMG_CF_RAW_ALPHA or LV_IMG_CF_RAW_CHROME_KEYED ac-
cordingly. You should choose the correct format according to your needs: fully opaque image, use alpha channel or use
chroma keying.
After decoding, the raw formats are considered True color by the library. In other words, the image decoder must decode
the Raw images to True color according to the format described in [#color-formats](Color formats) section.
4.12. Images 167

If you want to create a custom image, you should use LV_IMG_CF_USER_ENCODED_0..7 color formats. However,
the library can draw the images only in True color format (or Raw but finally it's supposed to be in True color format).
The LV_IMG_CF_USER_ENCODED_... formats are not known by the library and therefore they should be decoded
to one of the known formats from [#color-formats](Color formats) section. It's possible to decode the image to a non-true
color format first (for example: LV_IMG_INDEXED_4BITS) and then call the built-in decoder functions to convert it
to True color.
With User encoded formats, the color format in the open function (dsc->header.cf) should be changed according
to the new format.
Register an image decoder
Here's an example of getting LVGL to work with PNG images.

First, you need to create a new image decoder and set some functions to open/close the PNG files. It should looks like
this:
/*Create a new decoder and register functions */

lv_img_decoder_t * dec = lv_img_decoder_create();
lv_img_decoder_set_info_cb(dec, decoder_info);
lv_img_decoder_set_open_cb(dec, decoder_open);
lv_img_decoder_set_close_cb(dec, decoder_close);
/**
* Get info about a PNG image
* @param decoder pointer to the decoder where this function belongs
* @param src can be file name or pointer to a C array
* @param header store the info here
* @return LV_RES_OK: no error; LV_RES_INV: can't get the info
*/
static lv_res_t decoder_info(lv_img_decoder_t * decoder, const void * src, lv_img_
,→header_t * header)
{
/*Check whether the type `src` is known by the decoder*/
if(is_png(src) == false) return LV_RES_INV;
/* Read the PNG header and find `width` and `height` */

...
header->cf = LV_IMG_CF_RAW_ALPHA;
header->w = width;
header->h = height;
}
/**
* Open a PNG image and return the decided image
* @param dsc pointer to a descriptor which describes this decoding session
* @return LV_RES_OK: no error; LV_RES_INV: can't get the info
*/
static lv_res_t decoder_open(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t * dsc)
{
/*Check whether the type `src` is known by the decoder*/

if(is_png(src) == false) return LV_RES_INV;
4.12. Images 168


/*Decode and store the image. If `dsc->img_data` is `NULL`, the `read_line`␣
,→function will be called to get the image data line-by-line*/
dsc->img_data = my_png_decoder(src);
/*Change the color format if required. For PNG usually 'Raw' is fine*/
dsc->header.cf = LV_IMG_CF_...
/*Call a built in decoder function if required. It's not required if`my_png_

,→ decoder` opened the image in true color format.*/
lv_res_t res = lv_img_decoder_built_in_open(decoder, dsc);
return res;
}
/**
* Decode `len` pixels starting from the given `x`, `y` coordinates and store them in␣
,→`buf`.
* Required only if the "open" function can't open the whole decoded pixel array.␣
,→(dsc->img_data == NULL)
* @param decoder pointer to the decoder the function associated with

* @param dsc pointer to decoder descriptor
* @param x start x coordinate
* @param y start y coordinate
* @param len number of pixels to decode
* @param buf a buffer to store the decoded pixels
* @return LV_RES_OK: ok; LV_RES_INV: failed
*/
lv_res_t decoder_built_in_read_line(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t␣
,→* dsc, lv_coord_t x,
lv_coord_t y, lv_coord_t len, uint8_

,→t * buf)
{
/*With PNG it's usually not required*/
/*Copy `len` pixels from `x` and `y` coordinates in True color format to `buf` */
/**
* Free the allocated resources
* @param dsc pointer to a descriptor which describes this decoding session
*/
static void decoder_close(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t * dsc)
{
/*Free all allocated data*/
/*Call the built-in close function if the built-in open/read_line was used*/
lv_img_decoder_built_in_close(decoder, dsc);
So in summary:
• In decoder_info, you should collect some basic information about the image and store it in header.
• In decoder_open, you should try to open the image source pointed by dsc->src. Its type is already in dsc-
>src_type == LV_IMG_SRC_FILE/VARIABLE. If this format/type is not supported by the decoder, return
4.12. Images 169

LV_RES_INV. However, if you can open the image, a pointer to the decoded True color image should be set in
dsc->img_data. If the format is known but you don't want to decode the entire image (e.g. no memory for it)
set dsc->img_data = NULL to call read_line to get the pixels.
• In decoder_close you should free all the allocated resources.
• decoder_read is optional. Decoding the whole image requires extra memory and some computational over-
head. However, if can decode one line of the image without decoding the whole image, you can save memory and
time. To indicate that the line read function should be used, set dsc->img_data = NULL in the open function.
Manually use an image decoder
LVGL will use the registered image decoder automatically if you try and draw a raw image (i.e. using the lv_img
object) but you can use them manually too. Create a lv_img_decoder_dsc_t variable to describe the decoding
session and call lv_img_decoder_open().
lv_res_t res;
lv_img_decoder_dsc_t dsc;
res = lv_img_decoder_open(&dsc, &my_img_dsc, LV_COLOR_WHITE);
if(res == LV_RES_OK) {
/*Do something with `dsc->img_data`*/
lv_img_decoder_close(&dsc);
}
4.12.5 Image caching
Sometimes it takes a lot of time to open an image. Continuously decoding a PNG image or loading images from a slow
external memory would be inefficient and detrimental to the user experience.
Therefore, LVGL caches a given number of images. Caching means some images will be left open, hence LVGL can
quickly access them from dsc->img_data instead of needing to decode them again.
Of course, caching images is resource-intensive as it uses more RAM (to store the decoded image). LVGL tries to
optimize the process as much as possible (see below), but you will still need to evaluate if this would be beneficial for
your platform or not. If you have a deeply embedded target which decodes small images from a relatively fast storage
medium, image caching may not be worth it.
Cache size
The number of cache entries can be defined in LV_IMG_CACHE_DEF_SIZE in lv_conf.h. The default value is 1 so
only the most recently used image will be left open.
The size of the cache can be changed at run-time with lv_img_cache_set_size(entry_num).
4.12. Images 170

Value of images
When you use more images than cache entries, LVGL can't cache all of the images. Instead, the library will close one of
the cached images (to free space).
To decide which image to close, LVGL uses a measurement it previously made of how long it took to open the image.
Cache entries that hold slower-to-open images are considered more valuable and are kept in the cache as long as possible.
If you want or need to override LVGL's measurement, you can manually set the time to open value in the decoder open
function in dsc->time_to_open = time_ms to give a higher or lower value. (Leave it unchanged to let LVGL
set it.)
Every cache entry has a "life" value. Every time an image opening happens through the cache, the life value of all entries
is decreased to make them older. When a cached image is used, its life value is increased by the time to open value to
make it more alive.
If there is no more space in the cache, the entry with the smallest life value will be closed.
Memory usage
Note that the cached image might continuously consume memory. For example, if 3 PNG images are cached, they will
consume memory while they are open.
Therefore, it's the user's responsibility to be sure there is enough RAM to cache even the largest images at the same time.
Clean the cache
Let's say you have loaded a PNG image into a lv_img_dsc_t my_png variable and use it in an lv_img object. If
the image is already cached and you then change the underlying PNG file, you need to notify LVGL to cache the image
again. Otherwise, there is no easy way of detecting that the underlying file changed and LVGL will still draw the old
image.
To do this, use lv_img_cache_invalidate_src(&my_png). If NULL is passed as a parameter, the whole
cache will be cleaned.
4.12.6 API
Image buffer
Typedefs
typedef uint8_t lv_img_cf_t
4.12. Images 171

Enums
enum [anonymous]
Values:
enumerator LV_IMG_CF_UNKNOWN
enumerator LV_IMG_CF_RAW
Contains the file as it is. Needs custom decoder function
enumerator LV_IMG_CF_RAW_ALPHA
Contains the file as it is. The image has alpha. Needs custom decoder function
enumerator LV_IMG_CF_RAW_CHROMA_KEYED
Contains the file as it is. The image is chroma keyed. Needs custom decoder function
enumerator LV_IMG_CF_TRUE_COLOR
Color format and depth should match with LV_COLOR settings
enumerator LV_IMG_CF_TRUE_COLOR_ALPHA
Same as LV_IMG_CF_TRUE_COLOR but every pixel has an alpha byte
enumerator LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED
Same as LV_IMG_CF_TRUE_COLOR but LV_COLOR_TRANSP pixels will be transparent
enumerator LV_IMG_CF_INDEXED_1BIT
Can have 2 different colors in a palette (always chroma keyed)
enumerator LV_IMG_CF_ALPHA_1BIT
Can have one color and it can be drawn or not
Can have one color but 4 different alpha value
enumerator LV_IMG_CF_RESERVED_15
Reserved for further use.
4.12. Images 172

enumerator LV_IMG_CF_USER_ENCODED_0
User holder encoding format.
4.12. Images 173

Functions
lv_img_dsc_t *lv_img_buf_alloc(lv_coord_t w, lv_coord_t h, lv_img_cf_t cf)

Allocate an image buffer in RAM
Parameters
• w -- width of image
• h -- height of image
• cf -- a color format (LV_IMG_CF_...)
Returns an allocated image, or NULL on failure
lv_color_t lv_img_buf_get_px_color(lv_img_dsc_t *dsc, lv_coord_t x, lv_coord_t y, lv_color_t color)
Get the color of an image's pixel
Parameters
• dsc -- an image descriptor
• x -- x coordinate of the point to get
• y -- x coordinate of the point to get
• color -- the color of the image. In case of LV_IMG_CF_ALPHA_1/2/4/8 this color is
used. Not used in other cases.
• safe -- true: check out of bounds
Returns color of the point
lv_opa_t lv_img_buf_get_px_alpha(lv_img_dsc_t *dsc, lv_coord_t x, lv_coord_t y)
Get the alpha value of an image's pixel
Parameters
• dsc -- pointer to an image descriptor
• x -- x coordinate of the point to set
• y -- x coordinate of the point to set
Returns alpha value of the point
void lv_img_buf_set_px_color(lv_img_dsc_t *dsc, lv_coord_t x, lv_coord_t y, lv_color_t c)
Set the color of a pixel of an image. The alpha channel won't be affected.
Parameters
• c -- color of the point
void lv_img_buf_set_px_alpha(lv_img_dsc_t *dsc, lv_coord_t x, lv_coord_t y, lv_opa_t opa)
Set the alpha value of a pixel of an image. The color won't be affected
Parameters
4.12. Images 174


• opa -- the desired opacity
void lv_img_buf_set_palette(lv_img_dsc_t *dsc, uint8_t id, lv_color_t c)
Set the palette color of an indexed image. Valid only for LV_IMG_CF_INDEXED1/2/4/8
Parameters
• id -- the palette color to set:
– for LV_IMG_CF_INDEXED1: 0..1
• c -- the color to set
void lv_img_buf_free(lv_img_dsc_t *dsc)
Free an allocated image buffer
Parameters dsc -- image buffer to free
uint32_t lv_img_buf_get_img_size(lv_coord_t w, lv_coord_t h, lv_img_cf_t cf)
Get the memory consumption of a raw bitmap, given color format and dimensions.
Parameters
• w -- width
• h -- height
• cf -- color format
Returns size in bytes
void _lv_img_buf_transform_init(lv_img_transform_dsc_t *dsc)
Initialize a descriptor to rotate an image
Parameters dsc -- pointer to an lv_img_transform_dsc_t variable whose cfg field is ini-
tialized
bool _lv_img_buf_transform_anti_alias(lv_img_transform_dsc_t *dsc)
Continue transformation by taking the neighbors into account
Parameters dsc -- pointer to the transformation descriptor
bool _lv_img_buf_transform(lv_img_transform_dsc_t *dsc, lv_coord_t x, lv_coord_t y)
Get which color and opa would come to a pixel if it were rotated
Note: the result is written back to dsc->res_color and dsc->res_opa
Parameters
• dsc -- a descriptor initialized by lv_img_buf_rotate_init
• x -- the coordinate which color and opa should be get
4.12. Images 175

• y -- the coordinate which color and opa should be get

Returns true: there is valid pixel on these x/y coordinates; false: the rotated pixel was out of the image
void _lv_img_buf_get_transformed_area(lv_area_t *res, lv_coord_t w, lv_coord_t h, int16_t angle,

uint16_t zoom, const lv_point_t *pivot)
Get the area of a rectangle if its rotated and scaled
Parameters
• res -- store the coordinates here
• w -- width of the rectangle to transform
• h -- height of the rectangle to transform
• angle -- angle of rotation
• zoom -- zoom, (256 no zoom)
• pivot -- x,y pivot coordinates of rotation
struct lv_img_header_t
#include <lv_img_buf.h> The first 8 bit is very important to distinguish the different source types. For more info
see lv_img_get_src_type() in lv_img.c On big endian systems the order is reversed so cf and always_zero
must be at the end of the struct.
Public Members
uint32_t h
uint32_t w
uint32_t reserved
uint32_t always_zero
uint32_t cf
struct lv_img_header_t
#include <lv_img_buf.h> The first 8 bit is very important to distinguish the different source types. For more info
see lv_img_get_src_type() in lv_img.c On big endian systems the order is reversed so cf and always_zero
must be at the end of the struct.
Public Members
uint32_t h
uint32_t w
uint32_t reserved
uint32_t always_zero
uint32_t cf
struct lv_img_dsc_t
#include <lv_img_buf.h> Image header it is compatible with the result from image converter utility
4.12. Images 176

Public Members
lv_img_header_t header
A header describing the basics of the image
uint32_t data_size
Size of the image in bytes
const uint8_t *data

Pointer to the data of the image
struct lv_img_transform_dsc_t
Public Members
const void *src

lv_coord_t src_w
lv_coord_t src_h
lv_coord_t pivot_x
lv_coord_t pivot_y
int16_t angle
uint16_t zoom
lv_color_t color
lv_img_cf_t cf
bool antialias
struct lv_img_transform_dsc_t::[anonymous] cfg
lv_opa_t opa
struct lv_img_transform_dsc_t::[anonymous] res
lv_img_dsc_t img_dsc
int32_t pivot_x_256
int32_t pivot_y_256
int32_t sinma
int32_t cosma
uint8_t chroma_keyed
uint8_t has_alpha
uint8_t native_color
uint32_t zoom_inv
lv_coord_t xs
lv_coord_t ys
4.12. Images 177

lv_coord_t xs_int
lv_coord_t ys_int
uint32_t pxi
uint8_t px_size
struct lv_img_transform_dsc_t::[anonymous] tmp
4.13 File system
LVGL has a 'File system' abstraction module that enables you to attach any type of file system. The file system is identified
by a drive letter. For example, if the SD card is associated with the letter 'S', a file can be reached like "S:path/to/
file.txt".
4.13.1 Ready to use drivers
The lv_fs_if repository contains ready to use drivers using POSIX, standard C and FATFS API. See it's README for
the details.
4.13.2 Add a driver
Registering a driver
To add a driver, lv_fs_drv_t needs to be initialized like below. lv_fs_drv_t needs to be static, global or dy-
namically allocated and not a local varaible.
static lv_fs_drv_t drv; /*Needs to be static or global*/

lv_fs_drv_init(&drv); /*Basic initialization*/
drv.letter = 'S'; /*An uppercase letter to identify the drive␣

,→*/
drv.ready_cb = my_ready_cb; /*Callback to tell if the drive is ready to␣

,→use */
drv.open_cb = my_open_cb; /*Callback to open a file */

drv.close_cb = my_close_cb; /*Callback to close a file */
drv.read_cb = my_read_cb; /*Callback to read a file */
drv.write_cb = my_write_cb; /*Callback to write a file */
drv.seek_cb = my_seek_cb; /*Callback to seek in a file (Move cursor)␣
,→*/
drv.tell_cb = my_tell_cb; /*Callback to tell the cursor position */
drv.dir_open_cb = my_dir_open_cb; /*Callback to open directory to read its␣

,→content */
drv.dir_read_cb = my_dir_read_cb; /*Callback to read a directory's content */

drv.dir_close_cb = my_dir_close_cb; /*Callback to close a directory */
drv.user_data = my_user_data; /*Any custom data if required*/
lv_fs_drv_register(&drv); /*Finally register the drive*/
Any of the callbacks can be NULL to indicate that operation is not supported.
4.13. File system 178

Implementing the callbacks
Open callback
The prototype of open_cb looks like this:
void * (*open_cb)(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode);
path is path after the driver letter (e.g. "S:path/to/file.txt" -> "path/to/file.txt"). mode can be LV_FS_MODE_WR or
LV_FS_MODE_RD to open for write or read.
The return value is a pointer the file object the describes the opened file or NULL if there were any issues (e.g. the file
wasn't found). The returned file object will be passed to to other file system related callbacks. (see below)
Other callbacks
The other callbacks are quite similar. For example write_cb looks like this:
lv_fs_res_t (*write_cb)(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t␣

,→btw, uint32_t * bw);
As file_p LVGL passes the return value of open_cb, buf is the data to write, btw is the Bytes To Write, bw is the
actually written bytes.
For a template to the callbacks see lv_fs_template.c.
4.13.3 Usage example
The example below shows how to read from a file:
lv_fs_file_t f;
lv_fs_res_t res;
res = lv_fs_open(&f, "S:folder/file.txt", LV_FS_MODE_RD);
if(res != LV_FS_RES_OK) my_error_handling();
uint32_t read_num;
uint8_t buf[8];
res = lv_fs_read(&f, buf, 8, &read_num);
if(res != LV_FS_RES_OK || read_num != 8) my_error_handling();
lv_fs_close(&f);
The mode in lv_fs_open can be LV_FS_MODE_WR to open for write or LV_FS_MODE_RD | LV_FS_MODE_WR
for both
This example shows how to read a directory's content. It's up to the driver how to mark the directories, but it can be a
good practice to insert a '/' in front of the directory name.
lv_fs_dir_t dir;
lv_fs_res_t res;
res = lv_fs_dir_open(&dir, "S:/folder");
if(res != LV_FS_RES_OK) my_error_handling();
char fn[256];
while(1) {


res = lv_fs_dir_read(&dir, fn);
if(res != LV_FS_RES_OK) {
my_error_handling();
break;
}
/*fn is empty, if not more files to read*/

if(strlen(fn) == 0) {
break;
}
printf("%s\n", fn);
}
lv_fs_dir_close(&dir);
4.13.4 Use drivers for images
Image objects can be opened from files too (besides variables stored in the flash).
To use files in image widgets the following callbacks are required:
• open
• close
• read
• seek
• tell
4.13.5 API
Typedefs
typedef uint8_t lv_fs_res_t

typedef uint8_t lv_fs_mode_t
typedef struct _lv_fs_drv_t lv_fs_drv_t
Enums
enum [anonymous]
Errors in the file system module.
Values:
enumerator LV_FS_RES_OK
enumerator LV_FS_RES_HW_ERR
enumerator LV_FS_RES_FS_ERR

enumerator LV_FS_RES_NOT_EX
enumerator LV_FS_RES_FULL
enumerator LV_FS_RES_LOCKED
enumerator LV_FS_RES_DENIED
enumerator LV_FS_RES_BUSY
enumerator LV_FS_RES_TOUT
enumerator LV_FS_RES_NOT_IMP
enumerator LV_FS_RES_OUT_OF_MEM
enumerator LV_FS_RES_INV_PARAM
enumerator LV_FS_RES_UNKNOWN
enum [anonymous]
File open mode.
Values:
enumerator LV_FS_MODE_WR
enumerator LV_FS_MODE_RD
enum lv_fs_whence_t
Seek modes.
Values:
enumerator LV_FS_SEEK_SET
Set the position from absolutely (from the start of file)
enumerator LV_FS_SEEK_CUR
Set the position from the current position
enumerator LV_FS_SEEK_END
Set the position from the end of the file
Functions
void _lv_fs_init(void)
Initialize the File system interface
void lv_fs_drv_init(lv_fs_drv_t *drv)
Initialize a file system driver with default values. It is used to surly have known values in the fields ant not memory
junk. After it you can set the fields.
Parameters drv -- pointer to driver variable to initialize
void lv_fs_drv_register(lv_fs_drv_t *drv_p)
Add a new drive
Parameters drv_p -- pointer to an lv_fs_drv_t structure which is inited with the corresponding func-
tion pointers. Only pointer is saved, so the driver should be static or dynamically allocated.

lv_fs_drv_t *lv_fs_get_drv(char letter)

Give a pointer to a driver from its letter
Parameters letter -- the driver letter
Returns pointer to a driver or NULL if not found
bool lv_fs_is_ready(char letter)
Test if a drive is ready or not. If the ready function was not initialized true will be returned.
Parameters letter -- letter of the drive
Returns true: drive is ready; false: drive is not ready
lv_fs_res_t lv_fs_open(lv_fs_file_t *file_p, const char *path, lv_fs_mode_t mode)
Open a file
Parameters
• file_p -- pointer to a lv_fs_file_t variable
• path -- path to the file beginning with the driver letter (e.g. S:/folder/file.txt)
• mode -- read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD |
FS_MODE_WR
Returns LV_FS_RES_OK or any error from lv_fs_res_t enum
lv_fs_res_t lv_fs_close(lv_fs_file_t *file_p)
Close an already opened file
Parameters file_p -- pointer to a lv_fs_file_t variable
lv_fs_res_t lv_fs_read(lv_fs_file_t *file_p, void *buf, uint32_t btr, uint32_t *br)
Read from a file
Parameters
• buf -- pointer to a buffer where the read bytes are stored
• btr -- Bytes To Read
• br -- the number of real read bytes (Bytes Read). NULL if unused.
lv_fs_res_t lv_fs_write(lv_fs_file_t *file_p, const void *buf, uint32_t btw, uint32_t *bw)
Write into a file
Parameters
• buf -- pointer to a buffer with the bytes to write
• btr -- Bytes To Write
• br -- the number of real written bytes (Bytes Written). NULL if unused.
lv_fs_res_t lv_fs_seek(lv_fs_file_t *file_p, uint32_t pos, lv_fs_whence_t whence)
Set the position of the 'cursor' (read write pointer) in a file
Parameters


• pos -- the new position expressed in bytes index (0: start of file)
lv_fs_res_t lv_fs_tell(lv_fs_file_t *file_p, uint32_t *pos)
Give the position of the read write pointer
Parameters
• pos_p -- pointer to store the position of the read write pointer
Returns LV_FS_RES_OK or any error from 'fs_res_t'
lv_fs_res_t lv_fs_dir_open(lv_fs_dir_t *rddir_p, const char *path)
Initialize a 'fs_dir_t' variable for directory reading
Parameters
• rddir_p -- pointer to a 'lv_fs_dir_t' variable
• path -- path to a directory
lv_fs_res_t lv_fs_dir_read(lv_fs_dir_t *rddir_p, char *fn)
Read the next filename form a directory. The name of the directories will begin with '/'
Parameters
• rddir_p -- pointer to an initialized 'fs_dir_t' variable
• fn -- pointer to a buffer to store the filename
lv_fs_res_t lv_fs_dir_close(lv_fs_dir_t *rddir_p)
Close the directory reading
Parameters rddir_p -- pointer to an initialized 'fs_dir_t' variable
char *lv_fs_get_letters(char *buf)
Fill a buffer with the letters of existing drivers
Parameters buf -- buffer to store the letters ('\0' added after the last letter)
Returns the buffer
const char *lv_fs_get_ext(const char *fn)
Return with the extension of the filename
Parameters fn -- string with a filename
Returns pointer to the beginning extension or empty string if no extension
char *lv_fs_up(char *path)
Step up one level
Parameters path -- pointer to a file name
Returns the truncated file name
const char *lv_fs_get_last(const char *path)
Get the last element of a path (e.g. U:/folder/file -> file)

Parameters path -- pointer to a file name

Returns pointer to the beginning of the last element in the path
struct _lv_fs_drv_t
Public Members
char letter
bool (*ready_cb)(struct _lv_fs_drv_t *drv)
void *(*open_cb)(struct _lv_fs_drv_t *drv, const char *path, lv_fs_mode_t mode)
lv_fs_res_t (*close_cb)(struct _lv_fs_drv_t *drv, void *file_p)
lv_fs_res_t (*read_cb)(struct _lv_fs_drv_t *drv, void *file_p, void *buf, uint32_t btr, uint32_t *br)
lv_fs_res_t (*write_cb)(struct _lv_fs_drv_t *drv, void *file_p, const void *buf, uint32_t btw, uint32_t *bw)
lv_fs_res_t (*seek_cb)(struct _lv_fs_drv_t *drv, void *file_p, uint32_t pos, lv_fs_whence_t whence)
lv_fs_res_t (*tell_cb)(struct _lv_fs_drv_t *drv, void *file_p, uint32_t *pos_p)
void *(*dir_open_cb)(struct _lv_fs_drv_t *drv, const char *path)
lv_fs_res_t (*dir_read_cb)(struct _lv_fs_drv_t *drv, void *rddir_p, char *fn)
lv_fs_res_t (*dir_close_cb)(struct _lv_fs_drv_t *drv, void *rddir_p)
void *user_data
Custom file user data
struct lv_fs_file_t
Public Members
void *file_d
lv_fs_drv_t *drv
struct lv_fs_dir_t
Public Members
void *dir_d
lv_fs_drv_t *drv

4.14 Animations
You can automatically change the value of a variable between a start and an end value using animations. The animation
will happen by periodically calling an "animator" function with the corresponding value parameter.
The animator functions have the following prototype:
void func(void * var, lv_anim_var_t value);
This prototype is compatible with the majority of the set functions of LVGL. For example lv_obj_set_x(obj,
value) or lv_obj_set_width(obj, value)
4.14.1 Create an animation
To create an animation an lv_anim_t variable has to be initialized and configured with lv_anim_set_...()
functions.
/* INITIALIZE AN ANIMATION
*-----------------------*/
lv_anim_t a;
lv_anim_init(&a);
/* MANDATORY SETTINGS
*------------------*/
/*Set the "animator" function*/

lv_anim_set_exec_cb(&a, (lv_anim_exec_xcb_t) lv_obj_set_x);
/*Set the "animator" function*/

lv_anim_set_var(&a, obj);
/*Length of the animation [ms]*/

lv_anim_set_time(&a, duration);
/*Set start and end values. E.g. 0, 150*/

lv_anim_set_values(&a, start, end);
/* OPTIONAL SETTINGS
*------------------*/
/*Time to wait before starting the animation [ms]*/

lv_anim_set_delay(&a, delay);
/*Set path (curve). Default is linear*/

lv_anim_set_path(&a, lv_anim_path_ease_in);
/*Set a callback to call when animation is ready.*/

lv_anim_set_ready_cb(&a, ready_cb);
/*Set a callback to call when animation is started (after delay).*/

lv_anim_set_start_cb(&a, start_cb);
/*Play the animation backward too with this duration. Default is 0 (disabled) [ms]*/
lv_anim_set_playback_time(&a, wait_time);
4.14. Animations 185

/*Delay before playback. Default is 0 (disabled) [ms]*/

lv_anim_set_playback_delay(&a, wait_time);
/*Number of repetitions. Default is 1. LV_ANIM_REPEAT_INFINIT for infinite␣

,→repetition*/
lv_anim_set_repeat_count(&a, wait_time);
/*Delay before repeat. Default is 0 (disabled) [ms]*/

lv_anim_set_repeat_delay(&a, wait_time);
/*true (default): apply the start vale immediately, false: apply start vale after␣
,→delay when then anim. really starts. */
lv_anim_set_early_apply(&a, true/false);
/* START THE ANIMATION

*------------------*/
lv_anim_start(&a); /*Start the animation*/
You can apply multiple different animations on the same variable at the same time. For example, animate the x and y
coordinates with lv_obj_set_x and lv_obj_set_y. However, only one animation can exist with a given variable
and function pair. Therefore lv_anim_start() will delete the already existing variable-function animations.
4.14.2 Animation path
You can determinate the path of animation. The most simple case is linear, meaning the current value between start and
end is changed with fixed steps. A path is a function which calculates the next value to set based on the current state of
the animation. Currently, there are the following built-in paths functions:
• lv_anim_path_linear linear animation
• lv_anim_path_step change in one step at the end
• lv_anim_path_ease_in slow at the beginning
• lv_anim_path_ease_out slow at the end
• lv_anim_path_ease_in_out slow at the beginning and at the end
• lv_anim_path_overshoot overshoot the end value
• lv_anim_path_bounce bounce back a little from the end value (like hitting a wall)
4.14.3 Speed vs time
By default, you set the animation time. But in some cases, setting the animation speed is more practical.
The lv_anim_speed_to_time(speed, start, end) function calculates the required time in milliseconds to
reach the end value from a start value with the given speed. The speed is interpreted in unit/sec dimension. For example,
lv_anim_speed_to_time(20,0,100) will yield 5000 milliseconds. For example, in case of lv_obj_set_x
unit is pixels so 20 means 20 px/sec speed.

4.14.4 Delete animations
You can delete an animation with lv_anim_del(var, func) if you provide the animated variable and its animator
function.
4.14.5 Examples
Start animation on an event
static void anim_x_cb(void * var, int32_t v)

{
lv_obj_set_x(var, v);
}
static void sw_event_cb(lv_event_t * e)

{
lv_obj_t * sw = lv_event_get_target(e);
lv_obj_t * label = lv_event_get_user_data(e);
if(lv_obj_has_state(sw, LV_STATE_CHECKED)) {
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, label);
lv_anim_set_values(&a, lv_obj_get_x(label), 100);
lv_anim_set_time(&a, 500);
lv_anim_set_exec_cb(&a, anim_x_cb);
lv_anim_set_path_cb(&a, lv_anim_path_overshoot);
lv_anim_start(&a);
} else {
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, label);
lv_anim_set_values(&a, lv_obj_get_x(label), -lv_obj_get_width(label));
lv_anim_set_path_cb(&a, lv_anim_path_ease_in);
lv_anim_start(&a);
}
/**
* Start animation on an event
*/
void lv_example_anim_1(void)
{
lv_label_set_text(label, "Hello animations!");
lv_obj_set_pos(label, 100, 10);

lv_obj_t * sw = lv_switch_create(lv_scr_act());
lv_obj_center(sw);
lv_obj_add_state(sw, LV_STATE_CHECKED);
lv_obj_add_event_cb(sw, sw_event_cb, LV_EVENT_VALUE_CHANGED, label);
}
#endif
Playback animation
static void anim_x_cb(void * var, int32_t v)

{
lv_obj_set_x(var, v);
}
static void anim_size_cb(void * var, int32_t v)

{
lv_obj_set_size(var, v, v);
}
/**
* Create a playback animation
*/
void lv_example_anim_2(void)
{

lv_obj_set_style_bg_color(obj, lv_palette_main(LV_PALETTE_RED), 0);
lv_obj_set_style_radius(obj, LV_RADIUS_CIRCLE, 0);
lv_obj_align(obj, LV_ALIGN_LEFT_MID, 10, 0);
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, obj);
lv_anim_set_values(&a, 10, 50);
lv_anim_set_playback_delay(&a, 100);
lv_anim_set_playback_time(&a, 300);
lv_anim_set_repeat_delay(&a, 500);
lv_anim_set_repeat_count(&a, LV_ANIM_REPEAT_INFINITE);
lv_anim_set_path_cb(&a, lv_anim_path_ease_in_out);
lv_anim_set_exec_cb(&a, anim_size_cb);
lv_anim_start(&a);
lv_anim_start(&a);
}

#endif
MicroPython
No examples yet.
4.14.6 API
Typedefs
typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*)

Get the current value during an animation
typedef void (*lv_anim_exec_xcb_t)(void*, int32_t)

Generic prototype of "animator" functions. First parameter is the variable to animate. Second parameter is the
value to set. Compatible with lv_xxx_set_yyy(obj, value) functions The x in _xcb_t means its not
a fully generic prototype because it doesn't receive lv_anim_t * as its first argument
typedef void (*lv_anim_custom_exec_cb_t)(struct _lv_anim_t*, int32_t)

Same as lv_anim_exec_xcb_t but receives lv_anim_t * as the first parameter. It's more consistent but
less convenient. Might be used by binding generator functions.
typedef void (*lv_anim_ready_cb_t)(struct _lv_anim_t*)

Callback to call when the animation is ready
typedef void (*lv_anim_start_cb_t)(struct _lv_anim_t*)

Callback to call when the animation really stars (considering delay)
typedef int32_t (*lv_anim_get_value_cb_t)(struct _lv_anim_t*)

Callback used when the animation values are relative to get the current value
typedef struct _lv_anim_t lv_anim_t

Describes an animation
Enums
enum lv_anim_enable_t
Can be used to indicate if animations are enabled or disabled in a case
Values:
enumerator LV_ANIM_OFF
enumerator LV_ANIM_ON

Functions
LV_EXPORT_CONST_INT(LV_ANIM_REPEAT_INFINITE)
void _lv_anim_core_init(void)
Init. the animation module
void lv_anim_init(lv_anim_t *a)
Initialize an animation variable. E.g.: lv_anim_t a; lv_anim_init(&a); lv_anim_set_...(&a); lv_anim_start(&a);
Parameters a -- pointer to an lv_anim_t variable to initialize
static inline void lv_anim_set_var(lv_anim_t *a, void *var)
Set a variable to animate
Parameters
• a -- pointer to an initialized lv_anim_t variable
• var -- pointer to a variable to animate
static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb)
Set a function to animate var
Parameters
• exec_cb -- a function to execute during animation LVGL's built-in functions can be used.
E.g. lv_obj_set_x
static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration)
Set the duration of an animation
Parameters
• duration -- duration of the animation in milliseconds
static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay)
Set a delay before starting the animation
Parameters
• delay -- delay before the animation in milliseconds
static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end)
Set the start and end values of an animation
Parameters
• start -- the start value
• end -- the end value
static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)
Similar to lv_anim_set_exec_cb but lv_anim_custom_exec_cb_t receives lv_anim_t * as its
first parameter instead of void *. This function might be used when LVGL is binded to other languages because
it's more consistent to have lv_anim_t * as first parameter. The variable to animate can be stored in the
animation's user_sata

Parameters
• exec_cb -- a function to execute.
static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb)
Set the path (curve) of the animation.
Parameters
• path_cb -- a function the get the current value of the animation.
static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_ready_cb_t start_cb)
Set a function call when the animation really starts (considering delay)
Parameters
• start_cb -- a function call when the animation starts
static inline void lv_anim_set_get_value_cb(lv_anim_t *a, lv_anim_get_value_cb_t get_value_cb)
Set a function to use the current value of the variable and make start and end value relative the the returned current
value.
Parameters
• get_value_cb -- a function call when the animation starts
static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb)
Set a function call when the animation is ready
Parameters
• ready_cb -- a function call when the animation is ready
static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time)
Make the animation to play back to when the forward direction is ready
Parameters
• time -- the duration of the playback animation in in milliseconds. 0: disable playback
static inline void lv_anim_set_playback_delay(lv_anim_t *a, uint32_t delay)
Make the animation to play back to when the forward direction is ready
Parameters
• delay -- delay in milliseconds before starting the playback animation.
static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt)
Make the animation repeat itself.
Parameters

• cnt -- repeat count or LV_ANIM_REPEAT_INFINITE for infinite repetition. 0: to disable

repetition.
static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay)
Set a delay before repeating the animation.
Parameters
• delay -- delay in milliseconds before repeating the animation.
static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en)
Set a whether the animation's should be applied immediately or only when the delay expired.
Parameters
• en -- true: apply the start value immediately in lv_anim_start; false: apply the start value
only when delay ms is elapsed and the animations really starts
lv_anim_t *lv_anim_start(const lv_anim_t *a)
Create an animation
Parameters a -- an initialized 'anim_t' variable. Not required after call.
Returns pointer to the created animation (different from the a parameter)
static inline uint32_t lv_anim_get_delay(lv_anim_t *a)
Get a delay before starting the animation
Parameters a -- pointer to an initialized lv_anim_t variable
Returns delay before the animation in milliseconds
bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb)
Delete an animation of a variable with a given animator function
Parameters
• var -- pointer to variable
• exec_cb -- a function pointer which is animating 'var', or NULL to ignore it and delete all
the animations of 'var
Returns true: at least 1 animation is deleted, false: no animation is deleted
void lv_anim_del_all(void)
Delete all the animations animation
lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb)
Get the animation of a variable and its exec_cb.
Parameters
• var -- pointer to variable
• exec_cb -- a function pointer which is animating 'var', or NULL to return first matching 'var'
Returns pointer to the animation.
static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)
Delete an animation by getting the animated variable from a. Only animations with exec_cb will be deleted.
This function exists because it's logical that all anim. functions receives an lv_anim_t as their first parameter.
It's not practical in C but might make the API more consequent and makes easier to generate bindings.

Parameters
• a -- pointer to an animation.
• exec_cb -- a function pointer which is animating 'var', or NULL to ignore it and delete all
the animations of 'var
Returns true: at least 1 animation is deleted, false: no animation is deleted
uint16_t lv_anim_count_running(void)
Get the number of currently running animations
Returns the number of running animations
uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end)
Calculate the time of an animation with a given speed and the start and end values
Parameters
• speed -- speed of animation in unit/sec
• start -- start value of the animation
• end -- end value of the animation
Returns the required time [ms] for the animation with the given parameters
void lv_anim_refr_now(void)
Manually refresh the state of the animations. Useful to make the animations running in a blocking process where
lv_timer_handler can't run for a while. Shouldn't be used directly because it is called in lv_refr_now().
int32_t lv_anim_path_linear(const lv_anim_t *a)
Calculate the current value of an animation applying linear characteristic
Parameters a -- pointer to an animation
Returns the current value to set
int32_t lv_anim_path_ease_in(const lv_anim_t *a)
Calculate the current value of an animation slowing down the start phase
int32_t lv_anim_path_ease_out(const lv_anim_t *a)
Calculate the current value of an animation slowing down the end phase
int32_t lv_anim_path_ease_in_out(const lv_anim_t *a)
Calculate the current value of an animation applying an "S" characteristic (cosine)
int32_t lv_anim_path_overshoot(const lv_anim_t *a)
Calculate the current value of an animation with overshoot at the end
int32_t lv_anim_path_bounce(const lv_anim_t *a)
Calculate the current value of an animation with 3 bounces


int32_t lv_anim_path_step(const lv_anim_t *a)
Calculate the current value of an animation applying step characteristic. (Set end value on the end of the animation)
struct _lv_anim_t
#include <lv_anim.h> Describes an animation
Public Members
void *var
Variable to animate
lv_anim_exec_xcb_t exec_cb
Function to execute to animate
lv_anim_start_cb_t start_cb
Call it when the animation is starts (considering delay)
lv_anim_ready_cb_t ready_cb
Call it when the animation is ready
lv_anim_get_value_cb_t get_value_cb
Get the current value in relative mode
void *user_data
Custom user data
lv_anim_path_cb_t path_cb
Describe the path (curve) of animations
int32_t start_value
Start value
int32_t current_value
Current value
int32_t end_value
End value
int32_t time
Animation time in ms
int32_t act_time
Current time in animation. Set to negative to make delay.

uint32_t playback_delay
Wait before play back
uint32_t playback_time
Duration of playback animation
uint32_t repeat_delay
Wait before repeat
uint16_t repeat_cnt
Repeat count for the animation
uint8_t early_apply
1: Apply start value immediately even is there is delay
uint8_t playback_now
Play back is in progress
uint8_t run_round
Indicates the animation has run in this round
uint8_t start_cb_called
Indicates that the start_cb was already called
uint32_t time_orig
4.15 Timers
LVGL has a built-in timer system. You can register a function to have it be called periodically. The timers are handled and
called in lv_timer_handler(), which needs to be called every few milliseconds. See Porting for more information.
The timers are non-preemptive, which means a timer cannot interrupt another timer. Therefore, you can call any LVGL
related function in a timer.
4.15.1 Create a timer
To create a new timer, use lv_timer_create(timer_cb, period_ms, user_data). It will

create an lv_timer_t * variable, which can be used later to modify the parameters of the timer.
lv_timer_create_basic() can also be used. This allows you to create a new timer without specifying any pa-
rameters.
A timer callback should have void (*lv_timer_cb_t)(lv_timer_t *); prototype.
For example:
void my_timer(lv_timer_t * timer)
{
/*Use the user_data*/
uint32_t * user_data = timer->user_data;
printf("my_timer called with user data: %d\n", *user_data);
4.15. Timers 195


/*Do something with LVGL*/
if(something_happened) {
something_happened = false;
lv_btn_create(lv_scr_act(), NULL);
}
}
...
static uint32_t user_data = 10;

lv_timer_t * timer = lv_timer_create(my_timer, 500, &user_data);
4.15.2 Ready and Reset
lv_timer_ready(timer) makes the timer run on the next call of lv_timer_handler().

lv_timer_reset(timer) resets the period of a timer. It will be called again after the defined period of milliseconds
has elapsed.
4.15.3 Set parameters
You can modify some parameters of the timers later:

• lv_timer_set_cb(timer, new_cb)
• lv_timer_set_period(timer, new_period)
4.15.4 Repeat count
You can make a timer repeat only a given number of times with lv_timer_set_repeat_count(timer,
count). The timer will automatically be deleted after being called the defined number of times. Set the count to
-1 to repeat indefinitely.
4.15.5 Measure idle time
You can get the idle percentage time of lv_timer_handler with lv_timer_get_idle(). Note that, it doesn't
measure the idle time of the overall system, only lv_timer_handler. It can be misleading if you use an operating
system and call lv_timer_handler in a timer, as it won't actually measure the time the OS spends in an idle thread.
4.15.6 Asynchronous calls
In some cases, you can't do an action immediately. For example, you can't delete an object because something else
is still using it or you don't want to block the execution now. For these cases, lv_async_call(my_function,
data_p) can be used to make my_function be called on the next call of lv_timer_handler. data_p will be
passed to function when it's called. Note that, only the pointer of the data is saved so you need to ensure that the variable
will be "alive" while the function is called. It can be static, global or dynamically allocated data.
For example:
4.15. Timers 196

void my_screen_clean_up(void * scr)

{
/*Free some resources related to `scr`*/
/*Finally delete the screen*/

lv_obj_del(scr);
}
...
/*Do somethings with the object on the current screen*/
/*Delete screen on next call of `lv_timer_handler`, so not now.*/

lv_async_call(my_screen_clean_up, lv_scr_act());
/*The screen is still valid so you can do other things with it*/
If you just want to delete an object, and don't need to clean anything up in my_screen_cleanup, you could just use
lv_obj_del_async, which will delete the object on the next call to lv_timer_handler.
4.15.7 API
Typedefs
typedef void (*lv_timer_cb_t)(struct _lv_timer_t*)

Timers execute this type of functions.
typedef struct _lv_timer_t lv_timer_t

Descriptor of a lv_timer
Functions
void _lv_timer_core_init(void)
Init the lv_timer module
lv_timer_t *lv_timer_create_basic(void)
Create an "empty" timer. It needs to initialized with at least lv_timer_set_cb and
lv_timer_set_period
Returns pointer to the created timer
lv_timer_t *lv_timer_create(lv_timer_cb_t timer_xcb, uint32_t period, void *user_data)
Create a new lv_timer
Parameters
• timer_xcb -- a callback to call periodically. (the 'x' in the argument name indicates that its
not a fully generic function because it not follows the func_name(object, callback,
...) convention)
• period -- call period in ms unit
• user_data -- custom parameter
Returns pointer to the new timer
4.15. Timers 197

void lv_timer_del(lv_timer_t *timer)

Delete a lv_timer
Parameters timer -- pointer to an lv_timer
void lv_timer_pause(lv_timer_t *timer)
Pause/resume a timer.
Parameters
• timer -- pointer to an lv_timer
• pause -- true: pause the timer; false: resume
void lv_timer_resume(lv_timer_t *timer)
void lv_timer_set_cb(lv_timer_t *timer, lv_timer_cb_t timer_cb)

Set the callback the timer (the function to call periodically)
Parameters
• timer -- pointer to a timer
• timer_cb -- the function to call periodically
void lv_timer_set_period(lv_timer_t *timer, uint32_t period)
Set new period for a lv_timer
Parameters
• timer -- pointer to a lv_timer
• period -- the new period
void lv_timer_ready(lv_timer_t *timer)
Make a lv_timer ready. It will not wait its period.
Parameters timer -- pointer to a lv_timer.
void lv_timer_set_repeat_count(lv_timer_t *timer, int32_t repeat_count)
Set the number of times a timer will repeat.
Parameters
• timer -- pointer to a lv_timer.
• repeat_count -- -1 : infinity; 0 : stop ; n>0: residual times
void lv_timer_reset(lv_timer_t *timer)
Reset a lv_timer. It will be called the previously set period milliseconds later.
Parameters timer -- pointer to a lv_timer.
void lv_timer_enable(bool en)
Enable or disable the whole lv_timer handling
Parameters en -- true: lv_timer handling is running, false: lv_timer handling is suspended
uint8_t lv_timer_get_idle(void)
Get idle percentage
Returns the lv_timer idle in percentage
lv_timer_t *lv_timer_get_next(lv_timer_t *timer)
Iterate through the timers
Parameters timer -- NULL to start iteration or the previous return value to get the next timer
4.15. Timers 198

Returns the next timer or NULL if there is no more timer
struct _lv_timer_t
#include <lv_timer.h> Descriptor of a lv_timer
Public Members
uint32_t period
How often the timer should run
uint32_t last_run
Last time the timer ran
lv_timer_cb_t timer_cb
Timer function
void *user_data
Custom user data
int32_t repeat_count
1: One time; -1 : infinity; n>0: residual times
uint32_t paused
Typedefs
typedef void (*lv_async_cb_t)(void*)

Type for async callback.
Functions
lv_res_t lv_async_call(lv_async_cb_t async_xcb, void *user_data)

Call an asynchronous function the next time lv_timer_handler() is run. This function is likely to return before the
call actually happens!
Parameters
• async_xcb -- a callback which is the task itself. (the 'x' in the argument name indi-
cates that its not a fully generic function because it not follows the func_name(object,
callback, ...) convention)
• user_data -- custom parameter
4.15. Timers 199

4.16 Drawing
With LVGL, you don't need to draw anything manually. Just create objects (like buttons, labels, arc, etc), move and
change them, and LVGL will refresh and redraw what is required.
However, it might be useful to have a basic understanding of how drawing happens in LVGL to add customization, make
it easier to find bugs or just out of curiosity.
The basic concept is to not draw directly to the screen, but draw to an internal draw buffer first. When drawing (rendering)
is ready, that buffer is copied to the screen.
The draw buffer can be smaller than the screen's size. LVGL will simply render in "tiles" that fit into the given draw
buffer.
This approach has two main advantages compared to directly drawing to the screen:
1. It avoids flickering while the layers of the UI are drawn. For example, if LVGL drawn directly into the display,
when drawing a background + button + text, each "stage" would be visible for a short time .
2. It's faster to modify a buffer in internal RAM and finally write one pixel only once than reading/writing the display
directly on each pixel access. (e.g. via a display controller with SPI interface).
Note that this concept is different from "traditional" double buffering where there are 2 screen sized frame buffers: one
holds the current image to show on the display, and rendering happens to the other (inactive) frame buffer, and they are
swapped when the rendering is finished. The main difference is that with LVGL you don't have to store 2 frame buffers
(which usually requires external RAM) but only smaller draw buffer(s) that can easily fit into the internal RAM too.
4.16.1 Mechanism of screen refreshing
Be sure to get familiar with the Buffering modes of LVGL first.

LVGL refreshes the screen in the following steps:
1. Something happens on the UI which requires redrawing. For example, a button is pressed, a chart is changed, an
animation happened, etc.
2. LVGL saves the changed object's old and new area into a buffer, called an Invalid area buffer. For optimization, in
some cases, objects are not added to the buffer:
• Hidden objects are not added.
• Objects completely out of their parent are not added.
• Areas partially out of the parent are cropped to the parent's area.
• The objects on other screens are not added.
3. In every LV_DISP_DEF_REFR_PERIOD (set in lv_conf.h) the followings happen:
• LVGL checks the invalid areas and joins the adjacent or intersecting areas.
• Takes the first joined area, if it's smaller than the draw buffer, then simply render the area's content into the
draw buffer. If the area doesn't fit into the buffer, draw as many lines as possible to the draw buffer.
• When the area is rendered, call flush_cb from the display driver to refresh the display.
• If the area was larger than the buffer, render the remaining parts too.
• Do the same with all the joined areas.
When an area is redrawn, the library searches the top most object which covers that area, and starts drawing from that
object. For example, if a button's label has changed, the library will see that it's enough to draw the button under the text,
and that it's not required to draw the screen under the button too.
4.16. Drawing 200

The difference between buffering modes regarding the drawing mechanism is the following:
1. One buffer - LVGL needs to wait for lv_disp_flush_ready() (called from flush_cb) before starting
to redraw the next part.
2. Two buffers - LVGL can immediately draw to the second buffer when the first is sent to flush_cb because the
flushing should be done by DMA (or similar hardware) in the background.
3. Double buffering - flush_cb should only swap the address of the frame buffer.
4.16.2 Masking
Masking is the basic concept of LVGL's draw engine. To use LVGL it's not required to know about the mechanisms
described here, but you might find interesting to know how drawing works under hood. Knowing about masking comes
in handy if you want to customize drawing.
To learn masking let's learn the steps of drawing first. LVGL performs the following steps to render any shape, image or
text. It can be considered as a drawing pipeline.
1. Prepare the draw descriptors Create a draw descriptor from an object's styles (e.g. lv_draw_rect_dsc_t).
This gives us the parameters for drawing, for example the colors, widths, opacity, fonts, radius, etc.
2. Call the draw function Call the draw function with the draw descriptor and some other parameters (e.g.
lv_draw_rect()). It renders the primitive shape to the current draw buffer.
3. Create masks If the shape is very simple and doesn't require masks go to #5. Else create the required masks (e.g.
a rounded rectangle mask)
4. Calculate all the added mask. It creates 0..255 values into a mask buffer with the "shape" of the created masks.
E.g. in case of a "line mask" according to the parameters of the mask, keep one side of the buffer as it is (255 by
default) and set the rest to 0 to indicate that this side should be removed.
5. Blend a color or image During blending masks (make some pixels transparent or opaque), blending modes (ad-
ditive, subtractive, etc) and opacity are handled.
LVGL has the following built-in mask types which can be calculated and applied real-time:
• LV_DRAW_MASK_TYPE_LINE Removes a side from a line (top, bottom, left or right). lv_draw_line uses
4 of it. Essentially, every (skew) line is bounded with 4 line masks by forming a rectangle.
• LV_DRAW_MASK_TYPE_RADIUS Removes the inner or outer parts of a rectangle which can have radius. It's
also used to create circles by setting the radius to large value (LV_RADIUS_CIRCLE)
• LV_DRAW_MASK_TYPE_ANGLE Removes a circle sector. It is used by lv_draw_arc to remove the "empty"
sector.
• LV_DRAW_MASK_TYPE_FADE Create a vertical fade (change opacity)
• LV_DRAW_MASK_TYPE_MAP The mask is stored in an array and the necessary parts are applied
Masks are used the create almost every basic primitives:
• letters Create a mask from the letter and draw a rectangle with the letter's color considering the mask.
• line Created from 4 "line masks", to mask out the left, right, top and bottom part of the line to get perfectly
perpendicular line ending.
• rounded rectangle A mask is created real-time to add radius to the corners.
• clip corner To clip to overflowing content (usually children) on the rounded corners also a rounded rectangle mask
is applied.
• rectangle border Same as a rounded rectangle, but inner part is masked out too.
4.16. Drawing 201

• arc drawing A circle border is drawn, but an arc mask is applied too.
• ARGB images The alpha channel is separated into a mask and the image is drawn as a normal RGB image.
4.16.3 Hook drawing
Although widgets can be very well customized by styles there might be cases when something really custom is required.
To ensure a great level of flexibility LVGL sends a lot events during drawing with parameters that tell what LVGL is about
to draw. Some fields of these parameters can be modified to draw something else or any custom drawing can be added
manually.
A good use case for it is the Button matrix widget. By default its buttons can be styled in different states but you can't style
the buttons one by one. However, an event is sent for every button and you can for example tell LVGL to use different
colors on a specific button or to manually draw an image on some buttons.
Below each of these events are described in detail.
Main drawing
These events are related to the actual drawing of the object. E.g. drawing of buttons, texts, etc happens here.
lv_event_get_clip_area(event) can be used to get the current clip area. The clip area is required in draw
functions to make them draw only on a limited area.
LV_EVENT_DRAW_MAIN_BEGIN
Sent before starting to draw an object. This is a good place to add masks manually. E.g. add a line mask that "removes"
the right side of an object.
LV_EVENT_DRAW_MAIN
The actual drawing of the object happens in this event. E.g. a rectangle for a button is drawn here. First, the widgets'
internal events are called to perform drawing and after that you can draw anything on top of them. For example you can
add a custom text or an image.
LV_EVENT_DRAW_MAIN_END
Called when the main drawing is finished. You can draw anything here as well and it's also good place to remove the
masks created in LV_EVENT_DRAW_MAIN_BEGIN.
Post drawing
Post drawing events are called when all the children of an object are drawn. For example LVGL use the post drawing
phase to draw the scrollbars because they should be above all the children.
lv_event_get_clip_area(event) can be used to get the current clip area.
4.16. Drawing 202

LV_EVENT_DRAW_POST_BEGIN
Sent before starting the post draw phase. Masks can be added here too to mask out the post drawn content.
LV_EVENT_DRAW_POST
The actual drawing should happen here.
LV_EVENT_DRAW_POST_END
Called when post drawing has finished. If the masks were not removed in LV_EVENT_DRAW_MAIN_END they should
be removed here.
Part drawing
When LVGL draws a part of an object (e.g. a slider's indicator, a table's cell or a button matrix's button) it sends events
before and after drawing that part with some context of the drawing. It allows changing the parts on a very low level with
masks, extra drawing, or changing the parameters that LVGL is planning to use for drawing.
In these events an lv_obj_draw_part_t structure is used to describe the context of the drawing. Not all fields are
set for every part and widget. To see which fields are set for a widget see the widget's documentation.
lv_obj_draw_part_t has the following fields:
// Always set
const lv_area_t * clip_area; // The current clip area, required if you need to␣
,→draw something in the event
uint32_t part; // The current part for which the event is sent
uint32_t id; // The index of the part. E.g. a button's index␣
,→on button matrix or table cell index.
// Draw desciptors, set only if related

lv_draw_rect_dsc_t * rect_dsc; // A draw descriptor that can be modified to␣
,→changed what LVGL will draw. Set only for rectangle-like parts
lv_draw_label_dsc_t * label_dsc; // A draw descriptor that can be modified to␣

,→changed what LVGL will draw. Set only for text-like parts
lv_draw_line_dsc_t * line_dsc; // A draw descriptor that can be modified to␣

,→changed what LVGL will draw. Set only for line-like parts
lv_draw_img_dsc_t * img_dsc; // A draw descriptor that can be modified to␣

,→changed what LVGL will draw. Set only for image-like parts
lv_draw_arc_dsc_t * arc_dsc; // A draw descriptor that can be modified to␣

,→changed what LVGL will draw. Set only for arc-like parts
// Other paramters
lv_area_t * draw_area; // The area of the part being drawn
const lv_point_t * p1; // A point calculated during drawing. E.g. a␣
,→point of chart or the center of an arc.
const lv_point_t * p2; // A point calculated during drawing. E.g. a␣

,→point of chart.
char text[16]; // A text calculated during drawing. Can be␣

,→modified. E.g. tick labels on a chart axis.
lv_coord_t radius; // E.g. the radius of an arc (not the corner␣

,→radius).
4.16. Drawing 203


int32_t value; // A value calculated during drawing. E.g. Chart
,→'s tick line value.
const void * sub_part_ptr; // A pointer the identifies something in the part.

,→ E.g. chart series.
lv_event_get_draw_part_dsc(event) can be used to get a pointer to lv_obj_draw_part_t.
LV_EVENT_DRAW_PART_BEGIN
Start the drawing of a part. This is a good place to modify the draw descriptors (e.g. rect_dsc), or add masks.
LV_EVENT_DRAW_PART_END
Finish the drawing of a part. This is a good place to draw extra content on the part, or remove the masks added in
LV_EVENT_DRAW_PART_BEGIN.
Others
LV_EVENT_COVER_CHECK
This event is used to check whether an object fully covers an area or not.
lv_event_get_cover_area(event) returns an pointer to an area to check and
lv_event_set_cover_res(event, res) can be used to set one of these results:
• LV_COVER_RES_COVER the areas is fully covered by the object
• LV_COVER_RES_NOT_COVER the areas is not covered by the object
• LV_COVER_RES_MASKED there is a mask on the object so it can not cover the area
Here are some reasons why an object would be unable to fully cover an area:
• It's simply not fully in area
• It has a radius
• It has not 100% background opacity
• It's an ARGB or chroma keyed image
• It does not have normal blending mode. In this case LVGL needs to know the colors under the object to do the
blending properly
• It's a text, etc
In short if for any reason the area below the object is visible than it doesn't cover that area.
Before sending this event LVGL checks if at least the widget's coordinates fully cover the area or not. If not the event is
not called.
You need to check only the drawing you have added. The existing properties known by widget are handled in the widget's
internal events. E.g. if a widget has > 0 radius it might not cover an area but you need to handle radius only if you will
modify it and the widget can't know about it.
4.16. Drawing 204

LV_EVENT_REFR_EXT_DRAW_SIZE
If you need to draw outside of a widget LVGL needs to know about it to provide the extra space for drawing. Let's say
you create an event the writes the current value of a slider above its knob. In this case LVGL needs to know that the
slider's draw area should be larger with the size required for the text.
You can simple set the required draw area with lv_event_set_ext_draw_size(e, size).
4.17 New widget
4.17. New widget 205

CHAPTER
FIVE
WIDGETS
5.1 Base object (lv_obj)
5.1.1 Overview
The 'Base Object' implements the basic properties of widgets on a screen, such as:
• coordinates
• parent object
• children
• contains the styles
• attributes like Clickable, Scrollable, etc.
In object-oriented thinking, it is the base class from which all other objects in LVGL are inherited.
The functions and functionalities of the Base object can be used with other widgets too. For example
lv_obj_set_width(slider, 100)
The Base object can be directly used as a simple widget: it nothing else than a rectangle. In HTML terms, think of it as
a <div>.
Coordinates
Only a small subset of coordinate settings is described here. To see all the features of LVGL (padding, coordinates in
styles, layouts, etc) visit the Coordinates page.
Size
The object size can be modified on individual axes with lv_obj_set_width(obj, new_width) and
lv_obj_set_height(obj, new_height), or both axes can be modified at the same time with
lv_obj_set_size(obj, new_width, new_height).
206
Position
You can set the position relative to the parent with lv_obj_set_x(obj, new_x) and lv_obj_set_y(obj,
new_y), or both axes at the same time with lv_obj_set_pos(obj, new_x, new_y).
Alignment
You can align the object on its parent with lv_obj_set_align(obj, LV_ALIGN_...). After this every x and
y setting will be ralitive to the set alignment mode. For example a this will shift the object by 10;20 px from the center
of its parent.
lv_obj_set_align(obj, LV_ALIGN_CENTER);
lv_obj_set_pos(obj, 10, 20);
//Or in one function

lv_obj_align(obj, LV_ALIGN_CENTER, 10, 20);
To align one object to another use lv_obj_align_to(obj_to_align, obj_referece, LV_ALIGN_...,

x, y)
For example, to align a text below an image: lv_obj_align(text, image, LV_ALIGN_OUT_BOTTOM_MID,
0, 10).
The following align types exist:
Parents and children
You can set a new parent for an object with lv_obj_set_parent(obj, new_parent). To get the current
parent, use lv_obj_get_parent(obj).
To get a specific children of a parent use lv_obj_get_child(parent, idx). Some examples for idx:
• 0 get the child created first child
• 1 get the child created second
• -1 get the child created last
5.1. Base object (lv_obj) 207

The children can be iterated lke this
uint32_t i;
for(i = 0; i < lv_obj_get_child_cnt(parent); i++) {
lv_obj_t * child = lv_obj_get_child(paernt, i);
/*Do something with child*/
}
lv_obj_get_child_id(obj) returns the index of the object. That is how many younger children its parent has.
You can bring an object to the foreground or send it to the background with lv_obj_move_foreground(obj)
and lv_obj_move_background(obj).
Screens
When you have created a screen like lv_obj_t * screen = lv_obj_create(NULL), you can load it with
lv_scr_load(screen). The lv_scr_act() function gives you a pointer to the current screen.
If you have multiple displays then it's important to know that these functions operate on the most-recently created or on
the explicitly selected (with lv_disp_set_default) display.
To get an object's screen use the lv_obj_get_screen(obj) function.
Events
To set an event callback for an object, use lv_obj_add_event_cb(obj, event_cb, LV_EVENT_...,

user_data),
To manually send an event to an object, use lv_event_send(obj, LV_EVENT_..., param)
Read the Event overview to learn more about the events.
Styles
Be sure to read the Style overview. Here only the most essential functions are described.
A new style can be added to an object with lv_obj_add_style(obj, &new_style, selector) function.
selector is a combination of part and state(s). E.g. LV_PART_SCROLLBAR | LV_STATE_PRESSED.
The base objects use LV_PART_MAIN style properties and LV_PART_SCROLLBAR with the typical backgroud style
properties.
Flags
There are some attributes which can be enabled/disabled by lv_obj_add/clear_flag(obj, LV_OBJ_FLAG_.

..):
• LV_OBJ_FLAG_HIDDEN Make the object hidden. (Like it wasn't there at all)
• LV_OBJ_FLAG_CLICKABLE Make the object clickable by the input devices
• LV_OBJ_FLAG_CLICK_FOCUSABLE Add focused state to the object when clicked
• LV_OBJ_FLAG_CHECKABLE Toggle checked state when the object is clicked
• LV_OBJ_FLAG_SCROLLABLE Make the object scrollable
• LV_OBJ_FLAG_SCROLL_ELASTIC Allow scrolling inside but with slower speed

• LV_OBJ_FLAG_SCROLL_MOMENTUM Make the object scroll further when "thrown"

• LV_OBJ_FLAG_SCROLL_ONE Allow scrolling only one snapable children
• LV_OBJ_FLAG_SCROLL_CHAIN Allow propagating the scroll to a parent
• LV_OBJ_FLAG_SCROLL_ON_FOCUS Automatically scroll object to make it visible when focused
• LV_OBJ_FLAG_SNAPABLE If scroll snap is enabled on the parent it can snap to this object
• LV_OBJ_FLAG_PRESS_LOCK Keep the object pressed even if the press slid from the object
• LV_OBJ_FLAG_EVENT_BUBBLE Propagate the events to the parent too
• LV_OBJ_FLAG_GESTURE_BUBBLE Propagate the gestures to the parent
• LV_OBJ_FLAG_ADV_HITTEST Allow performing more accurate hit (click) test. E.g. consider rounded corners.
• LV_OBJ_FLAG_IGNORE_LAYOUT Make the object position-able by the layouts
• LV_OBJ_FLAG_FLOATING Do not scroll the object when the parent scrolls and ignore layout
• LV_OBJ_FLAG_LAYOUT_1 Custom flag, free to use by layouts
• LV_OBJ_FLAG_LAYOUT_2 Custom flag, free to use by layouts
• LV_OBJ_FLAG_WIDGET_1 Custom flag, free to use by widget
• LV_OBJ_FLAG_WIDGET_2 Custom flag, free to use by widget
• LV_OBJ_FLAG_USER_1 Custom flag, free to use by user
• LV_OBJ_FLAG_USER_4 Custom flag, free to use by usersection.
Some examples:
/*Hide on object*/
lv_obj_add_flag(obj, LV_OBJ_FLAG_HIDDEN);
/*Make an obejct non-clickable*/

lv_obj_clear_flag(obj, LV_OBJ_FLAG_CLICKABLE);
Groups
Read the Input devices overview to learn more about the Groups.
Objects are added to a group with lv_group_add_obj(group, obj), and you can use
lv_obj_get_group(obj) to see which group an object belongs to.
lv_obj_is_focused(obj) returns if the object is currently focused on its group or not. If the object is not added
to a group, false will be returned.

Extended click area
By default, the objects can be clicked only on their coordinates, however, this area can be extended with
lv_obj_set_ext_click_area(obj, size).
5.1.2 Events
• LV_EVENT_VALUE_CHANGED when the LV_OBJ_FLAG_CHECKABLE flag is enabled and the object clicked
(on transition to/from the checked state)
Learn more about Events.
5.1.3 Keys
If LV_OBJ_FLAG_CHECKABLE is enabled LV_KEY_RIGHT and LV_KEY_UP make the object checked, and
LV_KEY_LEFT and LV_KEY_DOWN make it unchecked.
Learn more about Keys.
5.1.4 Example
Base objects with custom styles
#include "../../lv_examples.h"
void lv_example_obj_1(void)
{
lv_obj_t * obj1;
obj1 = lv_obj_create(lv_scr_act());
lv_obj_set_size(obj1, 100, 50);
lv_obj_align(obj1, LV_ALIGN_CENTER, -60, -30);
static lv_style_t style_shadow;

lv_style_init(&style_shadow);
lv_style_set_shadow_width(&style_shadow, 10);
lv_style_set_shadow_spread(&style_shadow, 5);
lv_style_set_shadow_color(&style_shadow, lv_palette_main(LV_PALETTE_BLUE));
lv_obj_t * obj2;
obj2 = lv_obj_create(lv_scr_act());
lv_obj_add_style(obj2, &style_shadow, 0);
lv_obj_align(obj2, LV_ALIGN_CENTER, 60, 30);
}
#endif

Make an object draggable
static void drag_event_handler(lv_event_t * e)

{
lv_indev_t * indev = lv_indev_get_act();

lv_point_t vect;
lv_indev_get_vect(indev, &vect);
lv_coord_t x = lv_obj_get_x(obj) + vect.x;

lv_coord_t y = lv_obj_get_y(obj) + vect.y;
lv_obj_set_pos(obj, x, y);
}
/**
* Make an object dragable.
*/
void lv_example_obj_2(void)
{
lv_obj_t * obj;
obj = lv_obj_create(lv_scr_act());
lv_obj_add_event_cb(obj, drag_event_handler, LV_EVENT_PRESSING, NULL);

lv_label_set_text(label, "Drag me");
}
#endif
MicroPython
No examples yet.
5.1.5 API
Typedefs
typedef uint16_t lv_state_t

typedef uint32_t lv_part_t
typedef uint32_t lv_obj_flag_t
typedef struct _lv_obj_t lv_obj_t

Enums
enum [anonymous]
Possible states of a widget. OR-ed values are possible
Values:
enumerator LV_STATE_DEFAULT
enumerator LV_STATE_CHECKED
enumerator LV_STATE_FOCUSED
enumerator LV_STATE_FOCUS_KEY
enumerator LV_STATE_EDITED
enumerator LV_STATE_HOVERED
enumerator LV_STATE_PRESSED
enumerator LV_STATE_SCROLLED
enumerator LV_STATE_DISABLED
enumerator LV_STATE_USER_1
enumerator LV_STATE_ANY
Special value can be used in some functions to target all states
enum [anonymous]
The possible parts of widgets. The parts can be considered as the internal building block of the widgets. E.g. slider
= background + indicator + knob Note every part is used by every widget
Values:
enumerator LV_PART_MAIN
A background like rectangle
enumerator LV_PART_SCROLLBAR
The scrollbar(s)
enumerator LV_PART_INDICATOR
Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
enumerator LV_PART_KNOB
Like handle to grab to adjust the value
enumerator LV_PART_SELECTED
Indicate the currently selected option or section
enumerator LV_PART_ITEMS
Used if the widget has multiple similar elements (e.g. table cells)

enumerator LV_PART_TICKS
Ticks on scale e.g. for a chart or meter
enumerator LV_PART_CURSOR
Mark a specific place e.g. for text area's cursor or on a chart
enumerator LV_PART_CUSTOM_FIRST
Extension point for custom widgets
enumerator LV_PART_ANY
Special value can be used in some functions to target all parts
enum [anonymous]
On/Off features controlling the object's behavior. OR-ed values are possible
Values:
enumerator LV_OBJ_FLAG_HIDDEN
Make the object hidden. (Like it wasn't there at all)
enumerator LV_OBJ_FLAG_CLICKABLE
Make the object clickable by the input devices
enumerator LV_OBJ_FLAG_CLICK_FOCUSABLE
Add focused state to the object when clicked
enumerator LV_OBJ_FLAG_CHECKABLE
Toggle checked state when the object is clicked
enumerator LV_OBJ_FLAG_SCROLLABLE
Make the object scrollable
enumerator LV_OBJ_FLAG_SCROLL_ELASTIC
Allow scrolling inside but with slower speed
enumerator LV_OBJ_FLAG_SCROLL_MOMENTUM
Make the object scroll further when "thrown"
enumerator LV_OBJ_FLAG_SCROLL_ONE
Allow scrolling only one snapable children
enumerator LV_OBJ_FLAG_SCROLL_CHAIN
Allow propagating the scroll to a parent
enumerator LV_OBJ_FLAG_SCROLL_ON_FOCUS
Automatically scroll object to make it visible when focused
enumerator LV_OBJ_FLAG_SNAPABLE
If scroll snap is enabled on the parent it can snap to this object

enumerator LV_OBJ_FLAG_PRESS_LOCK
Keep the object pressed even if the press slid from the object
enumerator LV_OBJ_FLAG_EVENT_BUBBLE
Propagate the events to the parent too
enumerator LV_OBJ_FLAG_GESTURE_BUBBLE
Propagate the gestures to the parent
enumerator LV_OBJ_FLAG_ADV_HITTEST
Allow performing more accurate hit (click) test. E.g. consider rounded corners.
enumerator LV_OBJ_FLAG_IGNORE_LAYOUT
Make the object position-able by the layouts
enumerator LV_OBJ_FLAG_FLOATING
Do not scroll the object when the parent scrolls and ignore layout
enumerator LV_OBJ_FLAG_LAYOUT_1
enumerator LV_OBJ_FLAG_LAYOUT_2
Custom flag, free to use by layouts
enumerator LV_OBJ_FLAG_WIDGET_1
Custom flag, free to use by layouts
enumerator LV_OBJ_FLAG_WIDGET_2
Custom flag, free to use by widget
enumerator LV_OBJ_FLAG_USER_1
Custom flag, free to use by widget
Custom flag, free to use by user
Functions
void lv_init(void)
Initialize LVGL library. Should be called before any other LVGL related function.
void lv_deinit(void)
Deinit the 'lv' library Currently only implemented when not using custom allocators, or GC is enabled.
lv_obj_t *lv_obj_create(lv_obj_t *parent)
Create a base object (a rectangle)
Parameters parent -- pointer to a parent object. If NULL then a screen will be created.

Returns pointer to the new object

void lv_obj_add_flag(lv_obj_t *obj, lv_obj_flag_t f)
Set one or more flags
Parameters
• obj -- pointer to an object
• f -- R-ed values from lv_obj_flag_t to set.
void lv_obj_clear_flag(lv_obj_t *obj, lv_obj_flag_t f)
Clear one or more flags
Parameters
• f -- OR-ed values from lv_obj_flag_t to set.
void lv_obj_add_state(lv_obj_t *obj, lv_state_t state)
Add one or more states to the object. The other state bits will remain unchanged. If specified in the styles, transition
animation will be started from the previous state to the current.
Parameters
• state -- the states to add. E.g LV_STATE_PRESSED | LV_STATE_FOCUSED
void lv_obj_clear_state(lv_obj_t *obj, lv_state_t state)
Remove one or more states to the object. The other state bits will remain unchanged. If specified in the styles,
transition animation will be started from the previous state to the current.
Parameters
• state -- the states to add. E.g LV_STATE_PRESSED | LV_STATE_FOCUSED
static inline void lv_obj_set_user_data(lv_obj_t *obj, void *user_data)
Set the user_data field of the object
Parameters
• user_data -- pointer to the new user_data.
bool lv_obj_has_flag(const lv_obj_t *obj, lv_obj_flag_t f)
Check if a given flag or all the given flags are set on an object.
Parameters
• f -- the flag(s) to check (OR-ed values can be used)
Returns true: all flags are set; false: not all flags are set
bool lv_obj_has_flag_any(const lv_obj_t *obj, lv_obj_flag_t f)
Check if a given flag or any of the flags are set on an object.
Parameters
• f -- the flag(s) to check (OR-ed values can be used)

Returns true: at lest one flag flag is set; false: none of the flags are set
lv_state_t lv_obj_get_state(const lv_obj_t *obj)
Get the state of an object
Returns the state (OR-ed values from lv_state_t)
bool lv_obj_has_state(const lv_obj_t *obj, lv_state_t state)
Check if the object is in a given state or not.
Parameters
• state -- a state or combination of states to check
Returns true: obj is in state; false: obj is not in state
void *lv_obj_get_group(const lv_obj_t *obj)
Get the group of the object
Returns the pointer to group of the object
static inline void *lv_obj_get_user_data(lv_obj_t *obj)
Get the user_data field of the object
Returns the pointer to the user_data of the object
void lv_obj_allocate_spec_attr(lv_obj_t *obj)
Allocate special data for an object if not allocated yet.
bool lv_obj_check_type(const lv_obj_t *obj, const lv_obj_class_t *class_p)
Get object's and its ancestors type. Put their name in type_buf starting with the current type. E.g.
buf.type[0]="lv_btn", buf.type[1]="lv_cont", buf.type[2]="lv_obj"
Parameters
• obj -- pointer to an object which type should be get
• buf -- pointer to an lv_obj_type_t buffer to store the types
bool lv_obj_has_class(const lv_obj_t *obj, const lv_obj_class_t *class_p)
Check if any object has a given class (type). It checks the ancestor classes too.
Parameters
• class_p -- a class to check (e.g. lv_slider_class)
Returns true: obj has the given class
const lv_obj_class_t *lv_obj_get_class(const lv_obj_t *obj)
Get the class (type) of the object
Returns the class (type) of the object

bool lv_obj_is_valid(const lv_obj_t *obj)

Check if any object is still "alive", and part of the hierarchy
Parameters
• obj_type -- type of the object. (e.g. "lv_btn")
Returns true: valid
static inline lv_coord_t lv_obj_dpx(const lv_obj_t *obj, lv_coord_t n)
Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the obj's
Parameters
• obj -- an object whose display's dpi should be considered
• n -- the number of pixels to scale
Variables
const lv_obj_class_t lv_obj_class

Make the base object's class publicly available.
struct _lv_obj_spec_attr_t
#include <lv_obj.h> Special, rarely used attributes. They are allocated automatically if any elements is set.
Public Members
struct _lv_obj_t **children

Store the pointer of the children in an array.
uint32_t child_cnt
Number of children
lv_group_t *group_p
struct _lv_event_dsc_t *event_dsc
Dynamically allocated event callback and user data array
lv_point_t scroll
The current X/Y scroll offset
lv_coord_t ext_click_pad
Extra click padding in all direction
lv_coord_t ext_draw_size
EXTend the size in every direction for drawing.
lv_scrollbar_mode_t scrollbar_mode
How to display scrollbars

lv_scroll_snap_t scroll_snap_x
Where to align the snapable children horizontally
lv_scroll_snap_t scroll_snap_y
Where to align the snapable children horizontally
lv_dir_t scroll_dir
The allowed scroll direction(s)
uint8_t event_dsc_cnt
Number of event callabcks stored in event_cb array
struct _lv_obj_t
Public Members
const lv_obj_class_t *class_p

struct _lv_obj_t *parent
_lv_obj_spec_attr_t *spec_attr
_lv_obj_style_t *styles
void *user_data
lv_area_t coords
lv_obj_flag_t flags
lv_state_t state
uint16_t layout_inv
uint16_t scr_layout_inv
uint16_t skip_trans
uint16_t style_cnt
uint16_t h_layout
uint16_t w_layout
5.2 Core widgets
5.2.1 Arc (lv_arc)
Overview
The Arc consists of a background and a foreground arc. The foregrond (indicator) can be touch-adjusted.
5.2. Core widgets 218

Parts and Styles
• LV_PART_MAIN Draws a background using the typical background style properties and an arc using the arc style
properties. The arc's size and position will respect the padding style properties.
• LV_PART_INDICATOR Draws an other arc using the arc style properties. Its padding values are interpreted
relative to the background arc.
• LV_PART_KNOB Draws a handle on the end of the indicator using all background properties and padding values.
With zero padding the knob size is the same as the indicator's width. Larger padding makes it larger, smaller
padding makes it smaller.
Usage
Value and range
A new value can be set using lv_arc_set_value(arc, new_value). The value is interpreted in a range
(minimum and maximum values) which can be modified with lv_arc_set_range(arc, min, max). The
default range is 1..100.
The indicator arc is drawn on the main part's arc. This if the value is set to maximum the indicator arc will cover the entire
"background" arc. To set the start and end angle of the background arc use the lv_arc_set_bg_angles(arc,
start_angle, end_angle) functions or lv_arc_set_bg_start/end_angle(arc, angle).
Zero degrees is at the middle right (3 o'clock) of the object and the degrees are increasing in clockwise direction. The
angles should be in the [0;360] range.
Rotation
An offset to the 0 degree position can added with lv_arc_set_rotation(arc, deg).
Mode
The arc can be one of the following modes:

• LV_ARC_MODE_NORMAL The indicator arc is drawn from the minimimum value to the current.
• LV_ARC_MODE_REVERSE The indicator arc is drawn counter-clockwise from the maximum value to the current.
• LV_ARC_MODE_SYMMETRICAL The indicator arc is drawn from the middle point to the current value.
The mode can be set by lv_arc_set_mode(arc, LV_ARC_MODE_...) and used only if the the angle is set by
lv_arc_set_value() or the arc is adjusted by finger.
Change rate
If the arc is pressed the current value will set with a limited speed according to the set change rate. The change rate is
defined in degree/second unit and can be set with lv_arc_set_change_rage(arc, rate)

Setting the indicator manually
It also possible to set the angles of the indicator arc directly with lv_arc_set_angles(arc, start_angle,
end_angle) function or lv_arc_set_start/end_angle(arc, start_angle). In this case the set
"value" and "mode" is ignored.
In other words, settings angles and values are independent. You should use either value and angle settings. Mixing the
two might result in unintended behavior.
To make the arc non-adjustabe remove the style of the knob and make the object non-clickable:
lv_obj_remove_style(arc, NULL, LV_PART_KNOB);

lv_obj_clear_flag(arc, LV_OBJ_FLAG_CLICKABLE);
Events
• LV_EVENT_VALUE_CHANGED sent when the arc is pressed/dragged to set a new value.

• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for the background rectan-
gle, the background arc, the foreground arc and the knob to allow hooking the drawing. For more detail on the
backround rectangle part see the Base object's documentation. The fields of lv_obj_draw_dsc_t are set as
follows:
– For both arcs: clip_area, p1 (center of the arc), radius, arc_dsc, part.
– For the knob: clip_area, draw_area, rect_dsc, part.
Keys
• LV_KEY_RIGHT/UP Increases the value by one.

• LV_KEY_LEFT/DOWN Decreases the value by one.
Example
Simple Arc
#if LV_USE_ARC && LV_BUILD_EXAMPLES
void lv_example_arc_1(void)
{
/*Create an Arc*/
lv_obj_t * arc = lv_arc_create(lv_scr_act());
lv_obj_set_size(arc, 150, 150);
lv_arc_set_rotation(arc, 135);
lv_arc_set_bg_angles(arc, 0, 270);


lv_arc_set_value(arc, 40);
lv_obj_center(arc);
}
#endif
Loader with Arc
#if LV_USE_ARC && LV_BUILD_EXAMPLES
static void set_angle(void * obj, int32_t v)

{
lv_arc_set_value(obj, v);
}
/**
* Create an arc which acts as a loader.
*/
void lv_example_arc_2(void)
{
/*Create an Arc*/
lv_obj_t * arc = lv_arc_create(lv_scr_act());
lv_arc_set_rotation(arc, 270);
lv_arc_set_bg_angles(arc, 0, 360);
lv_obj_remove_style(arc, NULL, LV_PART_KNOB); /*Be sure the knob is not␣
,→displayed*/
lv_obj_clear_flag(arc, LV_OBJ_FLAG_CLICKABLE); /*To not allow adjusting by click*/

lv_obj_center(arc);
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, arc);
lv_anim_set_exec_cb(&a, set_angle);
lv_anim_set_repeat_count(&a, LV_ANIM_REPEAT_INFINITE); /*Just for the demo*/
lv_anim_start(&a);
#endif

MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_arc_mode_t
Enums
enum [anonymous]
Values:
enumerator LV_ARC_MODE_NORMAL
enumerator LV_ARC_MODE_SYMMETRICAL
enumerator LV_ARC_MODE_REVERSE
Functions
lv_obj_t *lv_arc_create(lv_obj_t *parent)

Create a arc objects
Parameters par -- pointer to an object, it will be the parent of the new arc
Returns pointer to the created arc
void lv_arc_set_start_angle(lv_obj_t *arc, uint16_t start)
Set the start angle of an arc. 0 deg: right, 90 bottom, etc.
Parameters
• arc -- pointer to an arc object
• start -- the start angle
void lv_arc_set_end_angle(lv_obj_t *arc, uint16_t end)
Set the end angle of an arc. 0 deg: right, 90 bottom, etc.
Parameters
• end -- the end angle
void lv_arc_set_angles(lv_obj_t *arc, uint16_t start, uint16_t end)
Set the start and end angles
Parameters

void lv_arc_set_bg_start_angle(lv_obj_t *arc, uint16_t start)

Set the start angle of an arc background. 0 deg: right, 90 bottom, etc.
Parameters
void lv_arc_set_bg_end_angle(lv_obj_t *arc, uint16_t end)
Set the start angle of an arc background. 0 deg: right, 90 bottom etc.
Parameters
void lv_arc_set_bg_angles(lv_obj_t *arc, uint16_t start, uint16_t end)
Set the start and end angles of the arc background
Parameters
void lv_arc_set_rotation(lv_obj_t *arc, uint16_t rotation)
Set the rotation for the whole arc
Parameters
• rotation -- rotation angle
void lv_arc_set_mode(lv_obj_t *arc, lv_arc_mode_t type)
Set the type of arc.
Parameters
• arc -- pointer to arc object
• mode -- arc's mode
void lv_arc_set_value(lv_obj_t *arc, int16_t value)
Set a new value on the arc
Parameters
• arc -- pointer to a arc object
• value -- new value
void lv_arc_set_range(lv_obj_t *arc, int16_t min, int16_t max)
Set minimum and the maximum values of a arc
Parameters
• arc -- pointer to the arc object
• min -- minimum value
• max -- maximum value
void lv_arc_set_change_rate(lv_obj_t *arc, uint16_t rate)
Set a change rate to limit the speed how fast the arc should reache the pressed point.

Parameters
• arc -- pointer to a arc object
• rate -- the change rate
uint16_t lv_arc_get_angle_start(lv_obj_t *obj)
Get the start angle of an arc.
Parameters arc -- pointer to an arc object
Returns the start angle [0..360]
uint16_t lv_arc_get_angle_end(lv_obj_t *obj)
Get the end angle of an arc.
Returns the end angle [0..360]
uint16_t lv_arc_get_bg_angle_start(lv_obj_t *obj)
Get the start angle of an arc background.
Returns the start angle [0..360]
uint16_t lv_arc_get_bg_angle_end(lv_obj_t *obj)
Get the end angle of an arc background.
Returns the end angle [0..360]
int16_t lv_arc_get_value(const lv_obj_t *obj)
Get the value of a arc
Parameters arc -- pointer to a arc object
Returns the value of the arc
int16_t lv_arc_get_min_value(const lv_obj_t *obj)
Get the minimum value of a arc
Returns the minimum value of the arc
int16_t lv_arc_get_max_value(const lv_obj_t *obj)
Get the maximum value of a arc
Returns the maximum value of the arc
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t *obj)
Get whether the arc is type or not.
Returns arc's mode

Variables
const lv_obj_class_t lv_arc_class

struct lv_arc_t
Public Members
lv_obj_t obj
uint16_t rotation
uint16_t indic_angle_start
uint16_t indic_angle_end
uint16_t bg_angle_start
uint16_t bg_angle_end
int16_t value
int16_t min_value
int16_t max_value
uint16_t dragging
uint16_t type
uint16_t min_close
uint16_t chg_rate
uint32_t last_tick
int16_t last_angle
5.2.2 Bar (lv_bar)
Overview
The bar object has a background and an indicator on it. The width of the indicator is set according to the current value
of the bar.
Vertical bars can be created if the width of the object is smaller than its height.
Not only the end, but also the start value of the bar can be set, which changes the start position of the indicator.

Parts and Styles
• LV_PART_MAIN The background of the bar and it uses the typical background style properties. Adding padding
makes the indicator smaller or larger. The anim_time style property sets the animation time if the values set
with LV_ANIM_ON.
• LV_PART_INDICATOR The indicator itself; also also uses all the typical background properties.
Usage
Value and range
A new value can be set by lv_bar_set_value(bar, new_value, LV_ANIM_ON/OFF). The value is inter-
preted in a range (minimum and maximum values) which can be modified with lv_bar_set_range(bar, min,
max). The default range is 1..100.
The new value in lv_bar_set_value can be set with or without an animation depending on the last parameter
(LV_ANIM_ON/OFF).
Modes
The bar can be one the following modes:

• LV_BAR_MODE_NORMAL A normal bar as described above
• LV_BAR_SYMMETRICAL Draw the indicator from the zero value to current value. Requires a negative minimum
range and positive maximum range.
• LV_BAR_RANGE Allows setting the start value too by lv_bar_set_start_value(bar, new_value,
LV_ANIM_ON/OFF). The start value always has to be smaller than the end value.
Events
• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for both main and indicator
parts to allow hooking the drawing. For more detail on the main part see the Base object's documentation. For the
indicator the following fields are used: clip_area, draw_area, rect_dsc, part.
Keys
No Keys are processed by the object type.


Example
Simple Bar
#if LV_USE_BAR && LV_BUILD_EXAMPLES
void lv_example_bar_1(void)
{
lv_obj_t * bar1 = lv_bar_create(lv_scr_act());
lv_obj_set_size(bar1, 200, 20);
lv_obj_center(bar1);
lv_bar_set_value(bar1, 70, LV_ANIM_OFF);
}
#endif
Styling a bar
/**
* Example of styling the bar
*/
{
static lv_style_t style_bg;
lv_style_init(&style_bg);
lv_style_set_border_color(&style_bg, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_border_width(&style_bg, 2);
lv_style_set_pad_all(&style_bg, 6); /*To make the indicator smaller*/
lv_style_set_radius(&style_bg, 6);
lv_style_set_anim_time(&style_bg, 1000);
lv_style_set_bg_opa(&style_indic, LV_OPA_COVER);
lv_style_set_bg_color(&style_indic, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_radius(&style_indic, 3);
lv_obj_t * bar = lv_bar_create(lv_scr_act());

lv_obj_remove_style_all(bar); /*To have a clean start*/
lv_obj_add_style(bar, &style_bg, 0);
lv_obj_add_style(bar, &style_indic, LV_PART_INDICATOR);
lv_obj_set_size(bar, 200, 20);

lv_obj_center(bar);
lv_bar_set_value(bar, 100, LV_ANIM_ON);
}


#endif
Temperature meter
static void set_temp(void * bar, int32_t temp)

{
lv_bar_set_value(bar, temp, LV_ANIM_ON);
}
/**
* A temperature meter example
*/
{
lv_style_set_bg_opa(&style_indic, LV_OPA_COVER);
lv_style_set_bg_color(&style_indic, lv_palette_main(LV_PALETTE_RED));
lv_style_set_bg_grad_color(&style_indic, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_bg_grad_dir(&style_indic, LV_GRAD_DIR_VER);

lv_obj_center(bar);
lv_bar_set_range(bar, -20, 40);
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_exec_cb(&a, set_temp);
lv_anim_set_var(&a, bar);
lv_anim_set_values(&a, -20, 40);
lv_anim_start(&a);
}
#endif

Stripe pattern and range value
/**
* Bar with stripe pattern and ranged value
*/
{
LV_IMG_DECLARE(img_skew_strip);
lv_style_set_bg_img_src(&style_indic, &img_skew_strip);
lv_style_set_bg_img_tiled(&style_indic, true);
lv_style_set_bg_img_opa(&style_indic, LV_OPA_30);


lv_obj_center(bar);
lv_bar_set_mode(bar, LV_BAR_MODE_RANGE);
lv_bar_set_value(bar, 90, LV_ANIM_OFF);
lv_bar_set_start_value(bar, 20, LV_ANIM_OFF);
}
#endif
Bar with RTL and RTL base direction
/**
* Bar with LTR and RTL base direction
*/
{
lv_obj_t * label;
lv_obj_t * bar_ltr = lv_bar_create(lv_scr_act());

lv_obj_set_size(bar_ltr, 200, 20);
lv_bar_set_value(bar_ltr, 70, LV_ANIM_OFF);
lv_obj_align(bar_ltr, LV_ALIGN_CENTER, 0, -30);
lv_label_set_text(label, "Left to Right base direction");
lv_obj_align_to(label, bar_ltr, LV_ALIGN_OUT_TOP_MID, 0, -5);
lv_obj_t * bar_rtl = lv_bar_create(lv_scr_act());

lv_obj_set_style_base_dir(bar_rtl, LV_BASE_DIR_RTL, 0);
lv_obj_set_size(bar_rtl, 200, 20);


lv_bar_set_value(bar_rtl, 70, LV_ANIM_OFF);
lv_obj_align(bar_rtl, LV_ALIGN_CENTER, 0, 30);
lv_label_set_text(label, "Right to Left base direction");
lv_obj_align_to(label, bar_rtl, LV_ALIGN_OUT_TOP_MID, 0, -5);
}
#endif
Custom drawr to show the current value
static void set_value(void *bar, int32_t v)

{
lv_bar_set_value(bar, v, LV_ANIM_OFF);
}

{
lv_obj_draw_part_dsc_t * dsc = lv_event_get_param(e);
if(dsc->part != LV_PART_INDICATOR) return;
lv_obj_t * obj= lv_event_get_target(e);
lv_draw_label_dsc_t label_dsc;
lv_draw_label_dsc_init(&label_dsc);
label_dsc.font = LV_FONT_DEFAULT;
char buf[8];
lv_snprintf(buf, sizeof(buf), "%d", lv_bar_get_value(obj));
lv_point_t txt_size;
lv_txt_get_size(&txt_size, buf, label_dsc.font, label_dsc.letter_space, label_dsc.
,→line_space, LV_COORD_MAX, label_dsc.flag);
lv_area_t txt_area;
/*If the indicator is long enough put the text inside on the right*/
if(lv_area_get_width(dsc->draw_area) > txt_size.x + 20) {
txt_area.x2 = dsc->draw_area->x2 - 5;
txt_area.x1 = txt_area.x2 - txt_size.x + 1;
label_dsc.color = lv_color_white();
}
/*If the indicator is still short put the text out of it on the right*/
else {
txt_area.x1 = dsc->draw_area->x2 + 5;
txt_area.x2 = txt_area.x1 + txt_size.x - 1;
label_dsc.color = lv_color_black();
}
txt_area.y1 = dsc->draw_area->y1 + (lv_area_get_height(dsc->draw_area) - txt_size.

,→ y) / 2;


txt_area.y2 = txt_area.y1 + txt_size.y - 1;
lv_draw_label(&txt_area, dsc->clip_area, &label_dsc, buf, NULL);

}
/**
* Custom drawer on the bar to display the current value
*/
{
lv_obj_add_event_cb(bar, event_cb, LV_EVENT_DRAW_PART_END, NULL);
lv_obj_center(bar);
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, bar);
lv_anim_set_exec_cb(&a, set_value);
lv_anim_start(&a);
#endif
MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_bar_mode_t
Enums
enum [anonymous]
Values:
enumerator LV_BAR_MODE_NORMAL
enumerator LV_BAR_MODE_SYMMETRICAL
enumerator LV_BAR_MODE_RANGE

Functions
lv_obj_t *lv_bar_create(lv_obj_t *parent)

Create a bar objects
Parameters parent -- pointer to an object, it will be the parent of the new bar
Returns pointer to the created bar
void lv_bar_set_value(lv_obj_t *obj, int32_t value, lv_anim_enable_t anim)
Set a new value on the bar
Parameters
• bar -- pointer to a bar object
• anim -- LV_ANIM_ON: set the value with an animation; LV_ANIM_OFF: change the value
immediately
void lv_bar_set_start_value(lv_obj_t *obj, int32_t start_value, lv_anim_enable_t anim)
Set a new start value on the bar
Parameters
• obj -- pointer to a bar object
• value -- new start value
immediately
void lv_bar_set_range(lv_obj_t *obj, int32_t min, int32_t max)
Set minimum and the maximum values of a bar
Parameters
• obj -- pointer to the bar object
void lv_bar_set_mode(lv_obj_t *obj, lv_bar_mode_t mode)
Set the type of bar.
Parameters
• obj -- pointer to bar object
• mode -- bar type from ::lv_bar_mode_t
int32_t lv_bar_get_value(const lv_obj_t *obj)
Get the value of a bar
Parameters obj -- pointer to a bar object
Returns the value of the bar
int32_t lv_bar_get_start_value(const lv_obj_t *obj)
Get the start value of a bar
Returns the start value of the bar

int32_t lv_bar_get_min_value(const lv_obj_t *obj)

Get the minimum value of a bar
Returns the minimum value of the bar
int32_t lv_bar_get_max_value(const lv_obj_t *obj)
Get the maximum value of a bar
Returns the maximum value of the bar
lv_bar_mode_t lv_bar_get_mode(lv_obj_t *obj)
Get the type of bar.
Parameters obj -- pointer to bar object
Returns bar type from ::lv_bar_mode_t
Variables
const lv_obj_class_t lv_bar_class

struct _lv_bar_anim_t
Public Members
lv_obj_t *bar
int32_t anim_start
int32_t anim_end
int32_t anim_state
struct lv_bar_t
Public Members
lv_obj_t obj
int32_t cur_value
Current value of the bar
int32_t min_value
Minimum value of the bar
int32_t max_value
Maximum value of the bar
int32_t start_value
Start value of the bar

lv_area_t indic_area
Save the indicator area. Might be used by derived types
_lv_bar_anim_t cur_value_anim
_lv_bar_anim_t start_value_anim
lv_bar_mode_t mode
Type of bar
5.2.3 Button (lv_btn)
Overview
Buttons have no new features compared to the Base object. They are usuful for semantic purposes and have slightly
different default settings.
Buttons, by default, differ from Base object in the following ways:
• Not scrollable
• Added to the default group
• Default height and width set to LV_SIZE_CONTENT
Parts and Styles
• LV_PART_MAIN The background of the button. Uses the typical background style properties.
Usage
There are no new features compared to Base object.
Events
• LV_EVENT_VALUE_CHANGED when the LV_OBJ_FLAG_CHECKABLE flag is enabled and the object is

clicked. The event happens on transition to/from the checked state.
Keys
If LV_OBJ_FLAG_CHECKABLE is enabled LV_KEY_RIGHT and LV_KEY_UP make the object checked, and
LV_KEY_LEFT and LV_KEY_DOWN make it unchecked.
Note that the state of LV_KEY_ENTER is translated to LV_EVENT_PRESSED/PRESSING/RELEASED etc.

Example
Simple Buttons
static void event_handler(lv_event_t * e)

{
LV_LOG_USER("Clicked");
}
else if(code == LV_EVENT_VALUE_CHANGED) {
LV_LOG_USER("Toggled");
}
}
void lv_example_btn_1(void)
{
lv_obj_t * label;

lv_obj_add_event_cb(btn1, event_handler, LV_EVENT_ALL, NULL);
lv_obj_align(btn1, LV_ALIGN_CENTER, 0, -40);

lv_obj_add_event_cb(btn2, event_handler, LV_EVENT_ALL, NULL);
lv_obj_align(btn2, LV_ALIGN_CENTER, 0, 40);
lv_obj_add_flag(btn2, LV_OBJ_FLAG_CHECKABLE);
lv_obj_set_height(btn2, LV_SIZE_CONTENT);
lv_label_set_text(label, "Toggle");
}
#endif
Styling buttons
/**
* Style a button from scratch
*/


{
/*Init the style for the default state*/
lv_style_set_bg_opa(&style, LV_OPA_100);
lv_style_set_bg_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_bg_grad_color(&style, lv_palette_darken(LV_PALETTE_BLUE, 2));
lv_style_set_bg_grad_dir(&style, LV_GRAD_DIR_VER);
lv_style_set_border_opa(&style, LV_OPA_40);
lv_style_set_border_color(&style, lv_palette_main(LV_PALETTE_GREY));
lv_style_set_shadow_color(&style, lv_palette_main(LV_PALETTE_GREY));
lv_style_set_shadow_ofs_y(&style, 8);
lv_style_set_outline_opa(&style, LV_OPA_COVER);
lv_style_set_outline_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_text_color(&style, lv_color_white());
/*Init the pressed style*/

/*Ad a large outline when pressed*/

lv_style_set_outline_width(&style_pr, 30);
lv_style_set_outline_opa(&style_pr, LV_OPA_TRANSP);
lv_style_set_translate_y(&style_pr, 5);
lv_style_set_shadow_ofs_y(&style_pr, 3);
lv_style_set_bg_color(&style_pr, lv_palette_darken(LV_PALETTE_BLUE, 2));
lv_style_set_bg_grad_color(&style_pr, lv_palette_darken(LV_PALETTE_BLUE, 4));
/*Add a transition to the the outline*/

static lv_style_transition_dsc_t trans;
static lv_style_prop_t props[] = {LV_STYLE_OUTLINE_WIDTH, LV_STYLE_OUTLINE_OPA, 0}
,→ ;
lv_style_transition_dsc_init(&trans, props, lv_anim_path_linear, 300, 0, NULL);
lv_style_set_transition(&style_pr, &trans);

lv_obj_remove_style_all(btn1); /*Remove the style coming␣
,→from the theme*/
lv_obj_add_style(btn1, &style, 0);

lv_obj_add_style(btn1, &style_pr, LV_STATE_PRESSED);
lv_obj_set_size(btn1, LV_SIZE_CONTENT, LV_SIZE_CONTENT);
lv_obj_center(btn1);
lv_obj_t * label = lv_label_create(btn1);



}
#endif
Gummy button
#if LV_BUILD_EXAMPLES && LV_USE_BTN
/**
* Create a style transition on a button to act like a gum when clicked
*/
{
/*Properties to transition*/
static lv_style_prop_t props[] = {
LV_STYLE_TRANSFORM_WIDTH, LV_STYLE_TRANSFORM_HEIGHT, LV_STYLE_TEXT_LETTER_
,→SPACE, 0
};
/*Transition descriptor when going back to the default state.

*Add some delay to be sure the press transition is visible even if the press was␣
,→very short*/
static lv_style_transition_dsc_t transition_dsc_def;

lv_style_transition_dsc_init(&transition_dsc_def, props, lv_anim_path_overshoot,␣
,→250, 100, NULL);
/*Transition descriptor when going to pressed state.

*No delay, go to presses state immediately*/
static lv_style_transition_dsc_t transition_dsc_pr;
lv_style_transition_dsc_init(&transition_dsc_pr, props, lv_anim_path_ease_in_out,␣
,→250, 0, NULL);
/*Add only the new transition to he default state*/

lv_style_set_transition(&style_def, &transition_dsc_def);
/*Add the transition and some transformation to the presses state.*/

lv_style_set_transform_width(&style_pr, 10);
lv_style_set_transform_height(&style_pr, -10);
lv_style_set_text_letter_space(&style_pr, 10);
lv_style_set_transition(&style_pr, &transition_dsc_pr);

lv_obj_align(btn1, LV_ALIGN_CENTER, 0, -80);
lv_obj_add_style(btn1, &style_pr, LV_STATE_PRESSED);
lv_obj_add_style(btn1, &style_def, 0);
lv_obj_t * label = lv_label_create(btn1);

lv_label_set_text(label, "Gum");
}
#endif

MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_btn_create(lv_obj_t *parent)

Create a button object
Parameters parent -- pointer to an object, it will be the parent of the new button
Returns pointer to the created button
Variables
const lv_obj_class_t lv_btn_class

struct lv_btn_t
Public Members
lv_obj_t obj
5.2.4 Button matrix (lv_btnmatrix)
Overview
The Button Matrix object is a lightweight way to display multiple buttons in rows and columns. Lightweight because the
buttons are not actually created but just virtually drawn on the fly. This way, one button use only eight extra bytes of
memory instead of the ~100-150 bytes a normal Button object plus the 100 or so bytes for the the Label object.
The Button matrix is added to the default group (if one is set). Besides the Button matrix is an editable object to allow
selecting and clicking the buttons with encoder navigation too.
Parts and Styles
• LV_PART_MAIN The background of the button matrix, uses the typical background style properties. pad_row
and pad_column sets the space between the buttons.
• LV_PART_ITEMS The buttons all use the text and typical background style properties except translations and
transformations.

Usage
Button's text
There is a text on each button. To specify them a descriptor string array, called map, needs to be used. The map can be
set with lv_btnmatrix_set_map(btnm, my_map). The declaration of a map should look like const char
* map[] = {"btn1", "btn2", "btn3", NULL}. Note that the last element has to be either NULL or an
empty string ("")!
Use "\n" in the map to insert a line break. E.g. {"btn1", "btn2", "\n", "btn3", ""}. Each line's buttons
have their width calculated automatically. So in the example the first row will have 2 buttons each with 50% width and a
second row with 1 button having 100% width.
Control buttons
The buttons' width can be set relative to the other button in the same row with
lv_btnmatrix_set_btn_width(btnm, btn_id, width) E.g. in a line with two buttons: btnA,
width = 1 and btnB, width = 2, btnA will have 33 % width and btnB will have 66 % width. It's similar to how the
flex-grow property works in CSS. The width must be in the [1..7] range and the default width is 1.
In addition to the width, each button can be customized with the following parameters:
• LV_BTNMATRIX_CTRL_HIDDEN Makes a button hidden (hidden buttons still take up space in the layout, they
are just not visible or clickable)
• LV_BTNMATRIX_CTRL_NO_REPEAT Disable repeating when the button is long pressed
• LV_BTNMATRIX_CTRL_DISABLED Makes a button disabled Like LV_STATE_DISABLED on normal objects
• LV_BTNMATRIX_CTRL_CHECKABLE Enable toggling of a button. I.e. LV_STATE_CHECHED will be
added/removed as the button is clicked
• LV_BTNMATRIX_CTRL_CHECKED MAke the button checked. It will use the LV_STATE_CHECHKED styles.
• LV_BTNMATRIX_CTRL_CLICK_TRIG Enabled: send LV_EVENT_VALUE_CHANGE on CLICK, Dis-
abled: send LV_EVENT_VALUE_CHANGE on PRESS*/
• LV_BTNMATRIX_CTRL_RECOLOR Enable recoloring of button texts with #. E.g. "It's #ff0000 red#"
• LV_BTNMATRIX_CTRL_CUSTOM_1 Custom free to use flag
• LV_BTNMATRIX_CTRL_CUSTOM_2 Custom free to use flag
By default all flags are disabled.
To set or clear a button's control attribute, use lv_btnmatrix_set_btn_ctrl(btnm,
btn_id, LV_BTNM_CTRL_...) and lv_btnmatrix_clear_btn_ctrl(btnm, btn_id,
LV_BTNMATRIX_CTRL_...) respectively. More LV_BTNM_CTRL_... values can be OR-ed
To set/clear the same control attribute for all buttons of a button matrix, use
lv_btnmatrix_set_btn_ctrl_all(btnm, btn_id, LV_BTNM_CTRL_...) and
lv_btnmatrix_clear_btn_ctrl_all(btnm, btn_id, LV_BTNMATRIX_CTRL_...).
The set a control map for a button matrix (similarly to the map for the text), use
lv_btnmatrix_set_ctrl_map(btnm, ctrl_map). An element of ctrl_map should look like
ctrl_map[0] = width | LV_BTNM_CTRL_NO_REPEAT | LV_BTNM_CTRL_CHECHKABLE. The
number of elements should be equal to the number of buttons (excluding newlines characters).

One check
The "One check" feature can be enabled with lv_btnmatrix_set_one_check(btnm, true) to allow only
one button to be checked at a time.
Events
• LV_EVENT_VALUE_CHANGED Sent when a button is pressed/released or repeated after long press. The event
parameter is set to the ID of the pressed/released button.
• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for both the main and the
items (buttons) parts to allow hooking the drawing. For more detail on the main part see the Base object's docu-
mentation. For the buttons the following fields are used: clip_area, draw_area, rect_dsc, rect_dsc,
part, id (index of the button being drawn).
lv_btnmatrix_get_selected_btn(btnm) returns the index of the most recently released or focused button
or LV_BTNMATRIX_BTN_NONE if no such button.
lv_btnmatrix_get_btn_text(btnm, btn_id) returns a pointer to the text of btn_idth button.
Keys
• LV_KEY_RIGHT/UP/LEFT/RIGHT To navigate among the buttons to select one

• LV_KEY_ENTER To press/release the selected button
Example
Simple Button matrix
#if LV_USE_BTNMATRIX && LV_BUILD_EXAMPLES

{
uint32_t id = lv_btnmatrix_get_selected_btn(obj);
const char * txt = lv_btnmatrix_get_btn_text(obj, id);
LV_LOG_USER("%s was pressed\n", txt);

}
}
static const char * btnm_map[] = {"1", "2", "3", "4", "5", "\n",
"6", "7", "8", "9", "0", "\n",


"Action1", "Action2", ""};
void lv_example_btnmatrix_1(void)
{
lv_obj_t * btnm1 = lv_btnmatrix_create(lv_scr_act());
lv_btnmatrix_set_map(btnm1, btnm_map);
lv_btnmatrix_set_btn_width(btnm1, 10, 2); /*Make "Action1" twice as wide␣
,→as "Action2"*/
lv_btnmatrix_set_btn_ctrl(btnm1, 10, LV_BTNMATRIX_CTRL_CHECKABLE);

lv_btnmatrix_set_btn_ctrl(btnm1, 11, LV_BTNMATRIX_CTRL_CHECKED);
lv_obj_align(btnm1, LV_ALIGN_CENTER, 0, 0);
lv_obj_add_event_cb(btnm1, event_handler, LV_EVENT_ALL, NULL);
}
#endif
Custom buttons

{
if(code == LV_EVENT_DRAW_PART_BEGIN) {
/*Change the draw descriptor the 2nd button*/

if(dsc->id == 1) {
dsc->rect_dsc->radius = 0;
if(lv_btnmatrix_get_selected_btn(obj) == dsc->id) dsc->rect_dsc->bg_
,→color = lv_palette_darken(LV_PALETTE_BLUE, 3);
else dsc->rect_dsc->bg_color = lv_palette_main(LV_PALETTE_BLUE);
dsc->rect_dsc->shadow_width = 6;
dsc->rect_dsc->shadow_ofs_x = 3;
dsc->rect_dsc->shadow_ofs_y = 3;
dsc->label_dsc->color = lv_color_white();
}
/*Change the draw descriptor the 3rd button*/
else if(dsc->id == 2) {
dsc->rect_dsc->radius = LV_RADIUS_CIRCLE;
if(lv_btnmatrix_get_selected_btn(obj) == dsc->id) dsc->rect_dsc->bg_
,→color = lv_palette_darken(LV_PALETTE_RED, 3);
else dsc->rect_dsc->bg_color = lv_palette_main(LV_PALETTE_RED);
dsc->label_dsc->color = lv_color_white();
}
else if(dsc->id == 3) {
dsc->label_dsc->opa = LV_OPA_TRANSP; /*Hide the text if any*/
}


}
if(code == LV_EVENT_DRAW_PART_END) {
/*Add custom content to the 4th button when the button itself was drawn*/
if(dsc->id == 3) {
LV_IMG_DECLARE(img_star);
lv_img_header_t header;
lv_res_t res = lv_img_decoder_get_info(&img_star, &header);
if(res != LV_RES_OK) return;
lv_area_t a;
a.x1 = dsc->draw_area->x1 + (lv_area_get_width(dsc->draw_area) - header.
,→ w) / 2;
a.x2 = a.x1 + header.w - 1;
a.y1 = dsc->draw_area->y1 + (lv_area_get_height(dsc->draw_area) - header.
,→ h) / 2;
a.y2 = a.y1 + header.h - 1;
lv_draw_img_dsc_t img_draw_dsc;
lv_draw_img_dsc_init(&img_draw_dsc);
img_draw_dsc.recolor = lv_color_black();
if(lv_btnmatrix_get_selected_btn(obj) == dsc->id) img_draw_dsc.recolor_
,→opa = LV_OPA_30;
lv_draw_img(&a, dsc->clip_area, &img_star, &img_draw_dsc);

}
}
}
/**
* Add custom drawer to the button matrix to customize butons one by one
*/
{
lv_obj_t * btnm = lv_btnmatrix_create(lv_scr_act());
lv_obj_add_event_cb(btnm, event_cb, LV_EVENT_ALL, NULL);
lv_obj_center(btnm);
}
#endif
Pagination

{
uint32_t id = lv_btnmatrix_get_selected_btn(obj);
bool prev = id == 0 ? true : false;
bool next = id == 6 ? true : false;
if(prev || next) {


/*Find the checked button*/
uint32_t i;
for(i = 1; i < 7; i++) {
if(lv_btnmatrix_has_btn_ctrl(obj, i, LV_BTNMATRIX_CTRL_CHECKED)) break;
}
if(prev && i > 1) i--;

else if(next && i < 5) i++;
lv_btnmatrix_set_btn_ctrl(obj, i, LV_BTNMATRIX_CTRL_CHECKED);
}
}
/**
* Make a button group (pagination)
*/
{
static lv_style_t style_bg;
lv_style_init(&style_bg);
lv_style_set_pad_all(&style_bg, 0);
lv_style_set_pad_gap(&style_bg, 0);
lv_style_set_clip_corner(&style_bg, true);
lv_style_set_radius(&style_bg, LV_RADIUS_CIRCLE);
lv_style_set_border_width(&style_bg, 0);

lv_style_set_border_opa(&style_btn, LV_OPA_50);
lv_style_set_border_color(&style_btn, lv_palette_main(LV_PALETTE_GREY));
lv_style_set_border_side(&style_btn, LV_BORDER_SIDE_INTERNAL);
static const char * map[] = {LV_SYMBOL_LEFT, "1", "2", "3", "4", "5", LV_SYMBOL_
,→ RIGHT, ""};

lv_btnmatrix_set_map(btnm, map);
lv_obj_add_style(btnm, &style_bg, 0);
lv_obj_add_style(btnm, &style_btn, LV_PART_ITEMS);
lv_obj_add_event_cb(btnm, event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_obj_set_size(btnm, 225, 35);
/*Allow selecting on one number at time*/

lv_btnmatrix_set_btn_ctrl_all(btnm, LV_BTNMATRIX_CTRL_CHECKABLE);
lv_btnmatrix_clear_btn_ctrl(btnm, 0, LV_BTNMATRIX_CTRL_CHECKABLE);
lv_btnmatrix_clear_btn_ctrl(btnm, 6, LV_BTNMATRIX_CTRL_CHECKABLE);
lv_btnmatrix_set_one_checked(btnm, true);
lv_btnmatrix_set_btn_ctrl(btnm, 1, LV_BTNMATRIX_CTRL_CHECKED);
lv_obj_center(btnm);
}

#endif
MicroPython
No examples yet.
API
Typedefs
typedef uint16_t lv_btnmatrix_ctrl_t

typedef bool (*lv_btnmatrix_btn_draw_cb_t)(lv_obj_t *btnm, uint32_t btn_id, const lv_area_t *draw_area,
const lv_area_t *clip_area)
Enums
enum [anonymous]
Type to store button control bits (disabled, hidden etc.) The first 3 bits are used to store the width
Values:
enumerator _LV_BTNMATRIX_WIDTH
Reserved to stire the size units
enumerator LV_BTNMATRIX_CTRL_HIDDEN
Button hidden
enumerator LV_BTNMATRIX_CTRL_NO_REPEAT
Do not repeat press this button.
enumerator LV_BTNMATRIX_CTRL_DISABLED
Disable this button.
enumerator LV_BTNMATRIX_CTRL_CHECKABLE
The button can be toggled.
enumerator LV_BTNMATRIX_CTRL_CHECKED
Button is currently toggled (e.g. checked).
enumerator LV_BTNMATRIX_CTRL_CLICK_TRIG
1: Send LV_EVENT_VALUE_CHANGE on CLICK, 0: Send LV_EVENT_VALUE_CHANGE on PRESS
enumerator LV_BTNMATRIX_CTRL_RECOLOR
Enable text recoloring with #color

enumerator _LV_BTNMATRIX_CTRL_RESERVED
Reserved for later use
enumerator LV_BTNMATRIX_CTRL_CUSTOM_1
Custom free to use flag
enumerator LV_BTNMATRIX_CTRL_CUSTOM_2
Custom free to use flag
Functions
LV_EXPORT_CONST_INT(LV_BTNMATRIX_BTN_NONE)
lv_obj_t *lv_btnmatrix_create(lv_obj_t *parent)

Create a button matrix objects
Parameters parent -- pointer to an object, it will be the parent of the new button matrix
Returns pointer to the created button matrix
void lv_btnmatrix_set_map(lv_obj_t *obj, const char *map[])
Set a new map. Buttons will be created/deleted according to the map. The button matrix keeps a reference to the
map and so the string array must not be deallocated during the life of the matrix.
Parameters
• obj -- pointer to a button matrix object
• map -- pointer a string array. The last string has to be: "". Use "\n" to make a line break.
void lv_btnmatrix_set_ctrl_map(lv_obj_t *obj, const lv_btnmatrix_ctrl_t ctrl_map[])
Set the button control map (hidden, disabled etc.) for a button matrix. The control map array will be copied and
so may be deallocated after this function returns.
Parameters
• ctrl_map -- pointer to an array of lv_btn_ctrl_t control bytes. The length of
the array and position of the elements must match the number and order of the indi-
vidual buttons (i.e. excludes newline entries). An element of the map should look like
e.g.: ctrl_map[0] = width | LV_BTNMATRIX_CTRL_NO_REPEAT |
LV_BTNMATRIX_CTRL_TGL_ENABLE
void lv_btnmatrix_set_selected_btn(lv_obj_t *obj, uint16_t btn_id)
Set the selected buttons
Parameters
• obj -- pointer to button matrix object
• btn_id -- 0 based index of the button to modify. (Not counting new lines)
void lv_btnmatrix_set_btn_ctrl(lv_obj_t *obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl)
Set the attributes of a button of the button matrix
Parameters

• ctrl -- OR-ed attributs. E.g. LV_BTNMATRIX_CTRL_NO_REPEAT |

LV_BTNMATRIX_CTRL_CHECKABLE
void lv_btnmatrix_clear_btn_ctrl(const lv_obj_t *obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl)
Clear the attributes of a button of the button matrix
Parameters
• ctrl -- OR-ed attributs. E.g. LV_BTNMATRIX_CTRL_NO_REPEAT |
LV_BTNMATRIX_CTRL_CHECKABLE
void lv_btnmatrix_set_btn_ctrl_all(lv_obj_t *obj, lv_btnmatrix_ctrl_t ctrl)
Set attributes of all buttons of a button matrix
Parameters
• ctrl -- attribute(s) to set from lv_btnmatrix_ctrl_t. Values can be ORed.
void lv_btnmatrix_clear_btn_ctrl_all(lv_obj_t *obj, lv_btnmatrix_ctrl_t ctrl)
Clear the attributes of all buttons of a button matrix
Parameters
• ctrl -- attribute(s) to set from lv_btnmatrix_ctrl_t. Values can be ORed.
• en -- true: set the attributes; false: clear the attributes
void lv_btnmatrix_set_btn_width(lv_obj_t *obj, uint16_t btn_id, uint8_t width)
Set a single button's relative width. This method will cause the matrix be regenerated and is a relatively expensive
operation. It is recommended that initial width be specified using lv_btnmatrix_set_ctrl_map and this
method only be used for dynamic changes.
Parameters
• btn_id -- 0 based index of the button to modify.
• width -- relative width compared to the buttons in the same row. [1..7]
void lv_btnmatrix_set_one_checked(lv_obj_t *obj, bool en)
Make the button matrix like a selector widget (only one button may be checked at a time).
LV_BTNMATRIX_CTRL_CHECKABLE must be enabled on the buttons to be selected useing
lv_btnmatrix_set_ctrl() or lv_btnmatrix_set_btn_ctrl_all().
Parameters
• en -- whether "one check" mode is enabled
const char **lv_btnmatrix_get_map(const lv_obj_t *obj)
Get the current map of a button matrix
Parameters obj -- pointer to a button matrix object
Returns the current map

uint16_t lv_btnmatrix_get_selected_btn(const lv_obj_t *obj)

Get the index of the lastly "activated" button by the user (pressed, released, focused etc) Useful in the the
event_cb to get the text of the button, check if hidden etc.
Parameters obj -- pointer to button matrix object
Returns index of the last released button (LV_BTNMATRIX_BTN_NONE: if unset)
const char *lv_btnmatrix_get_btn_text(const lv_obj_t *obj, uint16_t btn_id)
Get the button's text
Parameters
• btn_id -- the index a button not counting new line characters.
Returns text of btn_index` button
bool lv_btnmatrix_has_btn_ctrl(lv_obj_t *obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl)
Get the whether a control value is enabled or disabled for button of a button matrix
Parameters
• btn_id -- the index of a button not counting new line characters.
• ctrl -- control values to check (ORed value can be used)
Returns true: the control attribute is enabled false: disabled
bool lv_btnmatrix_get_one_checked(const lv_obj_t *obj)
Tell whether "one check" mode is enabled or not.
Parameters obj -- Button matrix object
Returns true: "one check" mode is enabled; false: disabled
Variables
const lv_obj_class_t lv_btnmatrix_class

struct lv_btnmatrix_t
Public Members
lv_obj_t obj
const char **map_p
lv_area_t *button_areas
lv_btnmatrix_ctrl_t *ctrl_bits
uint16_t btn_cnt
uint16_t btn_id_sel
uint8_t one_check

5.2.5 Canvas (lv_canvas)
Overview
A Canvas inherits from Image where the user can draw anything. Rectangles, texts, images, lines, arcs can be drawn here
using lvgl's drawing engine. Additionally "effects" can be applied, such as rotation, zoom and blur.
Parts and Styles
LV_PART_MAIN Uses the typical rectangle style properties and image style properties.
Usage
Buffer
The Canvas needs a buffer in which stores the drawn image. To assign a buffer to a Canvas, use
lv_canvas_set_buffer(canvas, buffer, width, height, LV_IMG_CF_...). Where buffer
is a static buffer (not just a local variable) to hold the image of the canvas. For example, static lv_color_t
buffer[LV_CANVAS_BUF_SIZE_TRUE_COLOR(width, height)]. LV_CANVAS_BUF_SIZE_...
macros help to determine the size of the buffer with different color formats.
The canvas supports all the built-in color formats like LV_IMG_CF_TRUE_COLOR or
LV_IMG_CF_INDEXED_2BIT. See the full list in the Color formats section.
Indexed colors
For LV_IMG_CF_INDEXED_1/2/4/8 color formats a palette needs to be initialized with

lv_canvas_set_palette(canvas, 3, LV_COLOR_RED). It sets pixels with index=3 to red.
Drawing
To set a pixel on the canvas, use lv_canvas_set_px(canvas, x, y, LV_COLOR_RED). With

LV_IMG_CF_INDEXED_... or LV_IMG_CF_ALPHA_..., the index of the color or the alpha value needs to be
passed as color. E.g. lv_color_t c; c.full = 3;
lv_canvas_fill_bg(canvas, LV_COLOR_BLUE, LV_OPA_50) fills the whole canvas to blue with 50%
opacity. Note that if the current color format doesn't support colors (e.g. LV_IMG_CF_ALPHA_2BIT) the color will
be ignored. Similarly, if opacity is not supported (e.g. LV_IMG_CF_TRUE_COLOR) it will be ignored.
An array of pixels can be copied to the canvas with lv_canvas_copy_buf(canvas, buffer_to_copy, x,
y, width, height). The color format of the buffer and the canvas need to match.
To draw something to the canvas use
• lv_canvas_draw_rect(canvas, x, y, width, heigth, &draw_dsc)
• lv_canvas_draw_text(canvas, x, y, max_width, &draw_dsc, txt)
• lv_canvas_draw_img(canvas, x, y, &img_src, &draw_dsc)
• lv_canvas_draw_line(canvas, point_array, point_cnt, &draw_dsc)
• lv_canvas_draw_polygon(canvas, points_array, point_cnt, &draw_dsc)
• lv_canvas_draw_arc(canvas, x, y, radius, start_angle, end_angle, &draw_dsc)

draw_dsc is a lv_draw_rect/label/img/line/arc_dsc_t variable which should be first initialized with

one of lv_draw_rect/label/img/line/arc_dsc_init() and then modified with the desired colors and
other values.
The draw function can draw to any color format. For example, it's possible to draw a text to an
LV_IMG_VF_ALPHA_8BIT canvas and use the result image as a draw mask later.
Transformations
lv_canvas_transform() can be used to rotate and/or scale the image of an image and store the result on the
canvas. The function needs the following parameters:
• canvas pointer to a canvas object to store the result of the transformation.
• img pointer to an image descriptor to transform. Can be the image descriptor of an other canvas too
(lv_canvas_get_img()).
• angle the angle of rotation (0..3600), 0.1 deg resolution
• zoom zoom factor (256: no zoom, 512: double size, 128: half size);
• offset_x offset X to tell where to put the result data on destination canvas
• offset_y offset X to tell where to put the result data on destination canvas
• pivot_x pivot X of rotation. Relative to the source canvas. Set to source width / 2 to rotate around the
center
• pivot_y pivot Y of rotation. Relative to the source canvas. Set to source height / 2 to rotate around the
center
• antialias true: apply anti-aliasing during the transformation. Looks better but slower.
Note that a canvas can't be rotated on itself. You need a source and destination canvas or image.
Blur
A given area of the canvas can be blurred horizontally with lv_canvas_blur_hor(canvas, &area, r) or
vertically with lv_canvas_blur_ver(canvas, &area, r). r is the radius of the blur (greater value means
more intensive burring). area is the area where the blur should be applied (interpreted relative to the canvas).
Events
The same events are sent as for the Images.


Keys

Example
Drawing on the Canvas and rotate
#if LV_USE_CANVAS && LV_BUILD_EXAMPLES
#define CANVAS_WIDTH 200

#define CANVAS_HEIGHT 150
void lv_example_canvas_1(void)
{
lv_draw_rect_dsc_t rect_dsc;
lv_draw_rect_dsc_init(&rect_dsc);
rect_dsc.radius = 10;
rect_dsc.bg_opa = LV_OPA_COVER;
rect_dsc.bg_grad_dir = LV_GRAD_DIR_HOR;
rect_dsc.bg_color = lv_palette_main(LV_PALETTE_RED);
rect_dsc.bg_grad_color = lv_palette_main(LV_PALETTE_BLUE);
rect_dsc.border_width = 2;
rect_dsc.border_opa = LV_OPA_90;
rect_dsc.border_color = lv_color_white();
rect_dsc.shadow_width = 5;
rect_dsc.shadow_ofs_x = 5;
rect_dsc.shadow_ofs_y = 5;
lv_draw_label_dsc_t label_dsc;
lv_draw_label_dsc_init(&label_dsc);
label_dsc.color = lv_palette_main(LV_PALETTE_YELLOW);
static lv_color_t cbuf[LV_CANVAS_BUF_SIZE_TRUE_COLOR(CANVAS_WIDTH, CANVAS_

,→ HEIGHT)];
lv_obj_t * canvas = lv_canvas_create(lv_scr_act());

lv_canvas_set_buffer(canvas, cbuf, CANVAS_WIDTH, CANVAS_HEIGHT, LV_IMG_CF_TRUE_
,→COLOR);
lv_obj_center(canvas);
lv_canvas_fill_bg(canvas, lv_palette_lighten(LV_PALETTE_GREY, 3), LV_OPA_COVER);
lv_canvas_draw_rect(canvas, 70, 60, 100, 70, &rect_dsc);
lv_canvas_draw_text(canvas, 40, 20, 100, &label_dsc, "Some text on text canvas");
/*Test the rotation. It requires an other buffer where the orignal image is␣
,→ stored.
*So copy the current image to buffer and rotate it to the canvas*/


static lv_color_t cbuf_tmp[CANVAS_WIDTH * CANVAS_HEIGHT];
memcpy(cbuf_tmp, cbuf, sizeof(cbuf_tmp));
lv_img_dsc_t img;
img.data = (void *)cbuf_tmp;
img.header.cf = LV_IMG_CF_TRUE_COLOR;
img.header.w = CANVAS_WIDTH;
img.header.h = CANVAS_HEIGHT;
lv_canvas_fill_bg(canvas, lv_palette_lighten(LV_PALETTE_GREY, 3), LV_OPA_COVER);

lv_canvas_transform(canvas, &img, 30, LV_IMG_ZOOM_NONE, 0, 0, CANVAS_WIDTH / 2,␣
,→CANVAS_HEIGHT / 2, true);
#endif
Transparent Canvas with chroma keying
#if LV_USE_CANVAS && LV_BUILD_EXAMPLES
#define CANVAS_WIDTH 50
#define CANVAS_HEIGHT 50
/**
* Create a transparent canvas with Chroma keying and indexed color format (palette).
*/
void lv_example_canvas_2(void)
{
/*Create a button to better see the transparency*/
lv_btn_create(lv_scr_act());
/*Create a buffer for the canvas*/

static lv_color_t cbuf[LV_CANVAS_BUF_SIZE_INDEXED_1BIT(CANVAS_WIDTH, CANVAS_
,→HEIGHT)];
/*Create a canvas and initialize its the palette*/

lv_obj_t * canvas = lv_canvas_create(lv_scr_act());
lv_canvas_set_buffer(canvas, cbuf, CANVAS_WIDTH, CANVAS_HEIGHT, LV_IMG_CF_INDEXED_
,→1BIT);
lv_canvas_set_palette(canvas, 0, LV_COLOR_CHROMA_KEY);
lv_canvas_set_palette(canvas, 1, lv_palette_main(LV_PALETTE_RED));
/*Create colors with the indices of the palette*/

lv_color_t c0;
lv_color_t c1;
c0.full = 0;
c1.full = 1;
/*Red background (There is no dedicated alpha channel in indexed images so LV_OPA_

,→COVER is ignored)*/
lv_canvas_fill_bg(canvas, c1, LV_OPA_COVER);
/*Create hole on the canvas*/



uint32_t x;
uint32_t y;
for( y = 10; y < 30; y++) {
for( x = 5; x < 20; x++) {
lv_canvas_set_px(canvas, x, y, c0);
}
}
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_canvas_create(lv_obj_t *parent)

Create a canvas object
Parameters parent -- pointer to an object, it will be the parent of the new canvas
Returns pointer to the created canvas
void lv_canvas_set_buffer(lv_obj_t *canvas, void *buf, lv_coord_t w, lv_coord_t h, lv_img_cf_t cf)
Set a buffer for the canvas.
Parameters
• buf -- a buffer where the content of the canvas will be. The required size
is (lv_img_color_format_get_px_size(cf) * w) / 8 * h) It can be allocated with
lv_mem_alloc() or it can be statically allocated array (e.g. static lv_color_t buf[100*50])
or it can be an address in RAM or external SRAM
• canvas -- pointer to a canvas object
• w -- width of the canvas
• h -- height of the canvas
• cf -- color format. LV_IMG_CF_...
void lv_canvas_set_px(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y, lv_color_t c)
Set the color of a pixel on the canvas
Parameters
• canvas --
• c -- color of the point
void lv_canvas_set_palette(lv_obj_t *canvas, uint8_t id, lv_color_t c)
Set the palette color of a canvas with index format. Valid only for LV_IMG_CF_INDEXED1/2/4/8

Parameters
• canvas -- pointer to canvas object
• id -- the palette color to set:
• c -- the color to set
lv_color_t lv_canvas_get_px(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y)
Get the color of a pixel on the canvas
Parameters
• canvas --
Returns color of the point
lv_img_dsc_t *lv_canvas_get_img(lv_obj_t *canvas)
Get the image of the canvas as a pointer to an lv_img_dsc_t variable.
Parameters canvas -- pointer to a canvas object
Returns pointer to the image descriptor.
void lv_canvas_copy_buf(lv_obj_t *canvas, const void *to_copy, lv_coord_t x, lv_coord_t y, lv_coord_t w,
lv_coord_t h)
Copy a buffer to the canvas
Parameters
• to_copy -- buffer to copy. The color format has to match with the canvas's buffer color
format
• x -- left side of the destination position
• y -- top side of the destination position
• w -- width of the buffer to copy
• h -- height of the buffer to copy
void lv_canvas_transform(lv_obj_t *canvas, lv_img_dsc_t *img, int16_t angle, uint16_t zoom, lv_coord_t
offset_x, lv_coord_t offset_y, int32_t pivot_x, int32_t pivot_y, bool antialias)
Transform and image and store the result on a canvas.
Parameters
• canvas -- pointer to a canvas object to store the result of the transformation.
• img -- pointer to an image descriptor to transform. Can be the image descriptor of an other
canvas too (lv_canvas_get_img()).
• angle -- the angle of rotation (0..3600), 0.1 deg resolution
• zoom -- zoom factor (256 no zoom);

• offset_x -- offset X to tell where to put the result data on destination canvas
• offset_y -- offset X to tell where to put the result data on destination canvas
• pivot_x -- pivot X of rotation. Relative to the source canvas Set to source width /
2 to rotate around the center
• pivot_y -- pivot Y of rotation. Relative to the source canvas Set to source height /
2 to rotate around the center
• antialias -- apply anti-aliasing during the transformation. Looks better but slower.
void lv_canvas_blur_hor(lv_obj_t *canvas, const lv_area_t *area, uint16_t r)
Apply horizontal blur on the canvas
Parameters
• area -- the area to blur. If NULL the whole canvas will be blurred.
• r -- radius of the blur
void lv_canvas_blur_ver(lv_obj_t *canvas, const lv_area_t *area, uint16_t r)
Apply vertical blur on the canvas
Parameters
• area -- the area to blur. If NULL the whole canvas will be blurred.
• r -- radius of the blur
void lv_canvas_fill_bg(lv_obj_t *canvas, lv_color_t color, lv_opa_t opa)
Fill the canvas with color
Parameters
• canvas -- pointer to a canvas
• color -- the background color
• opa -- the desired opacity
void lv_canvas_draw_rect(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y, lv_coord_t w, lv_coord_t h, const
lv_draw_rect_dsc_t *draw_dsc)
Draw a rectangle on the canvas
Parameters
• x -- left coordinate of the rectangle
• y -- top coordinate of the rectangle
• w -- width of the rectangle
• h -- height of the rectangle
• draw_dsc -- descriptor of the rectangle
void lv_canvas_draw_text(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y, lv_coord_t max_w,
lv_draw_label_dsc_t *draw_dsc, const char *txt)
Draw a text on the canvas.
Parameters


• x -- left coordinate of the text
• y -- top coordinate of the text
• max_w -- max width of the text. The text will be wrapped to fit into this size
• draw_dsc -- pointer to a valid label descriptor lv_draw_label_dsc_t
• txt -- text to display
void lv_canvas_draw_img(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y, const void *src, const
lv_draw_img_dsc_t *draw_dsc)
Draw an image on the canvas
Parameters
• x -- left coordinate of the image
• y -- top coordinate of the image
• src -- image source. Can be a pointer an lv_img_dsc_t variable or a path an image.
• draw_dsc -- pointer to a valid label descriptor lv_draw_img_dsc_t
void lv_canvas_draw_line(lv_obj_t *canvas, const lv_point_t points[], uint32_t point_cnt, const
lv_draw_line_dsc_t *draw_dsc)
Draw a line on the canvas
Parameters
• points -- point of the line
• point_cnt -- number of points
• draw_dsc -- pointer to an initialized lv_draw_line_dsc_t variable
void lv_canvas_draw_polygon(lv_obj_t *canvas, const lv_point_t points[], uint32_t point_cnt, const
lv_draw_rect_dsc_t *draw_dsc)
Draw a polygon on the canvas
Parameters
• points -- point of the polygon
• point_cnt -- number of points
• draw_dsc -- pointer to an initialized lv_draw_rect_dsc_t variable
void lv_canvas_draw_arc(lv_obj_t *canvas, lv_coord_t x, lv_coord_t y, lv_coord_t r, int32_t start_angle,
int32_t end_angle, const lv_draw_arc_dsc_t *draw_dsc)
Draw an arc on the canvas
Parameters
• x -- origo x of the arc
• y -- origo y of the arc
• r -- radius of the arc

• start_angle -- start angle in degrees

• end_angle -- end angle in degrees
• draw_dsc -- pointer to an initialized lv_draw_line_dsc_t variable
Variables
const lv_obj_class_t lv_canvas_class

struct lv_canvas_t
Public Members
lv_img_t img
lv_img_dsc_t dsc
5.2.6 Checkbox (lv_checkbox)
Overview
The Checkbox object is created from a "tick box" and a label. When the Chackbox is clicked the tick box is toggled.
Parts and Styles
• LV_PART_MAIN The is the background of the Checkbox and it uses the text and all the typical backround style
properties. pad_column adjusts the spacing between the tickbox and the label
• LV_PART_INDICATOR The "tick box" is a square that uses all the typical backround style properties. By default
its size is equal to the height of the main part's font. Padding properties make the tick box larger in the respective
directions.
The Checkbox is added to the default group (if it is set).
Usage
Text
The text can be modified with the lv_checkbox_set_text(cb, "New text") function and will be dynamically
allocated.
To set a static text, use lv_checkbox_set_static_text(cb, txt). This way, only a pointer to txt will be
stored. The text then shouldn't be deallocated while the checkbox exists.

Check, uncheck, disable
You can manually check, un-check, and disable the Checkbox by using the common state add/clear function:
lv_obj_add_state(cb, LV_STATE_CHECKED); /*Make the chekbox checked*/

lv_obj_clear_state(cb, LV_STATE_CHECKED); /*MAke the checkbox unchecked*/
lv_obj_add_state(cb, LV_STATE_CHECKED | LV_STATE_DISABLED); /*Make the checkbox␣
,→checked and disabled*/
Events
• LV_EVENT_VALUE_CHANGED Sent when the checkbox is toggled.

• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for both main and indicator
parts to allow hooking the drawing. For more detail on the main part see the Base object's documentation. For the
indicator the following fields are used: clip_area, draw_area, rect_dsc, part.
Keys
The following Keys are processed by the 'Buttons':

• LV_KEY_RIGHT/UP Go to toggled state if toggling is enabled
• LV_KEY_LEFT/DOWN Go to non-toggled state if toggling is enabled
• LV_KEY_ENTER Clicks the checkbox and toggles it
Note that, as usual, the state of LV_KEY_ENTER is translated to LV_EVENT_PRESSED/PRESSING/RELEASED
etc.
Example
Simple Checkboxes
#if LV_USE_CHECKBOX && LV_BUILD_EXAMPLES

{
const char * txt = lv_checkbox_get_text(obj);
const char * state = lv_obj_get_state(obj) & LV_STATE_CHECKED ? "Checked" :
,→"Unchecked";
LV_LOG_USER("%s: %s", txt, state);

}
}

void lv_example_checkbox_1(void)
{
lv_obj_set_flex_flow(lv_scr_act(), LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(lv_scr_act(), LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_START, LV_
,→FLEX_ALIGN_CENTER);
lv_obj_t * cb;
cb = lv_checkbox_create(lv_scr_act());
lv_checkbox_set_text(cb, "Apple");
lv_obj_add_event_cb(cb, event_handler, LV_EVENT_ALL, NULL);
lv_checkbox_set_text(cb, "Banana");
lv_obj_add_state(cb, LV_STATE_CHECKED);
lv_checkbox_set_text(cb, "Lemon");
lv_obj_add_state(cb, LV_STATE_DISABLED);
lv_obj_add_state(cb, LV_STATE_CHECKED | LV_STATE_DISABLED);
lv_checkbox_set_text(cb, "Melon\nand a new line");
lv_obj_update_layout(cb);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_checkbox_create(lv_obj_t *parent)

Create a check box object
Parameters parent -- pointer to an object, it will be the parent of the new button
Returns pointer to the created check box
void lv_checkbox_set_text(lv_obj_t *obj, const char *txt)
Set the text of a check box. txt will be copied and may be deallocated after this function returns.
Parameters
• cb -- pointer to a check box
• txt -- the text of the check box. NULL to refresh with the current text.

void lv_checkbox_set_text_static(lv_obj_t *obj, const char *txt)

Set the text of a check box. txt must not be deallocated during the life of this checkbox.
Parameters
• cb -- pointer to a check box
• txt -- the text of the check box. NULL to refresh with the current text.
const char *lv_checkbox_get_text(const lv_obj_t *obj)
Get the text of a check box
Parameters cb -- pointer to check box object
Returns pointer to the text of the check box
Variables
const lv_obj_class_t lv_checkbox_class

struct lv_checkbox_t
Public Members
lv_obj_t obj
char *txt
uint32_t static_txt
5.2.7 Drop-down list (lv_dropdown)
Overview
The drop-down list allows the user to select one value from a list.
The drop-down list is closed by default and displays a single value or a predefined text. When activated (by click on the
drop-down list), a list is created from which the user may select one option. When the user selects a new value, the list is
deleted again.
The Drop-down list is added to the default group (if it is set). Besides the Drop-down list is an editable object to allow
selecting an option with encoder navigation too.
Parts and Styles
The Dropdown widget is built from the elements: "button" and "list" (both not related to the button and list widgets)

Button
• LV_PART_MAIN The background of the button. Uses the typical background properties and text properties for
the text on it.
• LV_PART_INDICATOR Typically an arrow symbol that can be an image or a text (LV_SYMBOL).
The button goes to LV_STATE_CHECKED when its opened.
List
• LV_PART_MAIN The list itself. Uses the typical background properties. max_height can be used to limit the
height of the list.
• LV_PART_SCROLLBAR The scrollbar background, border, shadow properties and width (for its own width) and
right padding for the spacing on the right.
• LV_PART_SELECTED Refers to the currently pressed, checked or pressed+checked option. Also uses the typical
background properties.
As list does not exist when the drop-down list is closed it's not possible to simply add styles to it. Instead the following
should be done:
1. Ad an event handler to the button for LV_EVENT_VALUE_CHANGED (triggered when the list is opened/closed)
2. Use lv_obj_t * list = lv_dropdown_get_list(dropdown)
3. if(list != NULL) {/*Add the styles to the list*/}
Alternatively the theme can be extended with the new styles.
Usage
Overview
Set options
Options are passed to the drop-down list as a string with lv_dropdown_set_options(dropdown, options).
Options should be separated by \n. For example: "First\nSecond\nThird". This string will be saved in the
drop-down list, so it can in a local variable.
The lv_dropdown_add_option(dropdown, "New option", pos) function inserts a new option to pos
index.
To save memory the options can set from a static(constant) string too with
lv_dropdown_set_static_options(dropdown, options). In this case the options string should
be alive while the drop-down list exists and lv_dropdown_add_option can't be used
You can select an option manually with lv_dropdown_set_selected(dropdown, id), where id is the index
of an option.

Get selected option
The get the index of the selected option, use lv_dropdown_get_selected(dropdown).

lv_dropdown_get_selected_str(dropdown, buf, buf_size) copies the name of the selected option
to buf.
Direction
The list can be created on any side. The default LV_DIR_BOTTOM can be modified by
lv_dropdown_set_dir(dropdown, LV_DIR_LEFT/RIGHT/UP/BOTTOM) function.
If the list would be vertically out of the screen, it will be aligned to the edge.
Symbol
A symbol (typically an arrow) can be added to the drop down list with lv_dropdown_set_symbol(dropdown,
LV_SYMBOL_...)
If the direction of the drop-down list is LV_DIR_LEFT the symbol will be shown on the left, otherwise on the right.
Show selected
The main part can either show the selected option or a static text. If a static is set with
lv_dropdown_set_text(dropdown, "Some text") it will be shown regardless to th selected op-
tion. If the text is NULL the selected option is displayed on the button.
Manually open/close
To manually open or close the drop-down list the lv_dropdown_open/close(dropdown) function can be used.
Events
Apart from the Generic events, the following Special events are sent by the drop-down list:
• LV_EVENT_VALUE_CHANGED Sent when the new option is selected or the list is opened/closed.
Keys
• LV_KEY_RIGHT/DOWN Select the next option.

• LV_KEY_LEFT/UP Select the previous option.
• LY_KEY_ENTER Apply the selected option (Sends LV_EVENT_VALUE_CHANGED event and closes the drop-
down list).

Example
Simple Drop down list
#if LV_USE_DROPDOWN && LV_BUILD_EXAMPLES

{
char buf[32];
lv_dropdown_get_selected_str(obj, buf, sizeof(buf));
LV_LOG_USER("Option: %s", buf);
}
}
void lv_example_dropdown_1(void)
{
/*Create a normal drop down list*/

lv_obj_t * dd = lv_dropdown_create(lv_scr_act());
lv_dropdown_set_options(dd, "Apple\n"
"Banana\n"
"Orange\n"
"Cherry\n"
"Grape\n"
"Raspberry\n"
"Melon\n"
"Orange\n"
"Lemon\n"
"Nuts");
lv_obj_align(dd, LV_ALIGN_TOP_MID, 0, 20);

lv_obj_add_event_cb(dd, event_handler, LV_EVENT_ALL, NULL);
}
#endif
Drop down in four directions
/**
* Create a drop down, up, left and right menus
*/
{
static const char * opts = "Apple\n"


"Banana\n"
"Orange\n"
"Melon";
lv_obj_t * dd;
dd = lv_dropdown_create(lv_scr_act());
lv_dropdown_set_options_static(dd, opts);
lv_obj_align(dd, LV_ALIGN_TOP_MID, 0, 10);
lv_dropdown_set_dir(dd, LV_DIR_BOTTOM);
lv_dropdown_set_symbol(dd, LV_SYMBOL_UP);
lv_obj_align(dd, LV_ALIGN_BOTTOM_MID, 0, -10);
lv_dropdown_set_dir(dd, LV_DIR_RIGHT);
lv_dropdown_set_symbol(dd, LV_SYMBOL_RIGHT);
lv_obj_align(dd, LV_ALIGN_LEFT_MID, 10, 0);
lv_dropdown_set_dir(dd, LV_DIR_LEFT);
lv_dropdown_set_symbol(dd, LV_SYMBOL_LEFT);
lv_obj_align(dd, LV_ALIGN_RIGHT_MID, -10, 0);
}
#endif
Menu

{
lv_obj_t * dropdown = lv_event_get_target(e);
char buf[64];
lv_dropdown_get_selected_str(dropdown, buf, sizeof(buf));
LV_LOG_USER("'%s' is selected", buf);
}
/**
* Create a menu from a drop-down list and show some drop-down list features and␣
,→styling
*/
{
/*Create a drop down list*/
lv_obj_t * dropdown = lv_dropdown_create(lv_scr_act());
lv_obj_align(dropdown, LV_ALIGN_TOP_LEFT, 10, 10);
lv_dropdown_set_options(dropdown, "New project\n"
"New file\n"


"Save\n"
"Save as ...\n"
"Open project\n"
"Recent projects\n"
"Preferences\n"
"Exit");
/*Set a fixed text to display on the button of the drop-down list*/

lv_dropdown_set_text(dropdown, "Menu");
/*Use a custom image as down icon and flip it when the list is opened*/
LV_IMG_DECLARE(img_caret_down)
lv_dropdown_set_symbol(dropdown, &img_caret_down);
lv_obj_set_style_transform_angle(dropdown, 1800, LV_PART_INDICATOR | LV_STATE_
,→CHECKED);
/*In a menu we don't need to show the last clicked item*/

lv_dropdown_set_selected_highlight(dropdown, false);
lv_obj_add_event_cb(dropdown, event_cb, LV_EVENT_VALUE_CHANGED, NULL);

}
#endif
MicroPython
No examples yet.
API
Functions
LV_EXPORT_CONST_INT(LV_DROPDOWN_POS_LAST)
lv_obj_t *lv_dropdown_create(lv_obj_t *parent)

Create a drop-down list objects
Parameters parent -- pointer to an object, it will be the parent of the new drop-down list
Returns pointer to the created drop-down list
void lv_dropdown_set_text(lv_obj_t *obj, const char *txt)
Set text of the drop-down list's button. If set to NULL the selected option's text will be displayed on the button. If
set to a specific text then that text will be shown regardless the selected option.
Parameters
• obj -- pointer to a drop-down list object
• txt -- the text as a string (Only it's pointer is saved)
void lv_dropdown_set_options(lv_obj_t *obj, const char *options)
Set the options in a drop-down list from a string. The options will be copied and saved in the object so the options
can be destroyed after calling this function
Parameters

• obj -- pointer to drop-down list object

• options -- a string with '
' separated options. E.g. "One\nTwo\nThree"
void lv_dropdown_set_options_static(lv_obj_t *obj, const char *options)
Set the options in a drop-down list from a static string (global, static or dynamically allocated). Only the pointer of
the option string will be saved.
Parameters
• options -- a static string with '
void lv_dropdown_add_option(lv_obj_t *obj, const char *option, uint32_t pos)
Add an options to a drop-down list from a string. Only works for non-static options.
Parameters
• option -- a string without '
'. E.g. "Four"
• pos -- the insert position, indexed from 0, LV_DROPDOWN_POS_LAST = end of string
void lv_dropdown_clear_options(lv_obj_t *obj)
Clear all options in a drop-down list. Works with both static and dynamic optins.
Parameters obj -- pointer to drop-down list object
void lv_dropdown_set_selected(lv_obj_t *obj, uint16_t sel_opt)
Set the selected option
Parameters
• sel_opt -- id of the selected option (0 ... number of option - 1);
void lv_dropdown_set_dir(lv_obj_t *obj, lv_dir_t dir)
Set the direction of the a drop-down list
Parameters
• obj -- pointer to a drop-down list object
• dir -- LV_DIR_LEFT/RIGHT/TOP/BOTTOM
void lv_dropdown_set_symbol(lv_obj_t *obj, const void *symbol)
Set an arrow or other symbol to display when on drop-down list's button. Typically a down caret or arrow.
Note: angle and zoom transformation can be applied if the symbol is an image. E.g. when drop down is checked
(opened) rotate the symbol by 180 degree
Parameters

• symbol -- a text like LV_SYMBOL_DOWN, an image (pointer or path) or NULL to not draw
symbol icon
void lv_dropdown_set_selected_highlight(lv_obj_t *obj, bool en)

Set whether the selected option in the list should be highlighted or not
Parameters
• en -- true: highlight enabled; false: disabled
lv_obj_t *lv_dropdown_get_list(lv_obj_t *obj)
Get the list of a drop-down to allow styling or other modifications
Parameters obj -- pointer to a drop-down list object
Returns pointer to the list of the drop-down
const char *lv_dropdown_get_text(lv_obj_t *obj)
Get text of the drop-down list's button.
Returns the text as string, NULL if no text
const char *lv_dropdown_get_options(const lv_obj_t *obj)
Get the options of a drop-down list
Returns
the options separated by '
'-s (E.g. "Option1\nOption2\nOption3")
uint16_t lv_dropdown_get_selected(const lv_obj_t *obj)
Get the index of the selected option
Returns index of the selected option (0 ... number of option - 1);
uint16_t lv_dropdown_get_option_cnt(const lv_obj_t *obj)
Get the total number of options
Returns the total number of options in the list
void lv_dropdown_get_selected_str(const lv_obj_t *obj, char *buf, uint32_t buf_size)
Get the current selected option as a string
Parameters
• obj -- pointer to drop-down object
• buf -- pointer to an array to store the string
• buf_size -- size of buf in bytes. 0: to ignore it.
const char *lv_dropdown_get_symbol(lv_obj_t *obj)
Get the symbol on the drop-down list. Typically a down caret or arrow.
Returns the symbol or NULL if not enabled

bool lv_dropdown_get_selected_highlight(lv_obj_t *obj)

Get whether the selected option in the list should be highlighted or not
Returns true: highlight enabled; false: disabled
lv_dir_t lv_dropdown_get_dir(const lv_obj_t *obj)
Get the direction of the drop-down list
Returns LV_DIR_LEF/RIGHT/TOP/BOTTOM
void lv_dropdown_open(lv_obj_t *dropdown_obj)
Open the drop.down list
void lv_dropdown_close(lv_obj_t *obj)
Close (Collapse) the drop-down list
Variables
const lv_obj_class_t lv_dropdown_class

const lv_obj_class_t lv_dropdownlist_class
struct lv_dropdown_t
Public Members
lv_obj_t obj
lv_obj_t *list
The dropped down list
const char *text

Text to display on the dropdown's button
const void *symbol

Arrow or other icon when the drop-down list is closed
char *options
Options in a a '
' separated list
uint16_t option_cnt
Number of options
uint16_t sel_opt_id
Index of the currently selected option

uint16_t sel_opt_id_orig
Store the original index on focus
uint16_t pr_opt_id
Index of the currently pressed option
lv_dir_t dir
Direction in which the list should open
uint8_t static_txt
1: Only a pointer is saved in options
uint8_t selected_highlight
1: Make the selected option highlighted in the list
struct lv_dropdown_list_t
Public Members
lv_obj_t obj
lv_obj_t *dropdown
5.2.8 Image (lv_img)
Overview
Images are the basic object to display images from flash (as arrays) or from files. Images can display symbols
(LV_SYMBOL_...) too.
Using the Image decoder interface custom image formats can be supported as well.
Parts and Styles
• LV_PART_MAIN A background rectangle that uses the typical background style properties and the image itself
using the image style properties.
Usage
Image source
To provide maximum flexibility, the source of the image can be:

• a variable in code (a C array with the pixels).
• a file stored externally (e.g. on an SD card).
• a text with Symbols.

To set the source of an image, use lv_img_set_src(img, src).

To generate a pixel array from a PNG, JPG or BMP image, use the Online image converter tool and set the converted
image with its pointer: lv_img_set_src(img1, &converted_img_var); To make the variable visible in
the C file, you need to declare it with LV_IMG_DECLARE(converted_img_var).
To use external files, you also need to convert the image files using the online converter tool but now you should se-
lect the binary output format. You also need to use LVGL's file system module and register a driver with some func-
tions for the basic file operation. Go to the File system to learn more. To set an image sourced from a file, use
lv_img_set_src(img, "S:folder1/my_img.bin").
You can also set a symbol similarly to Labels. In this case, the image will be rendered as text according to the font
specified in the style. It enables to use of light-weight monochrome "letters" instead of real images. You can set symbol
like lv_img_set_src(img1, LV_SYMBOL_OK).
Label as an image
Images and labels are sometimes used to convey the same thing. For example, to describe what a button does. Therefore,
images and labels are somewhat interchangeable, that is the images can display texts by using LV_SYMBOL_DUMMY as
the prefix of the text. For example, lv_img_set_src(img, LV_SYMBOL_DUMMY "Some text").
Transparency
The internal (variable) and external images support 2 transparency handling methods:
• Chroma-keying - Pixels with LV_COLOR_CHROMA_KEY (lv_conf.h) color will be transparent.
• Alpha byte - An alpha byte is added to every pixel that contains the pixel's opacity
Palette and Alpha index
Besides the True color (RGB) color format, the following formats are supported:
• Indexed - Image has a palette.
• Alpha indexed - Only alpha values are stored.
These options can be selected in the image converter. To learn more about the color formats, read the Images section.
Recolor
A color can be mixed with every pixel of an image with a given intensity. This can be useful to show different states
(checked, inactive, pressed, etc.) of an image without storing more versions of the same image. This feature can be enabled
in the style by setting img_recolor_opa between LV_OPA_TRANSP (no recolor, value: 0) and LV_OPA_COVER
(full recolor, value: 255). The default value is LV_OPA_TRANSP so this feature is disabled.
The color to mix is set by img_recolor.

Auto-size
If the width or height of the image object is set to LV_SIZE_CONTENT the object's size will be set according to the size
of the image source in the respective direction.
Mosaic
If the object's size is greater than the image size in any directions, then the image will be repeated like a mosaic. This
allows creation a large image from only a very narrow source. For example, you can have a 300 x 5 image with a special
gradient and set it as a wallpaper using the mosaic feature.
Offset
With lv_img_set_offset_x(img, x_ofs) and lv_img_set_offset_y(img, y_ofs), you can add

some offset to the displayed image. Useful if the object size is smaller than the image source size. Using the offset
parameter a Texture atlas or a "running image" effect can be created by Animating the x or y offset.
Transformations
Using the lv_img_set_zoom(img, factor) the images will be zoomed. Set factor to 256 or
LV_IMG_ZOOM_NONE to disable zooming. A larger value enlarges the images (e.g. 512 double size), a smaller value
shrinks it (e.g. 128 half size). Fractional scale works as well. E.g. 281 for 10% enlargement.
To rotate the image use lv_img_set_angle(img, angle). Angle has 0.1 degree precision, so for 45.8° set 458.
The transform_zoom and transform_angle style properties are also used to determine the final zoom and angle.
By default, the pivot point of the rotation is the center of the image. It can be changed with
lv_img_set_pivot(img, pivot_x, pivot_y). 0;0 is the top left corner.
The quality of the transformation can be adjusted with lv_img_set_antialias(img, true/false). With
enabled anti-aliasing the transformations are higher quality but slower.
The transformations require the whole image to be available. Therefore indexed images (LV_IMG_CF_INDEXED_.
..), alpha only images (LV_IMG_CF_ALPHA_...) or images from files can not be transformed. In other words
transformations work only on true color images stored as C array, or if a custom Image decoder returns the whole image.
Note that the real coordinates of image objects won't change during transformation. That is lv_obj_get_width/
height/x/y() will return the original, non-zoomed coordinates.
Events
No special events are sent by image objects.


Keys

Example
Image from variable and symbol
#if LV_USE_IMG && LV_BUILD_EXAMPLES
void lv_example_img_1(void)
{
lv_obj_t * img1 = lv_img_create(lv_scr_act());
lv_img_set_src(img1, &img_cogwheel_argb);
lv_obj_align(img1, LV_ALIGN_CENTER, 0, -20);
lv_obj_set_size(img1, 200, 200);
lv_obj_t * img2 = lv_img_create(lv_scr_act());

lv_img_set_src(img2, LV_SYMBOL_OK "Accept");
lv_obj_align_to(img2, img1, LV_ALIGN_OUT_BOTTOM_MID, 0, 20);
}
#endif
Image recoloring
#if LV_USE_IMG && LV_USE_SLIDER && LV_BUILD_EXAMPLES
static lv_obj_t * create_slider(lv_color_t color);

static void slider_event_cb(lv_event_t * e);
static lv_obj_t * red_slider, * green_slider, * blue_slider, * intense_slider;

static lv_obj_t * img1;
/**
* Demonstrate runtime image re-coloring
*/
{
/*Create 4 sliders to adjust RGB color and re-color intensity*/
red_slider = create_slider(lv_palette_main(LV_PALETTE_RED));
green_slider = create_slider(lv_palette_main(LV_PALETTE_GREEN));
blue_slider = create_slider(lv_palette_main(LV_PALETTE_BLUE));
intense_slider = create_slider(lv_palette_main(LV_PALETTE_GREY));

lv_slider_set_value(red_slider, LV_OPA_20, LV_ANIM_OFF);

lv_slider_set_value(green_slider, LV_OPA_90, LV_ANIM_OFF);
lv_slider_set_value(blue_slider, LV_OPA_60, LV_ANIM_OFF);
lv_slider_set_value(intense_slider, LV_OPA_50, LV_ANIM_OFF);
lv_obj_align(red_slider, LV_ALIGN_LEFT_MID, 25, 0);

lv_obj_align_to(green_slider, red_slider, LV_ALIGN_OUT_RIGHT_MID, 25, 0);
lv_obj_align_to(blue_slider, green_slider, LV_ALIGN_OUT_RIGHT_MID, 25, 0);
lv_obj_align_to(intense_slider, blue_slider, LV_ALIGN_OUT_RIGHT_MID, 25, 0);
/*Now create the actual image*/

LV_IMG_DECLARE(img_cogwheel_argb)
img1 = lv_img_create(lv_scr_act());
lv_img_set_src(img1, &img_cogwheel_argb);
lv_obj_align(img1, LV_ALIGN_RIGHT_MID, -20, 0);
lv_event_send(intense_slider, LV_EVENT_VALUE_CHANGED, NULL);

}

{
LV_UNUSED(e);
/*Recolor the image based on the sliders' values*/

lv_color_t color = lv_color_make(lv_slider_get_value(red_slider), lv_slider_get_
,→value(green_slider), lv_slider_get_value(blue_slider));
lv_opa_t intense = lv_slider_get_value(intense_slider);

lv_obj_set_style_img_recolor_opa(img1, intense, 0);
lv_obj_set_style_img_recolor(img1, color, 0);
}
static lv_obj_t * create_slider(lv_color_t color)

{
lv_slider_set_range(slider, 0, 255);
lv_obj_set_size(slider, 10, 200);
lv_obj_set_style_bg_color(slider, color, LV_PART_KNOB);
lv_obj_set_style_bg_color(slider, lv_color_darken(color, LV_OPA_40), LV_PART_
,→INDICATOR);
lv_obj_add_event_cb(slider, slider_event_cb, LV_EVENT_VALUE_CHANGED, NULL);

return slider;
}
#endif

Rotate and zoom
static void set_angle(void * img, int32_t v)

{
lv_img_set_angle(img, v);
}
static void set_zoom(void * img, int32_t v)

{
lv_img_set_zoom(img, v);
}
/**
* Show transformations (zoom and rotation) using a pivot point.
*/
{
/*Now create the actual image*/

lv_obj_t * img = lv_img_create(lv_scr_act());
lv_img_set_src(img, &img_cogwheel_argb);
lv_obj_align(img, LV_ALIGN_CENTER, 50, 50);
lv_img_set_pivot(img, 0, 0); /*Rotate around the top left corner*/
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, img);
lv_anim_set_exec_cb(&a, set_angle);
lv_anim_start(&a);
lv_anim_set_exec_cb(&a, set_zoom);
lv_anim_start(&a);
#endif

Image offset and styling
static void ofs_y_anim(void * img, int32_t v)

{
lv_img_set_offset_y(img, v);
}
/**
* Image styling and offset
*/
{
LV_IMG_DECLARE(img_skew_strip);

lv_style_set_bg_color(&style, lv_palette_main(LV_PALETTE_YELLOW));
lv_style_set_img_recolor_opa(&style, LV_OPA_COVER);
lv_style_set_img_recolor(&style, lv_color_black());
lv_obj_t * img = lv_img_create(lv_scr_act());

lv_obj_add_style(img, &style, 0);
lv_img_set_src(img, &img_skew_strip);
lv_obj_set_size(img, 150, 100);
lv_obj_center(img);
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, img);
lv_anim_set_exec_cb(&a, ofs_y_anim);
lv_anim_start(&a);
#endif

MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_img_create(lv_obj_t *parent)

Create a image objects
Parameters parent -- pointer to an object, it will be the parent of the new image
Returns pointer to the created image
void lv_img_set_src(lv_obj_t *obj, const void *src)
Set the image data to display on the the object
Parameters
• obj -- pointer to an image object
• src_img -- 1) pointer to an lv_img_dsc_t descriptor (converted by LVGL's image converter)
(e.g. &my_img) or 2) path to an image file (e.g. "S:/dir/img.bin")or 3) a SYMBOL (e.g.
LV_SYMBOL_OK)
void lv_img_set_offset_x(lv_obj_t *obj, lv_coord_t x)
Set an offset for the source of an image so the image will be displayed from the new origin.
Parameters
• obj -- pointer to an image
• x -- the new offset along x axis.
void lv_img_set_offset_y(lv_obj_t *obj, lv_coord_t y)
Set an offset for the source of an image. so the image will be displayed from the new origin.
Parameters
• obj -- pointer to an image
• y -- the new offset along y axis.
void lv_img_set_angle(lv_obj_t *obj, int16_t angle)
Set the rotation angle of the image. The image will be rotated around the set pivot set by lv_img_set_pivot()
Parameters
• angle -- rotation angle in degree with 0.1 degree resolution (0..3600: clock wise)
void lv_img_set_pivot(lv_obj_t *obj, lv_coord_t x, lv_coord_t y)
Set the rotation center of the image. The image will be rotated around this point
Parameters
• x -- rotation center x of the image
• y -- rotation center y of the image

void lv_img_set_zoom(lv_obj_t *obj, uint16_t zoom)
void lv_img_set_antialias(lv_obj_t *obj, bool antialias)

Enable/disable anti-aliasing for the transformations (rotate, zoom) or not. The qualitiy is better with anti-aliasing
looks better but slower.
Parameters
• antialias -- true: anti-aliased; false: not anti-aliased
const void *lv_img_get_src(lv_obj_t *obj)
Get the source of the image
Parameters obj -- pointer to an image object
Returns the image source (symbol, file name or ::lv-img_dsc_t for C arrays)
lv_coord_t lv_img_get_offset_x(lv_obj_t *obj)
Get the offset's x attribute of the image object.
Parameters img -- pointer to an image
Returns offset X value.
lv_coord_t lv_img_get_offset_y(lv_obj_t *obj)
Get the offset's y attribute of the image object.
Parameters obj -- pointer to an image
Returns offset Y value.
uint16_t lv_img_get_angle(lv_obj_t *obj)
Get the rotation angle of the image.
Returns rotation angle in 0.1 degrees (0..3600)
void lv_img_get_pivot(lv_obj_t *obj, lv_point_t *pivot)
Get the pivot (rotation center) of the image.
Parameters
• img -- pointer to an image object
• pivot -- store the rotation center here
uint16_t lv_img_get_zoom(lv_obj_t *obj)
Get the zoom factor of the image.
Returns zoom factor (256: no zoom)
bool lv_img_get_antialias(lv_obj_t *obj)
Get whether the transformations (rotate, zoom) are anti-aliased or not
Returns true: anti-aliased; false: not anti-aliased

Variables
const lv_obj_class_t lv_img_class

struct lv_img_t
Public Members
lv_obj_t obj
const void *src
lv_point_t offset
lv_coord_t w
lv_coord_t h
uint16_t angle
lv_point_t pivot
uint16_t zoom
uint8_t src_type
uint8_t cf
uint8_t antialias
5.2.9 Label (lv_label)
Overview
A label is the basic object type that is used to display text.
Parts and Styles
• LV_PART_MAIN Uses all the typical background properties and the text properties. The padding values can be
used to add space between the text and the background.
• LV_PART_SCROLLBAR The scrollbar that is shown when the text is larger than the widget's size.
• LV_PART_SELECTED Tells the style of the selected text. Only text_color and bg_color style properties
can be used.

Usage
Set text
You can set the text on a label at runtime with lv_label_set_text(label, "New text"). This will allocate
a buffer dynamically, and the provided string will be copied into that buffer. Therefore, you don't need to keep the text
you pass to lv_label_set_text in scope after that function returns.
With lv_label_set_text_fmt(label, "Value: %d", 15) printf formatting can be used to set the text.
Labels are able to show text from a static character buffer. To do so, use lv_label_set_text_static(label,
"Text"). In this case, the text is not stored in the dynamic memory and the given buffer is used directly instead. This
means that the array can't be a local variable which goes out of scope when the function exits. Constant strings are safe
to use with lv_label_set_text_static (except when used with LV_LABEL_LONG_DOT, as it modifies the
buffer in-place), as they are stored in ROM memory, which is always accessible.
Newline
Newline characters are handled automatically by the label object. You can use \n to make a line break. For example:
"line1\nline2\n\nline4"
Long modes
By default, the width and height of the label is set to LV_SIZE_CONTENT. Therefore the size of the label is automatically
expanded to the text size. Otherwise, if the width or height are explicitly set (useing e.g.lv_obj_set_width or a
layout), the lines wider than the label's width can be manipulated according to several long mode policies. Similary, the
policies can be applied if the height of the text is greater than the height of the label.
• LV_LABEL_LONG_WRAP Wrap too long lines. If the height is LV_SIZE_CONTENT the label's height will be
expanded, otherwise the text will be clipped. (Default)
• LV_LABEL_LONG_DOT Replaces the last 3 characters from bottom right corner of the label with dots (.)
• LV_LABEL_LONG_SCROLL If the text is wider than the label scroll it horizontally back and forth. If it's higher,
scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.
• LV_LABEL_LONG_SCROLL_CIRCULAR If the text is wider than the label scroll it horizontally continously. If
it's higher, scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.
• LV_LABEL_LONG_CLIP Simply clip the parts of the text outside of the label.
You can specify the long mode with lv_label_set_long_mode(label, LV_LABEL_LONG_...)
Note that LV_LABEL_LONG_DOT manipulates the text buffer in-place in order to add/remove the dots.When
lv_label_set_text or lv_label_set_array_text are used, a separate buffer is allocated and this im-
plementation detail is unnoticed. This is not the case with lv_label_set_text_static. The buffer you pass to
lv_label_set_text_static must be writable if you plan to use LV_LABEL_LONG_DOT.

Text recolor
In the text, you can use commands to recolor parts of the text. For example: "Write a #ff0000 red# word".
This feature can be enabled individually for each label by lv_label_set_recolor() function.
Text selection
If enabled by LV_LABEL_TEXT_SELECTION part of the text can be selected. It's similar when on
PC a you use your mouse to select a text. The whole mechanism (click and select the text as you
drag your finger/mouse) is implemented in Text area and the Label widget only allows manual text se-
lection with lv_label_get_text_selection_start(label, start_char_index) and
lv_label_get_text_selection_start(label, end_char_index).
Very long texts
LVGL can efficiently handle very long (e.g. > 40k characters) labels by saving some extra data (~12 bytes) to speed up
drawing. To enable this feature, set LV_LABEL_LONG_TXT_HINT 1 in lv_conf.h.
Symbols
The labels can display symbols alongside letters (or on their own). Read the Font section to learn more about the symbols.
Events
No special events are sent by the Label.

Keys

Example
Line wrap, recoloring and scrolling
#if LV_USE_LABEL && LV_BUILD_EXAMPLES
/**
* Show line wrap, re-color, line align and text scrolling.
*/
void lv_example_label_1(void)
{


lv_obj_t * label1 = lv_label_create(lv_scr_act());
lv_label_set_long_mode(label1, LV_LABEL_LONG_WRAP); /*Break the long lines*/
lv_label_set_recolor(label1, true); /*Enable re-coloring by␣
,→commands in the text*/
lv_label_set_text(label1, "#0000ff Re-color# #ff00ff words# #ff0000 of a# label,␣

,→align the lines to the center "
"and wrap long text automatically.");

lv_obj_set_width(label1, 150); /*Set smaller width to make the lines wrap*/
lv_obj_set_style_text_align(label1, LV_TEXT_ALIGN_CENTER, 0);
lv_obj_align(label1, LV_ALIGN_CENTER, 0, -40);
lv_obj_t * label2 = lv_label_create(lv_scr_act());

lv_label_set_long_mode(label2, LV_LABEL_LONG_SCROLL_CIRCULAR); /*Circular␣
,→scroll*/
lv_obj_set_width(label2, 150);
lv_label_set_text(label2, "It is a circularly scrolling text. ");
lv_obj_align(label2, LV_ALIGN_CENTER, 0, 40);
}
#endif
Text shadow
#if LV_USE_LABEL && LV_BUILD_EXAMPLES
/**
* Create a fake text shadow
*/
{
/*Create a style for the shadow*/
static lv_style_t style_shadow;
lv_style_init(&style_shadow);
lv_style_set_text_opa(&style_shadow, LV_OPA_30);
lv_style_set_text_color(&style_shadow, lv_color_black());
/*Create a label for the shadow first (it's in the background)*/

lv_obj_t * shadow_label = lv_label_create(lv_scr_act());
lv_obj_add_style(shadow_label, &style_shadow, 0);
/*Create the main label*/

lv_obj_t * main_label = lv_label_create(lv_scr_act());
lv_label_set_text(main_label, "A simple method to create\n"
"shadows on a text.\n"
"It even works with\n\n"
"newlines and spaces.");
/*Set the same text for the shadow label*/

lv_label_set_text(shadow_label, lv_label_get_text(main_label));
/*Position the main label*/

lv_obj_align(main_label, LV_ALIGN_CENTER, 0, 0);

/*Shift the second label down and to the right by 2 pixel*/

lv_obj_align_to(shadow_label, main_label, LV_ALIGN_TOP_LEFT, 2, 2);
}
#endif
Show LTR, RTL and Chinese texts
#if LV_USE_LABEL && LV_BUILD_EXAMPLES && LV_FONT_DEJAVU_16_PERSIAN_HEBREW && LV_FONT_
,→SIMSUN_16_CJK && LV_USE_BIDI
/**
* Show mixed LTR, RTL and Chiease label
*/
{
lv_obj_t * ltr_label = lv_label_create(lv_scr_act());
lv_label_set_text(ltr_label, "In modern terminology, a microcontroller is similar␣
,→to a system on a chip (SoC).");
lv_obj_set_style_text_font(ltr_label, &lv_font_montserrat_16, 0);

lv_obj_set_width(ltr_label, 310);
lv_obj_align(ltr_label, LV_ALIGN_TOP_LEFT, 5, 5);
lv_obj_t * rtl_label = lv_label_create(lv_scr_act());

lv_label_set_text(rtl_label, ", : ) CPU␣
,→- Central Processing Unit).");
lv_obj_set_style_base_dir(rtl_label, LV_BASE_DIR_RTL, 0);

lv_obj_set_style_text_font(rtl_label, &lv_font_dejavu_16_persian_hebrew, 0);
lv_obj_set_width(rtl_label, 310);
lv_obj_align(rtl_label, LV_ALIGN_LEFT_MID, 5, 0);
lv_obj_t * cz_label = lv_label_create(lv_scr_act());

lv_label_set_text(cz_label, " Embedded System \
,→n ");
lv_obj_set_style_text_font(cz_label, &lv_font_simsun_16_cjk, 0);
lv_obj_set_width(cz_label, 310);
lv_obj_align(cz_label, LV_ALIGN_BOTTOM_LEFT, 5, -5);
}
#endif

MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_label_long_mode_t
Enums
enum [anonymous]
Long mode behaviors. Used in 'lv_label_ext_t'
Values:
enumerator LV_LABEL_LONG_WRAP
Keep the object width, wrap the too long lines and expand the object height
enumerator LV_LABEL_LONG_DOT
Keep the size and write dots at the end if the text is too long
enumerator LV_LABEL_LONG_SCROLL
Keep the size and roll the text back and forth
enumerator LV_LABEL_LONG_SCROLL_CIRCULAR
Keep the size and roll the text circularly
enumerator LV_LABEL_LONG_CLIP
Keep the size and clip the text out of it
Functions
LV_EXPORT_CONST_INT(LV_LABEL_DOT_NUM)
LV_EXPORT_CONST_INT(LV_LABEL_POS_LAST)
LV_EXPORT_CONST_INT(LV_LABEL_TEXT_SELECTION_OFF)
lv_obj_t *lv_label_create(lv_obj_t *parent)

Create a label objects
Parameters parent -- pointer to an object, it will be the parent of the new labely.
Returns pointer to the created button
void lv_label_set_text(lv_obj_t *obj, const char *text)
Set a new text for a label. Memory will be allocated to store the text by the label.

Parameters
• label -- pointer to a label object
• text -- '\0' terminated character string. NULL to refresh with the current text.
void lv_label_set_text_fmt (lv_obj_t *obj, const char *fmt,...

) LV_FORMAT_ATTRIBUTE(2
void void lv_label_set_text_static (lv_obj_t *obj, const char *text)
Set a static text. It will not be saved by the label so the 'text' variable has to be 'alive' while the label exist.
Parameters
• text -- pointer to a text. NULL to refresh with the current text.
void lv_label_set_long_mode(lv_obj_t *obj, lv_label_long_mode_t long_mode)
Set the behavior of the label with longer text then the object size
Parameters
• long_mode -- the new mode from 'lv_label_long_mode' enum. In
LV_LONG_WRAP/DOT/SCROLL/SCROLL_CIRC the size of the label should be
set AFTER this function
void lv_label_set_recolor(lv_obj_t *obj, bool en)
void lv_label_set_text_sel_start(lv_obj_t *obj, uint32_t index)

Set where text selection should start
Parameters
• obj -- pointer to a label object
• index -- character index from where selection should start.
LV_LABEL_TEXT_SELECTION_OFF for no selection
void lv_label_set_text_sel_end(lv_obj_t *obj, uint32_t index)
Set where text selection should end
Parameters
• index -- character index where selection should end.
LV_LABEL_TEXT_SELECTION_OFF for no selection
char *lv_label_get_text(const lv_obj_t *obj)
Get the text of a label
Parameters obj -- pointer to a label object
Returns the text of the label
lv_label_long_mode_t lv_label_get_long_mode(const lv_obj_t *obj)
Get the long mode of a label
Returns the current long mode

bool lv_label_get_recolor(const lv_obj_t *obj)

Get the recoloring attribute
Returns true: recoloring is enabled, false: disable
void lv_label_get_letter_pos(const lv_obj_t *obj, uint32_t char_id, lv_point_t *pos)
Get the relative x and y coordinates of a letter
Parameters
• index -- index of the character [0 ... text length - 1]. Expressed in character index, not byte
index (different in UTF-8)
• pos -- store the result here (E.g. index = 0 gives 0;0 coordinates if the text if aligned to the
left)
uint32_t lv_label_get_letter_on(const lv_obj_t *obj, lv_point_t *pos_in)
Get the index of letter on a relative point of a label.
Parameters
• obj -- pointer to label object
• pos -- pointer to point with coordinates on a the label
Returns The index of the letter on the 'pos_p' point (E.g. on 0;0 is the 0. letter if aligned to the left)
Expressed in character index and not byte index (different in UTF-8)
bool lv_label_is_char_under_pos(const lv_obj_t *obj, lv_point_t *pos)
Check if a character is drawn under a point.
Parameters
• label -- Label object
• pos -- Point to check for character under
Returns whether a character is drawn under the point
uint32_t lv_label_get_text_selection_start(const lv_obj_t *obj)
Get the selection start index.
Parameters obj -- pointer to a label object.
Returns selection start index. LV_LABEL_TEXT_SELECTION_OFF if nothing is selected.
uint32_t lv_label_get_text_selection_end(const lv_obj_t *obj)
Get the selection end index.
Parameters obj -- pointer to a label object.
Returns selection end index. LV_LABEL_TXT_SEL_OFF if nothing is selected.
void lv_label_ins_text(lv_obj_t *obj, uint32_t pos, const char *txt)
Insert a text to a label. The label text can not be static.
Parameters
• pos -- character index to insert. Expressed in character index and not byte index. 0: before
first char. LV_LABEL_POS_LAST: after last char.
• txt -- pointer to the text to insert

void lv_label_cut_text(lv_obj_t *obj, uint32_t pos, uint32_t cnt)

Delete characters from a label. The label text can not be static.
Parameters
• pos -- character index from where to cut. Expressed in character index and not byte index. 0:
start in from of the first character
• cnt -- number of characters to cut
Variables
const lv_obj_class_t lv_label_class

struct lv_label_t
Public Members
lv_obj_t obj
char *text
char *tmp_ptr
char tmp[LV_LABEL_DOT_NUM + 1]
union lv_label_t::[anonymous] dot
uint32_t dot_end
lv_draw_label_hint_t hint
uint32_t sel_start
uint32_t sel_end
lv_point_t offset
lv_label_long_mode_t long_mode
uint8_t static_txt
uint8_t recolor
uint8_t expand
uint8_t dot_tmp_alloc

5.2.10 Line (lv_line)
Overview
The Line object is capable of drawing straight lines between a set of points.
Parts and Styles
• LV_PART_MAIN uses all the typical background properties and line style properties.
Usage
Set points
The points have to be stored in an lv_point_t array and passed to the object by the
lv_line_set_points(lines, point_array, point_cnt) function.
Auto-size
By default the Line's width and height are set to LV_SIZE_CONTENT. This means it will automatically set its size to fit
all the points. If the size is set explicitly, parts on the line may not be visible.
Invert y
By default, the y == 0 point is in the top of the object. It might be conter-intuitive in some cases so the y coordinates can
be inverted with lv_line_set_y_invert(line, true). In this case, y == 0 will be the bottom of the object.
y invert is disabled by default.
Events
Only the Generic events are sent by the object type.

Keys


Example
Simple Line
#if LV_USE_LINE && LV_BUILD_EXAMPLES
void lv_example_line_1(void)
{
/*Create an array for the points of the line*/
static lv_point_t line_points[] = { {5, 5}, {70, 70}, {120, 10}, {180, 60}, {240,␣
,→10} };
/*Create style*/
static lv_style_t style_line;
lv_style_init(&style_line);
lv_style_set_line_width(&style_line, 8);
lv_style_set_line_color(&style_line, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_line_rounded(&style_line, true);
/*Create a line and apply the new style*/

lv_obj_t * line1;
line1 = lv_line_create(lv_scr_act());
lv_line_set_points(line1, line_points, 5); /*Set the points*/
lv_obj_add_style(line1, &style_line, 0);
lv_obj_center(line1);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_line_create(lv_obj_t *parent)

Create a line objects
Parameters par -- pointer to an object, it will be the parent of the new line
Returns pointer to the created line
void lv_line_set_points(lv_obj_t *obj, const lv_point_t points[], uint16_t point_num)
Set an array of points. The line object will connect these points.
Parameters
• obj -- pointer to a line object
• points -- an array of points. Only the address is saved, so the array needs to be alive while
the line exists

• point_num -- number of points in 'point_a'

void lv_line_set_y_invert(lv_obj_t *obj, bool en)
Enable (or disable) the y coordinate inversion. If enabled then y will be subtracted from the height of the object,
therefore the y = 0 coordinate will be on the bottom.
Parameters
• obj -- pointer to a line object
• en -- true: enable the y inversion, false:disable the y inversion
bool lv_line_get_y_invert(const lv_obj_t *obj)
Get the y inversion attribute
Parameters obj -- pointer to a line object
Returns true: y inversion is enabled, false: disabled
Variables
const lv_obj_class_t lv_line_class

struct lv_line_t
Public Members
lv_obj_t obj
const lv_point_t *point_array
Pointer to an array with the points of the line
uint16_t point_num
Number of points in 'point_array'
uint8_t y_inv
1: y == 0 will be on the bottom
5.2.11 Roller (lv_roller)
Overview
Roller allows you to simply select one option from a list by scrolling.

Parts and Styles
• LV_PART_MAIN The background of the roller uses all the typical background properties and text style properties.
style_text_line_space adjusts the space between the options. When the Roller is scrolled and doesn't
stop exactly on an option it will scroll to the nearest valid option automatically in anim_time milliseconds as
specified in the style.
• LV_PART_SELECTED The selected option in the middle. Besides the typical background properties it uses the
text style properties to change the appearance of the text in the selected area.
Usage
Set options
Options are passed to the Roller as a string with lv_roller_set_options(roller, options,

LV_ROLLER_MODE_NORMAL/INFINITE). The options should be separated by \n. For example: "First\
nSecond\nThird".
LV_ROLLER_MODE_INFINITE makes the roller circular.
You can select an option manually with lv_roller_set_selected(roller, id, LV_ANIM_ON/OFF),
where id is the index of an option.
Get selected option
The get the index of the currently selected option use lv_roller_get_selected(roller).
lv_roller_get_selected_str(roller, buf, buf_size) will copy the name of the selected option to
buf.
Visible rows
The number of visible rows can be adjusted with lv_roller_set_visible_row_count(roller, num).

This function calculates the height with the current style. If the font, line space, border width, etc of the roller changes
this function needs to be called again.
Events
• LV_EVENT_VALUE_CHANGED Sent when a new option is selected.


Keys
• LV_KEY_RIGHT/DOWN Select the next option

• LV_KEY_LEFT/UP Select the previous option
• LY_KEY_ENTER Apply the selected option (Send LV_EVENT_VALUE_CHANGED event)
Example
Simple Roller
#if LV_USE_ROLLER && LV_BUILD_EXAMPLES

{
char buf[32];
lv_roller_get_selected_str(obj, buf, sizeof(buf));
LV_LOG_USER("Selected month: %s\n", buf);
}
}
/**
* An infinite roller with the name of the months
*/
void lv_example_roller_1(void)
{
lv_obj_t *roller1 = lv_roller_create(lv_scr_act());
lv_roller_set_options(roller1,
"January\n"
"February\n"
"March\n"
"April\n"
"May\n"
"June\n"
"July\n"
"August\n"
"September\n"
"October\n"
"November\n"
"December",
LV_ROLLER_MODE_INFINITE);
lv_roller_set_visible_row_count(roller1, 4);
lv_obj_center(roller1);
lv_obj_add_event_cb(roller1, event_handler, LV_EVENT_ALL, NULL);
}
#endif

Styling the roller
#if LV_USE_ROLLER && LV_FONT_MONTSERRAT_22 && LV_BUILD_EXAMPLES

{
char buf[32];
lv_roller_get_selected_str(obj, buf, sizeof(buf));
LV_LOG_USER("Selected value: %s", buf);
}
}
/**
* Roller with various alignments and larger text in the selected area
*/
{
/*A style to make the selected option larger*/
static lv_style_t style_sel;
lv_style_init(&style_sel);
lv_style_set_text_font(&style_sel, &lv_font_montserrat_22);
const char * opts = "1\n2\n3\n4\n5\n6\n7\n8\n9\n10";

lv_obj_t *roller;
/*A roller on the left with left aligned text, and custom width*/
roller = lv_roller_create(lv_scr_act());
lv_roller_set_options(roller, opts, LV_ROLLER_MODE_NORMAL);
lv_roller_set_visible_row_count(roller, 2);
lv_obj_set_width(roller, 100);
lv_obj_add_style(roller, &style_sel, LV_PART_SELECTED);
lv_obj_set_style_text_align(roller, LV_TEXT_ALIGN_LEFT, 0);
lv_obj_align(roller, LV_ALIGN_LEFT_MID, 10, 0);
lv_obj_add_event_cb(roller, event_handler, LV_EVENT_ALL, NULL);
lv_roller_set_selected(roller, 2, LV_ANIM_OFF);
/*A roller on the middle with center aligned text, and auto (default) width*/
lv_obj_align(roller, LV_ALIGN_CENTER, 0, 0);
/*A roller on the right with right aligned text, and custom width*/
lv_obj_set_width(roller, 80);
lv_obj_set_style_text_align(roller, LV_TEXT_ALIGN_RIGHT, 0);
lv_obj_align(roller, LV_ALIGN_RIGHT_MID, -10, 0);


}
#endif
add fade mask to roller
#if LV_USE_ROLLER && LV_DRAW_COMPLEX && LV_BUILD_EXAMPLES
static void mask_event_cb(lv_event_t * e)

{
static int16_t mask_top_id = -1;

static int16_t mask_bottom_id = -1;
if (code == LV_EVENT_COVER_CHECK) {
lv_event_set_cover_res(e, LV_COVER_RES_MASKED);
} else if (code == LV_EVENT_DRAW_MAIN_BEGIN) {

/* add mask */
const lv_font_t * font = lv_obj_get_style_text_font(obj, LV_PART_MAIN);
lv_coord_t line_space = lv_obj_get_style_text_line_space(obj, LV_PART_MAIN);
lv_coord_t font_h = lv_font_get_line_height(font);
lv_area_t roller_coords;
lv_obj_get_coords(obj, &roller_coords);
lv_area_t rect_area;
rect_area.x1 = roller_coords.x1;
rect_area.x2 = roller_coords.x2;
rect_area.y1 = roller_coords.y1;
rect_area.y2 = roller_coords.y1 + (lv_obj_get_height(obj) - font_h - line_
,→space) / 2;
lv_draw_mask_fade_param_t * fade_mask_top = lv_mem_buf_get(sizeof(lv_draw_

,→mask_fade_param_t));
lv_draw_mask_fade_init(fade_mask_top, &rect_area, LV_OPA_TRANSP, rect_area.y1,
,→ LV_OPA_COVER, rect_area.y2);
mask_top_id = lv_draw_mask_add(fade_mask_top, NULL);
rect_area.y1 = rect_area.y2 + font_h + line_space - 1;

rect_area.y2 = roller_coords.y2;
lv_draw_mask_fade_param_t * fade_mask_bottom =lv_mem_buf_get(sizeof(lv_draw_

,→mask_fade_param_t));
lv_draw_mask_fade_init(fade_mask_bottom, &rect_area, LV_OPA_COVER, rect_area.
,→y1, LV_OPA_TRANSP, rect_area.y2);
mask_bottom_id = lv_draw_mask_add(fade_mask_bottom, NULL);
} else if (code == LV_EVENT_DRAW_POST_END) {



lv_draw_mask_fade_param_t * fade_mask_top = lv_draw_mask_remove_id(mask_top_
,→ id);
lv_draw_mask_fade_param_t * fade_mask_bottom = lv_draw_mask_remove_id(mask_
,→ bottom_id);
lv_mem_buf_release(fade_mask_top);
lv_mem_buf_release(fade_mask_bottom);
mask_top_id = -1;
mask_bottom_id = -1;
}
}
/**
* Add an fade mask to roller.
*/
{
lv_style_set_bg_color(&style, lv_color_black());
lv_style_set_text_color(&style, lv_color_white());
lv_obj_add_style(lv_scr_act(), &style, 0);
lv_obj_t *roller1 = lv_roller_create(lv_scr_act());

lv_obj_add_style(roller1, &style, 0);
lv_obj_set_style_bg_opa(roller1, LV_OPA_TRANSP, LV_PART_SELECTED);
#if LV_FONT_MONTSERRAT_22
lv_obj_set_style_text_font(roller1, &lv_font_montserrat_22, LV_PART_SELECTED);
#endif
lv_roller_set_options(roller1,
"January\n"
"February\n"
"March\n"
"April\n"
"May\n"
"June\n"
"July\n"
"August\n"
"September\n"
"October\n"
"November\n"
"December",
LV_ROLLER_MODE_NORMAL);
lv_obj_center(roller1);
lv_roller_set_visible_row_count(roller1, 3);
lv_obj_add_event_cb(roller1, mask_event_cb, LV_EVENT_ALL, NULL);
}
#endif

MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_roller_mode_t
Enums
enum [anonymous]
Roller mode.
Values:
enumerator LV_ROLLER_MODE_NORMAL
Normal mode (roller ends at the end of the options).
enumerator LV_ROLLER_MODE_INFINITE
Infinite mode (roller can be scrolled forever).
Functions
lv_obj_t *lv_roller_create(lv_obj_t *parent)

Create a roller objects
Parameters parent -- pointer to an object, it will be the parent of the new roller.
Returns pointer to the created roller
void lv_roller_set_options(lv_obj_t *obj, const char *options, lv_roller_mode_t mode)
Set the options on a roller
Parameters
• obj -- pointer to roller object
• options -- a string with '
• mode -- LV_ROLLER_MODE_NORMAL or LV_ROLLER_MODE_INFINITE
void lv_roller_set_selected(lv_obj_t *obj, uint16_t sel_opt, lv_anim_enable_t anim)
Set the selected option
Parameters
• obj -- pointer to a roller object
• sel_opt -- index of the selected option (0 ... number of option - 1);
• anim_en -- LV_ANIM_ON: set with animation; LV_ANOM_OFF set immediately

void lv_roller_set_visible_row_count(lv_obj_t *obj, uint8_t row_cnt)

Set the height to show the given number of rows (options)
Parameters
• obj -- pointer to a roller object
• row_cnt -- number of desired visible rows
uint16_t lv_roller_get_selected(const lv_obj_t *obj)
Get the index of the selected option
Parameters obj -- pointer to a roller object
Returns index of the selected option (0 ... number of option - 1);
void lv_roller_get_selected_str(const lv_obj_t *obj, char *buf, uint32_t buf_size)
Get the current selected option as a string.
Parameters
• obj -- pointer to ddlist object
• buf -- pointer to an array to store the string
• buf_size -- size of buf in bytes. 0: to ignore it.
const char *lv_roller_get_options(const lv_obj_t *obj)
Get the options of a roller
Parameters obj -- pointer to roller object
Returns
the options separated by '
'-s (E.g. "Option1\nOption2\nOption3")
uint16_t lv_roller_get_option_cnt(const lv_obj_t *obj)
Get the total number of options
Parameters obj -- pointer to a roller object
Returns the total number of options
Variables
const lv_obj_class_t lv_roller_class

struct lv_roller_t
Public Members
lv_obj_t obj
uint16_t option_cnt
Number of options
uint16_t sel_opt_id
Index of the current option

uint16_t sel_opt_id_ori
Store the original index on focus
lv_roller_mode_t mode
uint32_t moved
5.2.12 Slider (lv_slider)
Overview
The Slider object looks like a Bar supplemented with a knob. The knob can be dragged to set a value. Just like Bar, Slider
can be vertical or horizontal.
Parts and Styles
• LV_PART_MAIN The background of the slider. Uses all the typical background style properties. padding
makes the indicator smaller in the respective direction.
• LV_PART_INDICATOR The indicator that shows the current state of the slider. Also uses all the typical back-
ground style properties.
• LV_PART_KNOB A rectangle (or circle) drawn at the current value. Also uses all the typical background properties
to describe the knob(s). By default the knob is square (with a optional corner radius) with side length equal to
the smaller side of the slider. The knob can be made larger with the padding values. Padding values can be
asymmetric too.
Usage
Value and range
To set an initial value use lv_slider_set_value(slider, new_value, LV_ANIM_ON/OFF). The ani-

mation time is set by the styles' anim_time property.
To specify the range (min, max values), lv_slider_set_range(slider, min , max) can be used.
Modes
The slider can be one the following modes:

• LV_SLIDER_MODE_NORMAL A normal slider as described above
• LV_SLIDER_SYMMETRICAL Draw the indicator form the zero value to current value. Requires negaitve mini-
mum range and positive maximum range.
• LV_SLIDER_RANGE Allows setting the start value too by lv_bar_set_start_value(bar,
new_value, LV_ANIM_ON/OFF). The start value has to be always smaller than the end value.
The mode can be changed with lv_slider_set_mode(slider, LV_SLIDER_MODE_...)

Knob-only mode
Normally, the slider can be adjusted either by dragging the knob, or by clicking on the slider bar. In the latter case
the knob moves to the point clicked and slider value changes accordingly. In some cases it is desirable to set the
slider to react on dragging the knob only. This feature is enabled by adding the LV_OBJ_FLAG_ADV_HITTEST:
lv_obj_add_flag(slider, LV_OBJ_FLAG_ADV_HITTEST).
Events
• LV_EVENT_VALUE_CHANGED Sent while the slider is being dragged or changed with keys. The event is sent
continuously while the slider is dragged and once when released. Use lv_slider_is_dragged to detemine
whether the Slider is still being dragged or has just been released.
Keys
• LV_KEY_UP/RIGHT Increment the slider's value by 1

• LV_KEY_DOWN/LEFT Decrement the slider's value by 1
Example
Simple Slider
#if LV_USE_SLIDER && LV_BUILD_EXAMPLES

static lv_obj_t * slider_label;
/**
* A default slider with a label displaying the current value
*/
void lv_example_slider_1(void)
{
lv_obj_center(slider);
lv_obj_add_event_cb(slider, slider_event_cb, LV_EVENT_VALUE_CHANGED, NULL);
/*Create a label below the slider*/

slider_label = lv_label_create(lv_scr_act());
lv_label_set_text(slider_label, "0%");
lv_obj_align_to(slider_label, slider, LV_ALIGN_OUT_BOTTOM_MID, 0, 10);

}



{
lv_obj_t * slider = lv_event_get_target(e);
char buf[8];
lv_snprintf(buf, sizeof(buf), "%d%%", lv_slider_get_value(slider));
lv_label_set_text(slider_label, buf);
lv_obj_align_to(slider_label, slider, LV_ALIGN_OUT_BOTTOM_MID, 0, 10);
}
#endif
Slider with custom style
/**
* Show how to style a slider.
*/
{
/*Create a transition*/
static const lv_style_prop_t props[] = {LV_STYLE_BG_COLOR, 0};
static lv_style_transition_dsc_t transition_dsc;
lv_style_transition_dsc_init(&transition_dsc, props, lv_anim_path_linear, 300, 0,␣
,→NULL);
static lv_style_t style_main;

static lv_style_t style_indicator;
static lv_style_t style_knob;
static lv_style_t style_pressed_color;
lv_style_init(&style_main);
lv_style_set_bg_opa(&style_main, LV_OPA_COVER);
lv_style_set_bg_color(&style_main, lv_color_hex3(0xbbb));
lv_style_set_radius(&style_main, LV_RADIUS_CIRCLE);
lv_style_set_pad_ver(&style_main, -2); /*Makes the indicator larger*/
lv_style_init(&style_indicator);
lv_style_set_bg_opa(&style_indicator, LV_OPA_COVER);
lv_style_set_bg_color(&style_indicator, lv_palette_main(LV_PALETTE_CYAN));
lv_style_set_radius(&style_indicator, LV_RADIUS_CIRCLE);
lv_style_set_transition(&style_indicator, &transition_dsc);
lv_style_init(&style_knob);
lv_style_set_bg_opa(&style_knob, LV_OPA_COVER);
lv_style_set_bg_color(&style_knob, lv_palette_main(LV_PALETTE_CYAN));
lv_style_set_border_color(&style_knob, lv_palette_darken(LV_PALETTE_CYAN, 3));
lv_style_set_border_width(&style_knob, 2);
lv_style_set_radius(&style_knob, LV_RADIUS_CIRCLE);
lv_style_set_pad_all(&style_knob, 6); /*Makes the knob larger*/
lv_style_set_transition(&style_knob, &transition_dsc);
lv_style_init(&style_pressed_color);


lv_style_set_bg_color(&style_pressed_color, lv_palette_darken(LV_PALETTE_CYAN,␣
,→2));
/*Create a slider and add the style*/

lv_obj_remove_style_all(slider); /*Remove the styles coming from the␣
,→theme*/
lv_obj_add_style(slider, &style_main, LV_PART_MAIN);

lv_obj_add_style(slider, &style_indicator, LV_PART_INDICATOR);
lv_obj_add_style(slider, &style_pressed_color, LV_PART_INDICATOR | LV_STATE_
,→PRESSED);
lv_obj_add_style(slider, &style_knob, LV_PART_KNOB);

lv_obj_add_style(slider, &style_pressed_color, LV_PART_KNOB | LV_STATE_PRESSED);
}
#endif
Slider with extended drawer
/**
* Show the current value when the slider is pressed by extending the drawer
*
*/
{
lv_obj_t * slider;
slider = lv_slider_create(lv_scr_act());
lv_slider_set_mode(slider, LV_SLIDER_MODE_RANGE);
lv_slider_set_value(slider, 70, LV_ANIM_OFF);
lv_slider_set_left_value(slider, 20, LV_ANIM_OFF);
lv_obj_add_event_cb(slider, slider_event_cb, LV_EVENT_ALL, NULL);

lv_obj_refresh_ext_draw_size(slider);
}

{
/*Provide some extra space for the value*/

if(code == LV_EVENT_REFR_EXT_DRAW_SIZE) {
lv_coord_t * size = lv_event_get_param(e);


*size = LV_MAX(*size, 50);
}
else if(code == LV_EVENT_DRAW_PART_END) {
if(dsc->part == LV_PART_INDICATOR) {
char buf[16];
lv_snprintf(buf, sizeof(buf), "%d - %d", lv_slider_get_left_value(obj),␣
,→lv_slider_get_value(obj));
lv_point_t label_size;
lv_txt_get_size(&label_size, buf, LV_FONT_DEFAULT, 0, 0, LV_COORD_MAX, 0);
lv_area_t label_area;
label_area.x1 = dsc->draw_area->x1 + lv_area_get_width(dsc->draw_area) /␣
,→2 - label_size.x / 2;
label_area.x2 = label_area.x1 + label_size.x;

label_area.y2 = dsc->draw_area->y1 - 10;
label_area.y1 = label_area.y2 - label_size.y;
lv_draw_label_dsc_t label_draw_dsc;
lv_draw_label_dsc_init(&label_draw_dsc);
lv_draw_label(&label_area, dsc->clip_area, &label_draw_dsc, buf, NULL);

}
}
}
#endif
MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_slider_mode_t
Enums
enum [anonymous]
Values:
enumerator LV_SLIDER_MODE_NORMAL
enumerator LV_SLIDER_MODE_SYMMETRICAL
enumerator LV_SLIDER_MODE_RANGE

Functions
lv_obj_t *lv_slider_create(lv_obj_t *parent)

Create a slider objects
Parameters parent -- pointer to an object, it will be the parent of the new slider.
Returns pointer to the created slider
static inline void lv_slider_set_value(lv_obj_t *obj, int32_t value, lv_anim_enable_t anim)
Set a new value on the slider
Parameters
• obj -- pointer to a slider object
• value -- the new value
immediately
static inline void lv_slider_set_left_value(lv_obj_t *obj, int32_t value, lv_anim_enable_t anim)
Set a new value for the left knob of a slider
Parameters
immediately
static inline void lv_slider_set_range(lv_obj_t *obj, int32_t min, int32_t max)
Set minimum and the maximum values of a bar
Parameters
• obj -- pointer to the slider object
static inline void lv_slider_set_mode(lv_obj_t *obj, lv_slider_mode_t mode)
Set the mode of slider.
Parameters
• mode -- the mode of the slider. See ::lv_slider_mode_t
static inline int32_t lv_slider_get_value(const lv_obj_t *obj)
Get the value of the main knob of a slider
Parameters obj -- pointer to a slider object
Returns the value of the main knob of the slider
static inline int32_t lv_slider_get_left_value(const lv_obj_t *obj)
Get the value of the left knob of a slider
Returns the value of the left knob of the slider

static inline int32_t lv_slider_get_min_value(const lv_obj_t *obj)

Get the minimum value of a slider
Returns the minimum value of the slider
static inline int32_t lv_slider_get_max_value(const lv_obj_t *obj)
Get the maximum value of a slider
Returns the maximum value of the slider
bool lv_slider_is_dragged(const lv_obj_t *obj)
Give the slider is being dragged or not
Returns true: drag in progress false: not dragged
static inline lv_slider_mode_t lv_slider_get_mode(lv_obj_t *slider)
Get the mode of the slider.
Returns see ::lv_slider_mode_t
Variables
const lv_obj_class_t lv_slider_class

struct lv_slider_t
Public Members
lv_bar_t bar
lv_area_t left_knob_area
lv_area_t right_knob_area
int32_t *value_to_set
uint8_t dragging
uint8_t left_knob_focus
5.2.13 Switch (lv_switch)
Overview
The Switch looks like a little slider and can be used to turn something on and off.

Parts and Styles
• LV_PART_MAIN The background of the switch uses all the typical background style properties. padding makes
the indicator smaller in the respective direction.
• LV_PART_INDICATOR The indicator that shows the current state of the switch. Also uses all the typical back-
ground style properties.
• LV_PART_KNOB A rectangle (or circle) drawn at left or right side of the indicator. Also uses all the typical
background properties to describe the knob(s). By default the knob is square (with a optional corner radius) with
side length equal to the smaller side of the slider. The knob can be made larger with the padding values. Padding
values can be asymmetric too.
Usage
Change state
When the switch is turned on it goes to LV_STATE_CHECKED. To get the current satte of the switch use
lv_obj_has_state(switch, LV_STATE_CHECKED). To manually turn the switch on/off call lvobj_add/
clear_state(switch, LV_STATE_CHECKED).
Events
• LV_EVENT_VALUE_CHANGED Sent when the switch changes state.

Keys
• LV_KEY_UP/RIGHT Turns on the slider

• LV_KEY_DOWN/LEFT Turns off the slider
• LV_KEY_ENTER Toggles the switch
Example
Simple Switch
#if LV_USE_SWITCH && LV_BUILD_EXAMPLES

{
LV_LOG_USER("State: %s\n", lv_obj_has_state(obj, LV_STATE_CHECKED) ? "On" :
,→"Off");


}
}
void lv_example_switch_1(void)
{
lv_obj_set_flex_flow(lv_scr_act(), LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(lv_scr_act(), LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER,␣
,→LV_FLEX_ALIGN_CENTER);
lv_obj_t * sw;
sw = lv_switch_create(lv_scr_act());
lv_obj_add_event_cb(sw, event_handler, LV_EVENT_ALL, NULL);
lv_obj_add_state(sw, LV_STATE_CHECKED);
lv_obj_add_state(sw, LV_STATE_DISABLED);
lv_obj_add_state(sw, LV_STATE_CHECKED | LV_STATE_DISABLED);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_switch_create(lv_obj_t *parent)

Create a switch objects
Parameters parent -- pointer to an object, it will be the parent of the new switch
Returns pointer to the created switch

Variables
const lv_obj_class_t lv_switch_class

struct lv_switch_t
Public Members
lv_obj_t obj
5.2.14 Table (lv_table)
Overview
Tables, as usual, are built from rows, columns, and cells containing texts.
The Table object is very lightweight because only the texts are stored. No real objects are created for cells but they are
just drawn on the fly.
Parts and Styles
• LV_PART_MAIN The background of the table uses all the typical background style properties.
• LV_PART_ITEMS The cells of the table also use all the typical background style properties and the text properties.
Usage
Set cell value
The cells can store only text so numbers need to be converted to text before displaying them in a table.
lv_table_set_cell_value(table, row, col, "Content"). The text is saved by the table so it can be
even a local variable.
Line breaks can be used in the text like "Value\n60.3".
New rows and columns are automatically added is required
Rows and Columns
To explicitly set number of rows and columns use lv_table_set_row_cnt(table, row_cnt) and
lv_table_set_col_cnt(table, col_cnt)

Width and Height
The width of the columns can be set with lv_table_set_col_width(table, col_id, width). The overall
width of the Table object will be set to the sum of columns widths.
The height is calculated automatically from the cell styles (font, padding etc) and the number of rows.
Merge cells
Cells can be merged horizontally with lv_table_set_cell_merge_right(table, col, row, true).

To merge more adjacent cells call this function for each cell.
Scroll
If the label's width or height is set to LV_SIZE_CONTENT that size will be used to show the whole table in the respective
direction. E.g. lv_obj_set_size(table, LV_SIZE_CONTENT, LV_SIZE_CONTENT) automatically sets
the table size to show all the columns and rows.
If the width or height is set to a smaller number than the "intrinsic" size then the table becomes scrollable.
Events
• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for both main and items parts
to allow hooking the drawing. For more detail on the main part see the Base object's documentation. For the items
(cells) the following fields are used: clip_area, draw_area, part, rect_dsc, label_dsc id (current
row × col count + current column).
Keys

Example
Simple table
#if LV_USE_TABLE && LV_BUILD_EXAMPLES
static void draw_part_event_cb(lv_event_t * e)

{
/*If the cells are drawn...*/
if(dsc->part == LV_PART_ITEMS) {


uint32_t row = dsc->id / lv_table_get_col_cnt(obj);
uint32_t col = dsc->id - row * lv_table_get_col_cnt(obj);
/*Make the texts in the first cell center aligned*/

if(row == 0) {
dsc->label_dsc->align = LV_TEXT_ALIGN_CENTER;
dsc->rect_dsc->bg_color = lv_color_mix(lv_palette_main(LV_PALETTE_BLUE),␣
,→dsc->rect_dsc->bg_color, LV_OPA_20);
dsc->rect_dsc->bg_opa = LV_OPA_COVER;
}
/*In the first column align the texts to the right*/
else if(col == 0) {
dsc->label_dsc->flag = LV_TEXT_ALIGN_RIGHT;
}
/*MAke every 2nd row grayish*/

if((row != 0 && row % 2) == 0) {
dsc->rect_dsc->bg_color = lv_color_mix(lv_palette_main(LV_PALETTE_GREY),␣
,→dsc->rect_dsc->bg_color, LV_OPA_10);
dsc->rect_dsc->bg_opa = LV_OPA_COVER;
}
}
}
void lv_example_table_1(void)
{
lv_obj_t * table = lv_table_create(lv_scr_act());
/*Fill the first column*/

lv_table_set_cell_value(table, 0, 0, "Name");
lv_table_set_cell_value(table, 1, 0, "Apple");
lv_table_set_cell_value(table, 2, 0, "Banana");
lv_table_set_cell_value(table, 3, 0, "Lemon");
lv_table_set_cell_value(table, 4, 0, "Grape");
lv_table_set_cell_value(table, 5, 0, "Melon");
lv_table_set_cell_value(table, 6, 0, "Peach");
lv_table_set_cell_value(table, 7, 0, "Nuts");
/*Fill the second column*/

lv_table_set_cell_value(table, 0, 1, "Price");
lv_table_set_cell_value(table, 1, 1, "$7");
/*Set a smaller height to the table. It'll make it scrollable*/

lv_obj_set_height(table, 200);
lv_obj_center(table);
/*Add an event callback to to apply some custom drawing*/

lv_obj_add_event_cb(table, draw_part_event_cb, LV_EVENT_DRAW_PART_BEGIN, NULL);
}


#endif
Lightweighted list from table
#if LV_USE_TABLE && LV_BUILD_EXAMPLES
#define ITEM_CNT 200
static void draw_event_cb(lv_event_t * e)

{
lv_obj_draw_part_dsc_t * dsc = lv_event_get_draw_part_dsc(e);
/*If the cells are drawn...*/
bool chk = lv_table_has_cell_ctrl(obj, dsc->id, 0, LV_TABLE_CELL_CTRL_CUSTOM_
,→1);
lv_draw_rect_dsc_t rect_dsc;
lv_draw_rect_dsc_init(&rect_dsc);
rect_dsc.bg_color = chk ? lv_theme_get_color_primary(obj) : lv_palette_
,→lighten(LV_PALETTE_GREY, 2);
rect_dsc.radius = LV_RADIUS_CIRCLE;
lv_area_t sw_area;
sw_area.x1 = dsc->draw_area->x2 - 50;
sw_area.x2 = sw_area.x1 + 40;
sw_area.y1 = dsc->draw_area->y1 + lv_area_get_height(dsc->draw_area) / 2 -␣
,→ 10;
sw_area.y2 = sw_area.y1 + 20;
lv_draw_rect(&sw_area, dsc->clip_area, &rect_dsc);
rect_dsc.bg_color = lv_color_white();
if(chk) {
sw_area.x2 -= 2;
sw_area.x1 = sw_area.x2 - 16;
} else {
sw_area.x1 += 2;
sw_area.x2 = sw_area.x1 + 16;
}
sw_area.y1 += 2;
sw_area.y2 -= 2;
lv_draw_rect(&sw_area, dsc->clip_area, &rect_dsc);
}
}
static void change_event_cb(lv_event_t * e)

{
uint16_t col;
uint16_t row;
lv_table_get_selected_cell(obj, &row, &col);
bool chk = lv_table_has_cell_ctrl(obj, row, 0, LV_TABLE_CELL_CTRL_CUSTOM_1);
if(chk) lv_table_clear_cell_ctrl(obj, row, 0, LV_TABLE_CELL_CTRL_CUSTOM_1);


else lv_table_add_cell_ctrl(obj, row, 0, LV_TABLE_CELL_CTRL_CUSTOM_1);
}
/**
* A very light-weighted list created from table
*/
void lv_example_table_2(void)
{
/*Measure memory usage*/
lv_mem_monitor_t mon1;
lv_mem_monitor(&mon1);
uint32_t t = lv_tick_get();
lv_obj_t * table = lv_table_create(lv_scr_act());
/*Set a smaller height to the table. It'll make it scrollable*/

lv_obj_set_size(table, LV_SIZE_CONTENT, 200);
lv_table_set_col_width(table, 0, 150);
lv_table_set_row_cnt(table, ITEM_CNT); /*Not required but avoids a lot of memory␣
,→reallocation lv_table_set_set_value*/
lv_table_set_col_cnt(table, 1);
/*Don't make the cell pressed, we will draw something different in the event*/
lv_obj_remove_style(table, NULL, LV_PART_ITEMS | LV_STATE_PRESSED);
uint32_t i;
for(i = 0; i < ITEM_CNT; i++) {
lv_table_set_cell_value_fmt(table, i, 0, "Item %d", i + 1);
}
lv_obj_align(table, LV_ALIGN_CENTER, 0, -20);
/*Add an event callback to to apply some custom drawing*/

lv_obj_add_event_cb(table, draw_event_cb, LV_EVENT_DRAW_PART_END, NULL);
lv_obj_add_event_cb(table, change_event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_mem_monitor_t mon2;
lv_mem_monitor(&mon2);
uint32_t mem_used = mon1.free_size - mon2.free_size;
uint32_t elaps = lv_tick_elaps(t);

lv_label_set_text_fmt(label, "%d items were created in %d ms\n"
"using %d bytes of memory",
ITEM_CNT, elaps, mem_used);
lv_obj_align(label, LV_ALIGN_BOTTOM_MID, 0, -10);
#endif

MicroPython
No examples yet.
MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_table_cell_ctrl_t
Enums
enum [anonymous]
Values:
enumerator LV_TABLE_CELL_CTRL_MERGE_RIGHT
enumerator LV_TABLE_CELL_CTRL_TEXT_CROP
enumerator LV_TABLE_CELL_CTRL_CUSTOM_1
Functions
LV_EXPORT_CONST_INT(LV_TABLE_CELL_NONE)
lv_obj_t *lv_table_create(lv_obj_t *parent)

Create a table object
Parameters parent -- pointer to an object, it will be the parent of the new table
Returns pointer to the created table
void lv_table_set_cell_value(lv_obj_t *obj, uint16_t row, uint16_t col, const char *txt)
Set the value of a cell.
Note: New roes/columns are added automatically if required
Parameters
• obj -- pointer to a Table object

• row -- id of the row [0 .. row_cnt -1]

• col -- id of the column [0 .. col_cnt -1]
• txt -- text to display in the cell. It will be copied and saved so this variable is not required
after this function call.
void lv_table_set_cell_value_fmt(lv_obj_t *obj, uint16_t row, uint16_t col, const char *fmt, ...)
Set the value of a cell. Memory will be allocated to store the text by the table.
Note: New roes/columns are added automatically if required
Parameters
• fmt -- printf-like format
void lv_table_set_row_cnt(lv_obj_t *obj, uint16_t row_cnt)

Set the number of rows
Parameters
• obj -- table pointer to a Table object
• row_cnt -- number of rows
void lv_table_set_col_cnt(lv_obj_t *obj, uint16_t col_cnt)
Set the number of columns
Parameters
• col_cnt -- number of columns.
void lv_table_set_col_width(lv_obj_t *obj, uint16_t col_id, lv_coord_t w)
Set the width of a column
Parameters
• col_id -- id of the column [0 .. LV_TABLE_COL_MAX -1]
• w -- width of the column
void lv_table_add_cell_ctrl(lv_obj_t *obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl)
Add control bits to the cell.
Parameters
• ctrl -- OR-ed values from ::lv_table_cell_ctrl_t

void lv_table_clear_cell_ctrl(lv_obj_t *obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl)

Clear control bits of the cell.
Parameters
const char *lv_table_get_cell_value(lv_obj_t *obj, uint16_t row, uint16_t col)
Get the value of a cell.
Parameters
Returns text in the cell
uint16_t lv_table_get_row_cnt(lv_obj_t *obj)
Get the number of rows.
Parameters obj -- table pointer to a Table object
Returns number of rows.
uint16_t lv_table_get_col_cnt(lv_obj_t *obj)
Get the number of columns.
Parameters obj -- table pointer to a Table object
Returns number of columns.
lv_coord_t lv_table_get_col_width(lv_obj_t *obj, uint16_t col)
Get the width of a column
Parameters
• col -- id of the column [0 .. LV_TABLE_COL_MAX -1]
Returns width of the column
bool lv_table_has_cell_ctrl(lv_obj_t *obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl)
Get whether a cell has the control bits
Parameters
Returns true: all control bits are set; false: not all control bits are set
void lv_table_get_selected_cell(lv_obj_t *obj, uint16_t *row, uint16_t *col)
Get the selected cell (pressed and or focused)

Parameters
• obj -- pointer to a table object
• row -- pointer to variable to store the selected row (LV_TABLE_CELL_NONE: if no cell
selected)
• col -- pointer to variable to store the selected column (LV_TABLE_CELL_NONE: if no cell
selected)
Variables
const lv_obj_class_t lv_table_class

struct lv_table_t
Public Members
lv_obj_t obj
uint16_t col_cnt
uint16_t row_cnt
char **cell_data
lv_coord_t *row_h
lv_coord_t *col_w
uint16_t col_act
uint16_t row_act
5.2.15 Text area (lv_textarea)
Overview
The Text Area is a Base object with a Label and a cursor on it. Texts or characters can be added to it. Long lines are
wrapped and when the text becomes long enough the Text area can be scrolled.
One line mode and password modes are supported.
Parts and Styles
• LV_PART_MAIN The background of the text area. Uses all the typical backgrond style properties and the text
related style properties including text_align to align the text to the left, right or center.
• LV_PART_SCROLLBAR The scrollbar that is shown when the text is too long.
• LV_PART_SELECTED Detemines the style of the selected text. Only text_color and bg_color style prop-
erties can be used.
• LV_PART_CURSOR Marks the position where the characters are inserted. The cursor's area is always the bounding
box of the current character. A block cursor can be created by adding a background color and background opacity
to LV_PART_CURSOR's style. The create line cursor leave the cursor transparent and set a left border. The
anim_time style property sets the cursor's blink time.

• LV_PART_TEXTAREA_PLACEHOLDER Unique to Text Area, allows styling the placeholder text.
Usage
Add text
You can insert text or characters to the current cursor's position with:
• lv_textarea_add_char(textarea, 'c')
• lv_textarea_add_text(textarea, "insert this text")
To add wide characters like 'á', 'ß' or CJK characters use lv_textarea_add_text(ta, "á").
lv_textarea_set_text(ta, "New text") changes the whole text.
Placeholder
A placeholder text can be specified - which is displayed when the Text area is empty - with
lv_textarea_set_placeholder_text(ta, "Placeholder text")
Delete character
To delete a character from the left of the current cursor position use lv_textarea_del_char(textarea). To
delete from the right use lv_textarea_del_char_forward(textarea)
Move the cursor
The cursor position can be modified directly like lv_textarea_set_cursor_pos(textarea, 10). The 0
position means "before the first characters", LV_TA_CURSOR_LAST means "after the last character"
You can step the cursor with
• lv_textarea_cursor_right(textarea)
• lv_textarea_cursor_left(textarea)
• lv_textarea_cursor_up(textarea)
• lv_textarea_cursor_down(textarea)
If lv_textarea_set_cursor_click_pos(textarea, true) is applied the cursor will jump to the position
where the Text area was clicked.
Hide the cursor
The cursor is always visible, however it can be a good idea to style it to be visible only in LV_STATE_FOCUSED state.

One line mode
The Text area can be configured to be on a single line with lv_textarea_set_one_line(textarea, true).
In this mode the height is set automatically to show only one line, line break characters are ignored, and word wrap is
disabled.
Password mode
The text area supports password mode which can be enabled with lv_textarea_set_password_mode(textarea,
true).
If the • (Bullet, U+2022) character exists in the font, the entered characters are converted to it after some time or when
a new character is entered. If • not exists, * will be used.
In password mode lv_textarea_get_text(textarea) returns the actual text entered, not the bullet characters.
The visibility time can be adjusted with LV_TEXTAREA_DEF_PWD_SHOW_TIME) in lv_conf.h.
Accepted characters
You can set a list of accepted characters with lv_textarae_set_accepted_chars(textarea,

"0123456789.+-"). Other characters will be ignored.
Max text length
The maximum number of characters can be limited with lv_textarea_set_max_length(textarea,

max_char_num)
Very long texts
If there is a very long text in the Text area (e. g. > 20k characters), scrolling and drawing might be slow. However,
by enabling LV_LABEL_LONG_TXT_HINT 1 in lv_conf.h the performance can be hugely improved. This will
save some additional information about the label to speed up its drawing. Using LV_LABEL_LONG_TXT_HINT the
scrolling and drawing will as fast as with "normal" short texts.
Select text
Any part of the text can be selected if enabled with lv_textarea_set_text_selection(textarea,

true). This works much like when you select text on your PC with your mouse.

Events
• LV_EVENT_INSERT Sent right before a character or text is inserted. The event paramter is the text about to
be inserted. lv_textarea_set_insert_replace(textarea, "New text") replaces the text to
insert. The new text cannot be in a local variable which is destroyed when the event callback exists. "" means do
not insert anything.
• LV_EVENT_VALUE_CHANGED Sent when the content of the text area has been changed.
• LV_EVENT_APPLY Sent when LV_KEY_ENTER is pressed (or(sent) to a one line text area.
Keys
• LV_KEY_UP/DOWN/LEFT/RIGHT Move the cursor

• Any character Add the character to the current cursor position
Example
Simple Text area
#if LV_USE_TEXTAREA && LV_BUILD_EXAMPLES
static void textarea_event_handler(lv_event_t * e)

{
lv_obj_t * ta = lv_event_get_target(e);
LV_LOG_USER("Enter was pressed. The current text is: %s", lv_textarea_get_
,→text(ta));
static void btnm_event_handler(lv_event_t * e)

{
lv_obj_t * ta = lv_event_get_user_data(e);
const char * txt = lv_btnmatrix_get_btn_text(obj, lv_btnmatrix_get_selected_
,→btn(obj));
if(strcmp(txt, LV_SYMBOL_BACKSPACE) == 0) lv_textarea_del_char(ta);

else if(strcmp(txt, LV_SYMBOL_NEW_LINE) == 0) lv_event_send(ta, LV_EVENT_READY,␣
,→NULL);
else lv_textarea_add_text(ta, txt);
void lv_example_textarea_1(void)
{
lv_obj_t * ta = lv_textarea_create(lv_scr_act());
lv_textarea_set_one_line(ta, true);


lv_obj_align(ta, LV_ALIGN_TOP_MID, 0, 10);
lv_obj_add_event_cb(ta, textarea_event_handler, LV_EVENT_READY, ta);
lv_obj_add_state(ta, LV_STATE_FOCUSED); /*To be sure the cursor is visible*/
static const char * btnm_map[] = {"1", "2", "3", "\n",

"4", "5", "6", "\n",
"7", "8", "9", "\n",
LV_SYMBOL_BACKSPACE, "0", LV_SYMBOL_NEW_LINE, ""};

lv_obj_set_size(btnm, 200, 150);
lv_obj_align(btnm, LV_ALIGN_BOTTOM_MID, 0, -10);
lv_obj_add_event_cb(btnm, btnm_event_handler, LV_EVENT_VALUE_CHANGED, ta);
lv_obj_clear_flag(btnm, LV_OBJ_FLAG_CLICK_FOCUSABLE); /*To keep the text area␣
,→focused on button clicks*/
lv_btnmatrix_set_map(btnm, btnm_map);
}
#endif
Text area with password field
#if LV_USE_TEXTAREA && LV_USE_KEYBOARD && LV_BUILD_EXAMPLES
static void ta_event_cb(lv_event_t * e);
static lv_obj_t * kb;
{
/*Create the password box*/
lv_obj_t * pwd_ta = lv_textarea_create(lv_scr_act());
lv_textarea_set_text(pwd_ta, "");
lv_textarea_set_password_mode(pwd_ta, true);
lv_textarea_set_one_line(pwd_ta, true);
lv_obj_set_width(pwd_ta, lv_pct(40));
lv_obj_set_pos(pwd_ta, 5, 20);
lv_obj_add_event_cb(pwd_ta, ta_event_cb, LV_EVENT_ALL, NULL);
/*Create a label and position it above the text box*/

lv_obj_t * pwd_label = lv_label_create(lv_scr_act());
lv_label_set_text(pwd_label, "Password:");
lv_obj_align_to(pwd_label, pwd_ta, LV_ALIGN_OUT_TOP_LEFT, 0, 0);
/*Create the one-line mode text area*/

lv_obj_t * text_ta = lv_textarea_create(lv_scr_act());
lv_textarea_set_one_line(text_ta, true);
lv_textarea_set_password_mode(text_ta, false);
lv_obj_set_width(text_ta, lv_pct(40));
lv_obj_add_event_cb(text_ta, ta_event_cb, LV_EVENT_ALL, NULL);
lv_obj_align(text_ta, LV_ALIGN_TOP_RIGHT, -5, 20);


/*Create a label and position it above the text box*/
lv_obj_t * oneline_label = lv_label_create(lv_scr_act());
lv_label_set_text(oneline_label, "Text:");
lv_obj_align_to(oneline_label, text_ta, LV_ALIGN_OUT_TOP_LEFT, 0, 0);
/*Create a keyboard*/
kb = lv_keyboard_create(lv_scr_act());
lv_obj_set_size(kb, LV_HOR_RES, LV_VER_RES / 2);
lv_keyboard_set_textarea(kb, pwd_ta); /*Focus it on one of the text areas to␣

,→ start*/
}
static void ta_event_cb(lv_event_t * e)

{
if(code == LV_EVENT_CLICKED || code == LV_EVENT_FOCUSED) {
/*Focus on the clicked text area*/
if(kb != NULL) lv_keyboard_set_textarea(kb, ta);
}
else if(code == LV_EVENT_READY) {

LV_LOG_USER("Ready, current text: %s", lv_textarea_get_text(ta));
}
}
#endif
Text auto-formatting
#if LV_USE_TEXTAREA && LV_USE_KEYBOARD && LV_BUILD_EXAMPLES
static void ta_event_cb(lv_event_t * e);
static lv_obj_t * kb;
/**
* Automatically format text like a clock. E.g. "12:34"
* Add the ':' automatically.
*/
{
/*Create the text area*/
lv_obj_t * ta = lv_textarea_create(lv_scr_act());
lv_obj_add_event_cb(ta, ta_event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_textarea_set_accepted_chars(ta, "0123456789:");
lv_textarea_set_max_length(ta, 5);
lv_textarea_set_one_line(ta, true);
lv_textarea_set_text(ta, "");
/*Create a keyboard*/
kb = lv_keyboard_create(lv_scr_act());


lv_obj_set_size(kb, LV_HOR_RES, LV_VER_RES / 2);
lv_keyboard_set_mode(kb, LV_KEYBOARD_MODE_NUMBER);
lv_keyboard_set_textarea(kb, ta);
}
static void ta_event_cb(lv_event_t * e)

{
const char * txt = lv_textarea_get_text(ta);
if(txt[0] >= '0' && txt[0] <= '9' &&
txt[1] >= '0' && txt[1] <= '9' &&
txt[2] != ':')
{
lv_textarea_set_cursor_pos(ta, 2);
lv_textarea_add_char(ta, ':');
}
}
#endif
MicroPython
No examples yet.
API
Enums
enum [anonymous]
Values:
enumerator LV_PART_TEXTAREA_PLACEHOLDER
Functions
LV_EXPORT_CONST_INT(LV_TEXTAREA_CURSOR_LAST)
lv_obj_t *lv_textarea_create(lv_obj_t *parent)

Create a text area objects
Parameters parent -- pointer to an object, it will be the parent of the new text area
Returns pointer to the created text area
void lv_textarea_add_char(lv_obj_t *obj, uint32_t c)
Insert a character to the current cursor position. To add a wide char, e.g. 'Á' use _lv_txt_encoded_conv_wc('Á)`
Parameters
• obj -- pointer to a text area object
• c -- a character (e.g. 'a')

void lv_textarea_add_text(lv_obj_t *obj, const char *txt)

Insert a text to the current cursor position
Parameters
• txt -- a '\0' terminated string to insert
void lv_textarea_del_char(lv_obj_t *obj)
Delete a the left character from the current cursor position
Parameters obj -- pointer to a text area object
void lv_textarea_del_char_forward(lv_obj_t *obj)
Delete the right character from the current cursor position
void lv_textarea_set_text(lv_obj_t *obj, const char *txt)
Set the text of a text area
Parameters
• txt -- pointer to the text
void lv_textarea_set_placeholder_text(lv_obj_t *obj, const char *txt)
Set the placeholder text of a text area
Parameters
• txt -- pointer to the text
void lv_textarea_set_cursor_pos(lv_obj_t *obj, int32_t pos)
Set the cursor position
Parameters
• pos -- the new cursor position in character index < 0 : index from the end of the text
LV_TEXTAREA_CURSOR_LAST: go after the last character
void lv_textarea_set_cursor_click_pos(lv_obj_t *obj, bool en)
Enable/Disable the positioning of the cursor by clicking the text on the text area.
Parameters
• en -- true: enable click positions; false: disable
void lv_textarea_set_password_mode(lv_obj_t *obj, bool en)
Enable/Disable password mode
Parameters
• en -- true: enable, false: disable
void lv_textarea_set_one_line(lv_obj_t *obj, bool en)
Configure the text area to one line or back to normal

Parameters
• en -- true: one line, false: normal
void lv_textarea_set_accepted_chars(lv_obj_t *obj, const char *list)
Set a list of characters. Only these characters will be accepted by the text area
Parameters
• list -- list of characters. Only the pointer is saved. E.g. "+-.,0123456789"
void lv_textarea_set_max_length(lv_obj_t *obj, uint32_t num)
Set max length of a Text Area.
Parameters
• num -- the maximal number of characters can be added (lv_textarea_set_text ig-
nores it)
void lv_textarea_set_insert_replace(lv_obj_t *obj, const char *txt)
In LV_EVENT_INSERT the text which planned to be inserted can be replaced by an other text. It can be used to
add automatic formatting to the text area.
Parameters
• txt -- pointer to a new string to insert. If "" no text will be added. The variable must be live
after the event_cb exists. (Should be global or static)
void lv_textarea_set_text_selection(lv_obj_t *obj, bool en)
Enable/disable selection mode.
Parameters
• en -- true or false to enable/disable selection mode
void lv_textarea_set_password_show_time(lv_obj_t *obj, uint16_t time)
Set how long show the password before changing it to '*'
Parameters
• time -- show time in milliseconds. 0: hide immediately.
void lv_textarea_set_align(lv_obj_t *obj, lv_text_align_t align)
Set the label's alignment. It sets where the label is aligned (in one line mode it can be smaller than the text area)
and how the lines of the area align in case of multiline text area
Parameters
• align -- the align mode from ::lv_text_align_t
const char *lv_textarea_get_text(const lv_obj_t *obj)
Get the text of a text area. In password mode it gives the real text (not '*'s).

Returns pointer to the text

const char *lv_textarea_get_placeholder_text(lv_obj_t *obj)
Get the placeholder text of a text area
Returns pointer to the text
lv_obj_t *lv_textarea_get_label(const lv_obj_t *obj)
Get the label of a text area
Returns pointer to the label object
uint32_t lv_textarea_get_cursor_pos(const lv_obj_t *obj)
Get the current cursor position in character index
Returns the cursor position
bool lv_textarea_get_cursor_click_pos(lv_obj_t *obj)
Get whether the cursor click positioning is enabled or not.
Returns true: enable click positions; false: disable
bool lv_textarea_get_password_mode(const lv_obj_t *obj)
Get the password mode attribute
Returns true: password mode is enabled, false: disabled
bool lv_textarea_get_one_line(const lv_obj_t *obj)
Get the one line configuration attribute
Returns true: one line configuration is enabled, false: disabled
const char *lv_textarea_get_accepted_chars(lv_obj_t *obj)
Get a list of accepted characters.
Returns list of accented characters.
uint32_t lv_textarea_get_max_length(lv_obj_t *obj)
Get max length of a Text Area.
Returns the maximal number of characters to be add
bool lv_textarea_text_is_selected(const lv_obj_t *obj)
Find whether text is selected or not.
Returns whether text is selected or not
bool lv_textarea_get_text_selection(lv_obj_t *obj)
Find whether selection mode is enabled.


Returns true: selection mode is enabled, false: disabled
uint16_t lv_textarea_get_password_show_time(lv_obj_t *obj)
Set how long show the password before changing it to '*'
Returns show time in milliseconds. 0: hide immediately.
void lv_textarea_clear_selection(lv_obj_t *obj)
Clear the selection on the text area.
void lv_textarea_cursor_right(lv_obj_t *obj)
Move the cursor one character right
void lv_textarea_cursor_left(lv_obj_t *obj)
Move the cursor one character left
void lv_textarea_cursor_down(lv_obj_t *obj)
Move the cursor one line down
void lv_textarea_cursor_up(lv_obj_t *obj)
Move the cursor one line up
Variables
const lv_obj_class_t lv_textarea_class

struct lv_textarea_t
Public Members
lv_obj_t obj
lv_obj_t *label
char *placeholder_txt
char *pwd_tmp
const char *accepted_chars
uint32_t max_length
uint16_t pwd_show_time
lv_coord_t valid_x
uint32_t pos
lv_area_t area

uint32_t txt_byte_pos
uint8_t show
uint8_t click_pos
struct lv_textarea_t::[anonymous] cursor
uint32_t sel_start
uint32_t sel_end
uint8_t text_sel_in_prog
uint8_t text_sel_en
uint8_t pwd_mode
uint8_t one_line
5.3 Extra widgets
5.3.1 Calendar (lv_calendar)
Overview
The Calendar object is a classic calendar which can:

• show the days of any month in a 7x7 matrix
• Show the name of the days
• highlight the current day (today)
• highlight any user-defined dates
The Calendar is added to the default group (if it is set). Calendar is an editable object which allow selecting and clicking
the dates with encoder navigation too.
To make the Calendar flexible, by default it doesn't show the current year or month. Instead, there are external "headers"
that can be attached to the calendar.
Parts and Styles
The calendar object uses the Button matrix object under the hood to arrange the days into a matrix.
• LV_PART_MAIN The background of the calendar. Uses all the background related style properties.
• LV_PART_ITEMS Refers to the dates and day names. Button matrix control flags are set to differentiate the
buttons and a custom drawer event is added modify the properties of the buttons as follows:
– day names have no border, no background and drawn with a gray color
– days of the previous and next month have LV_BTNMATRIX_CTRL_DISABLED flag
– today has a thicker border with the theme's primary color
– highlighted days have some opacity with the theme's primary color.
5.3. Extra widgets 324

Usage
Some functions use the lv_calendar_date_t type which is a structure with year, month and day fields.
Current date
To set the current date (today), use the lv_calendar_set_today_date(calendar, year, month, day)
function. month needs to be in 1..12 range and day in 1..31 range.
Shown date
To set the shown date, use lv_calendar_set_shown_date(calendar, year, month);
Highlighted days
The list of highlighted dates should be stored in a lv_calendar_date_t array loaded by

lv_calendar_set_highlighted_dates(calendar, highlighted_dates, date_num).
Only the array's pointer will be saved so the array should be a static or global variable.
Name of the days
The name of the days can be adjusted with lv_calendar_set_day_names(calendar, day_names) where
day_names looks like const char * day_names[7] = {"Su", "Mo", ...}; Only the pointer of the
day names is saved so the elements should be static, global or constant variables.
Events
• LV_EVENT_VALUE_CHANGED Sent if a date is clicked. lv_calendar_get_pressed_date(calendar,

&date) set date to the date currently being pressed. Returns LV_RES_OK if there is a valid pressed date, else
LV_RES_INV.
Keys
• LV_KEY_RIGHT/UP/LEFT/RIGHT To navigate among the buttons to dates

• LV_KEY_ENTER To press/release the selected date

Headers
Arrow buttons
lv_calendar_header_arrow_create(parent, calendar, button_size) creates a header that con-

tains a left and right arrow on the sides and a text with the current year and month between them.
Drop-down
lv_calendar_header_dropdown_create(parent, calendar) creates a header that contains 2 drop-

drown lists: one for the year and another for the month.
Example
Calendar with header
#if LV_USE_CALENDAR && LV_BUILD_EXAMPLES

{
lv_calendar_date_t date;
if(lv_calendar_get_pressed_date(obj, &date)) {
LV_LOG_USER("Clicked date: %02d.%02d.%d", date.day, date.month, date.
,→year);
}
}
}
void lv_example_calendar_1(void)
{
lv_obj_t * calendar = lv_calendar_create(lv_scr_act());
lv_obj_set_size(calendar, 185, 185);
lv_obj_align(calendar, LV_ALIGN_CENTER, 0, 27);
lv_obj_add_event_cb(calendar, event_handler, LV_EVENT_ALL, NULL);
lv_calendar_set_today_date(calendar, 2021, 02, 23);

lv_calendar_set_showed_date(calendar, 2021, 02);
/*Highlight a few days*/

static lv_calendar_date_t highlighted_days[3]; /*Only its pointer will be␣
,→saved so should be static*/
highlighted_days[0].year = 2021;
highlighted_days[0].month = 02;
highlighted_days[0].day = 6;


lv_calendar_set_highlighted_dates(calendar, highlighted_days, 3);
#if LV_USE_CALENDAR_HEADER_DROPDOWN
lv_calendar_header_dropdown_create(lv_scr_act(), calendar);
#elif LV_USE_CALENDAR_HEADER_ARROW
lv_calendar_header_arrow_create(lv_scr_act(), calendar, 25);
#endif
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_calendar_create(lv_obj_t *parent)
void lv_calendar_set_today_date(lv_obj_t *obj, uint32_t year, uint32_t month, uint32_t day)

Set the today's date
Parameters
• obj -- pointer to a calendar object
• year -- today's year
• month -- today's month [1..12]
• day -- today's day [1..31]
void lv_calendar_set_showed_date(lv_obj_t *obj, uint32_t year, uint32_t month)
Set the currently showed
Parameters
• year -- today's year
• month -- today's month [1..12]
void lv_calendar_set_highlighted_dates(lv_obj_t *obj, lv_calendar_date_t highlighted[], uint16_t
date_num)
Set the the highlighted dates
Parameters


• highlighted -- pointer to an lv_calendar_date_t array containing the dates. Only
the pointer will be saved so this variable can't be local which will be destroyed later.
• date_num -- number of dates in the array
void lv_calendar_set_day_names(lv_obj_t *obj, const char **day_names)
Set the name of the days
Parameters
• day_names -- pointer to an array with the names. E.g. const char * days[7] =
{"Sun", "Mon", ...} Only the pointer will be saved so this variable can't be local which
will be destroyed later.
const lv_calendar_date_t *lv_calendar_get_today_date(const lv_obj_t *calendar)
Get the today's date
Parameters calendar -- pointer to a calendar object
Returns return pointer to an lv_calendar_date_t variable containing the date of today.
const lv_calendar_date_t *lv_calendar_get_showed_date(const lv_obj_t *calendar)
Get the currently showed
Returns pointer to an lv_calendar_date_t variable containing the date is being shown.
lv_calendar_date_t *lv_calendar_get_highlighted_dates(const lv_obj_t *calendar)
Get the the highlighted dates
Returns pointer to an lv_calendar_date_t array containing the dates.
uint16_t lv_calendar_get_highlighted_dates_num(const lv_obj_t *calendar)
Get the number of the highlighted dates
Returns number of highlighted days
lv_res_t lv_calendar_get_pressed_date(const lv_obj_t *calendar, lv_calendar_date_t *date)
Get the currently pressed day
Parameters
• calendar -- pointer to a calendar object
• date -- store the pressed date here
Returns LV_RES_OK: there is a valid pressed date; LV_RES_INV: there is no pressed data

Variables
const lv_obj_class_t lv_calendar_class

struct lv_calendar_date_t
#include <lv_calendar.h> Represents a date on the calendar object (platform-agnostic).
Public Members
uint16_t year
int8_t month
int8_t day
1..12
struct lv_calendar_t
Public Members
lv_btnmatrix_t btnm
lv_calendar_date_t today
lv_calendar_date_t showed_date
lv_calendar_date_t *highlighted_dates
uint16_t highlighted_dates_num
const char *map[8 * 7]
char nums[7 * 6][4]
5.3.2 Chart (lv_chart)
Overview
Charts are a basic object to visualize data points. Currently Line charts (connect points with lines and/or draw points on
them) and Bar charts are supported.
Charts can have:
• division lines
• 2 y axis
• axis ticks and texts on ticks
• cursors
• scrolling and zooming

Parts and Styles
• LV_PART_MAIN The background of the chart. Uses all the typical background and line (for the division lines)
related style properties. Padding makes the series area smaller.
• LV_PART_SCROLLBAR The scrollbar used if the chart is zoomed. See the Base object's documentation for
details.
• LV_PART_ITEMS Refers to the line or bar series.
– Line chart: The line properties are used by the lines. width, height, bg_color and radius is used
to set the appearance of points.
– Bar chart: The typical background properties are used to style the bars.
• LV_PART_INDICATOR Refers to the points on line and scatter chart (small circles or squares).
• LV_PART_CURSOR Line properties are used to style the cursors. width, height, bg_color and radius
are used to set the appearance of points.
• LV_PART_TICKS Line and Text style properties are used to style the ticks
Usage
Chart type
The following data display types exist:

• LV_CHART_TYPE_NONE Do not display any data. Can be used to hide the series.
• LV_CHART_TYPE_LINE Draw lines between the data points and/or points (rectangles or circles) on the data
points.
• LV_CHART_TYPE_BAR - Draw bars.
• LV_CHART_TYPE_SCATTER - X/Y chart drawing point's and lines between the points. .
You can specify the display type with lv_chart_set_type(chart, LV_CHART_TYPE_...).
Data series
You can add any number of series to the charts by lv_chart_add_series(chart, color, axis). This will
allocates a lv_chart_series_t structure which contains the chosen color and an array for the data points. axis
can have the following values:
• LV_CHART_AXIS_PRIMARY_Y Left axis
• LV_CHART_AXIS_SECONDARY_Y Right axis
• LV_CHART_AXIS_PRIMARY_X Bottom axis
• LV_CHART_AXIS_SECONDARY_X Top axis
axis tells which axis's range should be used te scale the values.
lv_chart_set_ext_y_array(chart, ser, value_array) makes the chart use an external array for the
given series. value_array should look like this: lv_coord_t * value_array[num_points]. The array
size needs to be large enough to hold all the points of that series. The array's pointer will be saved in the chart so it needs
to be global, static or dynamically allocated. Note: you should call lv_chart_refresh(chart) after the external
data source has been updated to update the chart.

The value array of a series can be obtained with lv_chart_get_y_array(chart, ser), which can be used
with ext_array or normal arrays.
For LV_CHART_TYPE_SCATTER type lv_chart_set_ext_x_array(chart, ser, value_array) and
lv_chart_get_x_array(chart, ser) can be used as well.
Modify the data
You have several options to set the data of series:

1. Set the values manually in the array like ser1->points[3] = 7 and refresh the chart with
lv_chart_refresh(chart).
2. Use lv_chart_set_value_by_id(chart, ser, value, id) where id is the index of the point
you wish to update.
3. Use the lv_chart_set_next_value(chart, ser, value).
4. Initialize all points to a given value with: lv_chart_set_all_value(chart, ser, value).
Use LV_CHART_POINT_DEF as value to make the library skip drawing that point, column, or line segment.
For LV_CHART_TYPE_SCATTER type lv_chart_set_value_by_id2(chart, ser, id, value) and
lv_chart_set_next_value2(chart, ser, x_valuem y_value) can be used as well.
Update modes
lv_chart_set_next_value can behave in two ways depending on update mode:

• LV_CHART_UPDATE_MODE_SHIFT Shift old data to the left and add the new one to the right.
• LV_CHART_UPDATE_MODE_CIRCULAR - Add the new data in circular fashion, like an ECG diagram).
The update mode can be changed with lv_chart_set_update_mode(chart,
LV_CHART_UPDATE_MODE_...).
Number of points
The number of points in the series can be modified by lv_chart_set_point_count(chart, point_num).

The default value is 10. Note: this also affects the number of points processed when an external buffer is assigned to a
series, so you need to be sure the external array is large enough.
Handling large number of points
On line charts if the number of points is greater than the pixels horizontally, the Chart will draw only vertical lines to
make the drawing of large amount of data effective. If there are, let's say, 10 points to a pixel, LVGL searches the smallest
and the largest value and draws a vertical lines between them to ensure no peaks are missed.

Vertical range
You can specify the minimum and maximum values in y-direction with lv_chart_set_range(chart, axis,
min, max). axis can be LV_CHART_AXIS_PRIMARY (left axis) or LV_CHART_AXIS_SECONDARY (right
axis).
The value of the points will be scaled proportionally. The default range is: 0..100.
Division lines
The number of horizontal and vertical division lines can be modified by

lv_chart_set_div_line_count(chart, hdiv_num, vdiv_num). The default settings are 3
horizontal and 5 vertical division lines. If there is a visible border on a side and no padding on that side, the division line
would be drawn on top of the border and therefore it won't be drawn.
Override default start point for series
If you want a plot to start from a point other than the default which is point[0] of the series, you can set an alternative
index with the function lv_chart_set_x_start_point(chart, ser, id) where id is the new index
position to start plotting from.
Note that LV_CHART_UPDATE_MODE_SHIFT also changes the start_point.
Tick marks and labels
Ticks and labels can be added to the axis with lv_chart_set_axis_tick(chart, axis, major_len,
minor_len, major_cnt, minor_cnt, label_en, draw_size).
• axis can be LV_CHART_AXIS_X/PRIMARY_Y/SECONDARY_Y
• major_len is the length of major ticks
• minor_len is the length of minor ticks
• major_cnt is the number of major ticks on the axis
• minor_cnt in the number of minor ticks between two major ticks
• label_en true: enable label drawing on major ticks
• draw_size extra size required to draw the tick and labels (start with 20 px and increase if the ticks/labels are
clipped)
Zoom
The chart can be zoomed independently in x and y directions with lv_chart_set_zoom_x(chart, factor)
and lv_chart_set_zoom_y(chart, factor). If factor is 256 there is no zoom. 512 means double zoom,
etc. Fractional values are also possible but < 256 value is not allowed.

Cursor
A cursor can be added with lv_chart_cursor_t * c1 = lv_chart_add_cursor(chart, color,

dir);. The possible values of dir LV_DIR_NONE/RIGHT/UP/LEFT/DOWN/HOR/VER/ALL or their OR-ed
values to tell in which direction(s) should the cursor be drawn.
lv_chart_set_cursor_pos(chart, cursor, &point) sets the position of the cursor. pos is a pointer
to an lv_point_t variable. E.g. lv_point_t point = {10, 20};. If the chart is scrolled the cursor will
remain in the same place.
lv_chart_get_point_pos_by_id(chart, series, id, &point_out) gets the coordinate of a given
point. It's useful to place the cursor at a given point.
lv_chart_set_cursor_point(chart, cursor, series, point_id) sticks the cursor at a point. If
the point's position changes (new value or scrolling) the cursor will move with the point.
Events
• LV_EVENT_VALUE_CHANGED Sent when a new point is clicked pressed.

lv_chart_get_pressed_point(chart) returns the zero-based index of the pressed point.
• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END are sent for multiple parts. The fields
of lv_obj_draw_part_dsc_t are set as follows:
– LV_PART_ITEMS (the series)
∗ Line chart clip_area, id (index of the point), value (value of idth point), p1, p2 (points of the
line), draw_area (area of the point), line_dsc, rect_dsc, sub_part_ptr (pointer to the
series), part
∗ Bar chart clip_area, id (index of the point), value (value of idth point), draw_area (area of
the point), rect_dsc, sub_part_ptr (pointer to the series), part
– LV_PART_TICKS (major tick lines and label) clip_area, id (axis), value (scaled value of the tick),
text (value converted to decimal), line_dsc, label_dsc, part
– LV_PART_CURSOR These events are sent at three times:
∗ vertical line clip_area, p1, p2 (points of the line), line_dsc, part
∗ horizontal line clip_area, p1, p2 (points of the line), line_dsc, part
∗ point clip_area, draw_area (points of the line), rect_dsc, part
– LV_PART_MAIN (the division lines) clip_area, id (index of the line), p1, p2 (points of the line),
line_dsc, part
Keys


Example
Line Chart
#if LV_USE_CHART && LV_BUILD_EXAMPLES
void lv_example_chart_1(void)
{
/*Create a chart*/
lv_obj_t * chart;
chart = lv_chart_create(lv_scr_act());
lv_obj_set_size(chart, 200, 150);
lv_obj_center(chart);
lv_chart_set_type(chart, LV_CHART_TYPE_LINE); /*Show lines and points too*/
/*Add two data series*/

lv_chart_series_t * ser1 = lv_chart_add_series(chart, lv_palette_main(LV_PALETTE_
,→RED), LV_CHART_AXIS_PRIMARY_Y);

,→GREEN), LV_CHART_AXIS_SECONDARY_Y);
/*Set the next points on 'ser1'*/

lv_chart_set_next_value(chart, ser1, 10);
/*Directly set points on 'ser2'*/

ser2->y_points[0] = 90;
lv_chart_refresh(chart); /*Required after direct set*/

}
#endif

Faded area line chart with custom division lines
#if LV_USE_CHART && LV_DRAW_COMPLEX && LV_BUILD_EXAMPLES
static lv_obj_t * chart1;

static lv_chart_series_t * ser1;
static lv_chart_series_t * ser2;

{
/*Add the faded area before the lines are drawn*/

if(!dsc->p1 || !dsc->p2) return;
/*Add a line mask that keeps the area below the line*/
lv_draw_mask_line_param_t line_mask_param;
lv_draw_mask_line_points_init(&line_mask_param, dsc->p1->x, dsc->p1->y, dsc->
,→p2->x, dsc->p2->y, LV_DRAW_MASK_LINE_SIDE_BOTTOM);
int16_t line_mask_id = lv_draw_mask_add(&line_mask_param, NULL);
/*Add a fade effect: transparent bottom covering top*/

lv_coord_t h = lv_obj_get_height(obj);
lv_draw_mask_fade_param_t fade_mask_param;
lv_draw_mask_fade_init(&fade_mask_param, &obj->coords, LV_OPA_COVER, obj->
,→coords.y1 + h / 8, LV_OPA_TRANSP,obj->coords.y2);
int16_t fade_mask_id = lv_draw_mask_add(&fade_mask_param, NULL);
/*Draw a rectangle that will be affected by the mask*/

lv_draw_rect_dsc_t draw_rect_dsc;
lv_draw_rect_dsc_init(&draw_rect_dsc);
draw_rect_dsc.bg_opa = LV_OPA_20;
draw_rect_dsc.bg_color = dsc->line_dsc->color;
lv_area_t a;
a.x1 = dsc->p1->x;
a.x2 = dsc->p2->x - 1;
a.y1 = LV_MIN(dsc->p1->y, dsc->p2->y);
a.y2 = obj->coords.y2;
lv_draw_rect(&a, dsc->clip_area, &draw_rect_dsc);
/*Remove the masks*/

lv_draw_mask_remove_id(line_mask_id);
lv_draw_mask_remove_id(fade_mask_id);
}
/*Hook the division lines too*/
else if(dsc->part == LV_PART_MAIN) {
if(dsc->line_dsc == NULL) return;
/*Vertical line*/
if(dsc->p1->x == dsc->p2->x) {
dsc->line_dsc->color = lv_palette_lighten(LV_PALETTE_GREY, 1);
if(dsc->id == 3) {
dsc->line_dsc->width = 2;


dsc->line_dsc->dash_gap = 0;
dsc->line_dsc->dash_width = 0;
}
else {
}
}
/*Horizontal line*/
else {
if(dsc->id == 2) {
}
else {
}
if(dsc->id == 1 || dsc->id == 3) {
dsc->line_dsc->color = lv_palette_main(LV_PALETTE_GREEN);
} else {
dsc->line_dsc->color = lv_palette_lighten(LV_PALETTE_GREY, 1);
}
}
}
}
static void add_data(lv_timer_t * timer)

{
LV_UNUSED(timer);
lv_chart_set_next_value(chart1, ser1, lv_rand(20, 90));
if(cnt % 4 == 0) lv_chart_set_next_value(chart1, ser2, lv_rand(40, 60));
cnt++;
}
/**
* Add a faded area effect to the line chart and make some division lines ticker
*/
{
/*Create a chart1*/
chart1 = lv_chart_create(lv_scr_act());
lv_obj_set_size(chart1, 200, 150);
lv_obj_center(chart1);
lv_chart_set_type(chart1, LV_CHART_TYPE_LINE); /*Show lines and points too*/
lv_chart_set_div_line_count(chart1, 5, 7);
lv_obj_add_event_cb(chart1, draw_event_cb, LV_EVENT_DRAW_PART_BEGIN, NULL);

lv_chart_set_update_mode(chart1, LV_CHART_UPDATE_MODE_CIRCULAR);


ser1 = lv_chart_add_series(chart1, lv_palette_main(LV_PALETTE_RED), LV_CHART_AXIS_
,→PRIMARY_Y);
ser2 = lv_chart_add_series(chart1, lv_palette_main(LV_PALETTE_BLUE), LV_CHART_

,→AXIS_SECONDARY_Y);
uint32_t i;
for(i = 0; i < 10; i++) {
}
lv_timer_create(add_data, 200, NULL);

}
#endif
Axis ticks and labels with scrolling

{
if(dsc->part == LV_PART_TICKS && dsc->id == LV_CHART_AXIS_PRIMARY_X) {
const char * month[] = {"Jan", "Febr", "March", "Apr", "May", "Jun", "July",
,→"Aug", "Sept", "Oct", "Nov", "Dec"};
lv_snprintf(dsc->text, sizeof(dsc->text), "%s", month[dsc->value]);

}
}
/**
* Add ticks and labels to the axis and demonstrate scrolling
*/
{
/*Create a chart*/
lv_obj_t * chart;
lv_chart_set_type(chart, LV_CHART_TYPE_BAR);
lv_chart_set_range(chart, LV_CHART_AXIS_PRIMARY_Y, 0, 100);
lv_chart_set_range(chart, LV_CHART_AXIS_SECONDARY_Y, 0, 400);
lv_chart_set_point_count(chart, 12);
lv_obj_add_event_cb(chart, draw_event_cb, LV_EVENT_DRAW_PART_BEGIN, NULL);
/*Add ticks and label to every axis*/

lv_chart_set_axis_tick(chart, LV_CHART_AXIS_PRIMARY_X, 10, 5, 12, 3, true, 40);
lv_chart_set_axis_tick(chart, LV_CHART_AXIS_PRIMARY_Y, 10, 5, 6, 2, true, 50);
lv_chart_set_axis_tick(chart, LV_CHART_AXIS_SECONDARY_Y, 10, 5, 3, 4, true, 50);


/*Zoom in a little in X*/
lv_chart_set_zoom_x(chart, 800);

lv_chart_series_t * ser1 = lv_chart_add_series(chart, lv_palette_lighten(LV_
,→PALETTE_GREEN, 2), LV_CHART_AXIS_PRIMARY_Y);
lv_chart_series_t * ser2 = lv_chart_add_series(chart, lv_palette_darken(LV_

,→PALETTE_GREEN, 2), LV_CHART_AXIS_SECONDARY_Y);
/*Set the next points on 'ser1'*/

lv_coord_t * ser2_array = lv_chart_get_y_array(chart, ser2);

/*Directly set points on 'ser2'*/
ser2_array[0] = 92;
ser2_array[1] = 71;
ser2_array[2] = 61;
ser2_array[3] = 15;
ser2_array[4] = 21;
ser2_array[5] = 35;
ser2_array[6] = 35;
ser2_array[7] = 58;
ser2_array[8] = 31;
ser2_array[9] = 53;
ser2_array[10] = 33;
ser2_array[11] = 73;
lv_chart_refresh(chart); /*Required after direct set*/

}
#endif
Show the value of the pressed points

{
lv_obj_t * chart = lv_event_get_target(e);


lv_obj_invalidate(chart);
}
if(code == LV_EVENT_REFR_EXT_DRAW_SIZE) {
lv_coord_t * s = lv_event_get_param(e);
*s = LV_MAX(*s, 20);
}
else if(code == LV_EVENT_DRAW_POST_END) {
int32_t id = lv_chart_get_pressed_point(chart);
if(id == LV_CHART_POINT_NONE) return;
LV_LOG_USER("Selected point %d", id);
lv_chart_series_t * ser = lv_chart_get_series_next(chart, NULL);

while(ser) {
lv_point_t p;
lv_chart_get_point_pos_by_id(chart, ser, id, &p);
lv_coord_t * y_array = lv_chart_get_y_array(chart, ser);

lv_coord_t value = y_array[id];
char buf[16];
lv_snprintf(buf, sizeof(buf), LV_SYMBOL_DUMMY"$%d", value);
draw_rect_dsc.bg_color = lv_color_black();
draw_rect_dsc.bg_opa = LV_OPA_50;
draw_rect_dsc.radius = 3;
draw_rect_dsc.bg_img_src = buf;
draw_rect_dsc.bg_img_recolor = lv_color_white();
lv_area_t a;
a.x1 = chart->coords.x1 + p.x - 20;
a.x2 = chart->coords.x1 + p.x + 20;
a.y1 = chart->coords.y1 + p.y - 30;
a.y2 = chart->coords.y1 + p.y - 10;
const lv_area_t * clip_area = lv_event_get_clip_area(e);

lv_draw_rect(&a, clip_area, &draw_rect_dsc);
ser = lv_chart_get_series_next(chart, ser);

}
}
else if(code == LV_EVENT_RELEASED) {
lv_obj_invalidate(chart);
}
}
/**
* Show the value of the pressed points
*/
{
/*Create a chart*/
lv_obj_t * chart;


lv_obj_add_event_cb(chart, event_cb, LV_EVENT_ALL, NULL);

lv_obj_refresh_ext_draw_size(chart);
/*Zoom in a little in X*/


,→RED), LV_CHART_AXIS_PRIMARY_Y);

,→GREEN), LV_CHART_AXIS_PRIMARY_Y);
uint32_t i;
for(i = 0; i < 10; i++) {
lv_chart_set_next_value(chart, ser1, lv_rand(60,90));
lv_chart_set_next_value(chart, ser2, lv_rand(10,40));
}
}
#endif
Display 1000 data points with zooming and scrolling
#if LV_USE_CHART && LV_USE_SLIDER && LV_BUILD_EXAMPLES
static lv_obj_t * chart;

/* Source: https://github.com/ankur219/ECG-Arrhythmia-classification/blob/
,→642230149583adfae1e4bd26c6f0e1fd8af2be0e/sample.csv*/
static const lv_coord_t ecg_sample[] = {

-2, 2, 0, -15, -39, -63, -71, -68, -67, -69, -84, -95, -104, -107, -108, -107, -
,→107, -107, -107, -114, -118, -117,
-112, -100, -89, -83, -71, -64, -58, -58, -62, -62, -58, -51, -46, -39, -27, -10,␣
,→4, 7, 1, -3, 0, 14, 24, 30, 25, 19,
13, 7, 12, 15, 18, 21, 13, 6, 9, 8, 17, 19, 13, 11, 11, 11, 23, 30, 37, 34, 25,␣
,→14, 15, 19, 28, 31, 26, 23, 25, 31,
39, 37, 37, 34, 30, 32, 22, 29, 31, 33, 37, 23, 13, 7, 2, 4, -2, 2, 11, 22, 33,␣
,→19, -1, -27, -55, -67, -72, -71, -63,
-49, -18, 35, 113, 230, 369, 525, 651, 722, 730, 667, 563, 454, 357, 305, 288,␣
,→274, 255, 212, 173, 143, 117, 82, 39,
-13, -53, -78, -91, -101, -113, -124, -131, -131, -131, -129, -128, -129, -125, -
,→123, -123, -129, -139, -148, -153,
-159, -166, -183, -205, -227, -243, -248, -246, -254, -280, -327, -381, -429, -
,→473, -517, -556, -592, -612, -620,
-620, -614, -604, -591, -574, -540, -497, -441, -389, -358, -336, -313, -284, -
,→222, -167, -114, -70, -47, -28, -4, 12,
38, 52, 58, 56, 56, 57, 68, 77, 86, 86, 80, 69, 67, 70, 82, 85, 89, 90, 89, 89,␣
,→88, 91, 96, 97, 91, 83, 78, 82, 88, 95,
96, 105, 106, 110, 102, 100, 96, 98, 97, 101, 98, 99, 100, 107, 113, 119, 115,␣
,→110, 96, 85, 73, 64, 69, 76, 79,
78, 75, 85, 100, 114, 113, 105, 96, 84, 74, 66, 60, 75, 85, 89, 83, 67, 61, 67,␣
,→73, 79, 74, 63, 57, 56, 58, 61, 55,


48, 45, 46, 55, 62, 55, 49, 43, 50, 59, 63, 57, 40, 31, 23, 25, 27, 31, 35, 34,␣
,→30, 36, 34, 42, 38, 36, 40, 46, 50,
47, 32, 30, 32, 52, 67, 73, 71, 63, 54, 53, 45, 41, 28, 13, 3, 1, 4, 4, -8, -23, -
,→32, -31, -19, -5, 3, 9, 13, 19,
24, 27, 29, 25, 22, 26, 32, 42, 51, 56, 60, 57, 55, 53, 53, 54, 59, 54, 49, 26, -
,→3, -11, -20, -47, -100, -194, -236,
-212, -123, 8, 103, 142, 147, 120, 105, 98, 93, 81, 61, 40, 26, 28, 30, 30, 27,␣
,→19, 17, 21, 20, 19, 19, 22, 36, 40,
35, 20, 7, 1, 10, 18, 27, 22, 6, -4, -2, 3, 6, -2, -13, -14, -10, -2, 3, 2, -1, -
,→5, -10, -19, -32, -42, -55, -60,
-68, -77, -86, -101, -110, -117, -115, -104, -92, -84, -85, -84, -73, -65, -52, -
,→50, -45, -35, -20, -3, 12, 20, 25,
26, 28, 28, 30, 28, 25, 28, 33, 42, 42, 36, 23, 9, 0, 1, -4, 1, -4, -4, 1, 5, 9,␣
,→9, -3, -1, -18, -50, -108, -190,
-272, -340, -408, -446, -537, -643, -777, -894, -920, -853, -697, -461, -251, -60,
,→ 58, 103, 129, 139, 155, 170, 173,
178, 185, 190, 193, 200, 208, 215, 225, 224, 232, 234, 240, 240, 236, 229, 226,␣
,→224, 232, 233, 232, 224, 219, 219,
223, 231, 226, 223, 219, 218, 223, 223, 223, 233, 245, 268, 286, 296, 295, 283,␣
,→271, 263, 252, 243, 226, 210, 197,
186, 171, 152, 133, 117, 114, 110, 107, 96, 80, 63, 48, 40, 38, 34, 28, 15, 2, -7,
,→ -11, -14, -18, -29, -37, -44, -50,
-58, -63, -61, -52, -50, -48, -61, -59, -58, -54, -47, -52, -62, -61, -64, -54, -
,→52, -59, -69, -76, -76, -69, -67,
-74, -78, -81, -80, -73, -65, -57, -53, -51, -47, -35, -27, -22, -22, -24, -21, -
,→17, -13, -10, -11, -13, -20, -20,
-12, -2, 7, -1, -12, -16, -13, -2, 2, -4, -5, -2, 9, 19, 19, 14, 11, 13, 19, 21,␣
,→20, 18, 19, 19, 19, 16, 15, 13, 14,
9, 3, -5, -9, -5, -3, -2, -3, -3, 2, 8, 9, 9, 5, 6, 8, 8, 7, 4, 3, 4, 5, 3, 5, 5,␣

,→13, 13, 12, 10, 10, 15, 22, 17,
14, 7, 10, 15, 16, 11, 12, 10, 13, 9, -2, -4, -2, 7, 16, 16, 17, 16, 7, -1, -16, -
,→18, -16, -9, -4, -5, -10, -9, -8,
-3, -4, -10, -19, -20, -16, -9, -9, -23, -40, -48, -43, -33, -19, -21, -26, -31, -
,→33, -19, 0, 17, 24, 9, -17, -47,
-63, -67, -59, -52, -51, -50, -49, -42, -26, -21, -15, -20, -23, -22, -19, -12, -
,→8, 5, 18, 27, 32, 26, 25, 26, 22,
23, 17, 14, 17, 21, 25, 2, -45, -121, -196, -226, -200, -118, -9, 73, 126, 131,␣
,→114, 87, 60, 42, 29, 26, 34, 35, 34,
25, 12, 9, 7, 3, 2, -8, -11, 2, 23, 38, 41, 23, 9, 10, 13, 16, 8, -8, -17, -23, -
,→26, -25, -21, -15, -10, -13, -13,
-19, -22, -29, -40, -48, -48, -54, -55, -66, -82, -85, -90, -92, -98, -114, -119,␣
,→-124, -129, -132, -146, -146, -138,
-124, -99, -85, -72, -65, -65, -65, -66, -63, -64, -64, -58, -46, -26, -9, 2, 2,␣
,→4, 0, 1, 4, 3, 10, 11, 10, 2, -4,
0, 10, 18, 20, 6, 2, -9, -7, -3, -3, -2, -7, -12, -5, 5, 24, 36, 31, 25, 6, 3, 7,␣
,→12, 17, 11, 0, -6, -9, -8, -7, -5,
-6, -2, -2, -6, -2, 2, 14, 24, 22, 15, 8, 4, 6, 7, 12, 16, 25, 20, 7, -16, -41, -
,→60, -67, -65, -54, -35, -11, 30,
84, 175, 302, 455, 603, 707, 743, 714, 625, 519, 414, 337, 300, 281, 263, 239,␣
,→197, 163, 136, 109, 77, 34, -18, -50,
-66, -74, -79, -92, -107, -117, -127, -129, -135, -139, -141, -155, -159, -167, -
,→171, -169, -174, -175, -178, -191,
-202, -223, -235, -243, -237, -240, -256, -298, -345, -393, -432, -475, -518, -
,→565, -596, -619, -623, -623, -614,
-599, -583, -559, -524, -477, -425, -383, -357, -331, -301, -252, -198, -143, -96,
,→ -57, -29, -8, 10, 31, 45, 60, 65,
70, 74, 76, 79, 82, 79, 75, 62,



};
static void slider_x_event_cb(lv_event_t * e)

{
int32_t v = lv_slider_get_value(obj);
lv_chart_set_zoom_x(chart, v);
}
static void slider_y_event_cb(lv_event_t * e)

{
int32_t v = lv_slider_get_value(obj);
lv_chart_set_zoom_y(chart, v);
}
/**
* Display 1000 data points with zooming and scrolling.
* See how the chart changes drawing mode (draw only vertical lines) when
* the points get too crowded.
*/
{
/*Create a chart*/
lv_obj_align(chart, LV_ALIGN_CENTER, -30, -30);
lv_chart_set_range(chart, LV_CHART_AXIS_PRIMARY_Y, -1000, 1000);
/*Do not display points on the data*/

lv_obj_set_style_size(chart, 0, LV_PART_INDICATOR);
lv_chart_series_t * ser = lv_chart_add_series(chart, lv_palette_main(LV_PALETTE_

,→ RED), LV_CHART_AXIS_PRIMARY_Y);
uint32_t pcnt = sizeof(ecg_sample) / sizeof(ecg_sample[0]);

lv_chart_set_point_count(chart, pcnt);
lv_chart_set_ext_y_array(chart, ser, (lv_coord_t *)ecg_sample);
lv_obj_t * slider;
lv_slider_set_range(slider, LV_IMG_ZOOM_NONE, LV_IMG_ZOOM_NONE * 10);
lv_obj_add_event_cb(slider, slider_x_event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_obj_align_to(slider, chart, LV_ALIGN_OUT_BOTTOM_MID, 0, 20);
lv_slider_set_range(slider, LV_IMG_ZOOM_NONE, LV_IMG_ZOOM_NONE * 10);
lv_obj_add_event_cb(slider, slider_y_event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_obj_align_to(slider, chart, LV_ALIGN_OUT_RIGHT_MID, 20, 0);
}
#endif

Show cursor on the clicked point
static lv_obj_t * chart;

static lv_chart_series_t * ser;
static lv_chart_cursor_t * cursor;

{
static int32_t last_id = -1;
last_id = lv_chart_get_pressed_point(obj);
if(last_id != LV_CHART_POINT_NONE) {
lv_chart_set_cursor_point(obj, cursor, NULL, last_id);
}
}
else if(code == LV_EVENT_DRAW_PART_END) {
if(dsc->part == LV_PART_CURSOR && dsc->p1 && dsc->p2 && dsc->p1->y == dsc->p2-
,→>y && last_id >= 0) {
lv_coord_t * data_array = lv_chart_get_y_array(chart, ser);

lv_coord_t v = data_array[last_id];
char buf[16];
lv_snprintf(buf, sizeof(buf), "%d", v);
lv_point_t size;
lv_txt_get_size(&size, buf, LV_FONT_DEFAULT, 0, 0, LV_COORD_MAX, LV_TEXT_
,→FLAG_NONE);
lv_area_t a;
a.y2 = dsc->p1->y - 5;
a.y1 = a.y2 - size.y - 10;
a.x1 = dsc->p1->x + 10;
a.x2 = a.x1 + size.x + 10;
draw_rect_dsc.bg_color = lv_palette_main(LV_PALETTE_BLUE);
draw_rect_dsc.radius = 3;
lv_draw_rect(&a, dsc->clip_area, &draw_rect_dsc);
lv_draw_label_dsc_t draw_label_dsc;
lv_draw_label_dsc_init(&draw_label_dsc);
draw_label_dsc.color = lv_color_white();
a.x1 += 5;
a.x2 -= 5;
a.y1 += 5;
a.y2 -= 5;
lv_draw_label(&a, dsc->clip_area, &draw_label_dsc, buf, NULL);
}
}


}
/**
* Show cursor on the clicked point
*/
{
lv_obj_align(chart, LV_ALIGN_CENTER, 0, -10);

lv_obj_add_event_cb(chart, event_cb, LV_EVENT_ALL, NULL);

lv_obj_refresh_ext_draw_size(chart);
cursor = lv_chart_add_cursor(chart, lv_palette_main(LV_PALETTE_BLUE), LV_DIR_LEFT␣

,→ | LV_DIR_BOTTOM);
ser = lv_chart_add_series(chart, lv_palette_main(LV_PALETTE_RED), LV_CHART_AXIS_

,→ PRIMARY_Y);
uint32_t i;
for(i = 0; i < 10; i++) {
lv_chart_set_next_value(chart, ser, lv_rand(10,90));
}

lv_label_set_text(label, "Click on a point");
lv_obj_align_to(label, chart, LV_ALIGN_OUT_TOP_MID, 0, -5);
}
#endif
Scatter chart

{
lv_chart_series_t * ser = lv_chart_get_series_next(obj, NULL);
uint32_t cnt = lv_chart_get_point_count(obj);
/*Make older value more transparent*/
dsc->rect_dsc->bg_opa = (LV_OPA_COVER * dsc->id) / (cnt - 1);
/*Make smaller values blue, higher values red*/

lv_coord_t * x_array = lv_chart_get_x_array(obj, ser);
lv_coord_t * y_array = lv_chart_get_y_array(obj, ser);


/*dsc->id is the tells drawing order, but we need the ID of the point being␣
,→drawn.*/
uint32_t start_point = lv_chart_get_x_start_point(obj, ser);

uint32_t p_act = (start_point + dsc->id) % cnt; /*Consider start point to get␣
,→the index of the array*/
lv_opa_t x_opa = (x_array[p_act] * LV_OPA_50) / 200;

lv_opa_t y_opa = (y_array[p_act] * LV_OPA_50) / 1000;
dsc->rect_dsc->bg_color = lv_color_mix(lv_palette_main(LV_PALETTE_RED),
lv_palette_main(LV_PALETTE_BLUE),
x_opa + y_opa);
}
}
static void add_data(lv_timer_t * timer)

{
LV_UNUSED(timer);
lv_obj_t * chart = timer->user_data;
lv_chart_set_next_value2(chart, lv_chart_get_series_next(chart, NULL), lv_rand(0,
,→200), lv_rand(0,1000));
/**
* A scatter chart
*/
{
lv_obj_t * chart = lv_chart_create(lv_scr_act());
lv_obj_align(chart, LV_ALIGN_CENTER, 0, 0);
lv_obj_add_event_cb(chart, draw_event_cb, LV_EVENT_DRAW_PART_BEGIN, NULL);
lv_obj_set_style_line_width(chart, 0, LV_PART_ITEMS); /*Remove the lines*/
lv_chart_set_type(chart, LV_CHART_TYPE_SCATTER);

lv_chart_set_range(chart, LV_CHART_AXIS_PRIMARY_X, 0, 200);

lv_chart_set_range(chart, LV_CHART_AXIS_PRIMARY_Y, 0, 1000);
lv_chart_set_point_count(chart, 50);
lv_chart_series_t * ser = lv_chart_add_series(chart, lv_palette_main(LV_PALETTE_

,→ RED), LV_CHART_AXIS_PRIMARY_Y);
uint32_t i;
for(i = 0; i < 50; i++) {
lv_chart_set_next_value2(chart, ser, lv_rand(0, 200), lv_rand(0, 1000));
}
lv_timer_create(add_data, 100, chart);

}
#endif

MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_chart_type_t

typedef uint8_t lv_chart_update_mode_t
typedef uint8_t lv_chart_axis_t
Enums
enum [anonymous]
Chart types
Values:
enumerator LV_CHART_TYPE_NONE
Don't draw the series
enumerator LV_CHART_TYPE_LINE
Connect the points with lines
enumerator LV_CHART_TYPE_BAR
Draw columns
enumerator LV_CHART_TYPE_SCATTER
Draw points and lines in 2D (x,y coordinates)
enum [anonymous]
Chart update mode for lv_chart_set_next
Values:
enumerator LV_CHART_UPDATE_MODE_SHIFT
Shift old data to the left and add the new one the right
enumerator LV_CHART_UPDATE_MODE_CIRCULAR
Add the new data in a circular way
enum [anonymous]
Enumeration of the axis'
Values:
enumerator LV_CHART_AXIS_PRIMARY_Y
enumerator LV_CHART_AXIS_SECONDARY_Y

enumerator LV_CHART_AXIS_PRIMARY_X
enumerator LV_CHART_AXIS_SECONDARY_X
enumerator _LV_CHART_AXIS_LAST
Functions
LV_EXPORT_CONST_INT(LV_CHART_POINT_NONE)
lv_obj_t *lv_chart_create(lv_obj_t *parent)

Create a chart objects
Parameters parent -- pointer to an object, it will be the parent of the new chart
Returns pointer to the created chart
void lv_chart_set_type(lv_obj_t *obj, lv_chart_type_t type)
Set a new type for a chart
Parameters
• obj -- pointer to a chart object
• type -- new type of the chart (from 'lv_chart_type_t' enum)
void lv_chart_set_point_count(lv_obj_t *obj, uint16_t cnt)
Set the number of points on a data line on a chart
Parameters
• cnt -- new number of points on the data lines
void lv_chart_set_range(lv_obj_t *obj, lv_chart_axis_t axis, lv_coord_t min, lv_coord_t max)
Set the minimal and maximal y values on an axis
Parameters
• axis -- LV_CHART_AXIS_PRIMARY_Y or LV_CHART_AXIS_SECONDARY_Y
• min -- minimum value of the y axis
• max -- maximum value of the y axis
void lv_chart_set_update_mode(lv_obj_t *obj, lv_chart_update_mode_t update_mode)
Set update mode of the chart object. Affects
Parameters
• mode -- the update mode
void lv_chart_set_div_line_count(lv_obj_t *obj, uint8_t hdiv, uint8_t vdiv)
Set the number of horizontal and vertical division lines
Parameters
• hdiv -- number of horizontal division lines

• vdiv -- number of vertical division lines

void lv_chart_set_zoom_x(lv_obj_t *obj, uint16_t zoom_x)
Zoom into the chart in X direction
Parameters
• zoom_x -- zoom in x direction. LV_ZOOM_NONE or 256 for no zoom, 512 double zoom
void lv_chart_set_zoom_y(lv_obj_t *obj, uint16_t zoom_y)
Zoom into the chart in Y direction
Parameters
• zoom_y -- zoom in y direction. LV_ZOOM_NONE or 256 for no zoom, 512 double zoom
uint16_t lv_chart_get_zoom_x(const lv_obj_t *obj)
Get X zoom of a chart
Parameters obj -- pointer to a chart object
Returns the X zoom value
uint16_t lv_chart_get_zoom_y(const lv_obj_t *obj)
Get Y zoom of a chart
Returns the Y zoom value
void lv_chart_set_axis_tick(lv_obj_t *obj, lv_chart_axis_t axis, lv_coord_t major_len, lv_coord_t
minor_len, lv_coord_t major_cnt, lv_coord_t minor_cnt, bool label_en,
lv_coord_t draw_size)
Set the number of tick lines on an axis
Parameters
• axis -- an axis which ticks count should be set
• major_len -- length of major ticks
• minor_len -- length of minor ticks
• major_cnt -- number of major ticks on the axis
• minor_cnt -- number of minor ticks between two major ticks
• label_en -- true: enable label drawing on major ticks
• draw_size -- extra size required to draw the tick and labels (start with 20 px and increase
if the ticks/labels are clipped)
lv_chart_type_t lv_chart_get_type(const lv_obj_t *obj)
Get the type of a chart
Parameters obj -- pointer to chart object
Returns type of the chart (from 'lv_chart_t' enum)
uint16_t lv_chart_get_point_count(const lv_obj_t *obj)
Get the data point number per data line on chart

Parameters chart -- pointer to chart object

Returns point number on each data line
uint16_t lv_chart_get_x_start_point(const lv_obj_t *obj, lv_chart_series_t *ser)
Get the current index of the x-axis start point in the data array
Parameters
• chart -- pointer to a chart object
• ser -- pointer to a data series on 'chart'
Returns the index of the current x start point in the data array
void lv_chart_get_point_pos_by_id(lv_obj_t *obj, lv_chart_series_t *ser, uint16_t id, lv_point_t *p_out)
Get the position of a point to the chart.
Parameters
• ser -- pointer to series
• id -- the index.
• p_out -- store the result position here
void lv_chart_refresh(lv_obj_t *obj)
Refresh a chart if its data line has changed
Parameters chart -- pointer to chart object
lv_chart_series_t *lv_chart_add_series(lv_obj_t *obj, lv_color_t color, lv_chart_axis_t axis)
Allocate and add a data series to the chart
Parameters
• color -- color of the data series
• axis -- the y axis to which the series should be attached
(::LV_CHART_AXIS_PRIMARY_Y or ::LV_CHART_AXIS_SECONDARY_Y)
Returns pointer to the allocated data series
void lv_chart_remove_series(lv_obj_t *obj, lv_chart_series_t *series)
Deallocate and remove a data series from a chart
Parameters
• series -- pointer to a data series on 'chart'
void lv_chart_hide_series(lv_obj_t *chart, lv_chart_series_t *series, bool hide)
Hide/Unhide a single series of a chart.
Parameters
• obj -- pointer to a chart object.
• series -- pointer to a series object
• hide -- true: hide the series
void lv_chart_set_series_color(lv_obj_t *chart, lv_chart_series_t *series, lv_color_t color)
Change the color of a series

Parameters
• obj -- pointer to a chart object.
• series -- pointer to a series object
• color -- the new color of the series
void lv_chart_set_x_start_point(lv_obj_t *obj, lv_chart_series_t *ser, uint16_t id)
Set the index of the x-axis start point in the data array. This point will be considers the first (left) point and the
other points will be drawn after it.
Parameters
• id -- the index of the x point in the data array
lv_chart_series_t *lv_chart_get_series_next(const lv_obj_t *chart, const lv_chart_series_t *ser)
Get the next series.
Parameters
• chart -- pointer to a chart
• ser -- the previous series or NULL to get the first
Returns the next series or NULL if thre is no more.
lv_chart_cursor_t *lv_chart_add_cursor(lv_obj_t *obj, lv_color_t color, lv_dir_t dir)
Add a cursor with a given color
Parameters
• obj -- pointer to chart object
• color -- color of the cursor
• dir -- direction of the cursor. LV_DIR_RIGHT/LEFT/TOP/DOWN/HOR/VER/ALL.
OR-ed values are possible
Returns pointer to the created cursor
void lv_chart_set_cursor_pos(lv_obj_t *chart, lv_chart_cursor_t *cursor, lv_point_t *pos)
Set the coordinate of the cursor with respect to the paddings
Parameters
• cursor -- pointer to the cursor
• pos -- the new coordinate of cursor relative the the chart
void lv_chart_set_cursor_point(lv_obj_t *chart, lv_chart_cursor_t *cursor, lv_chart_series_t *ser, uint16_t
point_id)
Stick the cursor to a point
Parameters
• cursor -- pointer to the cursor
• ser -- pointer to a series
• point_id -- the point's index or LV_CHART_POINT_NONE to not assign to any points.

lv_point_t lv_chart_get_cursor_point(lv_obj_t *chart, lv_chart_cursor_t *cursor)

Get the coordinate of the cursor with respect to the paddings
Parameters
• cursor -- pointer to cursor
Returns coordinate of the cursor as lv_point_t
void lv_chart_set_all_value(lv_obj_t *obj, lv_chart_series_t *ser, lv_coord_t value)
Initialize all data points of a series with a value
Parameters
• value -- the new value for all points. LV_CHART_POINT_DEF can be used to hide the
points.
void lv_chart_set_next_value(lv_obj_t *obj, lv_chart_series_t *ser, lv_coord_t value)
Set the next point's Y value according to the update mode policy.
Parameters
• value -- the new value of the next data
void lv_chart_set_next_value2(lv_obj_t *obj, lv_chart_series_t *ser, lv_coord_t x_value, lv_coord_t
y_value)
Set the next point's X and Y value according to the update mode policy.
Parameters
• x_value -- the new X value of the next data
• y_value -- the new Y value of the next data
void lv_chart_set_value_by_id(lv_obj_t *obj, lv_chart_series_t *ser, uint16_t id, lv_coord_t value)
Set an individual point's y value of a chart's series directly based on its index
Parameters
• id -- the index of the x point in the array
• value -- value to assign to array point
void lv_chart_set_value_by_id2(lv_obj_t *obj, lv_chart_series_t *ser, uint16_t id, lv_coord_t x_value,
lv_coord_t y_value)
Set an individual point's x and y value of a chart's series directly based on its index Can be used only with
LV_CHART_TYPE_SCATTER.
Parameters


• id -- the index of the x point in the array
• x_value -- the new X value of the next data
• y_value -- the new Y value of the next data
void lv_chart_set_ext_y_array(lv_obj_t *obj, lv_chart_series_t *ser, lv_coord_t array[])
Set an external array for the y data points to use for the chart NOTE: It is the users responsibility to make sure the
point_cnt matches the external array size.
Parameters
• array -- external array of points for chart
void lv_chart_set_ext_x_array(lv_obj_t *obj, lv_chart_series_t *ser, lv_coord_t array[])
Set an external array for the x data points to use for the chart NOTE: It is the users responsibility to make sure the
point_cnt matches the external array size.
Parameters
• array -- external array of points for chart
lv_coord_t *lv_chart_get_y_array(const lv_obj_t *obj, lv_chart_series_t *ser)
Get the array of y values of a series
Parameters
Returns the array of values with 'point_count' elements
lv_coord_t *lv_chart_get_x_array(const lv_obj_t *obj, lv_chart_series_t *ser)
Get the array of x values of a series
Parameters
Returns the array of values with 'point_count' elements
uint32_t lv_chart_get_pressed_point(const lv_obj_t *obj)
Get the index of the currently pressed point. It's the same for every series.
Returns the index of the point [0 .. point count] or LV_CHART_POINT_ID_NONE if no point is
being pressed

Variables
const lv_obj_class_t lv_chart_class

struct lv_chart_series_t
#include <lv_chart.h> Descriptor a chart series
Public Members
lv_coord_t *x_points
lv_coord_t *y_points
lv_color_t color
uint16_t start_point
uint8_t hidden
uint8_t x_ext_buf_assigned
uint8_t y_ext_buf_assigned
uint8_t x_axis_sec
uint8_t y_axis_sec
struct lv_chart_cursor_t
Public Members
lv_point_t pos
uint16_t point_id
lv_color_t color
lv_chart_series_t *ser
lv_dir_t dir
uint8_t pos_set
struct lv_chart_tick_dsc_t
Public Members
lv_coord_t major_len
lv_coord_t minor_len
lv_coord_t draw_size
uint32_t minor_cnt
uint32_t major_cnt
uint32_t label_en
struct lv_chart_t

Public Members
lv_obj_t obj
lv_ll_t series_ll
Linked list for the series (stores lv_chart_series_t)
lv_ll_t cursor_ll
Linked list for the cursors (stores lv_chart_cursor_t)
lv_chart_tick_dsc_t tick[4]
lv_coord_t ymin[2]
lv_coord_t ymax[2]
lv_coord_t xmin[2]
lv_coord_t xmax[2]
uint16_t pressed_point_id
uint16_t hdiv_cnt
Number of horizontal division lines
uint16_t vdiv_cnt
Number of vertical division lines
uint16_t point_cnt
Point number in a data line
uint16_t zoom_x
uint16_t zoom_y
lv_chart_type_t type
Line or column chart
lv_chart_update_mode_t update_mode
5.3.3 Color wheel (lv_colorwheel)
Overview
As its name implies Color wheel allows the user to select a color. The Hue, Saturation and Value of the color can be
selected separately.
Long pressing the object, the color wheel will change to the next parameter of the color (hue, saturation or value). A
double click will reset the current parameter.

Parts and Styles
• LV_PART_MAIN Only arc_width is used to set the width of the color wheel
• LV_PART_KNOB A rectangle (or circle) drawn on the current value. It uses all the rectangle like style properties
and padding to make it larger than the width of the arc.
Usage
Create a color wheel
lv_colorwheel_create(parent, knob_recolor) creates a new color wheel. With

knob_recolor=true the knob's background color will be set to the current color.
Set color
The color can be set manually with lv_colorwheel_set_hue/saturation/

value(colorwheel, x) or all at once with lv_colorwheel_set_hsv(colorwheel, hsv) or
lv_colorwheel_set_color(colorwheel, rgb)
Color mode
The current color mode can be manually selected with lv_colorwheel_set_color_mode(colorwheel,

LV_COLORWHEEL_MODE_HUE/SATURATION/VALUE).
The color mode can be fixed (so as to not change with long press) using
lv_colorwheel_set_color_mode_fixed(colorwheel, true)
Events
• LV_EVENT_VALUE_CHANGED Sent if a new color is selected.

Keys
• LV_KEY_UP, LV_KEY_RIGHT Increment the current parameter's value by 1

• LV_KEY_DOWN, LV_KEY_LEFT Decrement the current parameter's by 1
• LV_KEY_ENTER A long press will show the next mode. Double click to reset the current parameter.

Example
Simple Colorwheel
#if LV_USE_COLORWHEEL && LV_BUILD_EXAMPLES
void lv_example_colorwheel_1(void)
{
lv_obj_t * cw;
cw = lv_colorwheel_create(lv_scr_act(), true);
lv_obj_set_size(cw, 200, 200);
lv_obj_center(cw);
}
#endif
MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_colorwheel_mode_t
Enums
enum [anonymous]
Values:
enumerator LV_COLORWHEEL_MODE_HUE
enumerator LV_COLORWHEEL_MODE_SATURATION
enumerator LV_COLORWHEEL_MODE_VALUE

Functions
lv_obj_t *lv_colorwheel_create(lv_obj_t *parent, bool knob_recolor)

Create a color picker objects with disc shape
Parameters
• parent -- pointer to an object, it will be the parent of the new color picker
• knob_recolor -- true: set the knob's color to the current color
Returns pointer to the created color picker
bool lv_colorwheel_set_hsv(lv_obj_t *obj, lv_color_hsv_t hsv)
Set the current hsv of a color wheel.
Parameters
• colorwheel -- pointer to color wheel object
• color -- current selected hsv
Returns true if changed, otherwise false
bool lv_colorwheel_set_rgb(lv_obj_t *obj, lv_color_t color)
Set the current color of a color wheel.
Parameters
• color -- current selected color
Returns true if changed, otherwise false
void lv_colorwheel_set_mode(lv_obj_t *obj, lv_colorwheel_mode_t mode)
Set the current color mode.
Parameters
• mode -- color mode (hue/sat/val)
void lv_colorwheel_set_mode_fixed(lv_obj_t *obj, bool fixed)
Set if the color mode is changed on long press on center
Parameters
• fixed -- color mode cannot be changed on long press
lv_color_hsv_t lv_colorwheel_get_hsv(lv_obj_t *obj)
Get the current selected hsv of a color wheel.
Parameters colorwheel -- pointer to color wheel object
Returns current selected hsv
lv_color_t lv_colorwheel_get_rgb(lv_obj_t *obj)
Get the current selected color of a color wheel.
Returns color current selected color

lv_colorwheel_mode_t lv_colorwheel_get_color_mode(lv_obj_t *obj)

Get the current color mode.
Returns color mode (hue/sat/val)
bool lv_colorwheel_get_color_mode_fixed(lv_obj_t *obj)
Get if the color mode is changed on long press on center
Returns mode cannot be changed on long press
Variables
const lv_obj_class_t lv_colorwheel_class

struct lv_colorwheel_t
Public Members
lv_obj_t obj
lv_color_hsv_t hsv
lv_point_t pos
uint8_t recolor
struct lv_colorwheel_t::[anonymous] knob
uint32_t last_click_time
uint32_t last_change_time
lv_point_t last_press_point
lv_colorwheel_mode_t mode
uint8_t mode_fixed
5.3.4 Image button (lv_imgbtn)
Overview
The Image button is very similar to the simple 'Button' object. The only difference is that it displays user-defined images
in each state instead of drawing a rectangle.
You can set a left, right and center image, and the center image will be repeated to match the width of the object.

Parts and Styles
• LV_PART_MAIN Refers to the image(s). If background style properties are used, a rectangle will be drawn behind
the image button.
Usage
Image sources
To set the image in a state, use the lv_imgbtn_set_src(imgbtn, LV_IMGBTN_STATE_..., src_left,

src_center, src_right).
The image sources work the same as described in the Image object except that "Symbols" are not supported by the Image
button. Any of the sources can NULL.
The possible states are:
• LV_IMGBTN_STATE_RELEASED
• LV_IMGBTN_STATE_PRESSED
• LV_IMGBTN_STATE_DISABLED
• LV_IMGBTN_STATE_CHECKED_RELEASED
• LV_IMGBTN_STATE_CHECKED_PRESSED
• LV_IMGBTN_STATE_CHECKED_DISABLED
If you set sources only in LV_IMGBTN_STATE_RELEASED, these sources will be used in other states too. If you set
e.g. LV_IMGBTN_STATE_PRESSED they will be used in pressed state instead of the released images.
Events
• LV_EVENT_VALUE_CHANGED Sent when the button is toggled.

Keys
• LV_KEY_RIGHT/UP Go to toggled state if LV_OBJ_FLAG_CHECHABLE is enabled.

• LV_KEY_LEFT/DOWN Go to non-toggled state if LV_OBJ_FLAG_CHECHABLE is enabled.
• LV_KEY_ENTER Clicks the button

Example
Simple Image button
#if LV_USE_IMGBTN && LV_BUILD_EXAMPLES
void lv_example_imgbtn_1(void)
{
LV_IMG_DECLARE(imgbtn_left);
LV_IMG_DECLARE(imgbtn_right);
LV_IMG_DECLARE(imgbtn_mid);
/*Create a transition animation on width transformation and recolor.*/

static lv_style_prop_t tr_prop[] = {LV_STYLE_TRANSFORM_WIDTH, LV_STYLE_IMG_
,→RECOLOR_OPA, 0};
static lv_style_transition_dsc_t tr;

lv_style_transition_dsc_init(&tr, tr_prop, lv_anim_path_linear, 200, 0, NULL);

lv_style_set_text_color(&style_def, lv_color_white());
lv_style_set_transition(&style_def, &tr);
/*Darken the button when pressed and make it wider*/

lv_style_set_img_recolor_opa(&style_pr, LV_OPA_30);
lv_style_set_img_recolor(&style_pr, lv_color_black());
lv_style_set_transform_width(&style_pr, 20);
/*Create an image button*/

lv_obj_t * imgbtn1 = lv_imgbtn_create(lv_scr_act());
lv_imgbtn_set_src(imgbtn1, LV_IMGBTN_STATE_RELEASED, &imgbtn_left, &imgbtn_mid, &
,→imgbtn_right);
lv_obj_add_style(imgbtn1, &style_def, 0);

lv_obj_add_style(imgbtn1, &style_pr, LV_STATE_PRESSED);
lv_obj_align(imgbtn1, LV_ALIGN_CENTER, 0, 0);
/*Create a label on the image button*/

lv_obj_t * label = lv_label_create(imgbtn1);
lv_obj_align(label, LV_ALIGN_CENTER, 0, -4);
}
#endif

MicroPython
No examples yet.
API
Enums
enum lv_imgbtn_state_t
Values:
enumerator LV_IMGBTN_STATE_RELEASED
enumerator LV_IMGBTN_STATE_PRESSED
enumerator LV_IMGBTN_STATE_DISABLED
enumerator LV_IMGBTN_STATE_CHECKED_RELEASED
enumerator LV_IMGBTN_STATE_CHECKED_PRESSED
enumerator LV_IMGBTN_STATE_CHECKED_DISABLED
enumerator _LV_IMGBTN_STATE_NUM
Functions
lv_obj_t *lv_imgbtn_create(lv_obj_t *parent)

Create a image button objects
Parameters par -- pointer to an object, it will be the parent of the new image button
Returns pointer to the created image button
void lv_imgbtn_set_src(lv_obj_t *imgbtn, lv_imgbtn_state_t state, const void *src_left, const void *src_mid,
const void *src_right)
Set images for a state of the image button
Parameters
• imgbtn -- pointer to an image button object
• state -- for which state set the new image
• src_left -- pointer to an image source for the left side of the button (a C array or path to
a file)
• src_mid -- pointer to an image source for the middle of the button (ideally 1px wide) (a C
array or path to a file)
• src_right -- pointer to an image source for the right side of the button (a C array or path
to a file)
const void *lv_imgbtn_get_src_left(lv_obj_t *imgbtn, lv_imgbtn_state_t state)
Get the left image in a given state
Parameters
• state -- the state where to get the image (from lv_btn_state_t) `

Returns pointer to the left image source (a C array or path to a file)

const void *lv_imgbtn_get_src_middle(lv_obj_t *imgbtn, lv_imgbtn_state_t state)
Get the middle image in a given state
Parameters
Returns pointer to the middle image source (a C array or path to a file)
const void *lv_imgbtn_get_src_right(lv_obj_t *imgbtn, lv_imgbtn_state_t state)
Get the right image in a given state
Parameters
Returns pointer to the left image source (a C array or path to a file)
Variables
const lv_obj_class_t lv_imgbtn_class

struct lv_imgbtn_t
Public Members
lv_obj_t obj
const void *img_src_mid[_LV_IMGBTN_STATE_NUM]
const void *img_src_left[_LV_IMGBTN_STATE_NUM]
const void *img_src_right[_LV_IMGBTN_STATE_NUM]
lv_img_cf_t act_cf
5.3.5 Keyboard (lv_keyboard)
Overview
The Keyboard object is a special Button matrix with predefined keymaps and other features to realize a virtual keyboard
to write texts into a Text area.

Parts and Styles
Similarly to Button matrices Keyboards consist of 2 part:

• LV_PART_MAIN The main part. Uses all the typical background properties
• LV_PART_ITEMS The buttons. Also uses all typical background properties as well as the text properties.
Usage
Modes
The Keyboards have the following modes:

• LV_KEYBOARD_MODE_TEXT_LOWER Display lower case letters
• LV_KEYBOARD_MODE_TEXT_UPPER Display upper case letters
• LV_KEYBOARD_MODE_TEXT_SPECIAL Display special characters
• LV_KEYBOARD_MODE_NUM Display numbers, +/- sign, and decimal dot.
The TEXT modes' layout contains buttons to change mode.
To set the mode manually, use lv_keyboard_set_mode(kb, mode). The default mode is
LV_KEYBOARD_MODE_TEXT_UPPER.
Assign Text area
You can assign a Text area to the Keyboard to automatically put the clicked characters there. To assign the text area, use
lv_keyboard_set_textarea(kb, ta).
New Keymap
You can specify a new map (layout) for the keyboard with lv_keyboard_set_map(kb, map) and
lv_keyboard_set_ctrl_map(kb, ctrl_map). Learn more about the Button matrix object. Keep in mind
that using following keywords will have the same effect as with the original map:
• LV_SYMBOL_OK Apply.
• LV_SYMBOL_CLOSE or LV_SYMBOL_KEYBOARD Close.
• LV_SYMBOL_BACKSPACE Delete on the left.
• LV_SYMBOL_LEFT Move the cursor left.
• LV_SYMBOL_RIGHT Move the cursor right.
• LV_SYMBOL_NEW_LINE New line.
• "ABC" Load the uppercase map.
• "abc" Load the lower case map.
• "1#" Load the lower case map.

Events
• LV_EVENT_VALUE_CHANGED Sent when the button is pressed/released or repeated after long press. The event
data is set to the ID of the pressed/released button.
• LV_EVENT_READY - The Ok button is clicked.
• LV_EVENT_CANCEL - The Close button is clicked.
The keyboard has a default event handler callback called lv_keyboard_def_event_cb, which handles the button
pressing, map changing, the assigned text area, etc. You can remove it and replace it with a custom event handler if you
wish.
Keys
• LV_KEY_RIGHT/UP/LEFT/RIGHT To navigate among the buttons and select one.

• LV_KEY_ENTER To press/release the selected button.
Examples
Keyboard with text area
Error encountered while trying to open /home/runner/work/lvgl/lvgl/examples/_widgets/

,→keyboard/lv_example_keyboard_1.c
MicroPython
Keyboard with text area
No examples yet.
API
Typedefs
typedef uint8_t lv_keyboard_mode_t

Enums
enum [anonymous]
Current keyboard mode.
Values:
enumerator LV_KEYBOARD_MODE_TEXT_LOWER
enumerator LV_KEYBOARD_MODE_TEXT_UPPER
enumerator LV_KEYBOARD_MODE_SPECIAL
enumerator LV_KEYBOARD_MODE_NUMBER
Functions
lv_obj_t *lv_keyboard_create(lv_obj_t *parent)

Create a keyboard objects
Parameters par -- pointer to an object, it will be the parent of the new keyboard
Returns pointer to the created keyboard
void lv_keyboard_set_textarea(lv_obj_t *kb, lv_obj_t *ta)
Assign a Text Area to the Keyboard. The pressed characters will be put there.
Parameters
• kb -- pointer to a Keyboard object
• ta -- pointer to a Text Area object to write there
void lv_keyboard_set_mode(lv_obj_t *kb, lv_keyboard_mode_t mode)
Set a new a mode (text or number map)
Parameters
• mode -- the mode from 'lv_keyboard_mode_t'
void lv_keyboard_set_map(lv_obj_t *kb, lv_keyboard_mode_t mode, const char *map[], const
lv_btnmatrix_ctrl_t ctrl_map[])
Set a new map for the keyboard
Parameters
• mode -- keyboard map to alter 'lv_keyboard_mode_t'
• map -- pointer to a string array to describe the map. See 'lv_btnmatrix_set_map()' for more
info.
lv_obj_t *lv_keyboard_get_textarea(const lv_obj_t *kb)
Assign a Text Area to the Keyboard. The pressed characters will be put there.
Parameters kb -- pointer to a Keyboard object
Returns pointer to the assigned Text Area object
lv_keyboard_mode_t lv_keyboard_get_mode(const lv_obj_t *kb)
Set a new a mode (text or number map)

Parameters kb -- pointer to a Keyboard object

Returns the current mode from 'lv_keyboard_mode_t'
static inline const char **lv_keyboard_get_map_array(const lv_obj_t *kb)
Get the current map of a keyboard
Parameters kb -- pointer to a keyboard object
Returns the current map
void lv_keyboard_def_event_cb(lv_event_t *e)
Default keyboard event to add characters to the Text area and change the map. If a custom event_cb is added
to the keyboard this function be called from it to handle the button clicks
Parameters
• kb -- pointer to a keyboard
• event -- the triggering event
Variables
const lv_obj_class_t lv_keyboard_class

struct lv_keyboard_t
Public Members
lv_btnmatrix_t btnm
lv_obj_t *ta
lv_keyboard_mode_t mode
5.3.6 LED (lv_led)
Overview
The LEDs are rectangle-like (or circle) object whose brightness can be adjusted. With lower brightness the colors of the
LED become darker.
Parts and Styles
The LEDs have only one main part, called LV_LED_PART_MAIN and it uses all the typical background style properties.

Usage
Color
You can set the color of the LED with lv_led_set_color(led, lv_color_hex(0xff0080)). This will
be used as background color, border color, and shadow color.
Brightness
You can set their brightness with lv_led_set_bright(led, bright). The brightness should be between 0
(darkest) and 255 (lightest).
Toggle
Use lv_led_on(led) and lv_led_off(led) to set the brightness to a predefined ON or OFF value. The
lv_led_toggle(led) toggles between the ON and OFF state.
Events
No special event are sent by the LED object.

Keys

Example
LED with custom style
#if LV_USE_LED && LV_BUILD_EXAMPLES
/**
* Create LED's with different brightness and color
*/
void lv_example_led_1(void)
{
/*Create a LED and switch it OFF*/
lv_obj_t * led1 = lv_led_create(lv_scr_act());
lv_obj_align(led1, LV_ALIGN_CENTER, -80, 0);
lv_led_off(led1);
/*Copy the previous LED and set a brightness*/



lv_obj_align(led2, LV_ALIGN_CENTER, 0, 0);
lv_led_set_brightness(led2, 150);
lv_led_set_color(led2, lv_palette_main(LV_PALETTE_RED));
/*Copy the previous LED and switch it ON*/

lv_obj_align(led3, LV_ALIGN_CENTER, 80, 0);
lv_led_on(led3);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_led_create(lv_obj_t *parent)

Create a led objects
Parameters par -- pointer to an object, it will be the parent of the new led
Returns pointer to the created led
void lv_led_set_color(lv_obj_t *led, lv_color_t color)
Set the color of the LED
Parameters
• led -- pointer to a LED object
• color -- the color of the the LED
void lv_led_set_brightness(lv_obj_t *led, uint8_t bright)
Set the brightness of a LED object
Parameters
• led -- pointer to a LED object
• bright -- LV_LED_BRIGHT_MIN (max. dark) ... LV_LED_BRIGHT_MAX (max. light)
void lv_led_on(lv_obj_t *led)
Light on a LED
Parameters led -- pointer to a LED object
void lv_led_off(lv_obj_t *led)
Light off a LED
void lv_led_toggle(lv_obj_t *led)
Toggle the state of a LED

uint8_t lv_led_get_brightness(const lv_obj_t *obj)

Get the brightness of a LEd object
Parameters led -- pointer to LED object
Returns bright 0 (max. dark) ... 255 (max. light)
Variables
const lv_obj_class_t lv_led_class

struct lv_led_t
Public Members
lv_obj_t obj
lv_color_t color
uint8_t bright
Current brightness of the LED (0..255)
5.3.7 List (lv_list)
Overview
The List is basically a rectangle with vertical layout to which Buttons and Texts can be added
Parts and Styles
Background
• LV_PART_MAIN The main part of the list that uses all the typical background properties
• LV_PART_SCROLLBAR The scrollbar. See the Base objects documentation for details.
Buttons and Texts See the Button's and Label's documentation.
Usage
Buttons
lv_list_add_btn(list, icon, text) adds a full-width button with an icon - that can be an image or symbol
- and a text.
The text starts to scroll horizontally if its too long.

Texts
lv_list_add_text(list, text) adds a text.
Events
No special events are sent by the List, but sent by the Button as usual.
Keys

Example
Simple List
#if LV_USE_LIST && LV_BUILD_EXAMPLES
static lv_obj_t * list1;

{
LV_LOG_USER("Clicked: %s", lv_list_get_btn_text(list1, obj));
}
}
void lv_example_list_1(void)
{
/*Create a list*/
list1 = lv_list_create(lv_scr_act());
lv_obj_set_size(list1, 180, 220);
lv_obj_center(list1);
/*Add buttons to the list*/

lv_obj_t * btn;
lv_list_add_text(list1, "File");
btn = lv_list_add_btn(list1, LV_SYMBOL_FILE, "New");
lv_obj_add_event_cb(btn, event_handler, LV_EVENT_CLICKED, NULL);
btn = lv_list_add_btn(list1, LV_SYMBOL_DIRECTORY, "Open");
btn = lv_list_add_btn(list1, LV_SYMBOL_SAVE, "Save");
btn = lv_list_add_btn(list1, LV_SYMBOL_CLOSE, "Delete");


btn = lv_list_add_btn(list1, LV_SYMBOL_EDIT, "Edit");
lv_list_add_text(list1, "Connectivity");
btn = lv_list_add_btn(list1, LV_SYMBOL_BLUETOOTH, "Bluetooth");
btn = lv_list_add_btn(list1, LV_SYMBOL_GPS, "Navigation");
btn = lv_list_add_btn(list1, LV_SYMBOL_USB, "USB");
btn = lv_list_add_btn(list1, LV_SYMBOL_BATTERY_FULL, "Battery");
lv_list_add_text(list1, "Exit");
btn = lv_list_add_btn(list1, LV_SYMBOL_OK, "Apply");
btn = lv_list_add_btn(list1, LV_SYMBOL_CLOSE, "Close");
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_list_create(lv_obj_t *parent)
lv_obj_t *lv_list_add_text(lv_obj_t *list, const char *txt)
lv_obj_t *lv_list_add_btn(lv_obj_t *list, const char *icon, const char *txt)
const char *lv_list_get_btn_text(lv_obj_t *list, lv_obj_t *btn)
Variables
const lv_obj_class_t lv_list_class

const lv_obj_class_t lv_list_text_class
const lv_obj_class_t lv_list_btn_class

5.3.8 Meter (lv_meter)
Overview
The Meter widget can visualize data in very flexible ways. In can show arcs, needles, ticks lines and labels.
Parts and Styles
• LV_PART_MAIN The background of the Meter. Uses the typical background properties.
• LV_PART_TICK The tick lines a labels using the line and text style properties.
• LV_PART_INDICATOR The needle line or image using the line and img style properties, as well as the background
properties to draw a square (or circle) on the pivot of the needles. Padding makes the square larger.
• LV_PART_ITEMS The arcs using the arc properties.
Usage
Add a scale
First a Scale needs to be added to the Meter with lv_meter_scale_t * scale =

lv_meter_add_scale(meter). The Scale has minor and major ticks and labels on the major ticks. Later
indicators (needles, arcs, tick modifiers) can be added to the meter
Any number of scales can be added to Meter.
The minor tick lines can be configured with: lv_meter_set_scale_ticks(meter, scale, tick_count,
line_width, tick_length, ctick_olor).
To add major tick lines use lv_meter_set_scale_major_ticks(meter, scale, nth_major,
tick_width, tick_length, tick_color, label_gap). nth_major to specify how many minor
ticks to skip to draw a major tick.
Labels are added automatically on major ticks with label_gap distance from the ticks with text proportionally to the
values of the tick line.
lv_meter_set_scale_range(meter, scale, min, max, angle_range, rotation) sets the
value and angle range of the scale.
Add indicators
Indicators needs to be added to a Scale and their value is interpreted in the range of the Scale.
All the indicator add functions return lv_meter_indicator_t *.

Needle line
indic = lv_meter_add_needle_line(meter, scale, line_width, line_color, r_mod)

adds a needle line to a Scale. By default the length of the line is the same as the scale's radius but r_mod changes the
length.
lv_meter_set_indicator_value(meter, indic, value) sets the value of the indicator.
Needle image
indic = lv_meter_add_needle_img(meter, scale, img_src, pivot_x, pivot_y) sets an

image that will be used as a needle. img_src should be a needle pointing to the right like this -O--->. pivot_x
and pivot_y sets the pivot point of the rotation relative to the top left corner of the image.
lv_meter_set_indicator_value(meter, inidicator, value) sets the value of the indicator.
Arc
indic = lv_meter_add_arc(meter, scale, arc_width, arc_color, r_mod) adds and arc

indicator. . By default the radius of the arc is the same as the scale's radius but r_mod changes the radius.
lv_meter_set_indicator_start_value(meter, indic, value) and
lv_meter_set_indicator_end_value(meter, inidicator, value) sets the value of the in-
dicator.
Scale lines (ticks)
indic = lv_meter_add_scale_lines(meter, scale, color_start, color_end, local,

width_mod) adds an indicator that modifies the ticks lines. If local is true the ticks' color will be faded from
color_start to color_end in the indicator's start and end value range. If local is false color_start and
color_end will be mapped to the start and end value of the scale and only a "slice" of that color gradient will be visible
in the indicator's start and end value range. width_mod modifies the width of the tick lines.
lv_meter_set_indicator_start_value(meter, inidicator, value) and
lv_meter_set_indicator_end_value(meter, inidicator, value) sets the value of the in-
dicator.
Events
• LV_EVENT_DRAW_PART_BEGIN and LV_EVENT_DRAW_PART_END is sent for the tick labels to allow

overwriting the texts. The following fields of lv_obj_draw_part_dsc_t is set: clip_area, part (to
LV_PART_TICK), id (the index of the major tick line), value (the value of the tick line), label_dsc,
text (value converted to decimal)

Keys
No keys are handled by the Meter widget.

Example
Simple meter
#if LV_USE_METER && LV_BUILD_EXAMPLES
static lv_obj_t * meter;
static void set_value(void * indic, int32_t v)

{
lv_meter_set_indicator_value(meter, indic, v);
}
/**
* A simple meter
*/
void lv_example_meter_1(void)
{
meter = lv_meter_create(lv_scr_act());
lv_obj_center(meter);
lv_obj_set_size(meter, 200, 200);
/*Add a scale first*/

lv_meter_scale_t * scale = lv_meter_add_scale(meter);
lv_meter_set_scale_ticks(meter, scale, 41, 2, 10, lv_palette_main(LV_PALETTE_
,→GREY));
lv_meter_set_scale_major_ticks(meter, scale, 8, 4, 15, lv_color_black(), 10);
lv_meter_indicator_t * indic;
/*Add a blue arc to the start*/

indic = lv_meter_add_arc(meter, scale, 3, lv_palette_main(LV_PALETTE_BLUE), 0);
lv_meter_set_indicator_start_value(meter, indic, 0);
lv_meter_set_indicator_end_value(meter, indic, 20);
/*Make the tick lines blue at the start of the scale*/

indic = lv_meter_add_scale_lines(meter, scale, lv_palette_main(LV_PALETTE_BLUE),␣
,→lv_palette_main(LV_PALETTE_BLUE), false, 0);

/*Add a red arc to the end*/

indic = lv_meter_add_arc(meter, scale, 3, lv_palette_main(LV_PALETTE_RED), 0);


/*Make the tick lines red at the end of the scale*/
indic = lv_meter_add_scale_lines(meter, scale, lv_palette_main(LV_PALETTE_RED),␣
,→lv_palette_main(LV_PALETTE_RED), false, 0);

/*Add a needle line indicator*/

indic = lv_meter_add_needle_line(meter, scale, 4, lv_palette_main(LV_PALETTE_
,→GREY), -10);
/*Create an animation to set the value*/

lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, indic);
lv_anim_start(&a);
}
#endif
A meter with multiple arcs

{
lv_meter_set_indicator_end_value(meter, indic, v);
}
/**
* A meter with multiple arcs
*/
{
/*Remove the circle from the middle*/

lv_obj_remove_style(meter, NULL, LV_PART_INDICATOR);
/*Add a scale first*/

lv_meter_set_scale_ticks(meter, scale, 11, 2, 10, lv_palette_main(LV_PALETTE_
,→GREY));


lv_meter_set_scale_major_ticks(meter, scale, 1, 2, 30, lv_color_hex3(0xeee), 10);
lv_meter_set_scale_range(meter, scale, 0, 100, 270, 90);
/*Add a three arc indicator*/

lv_meter_indicator_t * indic1 = lv_meter_add_arc(meter, scale, 10, lv_palette_
,→main(LV_PALETTE_RED), 0);

,→main(LV_PALETTE_GREEN), -10);

,→main(LV_PALETTE_BLUE), -20);

lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, indic1);
lv_anim_start(&a);
lv_anim_start(&a);
lv_anim_start(&a);
}
#endif
A clock from a meter

{
lv_meter_set_indicator_end_value(meter, indic, v);
}
/**
* A clock from a meter
*/


{
/*Create a scale for the minutes*/

/*61 ticks in a 360 degrees range (the last and the first line overlaps)*/
lv_meter_scale_t * scale_min = lv_meter_add_scale(meter);
lv_meter_set_scale_ticks(meter, scale_min, 61, 1, 10, lv_palette_main(LV_PALETTE_
,→GREY));
lv_meter_set_scale_range(meter, scale_min, 0, 60, 360, 270);
/*Create an other scale for the hours. It's only visual and contains only major␣
,→ticks*/
lv_meter_scale_t * scale_hour = lv_meter_add_scale(meter);
lv_meter_set_scale_ticks(meter, scale_hour, 12, 0, 0, lv_palette_main(LV_PALETTE_
,→GREY)); /*12 ticks*/
lv_meter_set_scale_major_ticks(meter, scale_hour, 1, 2, 20, lv_color_black(), 10);
,→ /*Every tick is major*/
lv_meter_set_scale_range(meter, scale_hour, 1, 12, 330, 300); /*[1..12]␣
,→values in an almost full circle*/
LV_IMG_DECLARE(img_hand)
/*Add a the hands from images*/

lv_meter_indicator_t * indic_min = lv_meter_add_needle_img(meter, scale_min, &img_
,→hand, 5, 5);
lv_meter_indicator_t * indic_hour = lv_meter_add_needle_img(meter, scale_min, &

,→img_hand, 5, 5);

lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_time(&a, 2000); /*2 sec for 1 turn of the minute hand (1 hour)*/
lv_anim_set_var(&a, indic_min);
lv_anim_start(&a);
lv_anim_set_var(&a, indic_hour);
lv_anim_set_time(&a, 24000); /*24 sec for 1 turn of the hour hand*/
lv_anim_start(&a);
}
#endif

Pie chart
/**
* Create a pie chart
*/
{
lv_obj_t * meter = lv_meter_create(lv_scr_act());
/*Remove the background and the circle from the middle*/

lv_obj_remove_style(meter, NULL, LV_PART_MAIN);
lv_obj_remove_style(meter, NULL, LV_PART_INDICATOR);

/*Add a scale first with no ticks.*/

lv_meter_set_scale_ticks(meter, scale, 0, 0, 0, lv_color_black());
lv_meter_set_scale_range(meter, scale, 0, 100, 360, 0);
/*Add a three arc indicator*/

lv_coord_t indic_w = 100;
lv_meter_indicator_t * indic1 = lv_meter_add_arc(meter, scale, indic_w,lv_palette_
,→main(LV_PALETTE_ORANGE), 0);
lv_meter_set_indicator_start_value(meter, indic1, 0);

lv_meter_set_indicator_end_value(meter, indic1, 40);
lv_meter_indicator_t * indic2 = lv_meter_add_arc(meter, scale, indic_w, lv_

,→palette_main(LV_PALETTE_YELLOW), 0);
lv_meter_set_indicator_start_value(meter, indic2, 40); /*Start from the␣
,→previous*/
lv_meter_indicator_t * indic3 = lv_meter_add_arc(meter, scale, indic_w, lv_

,→ palette_main(LV_PALETTE_DEEP_ORANGE), 0);
lv_meter_set_indicator_start_value(meter, indic3, 80); /*Start from the␣
,→previous*/

}
#endif

MicroPython
No examples yet.
API
Enums
enum lv_meter_indicator_type_t
Values:
enumerator LV_METER_INDICATOR_TYPE_NEEDLE_IMG
enumerator LV_METER_INDICATOR_TYPE_NEEDLE_LINE
enumerator LV_METER_INDICATOR_TYPE_SCALE_LINES
enumerator LV_METER_INDICATOR_TYPE_ARC
Functions
lv_obj_t *lv_meter_create(lv_obj_t *parent)

Create a meter objects
Parameters parent -- pointer to an object, it will be the parent of the new bar.
Returns pointer to the created meter
lv_meter_scale_t *lv_meter_add_scale(lv_obj_t *obj)
Add a new scale to the meter.
Note: Indicators can be attached to scales.
Parameters obj -- pointer to a meter object

Returns the new scale
void lv_meter_set_scale_ticks(lv_obj_t *obj, lv_meter_scale_t *scale, uint16_t cnt, uint16_t width,

uint16_t len, lv_color_t color)
Set the properties of the ticks of a scale
Parameters
• obj -- pointer to a meter object
• scale -- pointer to scale (added to meter)
• cnt -- number of tick lines
• width -- width of tick lines
• len -- length of tick lines
• color -- color of tick lines

void lv_meter_set_scale_major_ticks(lv_obj_t *obj, lv_meter_scale_t *scale, uint16_t nth, uint16_t

width, uint16_t len, lv_color_t color, int16_t label_gap)
Make some "normal" ticks major ticks and set their attributes. Texts with the current value are also added to the
major ticks.
Parameters
• nth -- make every Nth normal tick major tick. (start from the first on the left)
• width -- width of the major ticks
• len -- length of the major ticks
• color -- color of the major ticks
• label_gap -- gap between the major ticks and the labels
void lv_meter_set_scale_range(lv_obj_t *obj, lv_meter_scale_t *scale, int32_t min, int32_t max, uint32_t
angle_range, uint32_t rotation)
Set the value and angular range of a scale.
Parameters
• min -- the minimum value
• max -- the maximal value
• angle_range -- the angular range of the scale
• rotation -- the angular offset from the 3 o'clock position (clock-wise)
lv_meter_indicator_t *lv_meter_add_needle_line(lv_obj_t *obj, lv_meter_scale_t *scale, uint16_t width,
lv_color_t color, int16_t r_mod)
Add a needle line indicator the scale
Parameters
• width -- width of the line
• color -- color of the line
• r_mod -- the radius modifier (added to the scale's radius) to get the lines length
Returns the new indicator
lv_meter_indicator_t *lv_meter_add_needle_img(lv_obj_t *obj, lv_meter_scale_t *scale, const void *src,
lv_coord_t pivot_x, lv_coord_t pivot_y)
Add a needle image indicator the scale
Note: the needle image should point to the right, like -O-->
Parameters


• src -- the image source of the indicator. path or pointer to lv_img_dsc_t
• pivot_x -- the X pivot point of the needle
• pivot_y -- the Y pivot point of the needle
lv_meter_indicator_t *lv_meter_add_arc(lv_obj_t *obj, lv_meter_scale_t *scale, uint16_t width, lv_color_t color,

int16_t r_mod)
Add an arc indicator the scale
Parameters
• width -- width of the arc
• color -- color of the arc
• r_mod -- the radius modifier (added to the scale's radius) to get the outer radius of the arc
lv_meter_indicator_t *lv_meter_add_scale_lines(lv_obj_t *obj, lv_meter_scale_t *scale, lv_color_t
color_start, lv_color_t color_end, bool local, int16_t
width_mod)
Add a scale line indicator the scale. It will modify the ticks.
Parameters
• color_start -- the start color
• color_end -- the end color
• local -- tell how to map start and end color. true: the indicator's start and end_value; false:
the scale's min max value
• width_mod -- add this the affected tick's width
void lv_meter_set_indicator_value(lv_obj_t *obj, lv_meter_indicator_t *indic, int32_t value)
Set the value of the indicator. It will set start and and value to the same value
Parameters
• indic -- pointer to an indicator
void lv_meter_set_indicator_start_value(lv_obj_t *obj, lv_meter_indicator_t *indic, int32_t value)
Set the start value of the indicator.
Parameters


void lv_meter_set_indicator_end_value(lv_obj_t *obj, lv_meter_indicator_t *indic, int32_t value)
Set the start value of the indicator.
Parameters
Variables
const lv_obj_class_t lv_meter_class

struct lv_meter_scale_t
Public Members
lv_color_t tick_color
uint16_t tick_cnt
uint16_t tick_length
uint16_t tick_width
lv_color_t tick_major_color
uint16_t tick_major_nth
uint16_t tick_major_length
uint16_t tick_major_width
int16_t label_gap
int16_t label_color
int32_t min
int32_t max
int16_t r_mod
uint16_t angle_range
int16_t rotation
struct lv_meter_indicator_t

Public Members
lv_meter_scale_t *scale
lv_meter_indicator_type_t type
lv_opa_t opa
int32_t start_value
int32_t end_value
const void *src
lv_point_t pivot
struct lv_meter_indicator_t::[anonymous]::[anonymous] needle_img
uint16_t width
int16_t r_mod
lv_color_t color
struct lv_meter_indicator_t::[anonymous]::[anonymous] needle_line
struct lv_meter_indicator_t::[anonymous]::[anonymous] arc
int16_t width_mod
lv_color_t color_start
lv_color_t color_end
uint8_t local_grad
struct lv_meter_indicator_t::[anonymous]::[anonymous] scale_lines
union lv_meter_indicator_t::[anonymous] type_data
struct lv_meter_t
Public Members
lv_obj_t obj
lv_ll_t scale_ll
lv_ll_t indicator_ll
5.3.9 Message box (lv_msgbox)
Overview
The Message boxes act as pop-ups. They are built from a background container, a title, an optional close button, a text
and optional buttons.
The text will be broken into multiple lines automatically and the height will be set automatically to include the text and
the buttons.
The message box can be modal (blocking clicks on the rest of the screen) or not modal.

Parts and Styles
The mesasge box is built from other widgets so you can check these widget's documentation for details.
• Background: lv_obj
• Close button: lv_btn
• Title and text: lv_label
• Buttons: lv_btnmatrix
Usage
Create a message box
lv_msgbox_create(parent, title, txt, btn_txts[], add_close_btn) creates a message box.

If parent is NULL the message box will be modal. title and txt are strings for the title and the text. btn_txts[]
is an array with the buttons' text. E.g. const char * btn_txts[] = {"Ok", "Cancel", NULL}.
add_colse_btn can be true or false to add/don't add a close button.
Get the parts
The building blocks of the message box can be obtained using the following functions:
lv_obj_t * lv_msgbox_get_title(lv_obj_t * mbox);

lv_obj_t * lv_msgbox_get_close_btn(lv_obj_t * mbox);
lv_obj_t * lv_msgbox_get_text(lv_obj_t * mbox);
lv_obj_t * lv_msgbox_get_btns(lv_obj_t * mbox);
Close the message box
lv_msgbox_close(msgbox) closes (deletes) the message box.
Events
• LV_EVENT_VALUE_CHANGED is sent by the buttons if one of them is clicked.

LV_OBJ_FLAG_EVENT_BUBBLE is enabled on the buttons so you can add events to the mes-
sage box itself. In the event handler, lv_event_get_target(e) will return the but-
ton matrix and lv_event_get_current_target(e) will givreturn the message box.
lv_msgbox_get_active_btn_text(msgbox) can be used to get the text of the clicked button.

Keys
Keys have effect on the close button and button matrix. You can add them manually to a group if required.
Example
Simple Message box
#if LV_USE_MSGBOX && LV_BUILD_EXAMPLES

{
lv_obj_t * obj = lv_event_get_current_target(e);
LV_LOG_USER("Button %s clicked", lv_msgbox_get_active_btn_text(obj));
}
void lv_example_msgbox_1(void)
{
static const char * btns[] ={"Apply", "Close", ""};
lv_obj_t * mbox1 = lv_msgbox_create(NULL, "Hello", "This is a message box with␣

,→ two buttons.", btns, true);
lv_obj_add_event_cb(mbox1, event_cb, LV_EVENT_VALUE_CHANGED, NULL);
lv_obj_center(mbox1);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_msgbox_create(lv_obj_t *parent, const char *title, const char *txt, const char *btn_txts[], bool
add_close_btn)
Create a message box objects
Parameters
• parent -- pointer to parent or NULL to create a full screen modal message box
• title -- the title of the message box
• txt -- the text of the message box
• btn_txts -- the buttons as an array of texts terminated by an "" element. E.g. {"btn1",
"btn2", ""}

• add_close_btn -- true: add a close button

Returns pointer to the message box object
lv_obj_t *lv_msgbox_get_title(lv_obj_t *mbox)
lv_obj_t *lv_msgbox_get_close_btn(lv_obj_t *mbox)
lv_obj_t *lv_msgbox_get_text(lv_obj_t *mbox)
lv_obj_t *lv_msgbox_get_btns(lv_obj_t *mbox)
const char *lv_msgbox_get_active_btn_text(lv_obj_t *mbox)
void lv_msgbox_close(lv_obj_t *mbox)
Variables
const lv_obj_class_t lv_msgbox_class
5.3.10 Span (lv_span)
Overview
A spangroup is the object that is used to display rich text. Different from the label object, spangroup can automatically
organize text of different fonts, colors, and sizes into the spangroup obj.
Parts and Styles
• LV_PART_MAIN The spangroup has only one part.
Usage
Set text and style
The spangroup object uses span to describe text and text style. so, first we need to create span de-
scriptor using lv_span_t * span = lv_spangroup_new_span(spangroup). Then use
lv_span_set_text(span, "text") to set text.The style of the modified text is the same as the normal style
used, eg:lv_style_set_text_color(&span->style, lv_palette_main(LV_PALETTE_RED)).
If spangroup object mode != LV_SPAN_MODE_FIXED you must call lv_spangroup_refr_mode() after you
have modified span style(eg:set text, changed the font size, del span).

Text align
like label object, the spangroup can be set to one the following modes:
• LV_TEXT_ALIGN_LEFT Align text to left.
• LV_TEXT_ALIGN_CENTER Align text to center.
• LV_TEXT_ALIGN_RIGHT Align text to right.
• LV_TEXT_ALIGN_AUTO Align text auto.
use function lv_spangroup_set_align(spangroup, LV_TEXT_ALIGN_CENTER) to set text align.
Modes
The spangroup can be set to one the following modes:

• LV_SPAN_MODE_FIXED fixes the object size.
• LV_SPAN_MODE_EXPAND Expand the object size to the text size but stay on a single line.
• LV_SPAN_MODE_BREAK Keep width, break the too long lines and auto expand height.
Use lv_spangroup_set_mode(spangroup, LV_SPAN_MODE_BREAK) to set object mode.
Overflow
The spangroup can be set to one the following modes:

• LV_SPAN_OVERFLOW_CLIP truncates the text at the limit of the area.
• LV_SPAN_OVERFLOW_ELLIPSIS will display an ellipsis(...) when text overflows the area.
Use lv_spangroup_set_overflow(spangroup, LV_SPAN_OVERFLOW_CLIP) to set object overflow
mode.
first line indent
Use lv_spangroup_set_indent(spangroup, 20) to set the indent of the first line, in pixels.
Events
No special events are sent by this widget.


Keys

Example
Span with custom styles
#if LV_USE_SPAN && LV_BUILD_EXAMPLES
/**
* Create span.
*/
void lv_example_span_1(void)
{
lv_style_set_border_color(&style, lv_palette_main(LV_PALETTE_ORANGE));
lv_obj_t * spans = lv_spangroup_create(lv_scr_act());

lv_obj_set_width(spans, 300);
lv_obj_set_height(spans,300);
lv_obj_center(spans);
lv_obj_add_style(spans, &style, 0);
lv_spangroup_set_align(spans, LV_TEXT_ALIGN_LEFT);
lv_spangroup_set_overflow(spans, LV_SPAN_OVERFLOW_CLIP);
lv_spangroup_set_indent(spans, 20);
lv_spangroup_set_mode(spans, LV_SPAN_MODE_BREAK);
lv_span_t * span = lv_spangroup_new_span(spans);

lv_span_set_text(span, "china is a beautiful country.");
lv_style_set_text_color(&span->style, lv_palette_main(LV_PALETTE_RED));
lv_style_set_text_decor(&span->style, LV_TEXT_DECOR_STRIKETHROUGH | LV_TEXT_DECOR_
,→UNDERLINE);
lv_style_set_text_opa(&span->style, LV_OPA_30);
span = lv_spangroup_new_span(spans);
lv_span_set_text_static(span, "good good study, day day up.");
lv_style_set_text_font(&span->style, &lv_font_montserrat_24);
#endif
lv_style_set_text_color(&span->style, lv_palette_main(LV_PALETTE_GREEN));
lv_span_set_text_static(span, "LVGL is an open-source graphics library.");
lv_style_set_text_color(&span->style, lv_palette_main(LV_PALETTE_BLUE));


lv_span_set_text_static(span, "the boy no name.");
lv_style_set_text_color(&span->style, lv_palette_main(LV_PALETTE_GREEN));
lv_style_set_text_font(&span->style, &lv_font_montserrat_20);
#endif
lv_style_set_text_decor(&span->style, LV_TEXT_DECOR_UNDERLINE);
lv_span_set_text(span, "I have a dream that hope to come true.");
lv_spangroup_refr_mode(spans);
}
#endif
MicroPython
No examples yet.
API
Typedefs
typedef uint8_t lv_span_overflow_t

typedef uint8_t lv_span_mode_t
Enums
enum [anonymous]
Values:
enumerator LV_SPAN_OVERFLOW_CLIP
enumerator LV_SPAN_OVERFLOW_ELLIPSIS
enum [anonymous]
Values:
enumerator LV_SPAN_MODE_FIXED
fixed the obj size
enumerator LV_SPAN_MODE_EXPAND
Expand the object size to the text size
enumerator LV_SPAN_MODE_BREAK
Keep width, break the too long lines and expand height

Functions
lv_obj_t *lv_spangroup_create(lv_obj_t *par)

Create a spangroup objects
Parameters par -- pointer to an object, it will be the parent of the new spangroup
Returns pointer to the created spangroup
lv_span_t *lv_spangroup_new_span(lv_obj_t *obj)
Create a span string descriptor and add to spangroup.
Parameters obj -- pointer to a spangroup object.
Returns pointer to the created span.
void lv_spangroup_del_span(lv_obj_t *obj, lv_span_t *span)
Remove the span from the spangroup and free memory.
Parameters
• obj -- pointer to a spangroup object.
• span -- pointer to a span.
void lv_span_set_text(lv_span_t *span, const char *text)
Set a new text for a span. Memory will be allocated to store the text by the span.
Parameters
• text -- pointer to a text.
void lv_span_set_text_static(lv_span_t *span, const char *text)
Set a static text. It will not be saved by the span so the 'text' variable has to be 'alive' while the span exist.
Parameters
• text -- pointer to a text.
void lv_spangroup_set_align(lv_obj_t *obj, lv_text_align_t align)
Set the align of the spangroup.
Parameters
• align -- see lv_text_align_t for details.
void lv_spangroup_set_overflow(lv_obj_t *obj, lv_span_overflow_t overflow)
Set the overflow of the spangroup.
Parameters
• overflow -- see lv_span_overflow_t for details.
void lv_spangroup_set_indent(lv_obj_t *obj, lv_coord_t indent)
Set the indent of the spangroup.
Parameters

• indent -- The first line indentation

void lv_spangroup_set_mode(lv_obj_t *obj, lv_span_mode_t mode)
Set the mode of the spangroup.
Parameters
• mode -- see lv_span_mode_t for details.
lv_text_align_t lv_spangroup_get_align(lv_obj_t *obj)
get the align of the spangroup.
Returns the align value.
lv_span_overflow_t lv_spangroup_get_overflow(lv_obj_t *obj)
get the overflow of the spangroup.
Returns the overflow value.
lv_coord_t lv_spangroup_get_indent(lv_obj_t *obj)
get the indent of the spangroup.
Returns the indent value.
lv_span_mode_t lv_spangroup_get_mode(lv_obj_t *obj)
get the mode of the spangroup.
lv_coord_t lv_spangroup_get_max_line_h(lv_obj_t *obj)
get max line height of all span in the spangroup.
lv_coord_t lv_spangroup_get_expand_width(lv_obj_t *obj)
get the width when all span of spangroup on a line. include spangroup pad.
lv_coord_t lv_spangroup_get_expand_height(lv_obj_t *obj, lv_coord_t width)
get the height with width fixed. the height include spangroup pad.
void lv_spangroup_refr_mode(lv_obj_t *obj)
update the mode of the spangroup.

Variables
const lv_obj_class_t lv_spangroup_class

struct lv_span_t
Public Members
char *txt
lv_obj_t *spangroup
lv_style_t style
uint8_t static_flag
struct lv_spangroup_t
#include <lv_span.h> Data of label
Public Members
lv_obj_t obj
lv_coord_t indent
lv_coord_t cache_w
lv_coord_t cache_h
lv_ll_t child_ll
uint8_t mode
uint8_t overflow
uint8_t refresh
5.3.11 Spinbox (lv_spinbox)
Overview
The Spinbox contains a number as text which can be increased or decreased by Keys or API functions. Under the hood
the Spinbox is a modified Text area.
Parts and Styles
The parts of the Spinbox are identical to the Text area.

Value, range and step
lv_spinbox_set_value(spinbox, 1234) sets a new value on the Spinbox.

lv_spinbox_increment(spinbox) and lv_spinbox_decrement(spinbox) increments/decrements
the value of the Spinbox according to the currently selected digit.
lv_spinbox_set_range(spinbox, -1000, 2500) sets a range. If the value is changed by
lv_spinbox_set_value, by Keys,lv_spinbox_increment/decrement this range will be respected.
lv_spinbox_set_step(spinbox, 100) sets which digits to change on increment/decrement. Only multiples
of ten can be set, and not for example 3.
Format
lv_spinbox_set_digit_format(spinbox, digit_count, separator_position) sets the num-

ber format. digit_count is the number of digits excluding the decimal separator and the sign. separa-
tor_position is the number of digits before the decimal point. If 0, no decimal point is displayed.
Rollover
lv_spinbox_set_rollover(spinbox, true/false) enables/disabled rollover mode. If either the mini-

mum or maximum value is reached with rollover enabled, the value will change to the other limit. If rollover is disabled
the value will be remain at the minimum or maximum value.
Events
• LV_EVENT_VALUE_CHANGED Sent when the value has changed.

Keys
• LV_KEY_LEFT/RIGHT With Keypad move the cursor left/right. With Encoder decrement/increment the se-
lected digit.
• LV_KEY_UP/DOWN With Keypad and Encoder increment/decrement the value.
• LV_KEY_ENTER With Encoder got the net digit. Jump to the first after the last.
Example
Simple Spinbox
#if LV_USE_SPINBOX && LV_BUILD_EXAMPLES
static lv_obj_t * spinbox;

static void lv_spinbox_increment_event_cb(lv_event_t * e)

{
if(code == LV_EVENT_SHORT_CLICKED || code == LV_EVENT_LONG_PRESSED_REPEAT) {
lv_spinbox_increment(spinbox);
}
}
static void lv_spinbox_decrement_event_cb(lv_event_t * e)

{
if(code == LV_EVENT_SHORT_CLICKED || code == LV_EVENT_LONG_PRESSED_REPEAT) {
lv_spinbox_decrement(spinbox);
}
}
void lv_example_spinbox_1(void)
{
spinbox = lv_spinbox_create(lv_scr_act());
lv_spinbox_set_range(spinbox, -1000, 25000);
lv_spinbox_set_digit_format(spinbox, 5, 2);
lv_spinbox_step_prev(spinbox);
lv_obj_set_width(spinbox, 100);
lv_obj_center(spinbox);
lv_coord_t h = lv_obj_get_height(spinbox);

lv_obj_set_size(btn, h, h);
lv_obj_align_to(btn, spinbox, LV_ALIGN_OUT_RIGHT_MID, 5, 0);
lv_obj_set_style_bg_img_src(btn, LV_SYMBOL_PLUS, 0);
lv_obj_add_event_cb(btn, lv_spinbox_increment_event_cb, LV_EVENT_ALL, NULL);
lv_obj_set_size(btn, h, h);
lv_obj_align_to(btn, spinbox, LV_ALIGN_OUT_LEFT_MID, -5, 0);
lv_obj_set_style_bg_img_src(btn, LV_SYMBOL_MINUS, 0);
lv_obj_add_event_cb(btn, lv_spinbox_decrement_event_cb, LV_EVENT_ALL, NULL);
}
#endif

MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_spinbox_create(lv_obj_t *parent)

Create a spinbox objects
Parameters par -- pointer to an object, it will be the parent of the new spinbox
Returns pointer to the created spinbox
void lv_spinbox_set_value(lv_obj_t *obj, int32_t i)
Set spinbox value
Parameters
• spinbox -- pointer to spinbox
• i -- value to be set
void lv_spinbox_set_rollover(lv_obj_t *obj, bool b)
Set spinbox rollover function
Parameters
• b -- true or false to enable or disable (default)
void lv_spinbox_set_digit_format(lv_obj_t *obj, uint8_t digit_count, uint8_t separator_position)
Set spinbox digit format (digit count and decimal format)
Parameters
• digit_count -- number of digit excluding the decimal separator and the sign
• separator_position -- number of digit before the decimal point. If 0, decimal point is
not shown
void lv_spinbox_set_step(lv_obj_t *obj, uint32_t step)
Set spinbox step
Parameters
• step -- steps on increment/decrement. Can be 1, 10, 100, 1000, etc the digit that will change.
void lv_spinbox_set_range(lv_obj_t *obj, int32_t range_min, int32_t range_max)
Set spinbox value range
Parameters
• range_min -- maximum value, inclusive
• range_max -- minimum value, inclusive

bool lv_spinbox_get_rollover(lv_obj_t *obj)

Get spinbox rollover function status
Parameters spinbox -- pointer to spinbox
int32_t lv_spinbox_get_value(lv_obj_t *obj)
Get the spinbox numeral value (user has to convert to float according to its digit format)
Returns value integer value of the spinbox
int32_t lv_spinbox_get_step(lv_obj_t *obj)
Get the spinbox step value (user has to convert to float according to its digit format)
Returns value integer step value of the spinbox
void lv_spinbox_step_next(lv_obj_t *obj)
Select next lower digit for edition by dividing the step by 10
void lv_spinbox_step_prev(lv_obj_t *obj)
Select next higher digit for edition by multiplying the step by 10
void lv_spinbox_increment(lv_obj_t *obj)
Increment spinbox value by one step
void lv_spinbox_decrement(lv_obj_t *obj)
Decrement spinbox value by one step
Variables
const lv_obj_class_t lv_spinbox_class

struct lv_spinbox_t
Public Members
lv_textarea_t ta
int32_t value
int32_t range_max
int32_t range_min
int32_t step
uint16_t digit_count
uint16_t dec_point_pos
uint16_t rollover

Example
5.3.12 Spinner (lv_spinner)
Overview
The Spinner object is a spinning arc over a ring.
Parts and Styles
The parts are identical to the parts of lv_arc.
Usage
Create a spinner
To create a spinner use lv_spinner_create(parent, spin_time, arc_length). spin time sets the
spin time in milliseconds, arc_length sets the length of the spinning arc in degrees.
Events
No special events are sent the the Spinner.

Keys

Example
Simple spinner
#if LV_USE_SPINNER && LV_BUILD_EXAMPLES
void lv_example_spinner_1(void)
{
/*Create a spinner*/
lv_obj_t * spinner = lv_spinner_create(lv_scr_act(), 1000, 60);
lv_obj_set_size(spinner, 100, 100);
lv_obj_center(spinner);
}
#endif

MicroPython
API
Functions
lv_obj_t *lv_spinner_create(lv_obj_t *parent, uint32_t time, uint32_t arc_length)
Variables
const lv_obj_class_t lv_spinner_class
5.3.13 Tabview (lv_tabview)
Overview
The Tab view object can be used to organize content in tabs. The Tab view is built from other widgets:
• Main container: lv_obj)
– Tab buttons: lv_btnmatrix
– Container for the tabs: lv_obj
∗ Content of the tabs: lv_obj
The tab buttons can be positioned on the top, bottom, left and right side of the Tab view.
A new tab can be selected either by clicking on a tab button or by sliding horizontally on the content.
Parts and Styles
There are no special parts on the Tab view but the lv_obj and lv_btnnmatrix widgets are used to create the Tab
view.
Usage
Create a Tab view
lv_tabview_create(parent, tab_pos, tab_size); creates a new empty Tab view. tab_pos can be
LV_DIR_TOP/BOTTOM/LEFT/RIGHT to position the tab buttons to a side. tab_size is the height (in case of
LV_DIR_TOP/BOTTOM) or width (in case of LV_DIR_LEFT/RIGHT) tab buttons.

Add tabs
New tabs can be added with lv_tabview_add_tab(tabview, "Tab name"). This will return a pointer to an
lv_obj object where the tab's content can be created.
Change tab
To select a new tab you can:

• Click on its tab button
• Slide horizontally
• Use lv_tabview_set_act(tabview, id, LV_ANIM_ON/OFF) function
Get the parts
lv_tabview_get_content(tabview) returns the container for the tabs,

lv_tabview_get_tab_btns(tabview) returns the Tab buttons object which is a Button matrix.
Events
• LV_EVENT_VALUE_CHANGED Sent when a new tab is selected by sliding or clicking the tab button.
lv_tabview_get_tab_act(tabview) returns the zero based index of the current tab.
Keys
Keys have effect only on the tab buttons (Button matrix). Add manually to a group if required.
Example
Simple Tabview
#if LV_USE_TABVIEW && LV_BUILD_EXAMPLES
void lv_example_tabview_1(void)
{
/*Create a Tab view object*/
lv_obj_t *tabview;
tabview = lv_tabview_create(lv_scr_act(), LV_DIR_TOP, 50);
/*Add 3 tabs (the tabs are page (lv_page) and can be scrolled*/
lv_obj_t *tab1 = lv_tabview_add_tab(tabview, "Tab 1");


/*Add content to the tabs*/

lv_obj_t * label = lv_label_create(tab1);
lv_label_set_text(label, "This the first tab\n\n"
"If the content\n"
"of a tab\n"
"becomes too\n"
"longer\n"
"than the\n"
"container\n"
"then it\n"
"automatically\n"
"becomes\n"
"scrollable.\n"
"\n"
"\n"
"\n"
"Can you see it?");
label = lv_label_create(tab2);
lv_label_set_text(label, "Second tab");
lv_label_set_text(label, "Third tab");
lv_obj_scroll_to_view_recursive(label, LV_ANIM_ON);
}
#endif
Tabs on the left, styling and no scrolling
#if LV_USE_TABVIEW && LV_BUILD_EXAMPLES
static void scroll_begin_event(lv_event_t * e)

{
/*Disable the scroll animations. Triggered when a tab button is clicked */
if(lv_event_get_code(e) == LV_EVENT_SCROLL_BEGIN) {
lv_anim_t * a = lv_event_get_param(e);
if(a) a->time = 0;
}
}
void lv_example_tabview_2(void)
{
/*Create a Tab view object*/
lv_obj_t *tabview;
tabview = lv_tabview_create(lv_scr_act(), LV_DIR_LEFT, 80);
lv_obj_add_event_cb(lv_tabview_get_content(tabview), scroll_begin_event, LV_EVENT_
,→SCROLL_BEGIN, NULL);
lv_obj_set_style_bg_color(tabview, lv_palette_lighten(LV_PALETTE_RED, 2), 0);


lv_obj_t * tab_btns = lv_tabview_get_tab_btns(tabview);

lv_obj_set_style_bg_color(tab_btns, lv_palette_darken(LV_PALETTE_GREY, 3), 0);
lv_obj_set_style_text_color(tab_btns, lv_palette_lighten(LV_PALETTE_GREY, 5), 0);
lv_obj_set_style_border_side(tab_btns, LV_BORDER_SIDE_RIGHT, LV_PART_ITEMS | LV_
,→STATE_CHECKED);
/*Add 3 tabs (the tabs are page (lv_page) and can be scrolled*/
lv_obj_set_style_bg_color(tab2, lv_palette_lighten(LV_PALETTE_AMBER, 3), 0);

lv_obj_set_style_bg_opa(tab2, LV_OPA_COVER, 0);
/*Add content to the tabs*/

lv_obj_t * label = lv_label_create(tab1);
lv_label_set_text(label, "First tab");
lv_label_set_text(label, "Second tab");
lv_label_set_text(label, "Third tab");
lv_label_set_text(label, "Forth tab");
lv_label_set_text(label, "Fifth tab");
lv_obj_clear_flag(lv_tabview_get_content(tabview), LV_OBJ_FLAG_SCROLLABLE);
}
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_tabview_create(lv_obj_t *parent, lv_dir_t tab_pos, lv_coord_t tab_size)
lv_obj_t *lv_tabview_add_tab(lv_obj_t *tv, const char *name)
lv_obj_t *lv_tabview_get_content(lv_obj_t *tv)

lv_obj_t *lv_tabview_get_tab_btns(lv_obj_t *tv)
void lv_tabview_set_act(lv_obj_t *obj, uint32_t id, lv_anim_enable_t anim_en)
uint16_t lv_tabview_get_tab_act(lv_obj_t *tv)
Variables
const lv_obj_class_t lv_tabview_class

struct lv_tabview_t
Public Members
lv_obj_t obj
char **map
uint16_t tab_cnt
uint16_t tab_cur
lv_dir_t tab_pos
5.3.14 Tile view (lv_tileview)
Overview
The Tile view is a container object whose elements (called tiles) can be arranged in grid form. By swiping the user can
navigate between the tiles. Any direction of swiping can be disabled on the tiles individually to not allow moving from
one tile to another.
If the Tile view is screen sized, the user interface resembles what you may have seen on smartwatches.
Parts and Styles
The Tile view is built from an lv_obj container and lv_obj tiles.
The parts and styles work the same as for lv_obj.

Usage
Add a tile
lv_tileview_add_tile(tileview, row_id, col_id, dir) creates a new tile on the row_idth row
and col_idth column. dir can be LV_DIR_LEFT/RIGHT/TOP/BOTTOM/HOR/VER/ALL or OR-ed values to
enable moving to the adjacent tiles into the given direction by swiping.
The returned value is an lv_obj_t * on which the content of the tab can be created.
Change tile
The Tile view can scroll to a tile with lv_obj_set_tile(tileview, tile_obj, LV_ANIM_ON/OFF) or
lv_obj_set_tile_id(tileviewv, col_id, row_id, LV_ANIM_ON/OFF);
Events
• LV_EVENT_VALUE_CHANGED Sent when a new tile loaded by scrolling.

lv_tileview_get_tile_act(tabview) can be used to get current tile.
Keys
Keys are not handled by the Tile view.

Example
Tileview with content
#if LV_USE_TILEVIEW && LV_BUILD_EXAMPLES
/**
* Create a 2x2 tile view and allow scrolling only in an "L" shape.
* Demonstrate scroll chaining with a long list that
* scrolls the tile view when it cant't be scrolled further.
*/
void lv_example_tileview_1(void)
{
lv_obj_t *tv = lv_tileview_create(lv_scr_act());
/*Tile1: just a label*/

lv_obj_t * tile1 = lv_tileview_add_tile(tv, 0, 0, LV_DIR_BOTTOM);
lv_obj_t * label = lv_label_create(tile1);
lv_label_set_text(label, "Scroll down");


/*Tile2: a button*/
lv_obj_t * tile2 = lv_tileview_add_tile(tv, 0, 1, LV_DIR_TOP | LV_DIR_RIGHT);
lv_obj_t * btn = lv_btn_create(tile2);
lv_label_set_text(label, "Scroll up or right");
lv_obj_set_size(btn, LV_SIZE_CONTENT, LV_SIZE_CONTENT);

lv_obj_center(btn);
/*Tile3: a list*/
lv_obj_t * tile3 = lv_tileview_add_tile(tv, 1, 1, LV_DIR_LEFT);
lv_obj_t * list = lv_list_create(tile3);
lv_obj_set_size(list, LV_PCT(100), LV_PCT(100));
lv_list_add_btn(list, NULL, "One");

lv_list_add_btn(list, NULL, "Two");
lv_list_add_btn(list, NULL, "Three");
lv_list_add_btn(list, NULL, "Four");
lv_list_add_btn(list, NULL, "Five");
lv_list_add_btn(list, NULL, "Six");
lv_list_add_btn(list, NULL, "Seven");
lv_list_add_btn(list, NULL, "Eight");
lv_list_add_btn(list, NULL, "Nine");
lv_list_add_btn(list, NULL, "Ten");
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_tileview_create(lv_obj_t *parent)

Create a tileview objects
Parameters par -- pointer to an object, it will be the parent of the new tileview
Returns pointer to the created tileview
lv_obj_t *lv_tileview_add_tile(lv_obj_t *tv, uint8_t row_id, uint8_t col_id, lv_dir_t dir)
void lv_obj_set_tile(lv_obj_t *tv, lv_obj_t *tile_obj, lv_anim_enable_t anim_en)
void lv_obj_set_tile_id(lv_obj_t *tv, uint32_t col_id, uint32_t row_id, lv_anim_enable_t anim_en)

lv_obj_t *lv_tileview_get_tile_act(lv_obj_t *obj)
Variables
const lv_obj_class_t lv_tileview_class

const lv_obj_class_t lv_tileview_tile_class
struct lv_tileview_t
Public Members
lv_obj_t obj
lv_obj_t *tile_act
struct lv_tileview_tile_t
Public Members
lv_obj_t obj
lv_dir_t dir
5.3.15 Window (lv_win)
Overview
The Window is container-like object built from a header with title and buttons and a content area.
Parts and Styles
The Window is built from other widgets so you can check their documentation for details:
• Background: lv_obj
• Header on the background: lv_obj
• Title on the header: lv_label
• Buttons on the header: lv_btn
• Content area on the background: lv_obj

Usage
Create a Window
lv_win_create(parent, header_height) creates a Window with an empty header.
Title and buttons
Any number of texts (but typically only one) can be added to the header with lv_win_add_title(win, "The
title").
Control buttons can be added to the window's header with lv_win_add_btn_right(win, icon,
btn_width). icon can be any image source, and btn_width is the width of the button.
The title and the buttons will be added in the order the functions are called. So adding a button, a text and two other
buttons will result in a button on the left, a title, and 2 buttons on the right. The width of the title is set to take all the
remaining space on the header. In other words: it pushes to the right all the buttons that are added after the title.
Get the parts
lv_win_get_header(win) returns a pointer to the header, lv_win_get_content(win) returns a pointer to

the content container to which the content of the window can be added.
Events
No special events are sent by the windows, however events can be added manually to the return value of
lv_win_add_btn_right.
Keys
No Keys are handled by the window.

Example
Simple window
#if LV_USE_WIN && LV_BUILD_EXAMPLES

{
LV_LOG_USER("Button %d clicked", lv_obj_get_child_id(obj));


}
void lv_example_win_1(void)
{
lv_obj_t * win = lv_win_create(lv_scr_act(), 40);
lv_obj_t * btn;
btn = lv_win_add_btn(win, LV_SYMBOL_LEFT, 40);
lv_win_add_title(win, "A title");
btn = lv_win_add_btn(win, LV_SYMBOL_RIGHT, 40);

btn = lv_win_add_btn(win, LV_SYMBOL_CLOSE, 60);

lv_obj_t * cont = lv_win_get_content(win); /*Content can be aded here*/

lv_obj_t * label = lv_label_create(cont);
lv_label_set_text(label, "This is\n"
"a pretty\n"
"long text\n"
"to see how\n"
"the window\n"
"becomes\n"
"scrollable.\n"
"\n"
"\n"
"Some more\n"
"text to be\n"
"sure it\n"
"overflows. :)");
#endif
MicroPython
No examples yet.
API
Functions
lv_obj_t *lv_win_create(lv_obj_t *parent, lv_coord_t header_height)
lv_obj_t *lv_win_add_title(lv_obj_t *win, const char *txt)
lv_obj_t *lv_win_add_btn(lv_obj_t *win, const void *icon, lv_coord_t btn_w)

lv_obj_t *lv_win_get_header(lv_obj_t *win)
lv_obj_t *lv_win_get_content(lv_obj_t *win)
Variables
const lv_obj_class_t lv_win_class

struct lv_win_t
Public Members
lv_obj_t obj

CHAPTER
SIX
LAYOUTS
6.1 Flex
6.1.1 Overview
The Flexbox (or Flex for short) is a subset of CSS Flexbox.

It can arrange items into rows or columns (tracks), handle wrapping, adjust the spacing between the items and tracks,
handle grow to make the item(s) fill the remaining space with respect to min/max width and height.
To make an object flex container call lv_obj_set_layout(obj, LV_LAYOUT_FLEX).
Note that the flex layout feature of LVGL needs to be globally enabled with LV_USE_FLEX in lv_conf.h.
6.1.2 Terms
• tracks: the rows or columns

• main direction: row or column, the direction in which the items are placed
• cross direction: perpendicular to the main direction
• wrap: if there there is no more space in the track a new track is started
• grow: if set on an item it will grow to fill the remaining space on the track. The available space will be distributed
among items respective to the their grow value (larger value means more space)
• gap: the space between the rows and columns or the items on a track
6.1.3 Simple interface
With the following functions you can set a Flex layout on any parent.
409
Flex flow
lv_obj_set_flex_flow(obj, flex_flow)
The possible values for flex_flow are:
• LV_FLEX_FLOW_ROW Place the children in a row without wrapping
• LV_FLEX_FLOW_COLUMN Place the children in a column without wrapping
• LV_FLEX_FLOW_ROW_WRAP Place the children in a row with wrapping
• LV_FLEX_FLOW_COLUMN_WRAP Place the children in a column with wrapping
• LV_FLEX_FLOW_ROW_REVERSE Place the children in a row without wrapping but in reversed order
• LV_FLEX_FLOW_COLUMN_REVERSE Place the children in a column without wrapping but in reversed order
• LV_FLEX_FLOW_ROW_WRAP_REVERSE Place the children in a row without wrapping but in reversed order
• LV_FLEX_FLOW_COLUMN_WRAP_REVERSE Place the children in a column without wrapping but in reversed
order
Flex align
To manage the placement of the children use lv_obj_set_flex_align(obj, main_place,

cross_place, track_cross_place)
• main_place determines how to distribute the items in their track on the main axis. E.g. flush the items to the
right on LV_FLEX_FLOW_ROW_WRAP. (It's called justify-content in CSS)
• cross_place determines how to distribute the items in their track on the cross axis. E.g. if the items have
different height place them to the bottom of the track. (It's called align-items in CSS)
• track_cross_place determines how to distribute the tracks (It's called align-content in CSS)
The possible values are:
• LV_FLEX_ALIGN_START means left on a horizontally and top vertically. (default)
• LV_FLEX_ALIGN_END means right on a horizontally and bottom vertically
• LV_FLEX_ALIGN_CENTER simply center
• LV_FLEX_ALIGN_SPACE_EVENLY items are distributed so that the spacing between any two items (and the
space to the edges) is equal. Does not apply to track_cross_place.
• LV_FLEX_ALIGN_SPACE_AROUND items are evenly distributed in the track with equal space around them.
Note that visually the spaces aren’t equal, since all the items have equal space on both sides. The first item will have
one unit of space against the container edge, but two units of space between the next item because that next item
has its own spacing that applies. Not applies to track_cross_place.
• LV_FLEX_ALIGN_SPACE_BETWEEN items are evenly distributed in the track: first item is on the start line,
last item on the end line. Not applies to track_cross_place.
6.1. Flex 410

Flex grow
Flex grow can be used to make one or more children fill the available space on the track. If more children has grow the
available space will be distributed proportionally to the grow values. For example let's there is 400 px remaining space
and 4 object with grow:
• A with grow = 1
• B with grow = 1
• C with grow = 2
A and B will have 100 px size, and C will have 200 px size.
Flex grow can be set on a child with lv_obj_set_flex_flow(child, value). value needs to be > 1 or 0
to disable grow on the child.
6.1.4 Style interface
All the Flex-related values are style properties under the hood and you can use them similarly to any other style property.
The following flex related style properties exist:
• FLEX_FLOW
• FLEX_MAIN_PLACE
• FLEX_CROSS_PLACE
• FLEX_TRACK_PLACE
• FLEX_GROW
RTL
If the base direction of the container is set the LV_BASE_DIR_RTL the meaning of LV_FLEX_ALIGN_START and
LV_FLEX_ALIGN_END is swapped on ROW layouts. I.e. START will mean right.
The items on ROW layouts, and tracks of COLUMN layouts will be placed from right to left.
New track
You can force Flex to put an item into a new line with lv_obj_add_flag(child,
LV_OBJ_FLAG_FLEX_IN_NEW_TRACK).
6.1. Flex 411

6.1.6 Example
A simple row and a column layout with flexbox
#if LV_USE_FLEX && LV_BUILD_EXAMPLES
/**
* A simple row and a column layout with flexbox
*/
void lv_example_flex_1(void)
{
/*Create a container with ROW flex direction*/
lv_obj_t * cont_row = lv_obj_create(lv_scr_act());
lv_obj_set_size(cont_row, 300, 75);
lv_obj_align(cont_row, LV_ALIGN_TOP_MID, 0, 5);
lv_obj_set_flex_flow(cont_row, LV_FLEX_FLOW_ROW);
/*Create a container with COLUMN flex direction*/

lv_obj_t * cont_col = lv_obj_create(lv_scr_act());
lv_obj_set_size(cont_col, 200, 150);
lv_obj_align_to(cont_col, cont_row, LV_ALIGN_OUT_BOTTOM_MID, 0, 5);
lv_obj_set_flex_flow(cont_col, LV_FLEX_FLOW_COLUMN);
uint32_t i;
for(i = 0; i < 10; i++) {
lv_obj_t * obj;
lv_obj_t * label;
/*Add items to the row*/

obj= lv_btn_create(cont_row);
lv_obj_set_size(obj, 100, LV_PCT(100));
label = lv_label_create(obj);
lv_label_set_text_fmt(label, "Item: %d", i);
/*Add items to the column*/

obj = lv_btn_create(cont_col);
lv_obj_set_size(obj, LV_PCT(100), LV_SIZE_CONTENT);
}
}
#endif
6.1. Flex 412

Arrange items in rows with wrap and even spacing
/**
* Arrange items in rows with wrap and place the items to get even space around them.
*/
{
lv_style_set_flex_flow(&style, LV_FLEX_FLOW_ROW_WRAP);
lv_style_set_flex_main_place(&style, LV_FLEX_ALIGN_SPACE_EVENLY);
lv_style_set_layout(&style, LV_LAYOUT_FLEX);

lv_obj_add_style(cont, &style, 0);
uint32_t i;
for(i = 0; i < 8; i++) {
lv_obj_t * obj = lv_obj_create(cont);
lv_obj_set_size(obj, 70, LV_SIZE_CONTENT);

}
}
#endif
Demonstrate flex grow
/**
* Demonstrate flex grow.
*/
{
lv_obj_set_flex_flow(cont, LV_FLEX_FLOW_ROW);
lv_obj_t * obj;
obj = lv_obj_create(cont);
lv_obj_set_size(obj, 40, 40); /*Fix size*/
6.1. Flex 413


lv_obj_set_flex_grow(obj, 1); /*1 portion from the free space*/
lv_obj_set_flex_grow(obj, 2); /*2 portion from the free space*/
lv_obj_set_size(obj, 40, 40); /*Fix size. It is flushed to the right by␣
,→the "grow" items*/
#endif
Demonstrate flex grow.
/**
* Reverse the order of flex items
*/
{

lv_obj_set_flex_flow(cont, LV_FLEX_FLOW_COLUMN_REVERSE);
uint32_t i;
for(i = 0; i < 6; i++) {

}
}
#endif
Demonstrate column and row gap style properties
static void row_gap_anim(void * obj, int32_t v)

{
lv_obj_set_style_pad_row(obj, v, 0);
}
6.1. Flex 414


static void column_gap_anim(void * obj, int32_t v)
{
lv_obj_set_style_pad_column(obj, v, 0);
}
/**
* Demonstrate the effect of column and row gap style properties
*/
{
uint32_t i;
for(i = 0; i < 9; i++) {

}
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, cont);
lv_anim_set_exec_cb(&a, row_gap_anim);
lv_anim_start(&a);
lv_anim_set_exec_cb(&a, column_gap_anim);
lv_anim_start(&a);
}
#endif
RTL base direction changes order of the items
/**
* RTL base direction changes order of the items.
* Also demonstrate how horizontal scrolling works with RTL.
*/
6.1. Flex 415


{
lv_obj_set_style_base_dir(cont, LV_BASE_DIR_RTL, 0);
uint32_t i;
for(i = 0; i < 20; i++) {

}
}
#endif
MicroPython
No examples yet.
6.1.7 API
Enums
enum lv_flex_align_t
Values:
enumerator LV_FLEX_ALIGN_START
enumerator LV_FLEX_ALIGN_END
enumerator LV_FLEX_ALIGN_CENTER
enumerator LV_FLEX_ALIGN_SPACE_EVENLY
enumerator LV_FLEX_ALIGN_SPACE_AROUND
enumerator LV_FLEX_ALIGN_SPACE_BETWEEN
enum lv_flex_flow_t
Values:
enumerator LV_FLEX_FLOW_ROW
enumerator LV_FLEX_FLOW_COLUMN
enumerator LV_FLEX_FLOW_ROW_WRAP
enumerator LV_FLEX_FLOW_ROW_REVERSE
enumerator LV_FLEX_FLOW_ROW_WRAP_REVERSE
enumerator LV_FLEX_FLOW_COLUMN_WRAP
6.1. Flex 416

enumerator LV_FLEX_FLOW_COLUMN_REVERSE
enumerator LV_FLEX_FLOW_COLUMN_WRAP_REVERSE
Functions
LV_EXPORT_CONST_INT(LV_OBJ_FLAG_FLEX_IN_NEW_TRACK)
void lv_flex_init(void)
Initialize a felx layout the default values
Parameters flex -- pointer to a flex layout descriptor
void lv_obj_set_flex_flow(lv_obj_t *obj, lv_flex_flow_t flow)
Set hot the item should flow
Parameters
• flex -- pointer to a flex layout descriptor
• flow -- an element of lv_flex_flow_t.
void lv_obj_set_flex_align(lv_obj_t *obj, lv_flex_align_t main_place, lv_flex_align_t cross_place,
lv_flex_align_t track_cross_place)
Set how to place (where to align) the items an tracks
Parameters
• flex -- pointer: to a flex layout descriptor
• main_place -- where to place the items on main axis (in their track). Any value of
lv_flex_align_t.
• cross_place -- where to place the item in their track on the cross axis.
LV_FLEX_ALIGN_START/END/CENTER
• track_place -- where to place the tracks in the cross direction. Any value of
lv_flex_align_t.
void lv_obj_set_flex_grow(lv_obj_t *obj, uint8_t grow)
Sets the width or height (on main axis) to grow the object in order fill the free space
Parameters
• obj -- pointer to an object. The parent must have flex layout else nothing will happen.
• grow -- a value to set how much free space to take proportionally to other growing items.
void lv_style_set_flex_flow(lv_style_t *style, lv_flex_flow_t value)
void lv_style_set_flex_main_place(lv_style_t *style, lv_flex_align_t value)
void lv_style_set_flex_cross_place(lv_style_t *style, lv_flex_align_t value)
void lv_style_set_flex_track_place(lv_style_t *style, lv_flex_align_t value)
void lv_style_set_flex_grow(lv_style_t *style, uint8_t value)
6.1. Flex 417

void lv_obj_set_style_flex_flow(lv_obj_t *obj, lv_flex_flow_t value, lv_style_selector_t selector)
void lv_obj_set_style_flex_main_place(lv_obj_t *obj, lv_flex_align_t value, lv_style_selector_t

selector)
void lv_obj_set_style_flex_cross_place(lv_obj_t *obj, lv_flex_align_t value, lv_style_selector_t

selector)
void lv_obj_set_style_flex_track_place(lv_obj_t *obj, lv_flex_align_t value, lv_style_selector_t

selector)
void lv_obj_set_style_flex_grow(lv_obj_t *obj, uint8_t value, lv_style_selector_t selector)
static inline lv_flex_flow_t lv_obj_get_style_flex_flow(const lv_obj_t *obj, uint32_t part)
static inline lv_flex_align_t lv_obj_get_style_flex_main_place(const lv_obj_t *obj, uint32_t part)
static inline lv_flex_align_t lv_obj_get_style_flex_cross_place(const lv_obj_t *obj, uint32_t part)
static inline lv_flex_align_t lv_obj_get_style_flex_track_place(const lv_obj_t *obj, uint32_t part)
static inline uint8_t lv_obj_get_style_flex_grow(const lv_obj_t *obj, uint32_t part)
Variables
uint32_t LV_LAYOUT_FLEX
lv_style_prop_t LV_STYLE_FLEX_FLOW
lv_style_prop_t LV_STYLE_FLEX_MAIN_PLACE
lv_style_prop_t LV_STYLE_FLEX_CROSS_PLACE
lv_style_prop_t LV_STYLE_FLEX_TRACK_PLACE
lv_style_prop_t LV_STYLE_FLEX_GROW
6.2 Grid
6.2.1 Overview
The Grid layout is a subset of CSS Flexbox.

It can arrange items into 2D "table" that has rows or columns (tracks). The item can span through multiple columns or
rows. The track's size can be set in pixel, to the largest item (LV_GRID_CONTENT) or in "Free unit" (FR) to distribute
the free space proportionally.
To make an object a grid container call lv_obj_set_layout(obj, LV_LAYOUT_GRID).
6.2. Grid 418

Note that the grid layout feature of LVGL needs to be globally enabled with LV_USE_GRID in lv_conf.h.
6.2.2 Terms
• tracks: the rows or columns

• free unit (FR): if set on track's size is set in FR it will grow to fill the remaining space on the parent.
• gap: the space between the rows and columns or the items on a track
6.2.3 Simple interface
With the following functions you can easily set a Grid layout on any parent.
Grid descriptors
First you need to describe the size of rows and columns. It can be done by declaring 2 arrays and the track sizes in them.
The last element must be LV_GRID_TEMPLATE_LAST.
For example:
static lv_coord_t column_dsc[] = {100, 400, LV_GRID_TEMPLATE_LAST}; /*2 columns␣

,→with 100 and 400 ps width*/
static lv_coord_t row_dsc[] = {100, 100, 100, LV_GRID_TEMPLATE_LAST}; /*3 100 px tall␣
,→rows*/
To set the descriptors on a parent use lv_obj_set_grid_dsc_array(obj, col_dsc, row_dsc).

Besides simple settings the size in pixel you can use two special values:
• LV_GRID_CONTENT set the width to the largest children on this track
• LV_GRID_FR(X) tell what portion of the remaining space should be used by this track. Larger value means
larger space.
Grid items
By default the children are not added to the grid. They need to be added manually to a cell.
To do this call lv_obj_set_grid_cell(child, column_align, column_pos, column_span,
row_align, row_pos, row_span).
column_align and row_align determine how to align the children in its cell. The possible values are:
• LV_GRID_ALIGN_START means left on a horizontally and top vertically. (default)
• LV_GRID_ALIGN_END means right on a horizontally and bottom vertically
• LV_GRID_ALIGN_CENTER simply center
colum_pos and row_pos means the zero based index of the cell into the item should be placed.
colum_span and row_span means how many tracks should the item involve from the start cell. Must be > 1.
6.2. Grid 419

Grid align
If there are some empty space the track can be aligned several ways:
• LV_GRID_ALIGN_START means left on a horizontally and top vertically. (default)
• LV_GRID_ALIGN_END means right on a horizontally and bottom vertically
• LV_GRID_ALIGN_CENTER simply center
• LV_GRID_ALIGN_SPACE_EVENLY items are distributed so that the spacing between any two items (and the
space to the edges) is equal. Not applies to track_cross_place.
• LV_GRID_ALIGN_SPACE_AROUND items are evenly distributed in the track with equal space around them.
Note that visually the spaces aren’t equal, since all the items have equal space on both sides. The first item will have
one unit of space against the container edge, but two units of space between the next item because that next item
has its own spacing that applies. Not applies to track_cross_place.
• LV_GRID_ALIGN_SPACE_BETWEEN items are evenly distributed in the track: first item is on the start line,
last item on the end line. Not applies to track_cross_place.
To set the track's alignment use lv_obj_set_grid_align(obj, column_align, row_align).
6.2.4 Style interface
All the Grid related values are style properties under the hood and you can use them similarly to any other style properties.
The following Grid related style properties exist:
• GRID_COLUMN_DSC_ARRAY
• GRID_ROW_DSC_ARRAY
• GRID_COLUMN_ALIGN
• GRID_ROW_ALIGN
• GRID_CELL_X_ALIGN
• GRID_CELL_COLUMN_POS
• GRID_CELL_COLUMN_SPAN
• GRID_CELL_Y_ALIGN
• GRID_CELL_ROW_POS
• GRID_CELL_ROW_SPAN
RTL
If the base direction of the container is set to LV_BASE_DIR_RTL, the meaning of LV_GRID_ALIGN_START and
LV_GRID_ALIGN_END is swapped. I.e. START will mean right-most.
The columns will be placed from right to left.
6.2. Grid 420

6.2.6 Example
A simple grid
#if LV_USE_GRID && LV_BUILD_EXAMPLES
/**
* A simple grid
*/
void lv_example_grid_1(void)
{
static lv_coord_t col_dsc[] = {70, 70, 70, LV_COORD_MAX};
static lv_coord_t row_dsc[] = {50, 50, 50, LV_COORD_MAX};
/*Create a container with grid*/

lv_obj_set_style_grid_column_dsc_array(cont, col_dsc, 0);
lv_obj_set_style_grid_row_dsc_array(cont, row_dsc, 0);
lv_obj_set_layout(cont, LV_LAYOUT_GRID);
lv_obj_t * label;
lv_obj_t * obj;
uint32_t i;
for(i = 0; i < 9; i++) {
uint8_t col = i % 3;
uint8_t row = i / 3;
obj = lv_btn_create(cont);
/*Stretch the cell horizontally and vertically too
*Set span to 1 to make the cell 1 column/row sized*/
lv_obj_set_grid_cell(obj, LV_GRID_ALIGN_STRETCH, col, 1,
LV_GRID_ALIGN_STRETCH, row, 1);
lv_label_set_text_fmt(label, "c%d, r%d", col, row);
}
}
#endif
6.2. Grid 421

Demonstrate cell placement and span
/**
* Demonstrate cell placement and span
*/
{
static lv_coord_t col_dsc[] = {70, 70, 70, LV_GRID_TEMPLATE_LAST};
static lv_coord_t row_dsc[] = {50, 50, 50, LV_GRID_TEMPLATE_LAST};

lv_obj_set_grid_dsc_array(cont, col_dsc, row_dsc);
lv_obj_t * label;
lv_obj_t * obj;
/*Cell to 0;0 and align to to the start (left/top) horizontally and vertically␣
,→too*/
lv_obj_set_size(obj, LV_SIZE_CONTENT, LV_SIZE_CONTENT);
lv_obj_set_grid_cell(obj, LV_GRID_ALIGN_START, 0, 1,
LV_GRID_ALIGN_START, 0, 1);
lv_label_set_text(label, "c0, r0");
/*Cell to 1;0 and align to to the start (left) horizontally and center vertically␣
,→too*/
LV_GRID_ALIGN_CENTER, 0, 1);
/*Cell to 2;0 and align to to the start (left) horizontally and end (bottom)␣
,→vertically too*/
LV_GRID_ALIGN_END, 0, 1);
/*Cell to 1;1 but 2 column wide (span = 2).Set width and height to stretched.*/
lv_obj_set_grid_cell(obj, LV_GRID_ALIGN_STRETCH, 1, 2,
LV_GRID_ALIGN_STRETCH, 1, 1);
lv_label_set_text(label, "c1-2, r1");
6.2. Grid 422

/*Cell to 0;1 but 2 rows tall (span = 2).Set width and height to stretched.*/
lv_obj_set_grid_cell(obj, LV_GRID_ALIGN_STRETCH, 0, 1,
LV_GRID_ALIGN_STRETCH, 1, 2);
lv_label_set_text(label, "c0\nr1-2");
}
#endif
Demonstrate grid's "free unit"
/**
* Demonstrate grid's "free unit"
*/
{
/*Column 1: fix width 60 px
*Column 2: 1 unit from the remaining free space
*Column 3: 2 unit from the remaining free space*/
static lv_coord_t col_dsc[] = {60, LV_GRID_FR(1), LV_GRID_FR(2), LV_GRID_TEMPLATE_
,→LAST};
/*Row 1: fix width 50 px

*Row 2: 1 unit from the remaining free space
*Row 3: fix width 50 px*/
static lv_coord_t row_dsc[] = {50, LV_GRID_FR(1), 50, LV_GRID_TEMPLATE_LAST};

lv_obj_t * label;
lv_obj_t * obj;
uint32_t i;
for(i = 0; i < 9; i++) {
lv_label_set_text_fmt(label, "%d,%d", col, row);
6.2. Grid 423


}
}
#endif
Demonstrate track placement
/**
* Demonstrate track placement
*/
{
/*Add space between the columns and move the rows to the bottom (end)*/

lv_obj_set_grid_align(cont, LV_GRID_ALIGN_SPACE_BETWEEN, LV_GRID_ALIGN_END);
lv_obj_t * label;
lv_obj_t * obj;
uint32_t i;
for(i = 0; i < 9; i++) {
}
}
#endif
6.2. Grid 424

Demonstrate column and row gap
static void row_gap_anim(void * obj, int32_t v)

{
lv_obj_set_style_pad_row(obj, v, 0);
}
static void column_gap_anim(void * obj, int32_t v)

{
lv_obj_set_style_pad_column(obj, v, 0);
}
/**
* Demonstrate column and row gap
*/
{
/*60x60 cells*/

lv_obj_t * label;
lv_obj_t * obj;
uint32_t i;
for(i = 0; i < 9; i++) {
}
lv_anim_t a;
lv_anim_init(&a);
lv_anim_set_var(&a, cont);
lv_anim_set_exec_cb(&a, row_gap_anim);
lv_anim_start(&a);
6.2. Grid 425


lv_anim_set_exec_cb(&a, column_gap_anim);
lv_anim_start(&a);
}
#endif
Demonstrate RTL direction on grid
/**
* Demonstrate RTL direction on grid
*/
{


lv_obj_set_style_base_dir(cont, LV_BASE_DIR_RTL, 0);
lv_obj_t * label;
lv_obj_t * obj;
uint32_t i;
for(i = 0; i < 9; i++) {
}
}
#endif
6.2. Grid 426

MicroPython
No examples yet.
6.2.7 API
Enums
enum lv_grid_align_t
Values:
enumerator LV_GRID_ALIGN_START
enumerator LV_GRID_ALIGN_CENTER
enumerator LV_GRID_ALIGN_END
enumerator LV_GRID_ALIGN_STRETCH
enumerator LV_GRID_ALIGN_SPACE_EVENLY
enumerator LV_GRID_ALIGN_SPACE_AROUND
enumerator LV_GRID_ALIGN_SPACE_BETWEEN
Functions
LV_EXPORT_CONST_INT(LV_GRID_CONTENT)
LV_EXPORT_CONST_INT(LV_GRID_TEMPLATE_LAST)
void lv_grid_init(void)
void lv_obj_set_grid_dsc_array(lv_obj_t *obj, const lv_coord_t col_dsc[], const lv_coord_t row_dsc[])
void lv_obj_set_grid_align(lv_obj_t *obj, lv_grid_align_t column_align, lv_grid_align_t row_align)
void lv_obj_set_grid_cell(lv_obj_t *obj, lv_grid_align_t column_align, uint8_t col_pos, uint8_t col_span,

lv_grid_align_t row_align, uint8_t row_pos, uint8_t row_span)
Set the cell of an object. The object's parent needs to have grid layout, else nothing will happen
Parameters
• hor_place -- the vertical alignment in the cell. LV_GRID_START/END/CENTER/
STRETCH
• col_pos -- column ID
• col_span -- number of columns to take (>= 1)
• ver_place -- the horizontal alignment in the cell. LV_GRID_START/END/CENTER/
STRETCH
6.2. Grid 427

• row_pos -- row ID
• row_span -- number of rows to take (>= 1)
static inline lv_coord_t lv_grid_fr(uint8_t x)
Just a wrapper to LV_GRID_FR for bindings.
void lv_style_set_grid_row_dsc_array(lv_style_t *style, const lv_coord_t value[])
void lv_style_set_grid_column_dsc_array(lv_style_t *style, const lv_coord_t value[])
void lv_style_set_grid_row_align(lv_style_t *style, lv_grid_align_t value)
void lv_style_set_grid_column_align(lv_style_t *style, lv_grid_align_t value)
void lv_style_set_grid_cell_column_pos(lv_style_t *style, lv_coord_t value)
void lv_style_set_grid_cell_column_span(lv_style_t *style, lv_coord_t value)
void lv_style_set_grid_cell_row_pos(lv_style_t *style, lv_coord_t value)
void lv_style_set_grid_cell_row_span(lv_style_t *style, lv_coord_t value)
void lv_style_set_grid_cell_x_align(lv_style_t *style, lv_coord_t value)
void lv_style_set_grid_cell_y_align(lv_style_t *style, lv_coord_t value)
void lv_obj_set_style_grid_row_dsc_array(lv_obj_t *obj, const lv_coord_t value[], lv_style_selector_t

selector)
void lv_obj_set_style_grid_column_dsc_array(lv_obj_t *obj, const lv_coord_t value[],

void lv_obj_set_style_grid_row_align(lv_obj_t *obj, lv_grid_align_t value, lv_style_selector_t selector)
void lv_obj_set_style_grid_column_align(lv_obj_t *obj, lv_grid_align_t value, lv_style_selector_t

selector)
void lv_obj_set_style_grid_cell_column_pos(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_grid_cell_column_span(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_grid_cell_row_pos(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
6.2. Grid 428

void lv_obj_set_style_grid_cell_row_span(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t

selector)
void lv_obj_set_style_grid_cell_x_align(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
void lv_obj_set_style_grid_cell_y_align(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t selector)
static inline const lv_coord_t *lv_obj_get_style_grid_row_dsc_array(const lv_obj_t *obj, uint32_t

part)
static inline const lv_coord_t *lv_obj_get_style_grid_column_dsc_array(const lv_obj_t *obj, uint32_t

part)
static inline lv_grid_align_t lv_obj_get_style_grid_row_align(const lv_obj_t *obj, uint32_t part)
static inline lv_grid_align_t lv_obj_get_style_grid_column_align(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_column_pos(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_column_span(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_row_pos(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_row_span(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_x_align(const lv_obj_t *obj, uint32_t part)
static inline lv_coord_t lv_obj_get_style_grid_cell_y_align(const lv_obj_t *obj, uint32_t part)
Variables
uint32_t LV_LAYOUT_GRID
lv_style_prop_t LV_STYLE_GRID_COLUMN_DSC_ARRAY
lv_style_prop_t LV_STYLE_GRID_COLUMN_ALIGN
lv_style_prop_t LV_STYLE_GRID_ROW_DSC_ARRAY
lv_style_prop_t LV_STYLE_GRID_ROW_ALIGN
lv_style_prop_t LV_STYLE_GRID_CELL_COLUMN_POS
lv_style_prop_t LV_STYLE_GRID_CELL_COLUMN_SPAN
lv_style_prop_t LV_STYLE_GRID_CELL_X_ALIGN
lv_style_prop_t LV_STYLE_GRID_CELL_ROW_POS
lv_style_prop_t LV_STYLE_GRID_CELL_ROW_SPAN
6.2. Grid 429

lv_style_prop_t LV_STYLE_GRID_CELL_Y_ALIGN
6.2. Grid 430

CHAPTER
SEVEN
CONTRIBUTING
7.1 Introduction
Join LVGL's community and leave your footprint in the library!

There are a lot of ways to contribute to LVGL even if you are are new to the library or even new to programming.
It might be scary to make the first step but you have nothing to be afraid of. A friendly and helpful community is waiting
for you. Get to know like-minded people and make something great together.
So let's find which contribution option fits you the best and help you join the development of LVGL!
Before getting started here are some guidelines to make contribution smoother:
• Be kind and friendly.
• Be sure to read the relevant part of the documentation before posting a question.
• Ask questions in the Forum and use GitHub for development-related discussions.
• Always fill out the post or issue templates in the Forum or GitHub (or at least provide equivalent information). It
makes understanding your contribution or issue easier and you will get a useful response faster.
• If possible send an absolute minimal but buildable code example in order to reproduce the issue. Be sure it contains
all the required variable declarations, constants, and assets (images, fonts).
• Use Markdown to format your posts. You can learn it in 10 minutes.
• Speak about one thing in one issue or topic. It makes your post easier to find later for someone with the same
question.
• Give feedback and close the issue or mark the topic as solved if your question is answered.
• For non-trivial fixes and features, it's better to open an issue first to discuss the details instead of sending a pull
request directly.
• Please read and follow the Coding style guide.
431
7.2 Pull request
Merging new code into the lvgl, documentation, blog, examples, and other repositories happen via Pull requests (PR for
short). A PR is a notification like "Hey, I made some updates to your project. Here are the changes, you can add them
if you want." To do this you need a copy (called fork) of the original project under your account, make some changes
there, and notify the original repository about your updates. You can see what it looks like on GitHub for LVGL here:
https://github.com/lvgl/lvgl/pulls.
To add your changes you can edit files online on GitHub and send a new Pull request from there (recommended for
small changes) or add the updates in your favorite editor/IDE and use git to publish the changes (recommended for more
complex updates).
7.2.1 From GitHub
1. Navigate to the file you want to edit.

2. Click the Edit button in the top right-hand corner.
3. Add your changes to the file.
4. Add a commit message on the bottom of the page.
5. Click the Propose changes button.
7.2.2 From command line
The instructions describe the main lvgl repository but it works the same way for the other repositories.
1. Fork the lvgl repository. To do this click the "Fork" button in the top right corner. It will "copy" the lvgl
repository to your GitHub account (https://github.com/<YOUR_NAME>?tab=repositories)
2. Clone your forked repository.
3. Add your changes. You can create a feature branch from master for the updates: git checkout -b the-
new-feature
4. Commit and push your changes to the forked lvgl repository.
5. Create a PR on GitHub from the page of your lvgl repository (https://github.com/<YOUR_NAME>/
lvgl) by clicking the "New pull request" button. Don't forget to select the branch where you added your changes.
6. Set the base branch. It means where you want to merge your update. In the lvgl repo fixes go to master, new
features to dev branch.
7. Describe what is in the update. An example code is welcome if applicable.
8. If you need to make more changes, just update your forked lvgl repo with new commits. They will automatically
appear in the PR.
7.2. Pull request 432

7.3 Developer Certification of Origin (DCO)
7.3.1 Overview
To ensure all licensing criteria are met for every repository of the LVGL project, we apply a process called DCO (Devel-
oper's Certificate of Origin).
The text of DCO can be read here: https://developercertificate.org/.
By contributing to any repositories of the LVGL project you agree that your contribution complies with the DCO.
If your contribution fulfills the requirements of the DCO no further action is needed. If you are unsure feel free to ask us
in a comment.
7.3.2 Accepted licenses and copyright notices
To make the DCO easier to digest, here are some practical guides about specific cases:
Your own work
The simplest case is when the contribution is solely your own work. In this case you can just send a Pull Request without
worrying about any licensing issues.
Use code from online source
If the code you would like to add is based on an article, post or comment on a website (e.g. StackOverflow) the license
and/or rules of that site should be followed.
For example in case of StackOwerflow a notice like this can be used:
/* The original version of this code-snippet was published on StackOverflow.

* Post: http://stackoverflow.com/questions/12345
* Author: http://stackoverflow.com/users/12345/username
* The following parts of the snippet were changed:
* - Check this or that
* - Optimize performance here and there
*/
... code snippet here ...
Use MIT licensed code
As LVGL is MIT licensed, other MIT licensed code can be integrated without issues. The MIT license requires a copyright
notice be added to the derived work. Any derivative work based on MIT licensed code must copy the original work's
license file or text.
7.3. Developer Certification of Origin (DCO) 433

Use GPL licensed code
The GPL license is not compatible with the MIT license. Therefore, LVGL can not accept GPL licensed code.
7.4 Ways to contribute
Even if you're just getting started with LVGL there are plenty of ways to get your feet wet. Most of these options don't
even require knowing a single line of LVGL code.
Below we have collected some opportunities about the ways you can contribute to LVGL.
7.4.1 Give LVGL a Star
Show that you like LVGL by giving it star on GitHub!

Star
This simple click makes LVGL more visible on GitHub and makes it more attractive to other people. So with this, you
already helped a lot!
7.4.2 Tell what you have achieved
Have you already started using LVGL in a Simulator, a development board, or on your custom hardware? Was it easy or
were there some obstacles? Are you happy with the result? Showing your project to others is a win-win situation because
it increases your and LVGL's reputation at the same time.
You can post about your project on Twitter, Facebook, LinkedIn, create a YouTube video, and so on. Only one thing:
On social media don't forget to add a link to https://lvgl.io or https://github.com/lvgl and use the
hashtag #lvgl. Thank you! :)
You can also open a new topic in the My projects category of the Forum.
The LVGL Blog welcomes posts from anyone. It's a good place to talk about a project you created with LVGL, write a
tutorial, or share some nice tricks. The latest blog posts are shown on the homepage of LVGL to make your work more
visible.
The blog is hosted on GitHub. If you add a post GitHub automatically turns it into a website. See the README of the
blog repo to see how to add your post.
Any of these help to spread the word and familiarize new developers with LVGL.
If you don't want to speak about your project publicly, feel free to use Contact form on lvgl.io to private message to us.
7.4.3 Write examples
As you learn LVGL you will probably play with the features of widgets. Why not publish your experiments?
Each widgets' documentation contains examples. For instance, here are the examples of the Drop-down list widget. The
examples are directly loaded from the lvgl/examples folder.
So all you need to do is send a Pull request to the lvgl repository and follow some conventions:
• Name the examples like lv_example_<widget_name>_<index>.
• Make the example as short and simple as possible.
7.4. Ways to contribute 434

• Add comments to explain what the example does.

• Use 320x240 resolution.
• Update index.rst in the example's folder with your new example. To see how other examples are added, look
in the lvgl/examples/widgets folder.
7.4.4 Improve the docs
As you read the documentation you might see some typos or unclear sentences. All the documentation is located in the
lvgl/docs folder. For typos and straightforward fixes, you can simply edit the file on GitHub.
Note that the documentation is also formatted in Markdown.
7.4.5 Report bugs
As you use LVGL you might find bugs. Before reporting them be sure to check the relevant parts of the documentation.
If it really seems like a bug feel free to open an issue on GitHub.
When filing the issue be sure to fill out the template. It helps find the root of the problem while avoiding extensive
questions and exchanges with other developers.
7.4.6 Send fixes
The beauty of open-source software is you can easily dig in to it to understand how it works. You can also fix or adjust it
as you wish.
If you found and fixed a bug don't hesitate to send a Pull request with the fix.
In your Pull request please also add a line to CHANGELOG.md.
7.4.7 Join the conversations in the Forum
It feels great to know you are not alone if something is not working. It's even better to help others when they struggle with
something.
While you were learning LVGL you might have had questions and used the Forum to get answers. As a result, you
probably have more knowledge about how LVGL works.
One of the best ways to give back is to use the Forum and answer the questions of newcomers - like you were once.
Just read the titles and if you are familiar with the topic don't hesitate to share your thoughts and suggestions.
Participating in the discussions is one of the best ways to become part of the project and get to know like-minded people!

7.4.8 Add features
We collect the planned features in GitHub on the Roadmap page. If you are interested in any of them feel free to share
your opinion and/or participate in the the implementation.
Other features which are (still) not on the road map are listed in the Feature request category of the Forum. If you have
a feature idea for LVGL please use the Forum to share it! Make sure to check that there isn't an existing post; if there is,
you should comment on it to show that there is increased interest in an existing request.
When adding a new features the followings also needs to be updated:
• Add a line to CHANGELOG.md.
• Update the documentation.
• Add an example if applicable. See this guide.
7.4.9 Become a maintainer
If you want to become part of the core development team, you can become a maintainer of a repository.
By becoming a maintainer:
• You get write access to that repo:
– Add code directly without sending a pull request
– Accept pull requests
– Close/reopen/edit issues
• Your input has higher impact when we are making decisions
You can become a maintainer by invitation, however the following conditions need to met
1. Have > 50 replies in the Forum. You can look at your stats here
2. Send > 5 non-trivial pull requests to the repo where you would like to be a maintainer
If you are interested, just send a message (e.g. from the Forum) to the current maintainers of the repository. They
will check if the prerequisites are met. Note that meeting the prerequisites is not a guarantee of acceptance, i.e. if the
conditions are met you won't automatically become a maintainer. It's up to the current maintainers to make the decision.
7.4.10 Move your project repository under LVGL organization
Besides the core lvgl repository there are other repos for ports to development boards, IDEs or other environment. If
you ported LVGL to a new platform we can host it under the LVGL organization among the other repos.
This way your project will become part of the whole LVGL project and can get more visibility. If you are interested in
this opportunity just open an issue in lvgl repo and tell what you have!
If we agree that your port fit well into the LVGL organization, we will open a repository for your project where you will
have admin rights.
To make this concept sustainable there a few rules to follow:
• You need to add a README to your repo.
• We expect to maintain the repo to some extent:
– Follow at least the major versions of LVGL
– Respond to the issues (in a reasonable time)

• If there is no activity in a repo for 1 year it will be archived

CHAPTER
EIGHT
CHANGELOG
8.1 v8.0.2 (16.07.2021)
• fix(theme) improve button focus of keyboard

• fix(tabview) send LV_EVENT_VALUE_CHANGED only once
• fix(imgbtn) use the correct src in LV_EVENT_GET_SELF_SIZE
• fix(color) remove extraneous cast for 8-bit color
• fix(obj style) fix children reposition if the parent's padding changes.
• fix(color) remove extraneous _LV_COLOR_MAKE_TYPE_HELPER (#2372)
• fix(spinner) should not be clickable (#2373)
• fix(obj) improve how the focusing indev is determined
• fix(template) update indev template for v8
• fix(printf) skip defining attribute if pycparser is used
• refactor(printf) add printf-like function attribute to _lv_txt_set_text_vfmt and lv_label_set_text_fmt (#2332)
• fix(template) include lvgl.h in lv_port_*_template.c files
• fix(obj) detecting which indev sent LV_EVENT_FOCUS
• fix (span) fill LV_EVENT_GET_SELF_SIZE (#2360)
• fix(arc) disable LV_OBJ_FLAG_SCROLL_CHAIN by default
• fix (draw) fix arc bg image drawing with full arcs
• fix(disp) fix memory leak in lv_disp_remove (#2355)
• fix warnigs introduced by 3fb8baf5
• fix(widgets) use lv_obj_class for all the widgets
• fix(obj) move clean ups from lv_obj_del to lv_obj_destructor
• fix(roller) fix partial redraw of the selected area
• fix(roller) adjust the size of the selected area correctly
• fix(obj) delete useless type conversion (#2343)
• fix(lv_obj_scroll.h) typos (#2345)
• fix(scroll) fire LV_EVENT_SCROLL_BEGIN in the same spot for both axes
438
• fix(btnmatrix) fix button invalidation on focus change

• fix(textarea) style update in oneline mode + improve sroll to cursor
• fix(tlsf) do not use <assert.h>
• fix(imgbtn) consider width==LV_SIZE_CONTENT if only mid. img is set
• fix(refr) reduce the nesting level in lv_refr_area
• fix(txt) enhance the function of break_chars (#2327)
• fix(pxp): update RTOS macro for SDK 2.10
• fix(vglite): update for v8
• fix(pxp): update for v8
• fix(flex) fix layout update and invalidation issues
• fix(flex) fix NULL pointer dereference
• fix(obj, switch) do not send LV_EVENT_VALUE_CHANGED twice
• fix(color) overflow with 16 bit color depth
• fix(coords) fix using large coordinates
• fix(chart) fix crash if no series are added
• fix(chart) invalidation with LV_CHART_UPDATE_MODE_SHIFT
• fix(align) fix lv_obj_align_to G
• fix(table) invalidate the table on cell value change
• fix(label) remove dupliacted lv_obj_refresh_self_size
• fix(draw) underflow in subpixel font drawing
• fix (scroll) do not send unnecessary scroll end events
8.2 v8.0.1 (14.06.2021)
• docs(filesystem) update to v8 7971ade4

• fix(msgbox) create modals on top layer instead of act screen 5cf6303e
• fix(colowheel) disable LV_OBJ_FLAG_SCROLL_CHAIN by default 48d1c292
• docs(grid) typo fix (#2310) 69d109d2
• fix(arduino) fix the prototype of my_touchpad_read in the LVGL_Arduino.ino 1a62f7a6
• fix(meter) fix needle image invalidation 54d8e817
• fix(mem) add lv_ prefix to tlsf functions and types 0d52b59c
• fix(calendar) fix the position calculation today ad05e196
• fix(typo) rename LV_OBJ_FLAG_SNAPABLE to LV_OBJ_FLAG_SNAPPABLE e697807c
• docs(color) language fixes (#2302) 07ecc9f1
• fix(tick) minor optmization on lv_tick_inc call test b4305df5
• Spelling and other language fixes to documentation (#2293) d0aaacaf
8.2. v8.0.1 (14.06.2021) 439

• fix(theme) show disabled state on buttons of btnmatrix, msgbox and kayboard 0be582b3
• fix(scroll) keep the scroll position on object deleted 52edbb46
• fix(msgbox) handle NULL btn map paramter 769c4a30
• fix(group) allow refocusing obejcts 1520208b
• docs(overview) spelling fixes d2efb8c6
• Merge branch 'master' of https://github.com/lvgl/lvgl 45960838
• feat(timer) check if lv_tick_inc is called aa6641a6
• feat(docs) add view on GitHub link a716ac6e
• fix(theme) fix the switch style in the default theme 0c0dc8ea
• docs fix typo 8ab80645
• Merge branch 'master' of https://github.com/lvgl/lvgl e796448f
• feat(event) pass the scroll aniamtion to LV_EVENT_SCROLL_BEGIN ca54ecfe
• fix(tabview) fix with left and right tabs 17c57449
• chore(docs) force docs rebuild 4a0f4139
• chore(docs) always deploy master to docs/master as well 6d05692d
• fix(template) udpate lv_objx_template to v8 38bb8afc
• docs(extra) add extra/README.md 8cd504d5
• Update CHANGELOG.md 48fd73d2
• Update quick-overview.md (#2295) 5616471c
• fix(pxp) change LV_COLOR_TRANSP to LV_COLOR_CHROMA_KEY to v8 compatibility 81f3068d
• adding micropython examples (#2286) c60ed68e
• docs(color) minor fix ac8f4534
• fix(example) revert test code 77e2c1ff
• fix(draw) with additive blending with 32 bit color depth 786db2af
• docs(color) update colors' docs 9056b5ee
• Merge branch 'master' of https://github.com/lvgl/lvgl a711a1dd
• perf(refresh) optimize where to wait for lv_disp_flush_ready with 2 buffers d0172f14
• docs(lv_obj_style) update add_style and remove_style function headers (#2287) 60f7bcbf
• fix memory leak of spangroup (#2285) 33e0926a
• fix make lv_img_cache.h public becasue cache invalidation is public 38ebcd81
• Merge branch 'master' of https://github.com/lvgl/lvgl 2b292495
• fix(btnmamatrix) fix focus event handling 3b58ef14
• Merge pull request #2280 from lvgl/dependabot/pip/docs/urllib3-1.26.5 a2f45b26
• fix(label) calculating the clip area 57e211cc
• chore(deps): bump urllib3 from 1.26.4 to 1.26.5 in /docs b2f77dfc
• fix(docs) add docs about the default group 29bfe604
8.2. v8.0.1 (14.06.2021) 440

8.3 v8.0.0 (01.06.2021)
v8.0 brings many new features like simplified and more powerful scrolling, new layouts inspired by CSS Flexbox and
Grid, simplified and improved widgets, more powerful events, hookable drawing, and more.
v8 is a major change and therefore it's not backward compatible with v7.
8.3.1 Directory structure
• The lv_ prefix is removed from the folder names

• The docs is moved to the lvgl repository
• The examples are moved to the lvgl repository
• Create an src/extra folder for complex widgets:
– It makes the core LVGL leaner
– In extra we can have a lot and specific widgets
– Good place for contributions
8.3.2 Widget changes
• lv_cont removed, layout features are moved to lv_obj

• lv_page removed, scroll features are moved to lv_obj
• lv_objmask the same can be achieved by events
• lv_meter added as the unioin of lv_linemeter and lv_gauge
• lv_span new widget mimicing HTML <span>
• lv_animing new widget for simple slideshow animations
• + many minor changes and improvements
8.3.3 New scrolling
• Support "elastic" scrolling when scrolled in

• Support scroll chaining among any objects types (not only lv_pagess)
• Remove lv_drag. Similar effect can be achieved by setting the position in LV_EVENT_PRESSING
• Add snapping
• Add snap stop to scroll max 1 snap point
8.3. v8.0.0 (01.06.2021) 441

8.3.4 New layouts
• CSS Grid-like layout support

• CSS Flexbox-like layout support
8.3.5 Styles
• Optimize and simplify styles

• State is saved in the object instead of the style property
• Object size and position can be set in styles too
8.3.6 Events
• Allow adding multiple events to an object

• A user_data can be attached to the added events
8.3.7 Driver changes
• lv_disp_drv_t, lv_indev_drv_t, lv_fs_drv_t needs to be static

• ...disp_buf... is renamed to draw_buf. See an initialization example here.
• No partial update if two screen sized buffers are set
• disp_drv->full_refresh = 1 makes always the whole display redraw.
• hor_res and ver_res need to be set in disp_drv
• indev_read_cb returns void. To indicate that there is more that to read set data->continue_reading
= 1 in the read_cb
8.3.8 Other changes
• Remove the copy parameter from create functions

• Simplified File system interface API
• Use a more generic inheritance
• The built-in themes are reworked
• lv_obj_align now saved the alignment and realigns the object automatically but can't be used to align to other
than the parent
• lv_obj_align_to can align to an object but doesn't save the alignment
• lv_pct(x) can be used to set the size and position in percentage
• There are many other changes in widgets that are not detailed here. Please refer to the documentation of the
widgets.
8.3. v8.0.0 (01.06.2021) 442

8.3.9 New release policy
• We will follow Release branches with GitLab flow

• Minor releases are expected in every 3-4 month
• master will always contain the latest changes
8.3.10 Migrating from v7 to v8
• First and foremost, create a new lv_conf.h based on lv_conf_template.h.

• To try the new version it's recommended to use a simulator project and see the examples.
• When migrating your project to v8
– Update the drivers are described above
– Update the styles
– Update the events
– Use the new layouts instead of lv_cont features
– Use lv_obj instead of lv_page
– The other parts are mainly minor renames and refactoring. See the functions' documentation for descriptions.
8.4 v7.11.0 (16.03.2021)
8.4.1 New features
• Add better screen orientation management with software rotation support

• Decide text animation's direction based on base_dir (when using LV_USE_BIDI)
8.4.2 Bugfixes
• fix(gauge) fix needle invalidation

• fix(bar) correct symmetric handling for vertical sliders
8.5 v7.10.1 (16.02.2021)
8.5.1 Bugfixes
• fix(draw) overlap outline with background to prevent aliasing artifacts

• fix(indev) clear the indev's act_obj in lv_indev_reset
• fix(text) fix out of bounds read in _lv_txt_get_width
• fix(list) scroll list when button is focused using LV_KEY_NEXT/PREV
• fix(text) improve Arabic contextual analysis by adding hyphen processing and proper handling of lam-alef sequence
8.4. v7.11.0 (16.03.2021) 443

• fix(delete) delete animation after the children are deleted

• fix(gauge) consider paddings for needle images
8.6 v7.10.0 (02.02.2021)
8.6.1 New features
• feat(indev) allow input events to be passed to disabled objects

• feat(spinbox) add inline get_step function for MicroPython support
8.6.2 Bugfixes
• fix(btnmatrix) fix lv_btnmatrix_get_active_btn_text() when used in a group
8.7 v7.9.1 (19.01.2021)
8.7.1 Bugfixes
• fix(cpicker) fix division by zero

• fix(dropdown) fix selecting options after the last one
• fix(msgbox) use the animation time provided
• fix(gpu_nxp_pxp) fix incorrect define name
• fix(indev) don't leave edit mode if there is only one object in the group
• fix(draw_rect) fix draw pattern stack-use-after-scope error
8.8 v7.9.0 (05.01.2021)
8.8.1 New features
• feat(chart) add lv_chart_remove_series and lv_chart_hide_series

• feat(img_cahce) allow disabling image caching
• calendar: make get_day_of_week() public
• Added support for Zephyr integration
8.6. v7.10.0 (02.02.2021) 444

8.8.2 Bugfixes
• fix(draw_rect) free buffer used for arabic processing

• fix(win) arabic process the title of the window
• fix(dropdown) arabic process the option in lv_dropdown_add_option
• fix(textarea) buffer overflow in password mode with UTF-8 characters
• fix(textarea) cursor position after hiding character in password mode
• fix(linemeter) draw critical lines with correct color
• fix(lv_conf_internal) be sure Kconfig defines are always uppercase
• fix(kconfig) handle disable sprintf float correctly.
• fix(layout) stop layout after recursion threshold is reached
• fix(gauge) fix redraw with image needle
8.9 v7.8.1 (15.12.2020)
8.9.1 Bugfixes
• fix(lv_scr_load_anim) fix when multiple screen are loaded at tsame time with delay
• fix(page) fix LV_SCOLLBAR_MODE_DRAG
8.10 v7.8.0 (01.12.2020)
8.10.1 New features
• make DMA2D non blocking

• add unscii-16 built-in font
• add KConfig
• add lv_refr_get_fps_avg()
8.10.2 Bugfixes
• fix(btnmatrix) handle arabic texts in button matrices

• fix(indev) disabled object shouldn't absorb clicks but let the parent to be clicked
• fix(arabic) support processing again already processed texts with _lv_txt_ap_proc
• fix(textarea) support Arabic letter connections
• fix(dropdown) support Arabic letter connections
• fix(value_str) support Arabic letter connections in value string property
• fix(indev) in LV_INDEV_TYPE_BUTTON recognize 1 cycle long presses too
• fix(arc) make arc work with encoder
8.9. v7.8.1 (15.12.2020) 445

• fix(slider) adjusting the left knob too with encoder

• fix reference to LV_DRAW_BUF_MAX_NUM in lv_mem.c
• fix(polygon draw) join adjacent points if they are on the same coordinate
• fix(linemeter) fix invalidation when setting new value
• fix(table) add missing invalidation when changing cell type
• refactor(roller) rename LV_ROLLER_MODE_INIFINITE -> LV_ROLLER_MODE_INFINITE
8.11 v7.7.2 (17.11.2020)
8.11.1 Bugfixes
• fix(draw_triangle): fix polygon/triangle drawing when the order of points is counter-clockwise

• fix(btnmatrix): fix setting the same map with modified pointers
• fix(arc) fix and improve arc dragging
• label: Repair calculate back dot character logical error which cause infinite loop.
• fix(theme_material): remove the bottom border from tabview header
• fix(imgbtn) guess a the closest available state with valid src
• fix(spinbox) update cursor position in lv_spinbox_set_step
8.12 v7.7.1 (03.11.2020)
8.12.1 Bugfixes
• Respect btnmatrix's one_check in lv_btnmatrix_set_btn_ctrl

• Gauge: make the needle images to use the styles from LV_GAUGE_PART_PART
• Group: fix in lv_group_remove_obj to handle deleting hidden obejcts correctly
8.13 v7.7.0 (20.10.2020)
8.13.1 New features
• Add PXP GPU support (for NXP MCUs)

• Add VG-Lite GPU support (for NXP MCUs)
• Allow max. 16 cell types for table
• Add lv_table_set_text_fmt()
• Use margin on calendar header to set distances and padding to the size of the header
• Add text_sel_bg style property
8.11. v7.7.2 (17.11.2020) 446

8.13.2 Bugfixes
• Theme update to support text selection background

• Fix imgbtn state change
• Support RTL in table (draw columns right to left)
• Support RTL in pretty layout (draw columns right to left)
• Skip objects in groups if they are in disabled state
• Fix dropdown selection with RTL basedirection
• Fix rectangle border drawing with large width
• Fix lv_win_clean()
8.14 v7.6.1 (06.10.2020)
8.14.1 Bugfixes
• Fix BIDI support in dropdown list

• Fix copying base dir in lv_obj_create
• Handle sub pixel rendering in font loader
• Fix transitions with style caching
• Fix click focus
• Fix imgbtn image switching with empty style
• Material theme: do not set the text font to allow easy global font change
8.15 v7.6.0 (22.09.2020)
8.15.1 New features
• Check whether any style property has changed on a state change to decide if any redraw is required
8.15.2 Bugfixes
• Fix selection of options with non-ASCII letters in dropdown list

• Fix font loader to support LV_FONT_FMT_TXT_LARGE
8.14. v7.6.1 (06.10.2020) 447

8.16 v7.5.0 (15.09.2020)
8.16.1 New features
• Add clean_dcache_cb and lv_disp_clean_dcache to enable users to use their own cache management
function
• Add gpu_wait_cb to wait until the GPU is working. It allows to run CPU a wait only when the rendered data
is needed.
• Add 10px and 8ox built in fonts
8.16.2 Bugfixes
• Fix unexpected DEFOCUS on lv_page when clicking to bg after the scrollable

• Fix lv_obj_del and lv_obj_clean if the children list changed during deletion.
• Adjust button matrix button width to include padding when spanning multiple units.
• Add rounding to btnmatrix line height calculation
• Add decmopr_buf to GC roots
• Fix divisioin by zero in draw_pattern (lv_draw_rect.c) if the image or letter is not found
• Fix drawing images with 1 px height or width
8.17 v7.4.0 (01.09.2020)
The main new features of v7.4 are run-time font loading, style caching and arc knob with value setting by click.
8.17.1 New features
• Add lv_font_load() function - Loads a lv_font_t object from a binary font file
• Add lv_font_free() function - Frees the memory allocated by the lv_font_load() function
• Add style caching to reduce access time of properties with default value
• arc: add set value by click feature
• arc: add LV_ARC_PART_KNOB similarly to slider
• send gestures event if the object was dragged. User can check dragging with
lv_indev_is_dragging(lv_indev_act()) in the event function.
8.16. v7.5.0 (15.09.2020) 448

8.17.2 Bugfixes
• Fix color bleeding on border drawing

• Fix using 'LV_SCROLLBAR_UNHIDE' after 'LV_SCROLLBAR_ON'
• Fix croping of last column/row if an image is zoomed
• Fix zooming and rotateing mosaic images
• Fix deleting tabview with LEFT/RIGHT tab position
• Fix btnmatrix to not send event when CLICK_TRIG = true and the cursor slid from a pressed button
• Fix roller width if selected text is larger than the normal
8.18 v7.3.1 (18.08.2020)
8.18.1 Bugfixes
• Fix drawing value string twice

• Rename lv_chart_clear_serie to lv_chart_clear_series and lv_obj_align_origo to
lv_obj_align_mid
• Add linemeter's mirror feature again
• Fix text decor (udnerline strikethrough) with older versions of font converter
• Fix setting local style property multiple times
• Add missing background drawing and radius handling to image button
• Allow adding extra label to list buttons
• Fix crash if lv_table_set_col_cnt is called before lv_table_set_row_cnt for the first time
• Fix overflow in large image transformations
• Limit extra button click area of button matrix's buttons. With large paddings it was counter intuitive. (Gaps are
mapped to button when clicked).
• Fix lv_btnmatrix_set_one_check not forcing exactly one button to be checked
• Fix color picker invalidation in rectangle mode
• Init disabled days to gray color in calendar
8.19 v7.3.0 (04.08.2020)
8.19.1 New features
• Add lv_task_get_next
• Add lv_event_send_refresh, lv_event_send_refresh_recursive to easily send
LV_EVENT_REFRESH to object
• Add lv_tabview_set_tab_name() function - used to change a tab's name
8.18. v7.3.1 (18.08.2020) 449

• Add LV_THEME_MATERIAL_FLAG_NO_TRANSITION and LV_THEME_MATERIAL_FLAG_NO_FOCUS

flags
• Reduce code size by adding: LV_USE_FONT_COMPRESSED and LV_FONT_USE_SUBPX and applying some
optimization
• Add LV_MEMCPY_MEMSET_STD to use standard memcpy and memset
8.19.2 Bugfixes
• Do not print warning for missing glyph if its height OR width is zero.
• Prevent duplicated sending of LV_EVENT_INSERT from text area
• Tidy outer edges of cpicker widget.
• Remove duplicated lines from lv_tabview_add_tab
• btnmatrix: hadle combined states of buttons (e.g. chacked + disabled)
• textarea: fix typo in lv_textarea_set_sscrollbar_mode
• gauge: fix image needle drawing
• fix using freed memory in _lv_style_list_remove_style
8.20 v7.2.0 (21.07.2020)
8.20.1 New features
• Add screen transitions with lv_scr_load_anim()

• Add display background color, wallpaper and opacity. Shown when the screen is transparent. Can be used with
lv_disp_set_bg_opa/color/image().
• Add LV_CALENDAR_WEEK_STARTS_MONDAY
• Add lv_chart_set_x_start_point() function - Set the index of the x-axis start point in the data array
• Add lv_chart_set_ext_array() function - Set an external array of data points to use for the chart
• Add lv_chart_set_point_id() function - Set an individual point value in the chart series directly based
on index
• Add lv_chart_get_x_start_point() function - Get the current index of the x-axis start point in the data
array
• Add lv_chart_get_point_id() function - Get an individual point value in the chart series directly based
on index
• Add ext_buf_assigned bit field to lv_chart_series_t structure - it's true if external buffer is assigned
to series
• Add lv_chart_set_series_axis() to assign series to primary or secondary axis
• Add lv_chart_set_y_range() to allow setting range of secondary y axis (based on
lv_chart_set_range but extended with an axis parameter)
• Allow setting different font for the selected text in lv_roller
8.20. v7.2.0 (21.07.2020) 450

• Add theme->apply_cb to replace theme->apply_xcb to make it compatible with the MicroPython bind-
ing
• Add lv_theme_set_base() to allow easy extension of built-in (or any) themes
• Add lv_obj_align_x() and lv_obj_align_y() functions
• Add lv_obj_align_origo_x() and lv_obj_align_origo_y() functions
8.20.2 Bugfixes
• tileview fix navigation when not screen sized

• Use 14px font by default to for better compatibility with smaller displays
• linemeter fix conversation of current value to "level"
• Fix drawing on right border
• Set the cursor image non clickable by default
• Improve mono theme when used with keyboard or encoder
8.21 v7.1.0 (07.07.2020)
8.21.1 New features
• Add focus_parent attribute to lv_obj

• Allow using buttons in encoder input device
• Add lv_btnmatrix_set/get_align capability
• DMA2D: Remove dependency on ST CubeMX HAL
• Added max_used propriety to lv_mem_monitor_t struct
• In lv_init test if the strings are UTF-8 encoded.
• Add user_data to themes
• Add LV_BIG_ENDIAN_SYSTEM flag to lv_conf.h in order to fix displaying images on big endian systems.
• Add inline function lv_checkbox_get_state(const lv_obj_t * cb) to extend the checkbox functionality.
• Add inline function lv_checkbox_set_state(const lv_obj_t * cb, lv_btn_state_t state ) to extend the checkbox func-
tionality.
8.21.2 Bugfixes
• lv_img fix invalidation area when angle or zoom changes

• Update the style handling to support Big endian MCUs
• Change some methods to support big endian hardware.
• remove use of c++ keyword 'new' in parameter of function lv_theme_set_base().
• Add LV_BIG_ENDIAN_SYSTEM flag to lv_conf.h in order to fix displaying images on big endian systems.
• Fix inserting chars in text area in big endian hardware.
8.21. v7.1.0 (07.07.2020) 451

8.22 v7.0.2 (16.06.2020)
8.22.1 Bugfixes
• lv_textarea fix wrong cursor position when clicked after the last character
• Change all text related indices from 16-bit to 32-bit integers throughout whole library. #1545
• Fix gestures
• Do not call set_px_cb for transparent pixel
• Fix list button focus in material theme
• Fix crash when the a text area is cleared with the backspace of a keyboard
• Add version number to lv_conf_template.h
• Add log in true double buffering mode with set_px_cb
• lv_dropdown: fix missing LV_EVENT_VALUE_CHANGED event when used with encoder
• lv_tileview: fix if not the {0;0} tile is created first
• lv_debug: restructure to allow asserting in from lv_misc too
• add assert if _lv_mem_buf_get() fails
• lv_textarea: fix character delete in password mode
• Update LV_OPA_MIN and LV_OPA_MAX to widen the opacity processed range
• lv_btnm fix sending events for hidden buttons
• lv_gaguge make lv_gauge_set_angle_offset offset the labels and needles too
• Fix typo in the API scrllable -> scrollable
• tabview by default allow auto expanding the page only to right and bottom (#1573)
• fix crash when drawing gradient to the same color
• chart: fix memory leak
• img: improve hit test for transformed images
8.23 v7.0.1 (01.06.2020)
8.23.1 Bugfixes
• Make the Microptyhon working by adding the required variables as GC_ROOT

• Prefix some internal API functions with _ to reduce the API of LVGL
• Fix built-in SimSun CJK font
• Fix UTF-8 encoding when LV_USE_ARABIC_PERSIAN_CHARS is enabled
• Fix DMA2D usage when 32 bit images directly blended
• Fix lv_roller in infinite mode when used with encoder
• Add lv_theme_get_color_secondary()
8.22. v7.0.2 (16.06.2020) 452

• Add LV_COLOR_MIX_ROUND_OFS to adjust color mixing to make it compatible with the GPU
• Improve DMA2D blending
• Remove memcpy from lv_ll (caused issues with some optimization settings)
• lv_chart fix X tick drawing
• Fix vertical dashed line drawing
• Some additional minor fixes and formattings
8.24 v7.0.0 (18.05.2020)
8.24.1 Documentation
The docs for v7 is available at https://docs.littlevgl.com/v7/en/html/index.html
8.24.2 Legal changes
The name of the project is changed to LVGL and the new website is on https://lvgl.io
LVGL remains free under the same conditions (MIT license) and a company is created to manage LVGL and offer services.
8.24.3 New drawing system
Complete rework of LVGL's draw engine to use "masks" for more advanced and higher quality graphical effects. A
possible use-case of this system is to remove the overflowing content from the rounded edges. It also allows drawing
perfectly anti-aliased circles, lines, and arcs. Internally, the drawings happen by defining masks (such as rounded rectangle,
line, angle). When something is drawn the currently active masks can make some pixels transparent. For example,
rectangle borders are drawn by using 2 rectangle masks: one mask removes the inner part and another the outer part.
The API in this regard remained the same but some new functions were added:
• lv_img_set_zoom: set image object's zoom factor
• lv_img_set_angle: set image object's angle without using canvas
• lv_img_set_pivot: set the pivot point of rotation
The new drawing engine brought new drawing features too. They are highlighted in the "style" section.
8.24.4 New style system
The old style system is replaced with a new more flexible and lightweighted one. It uses an approach similar to CSS:
support cascading styles, inheriting properties and local style properties per object. As part of these updates, a lot of
objects were reworked and the APIs have been changed.
• more shadows options: offset and spread
• gradient stop position to shift the gradient area and horizontal gradient
• LV_BLEND_MODE_NORMAL/ADDITIVE/SUBTRACTIVE blending modes
• clip corner: crop the content on the rounded corners
• text underline and strikethrough
8.24. v7.0.0 (18.05.2020) 453

• dashed vertical and horizontal lines (dash gap, dash_width)

• outline: a border-like part drawn out of the background. Can have spacing to the background.
• pattern: display and image in the middle of the background or repeat it
• value display a text which is stored in the style. It can be used e.g. as a lighweighted text on buttons too.
• margin: similar to padding but used to keep space outside of the object
Read the Style section of the documentation to learn how the new styles system works.
8.24.5 GPU integration
To better utilize GPUs, from this version GPU usage can be integrated into LVGL. In lv_conf.h any supported GPUs
can be enabled with a single configuration option.
Right now, only ST's DMA2D (Chrom-ART) is integrated. More will in the upcoming releases.
8.24.6 Renames
The following object types are renamed:

• sw -> switch
• ta -> textarea
• cb -> checkbox
• lmeter -> linemeter
• mbox -> msgbox
• ddlist -> dropdown
• btnm -> btnmatrix
• kb -> keyboard
• preload -> spinner
• lv_objx folder -> lv_widgets
• LV_FIT_FILL -> LV_FIT_PARENT
• LV_FIT_FLOOD -> LV_FLOOD_MAX
• LV_LAYOUT_COL_L/M/R -> LV_LAYOUT_COLUMN_LEFT/MID/RIGHT
• LV_LAYOUT_ROW_T/M/B -> LV_LAYOUT_ROW_TOP/MID/BOTTOM
8.24.7 Reworked and improved object
• dropdown: Completely reworked. Now creates a separate list when opened and can be dropped to
down/up/left/right.
• label: body_draw is removed, instead, if its style has a visible background/border/shadow etc it will be drawn.
Padding really makes the object larger (not just virtually as before)
• arc: can draw bacground too.
• btn: doesn't store styles for each state because it's done naturally in the new style system.
8.24. v7.0.0 (18.05.2020) 454

• calendar: highlight the pressed datum. The used styles are changed: use LV_CALENDAR_PART_DATE nor-
mal for normal dates, checked for highlighted, focused for today, pressed for the being pressed. (checked+pressed,
focused+pressed also work)
• chart: only has LINE and COLUMN types because with new styles all the others can be described.
LV_CHART_PART_SERIES sets the style of the series. bg_opa > 0 draws an area in LINE mode.
LV_CHART_PART_SERIES_BG also added to set a different style for the series area. Padding in
LV_CHART_PART_BG makes the series area smaller, and it ensures space for axis labels/numbers.
• linemeter, gauge: can have background if the related style properties are set. Padding makes the scale/lines
smaller. scale_border_width and scale_end_border_width allow to draw an arc on the outer part of the scale lines.
• gauge: lv_gauge_set_needle_img allows use image as needle
• canvas: allow drawing to true color alpha and alpha only canvas, add lv_canvas_blur_hor/ver and
rename lv_canvas_rotate to lv_canvas_transform
• textarea: If available in the font use bullet (U+2022) character in text area password
8.24.8 New object types
• lv_objmask: masks can be added to it. The children will be masked accordingly.
8.24.9 Others
• Change the built-in fonts to Montserrat and add built-in fonts from 12 px to 48 px for every 2nd size.
• Add example CJK and Arabic/Persian/Hebrew built-in font
• Add ° and "bullet" to the built-in fonts
• Add Arabic/Persian script support: change the character according to its position in the text.
• Add playback_time to animations.
• Add repeat_count to animations instead of the current "repeat forever".
• Replace LV_LAYOUT_PRETTY with LV_LAYOUT_PRETTY_TOP/MID/BOTTOM
8.24.10 Demos
• lv_examples was reworked and new examples and demos were added
8.24.11 New release policy
• Maintain this Changelog for every release

• Save old major version in new branches. E.g. release/v6
• Merge new features and fixes directly into master and release a patch or minor releases every 2 weeks.
8.24. v7.0.0 (18.05.2020) 455

8.24.12 Migrating from v6 to v7
• First and foremost, create a new lv_conf.h based on lv_conf_template.h.

• To try the new version it suggested using a simulator project and see the examples.
• If you have a running project, the most difficult part of the migration is updating to the new style system. Unfor-
tunately, there is no better way than manually updating to the new format.
• The other parts are mainly minor renames and refactoring as described above.
8.24. v7.0.0 (18.05.2020) 456

CHAPTER
NINE
ROADMAP
This is a summary for planned new features and a collection of ideas. This list indicates only the current intention and it
can be changed.
9.1 v8.X
• lv_snapshot: buffer a widget and all of its children into an image. he source widget can be on a different screen
too. The result image can be transformed.
• Add radio button support
• Unit testing (gtest?). See #1658
• Benchmarking (gem5?). See #1660
• chart: pre-delete X pint after the lastly set
• chart: autoscroll to the right
• 9-patch support for lv_imgbtn.
• Handle stride. See #1858
• Optimize line and circle drawing and masking
9.2 Ideas
• Reconsider color format management for run time color format setting, and custom color format usage. (Also
RGB888)
• Make gradients more versatile
• Make image transformations more versatile
• Switch to RGBA colors in styles
• Consider direct binary font format support
• Simplify groups. Discussion is here.
• Use generate-changelog to automatically generate changelog
• lv_mem_alloc_aligned(size, align)
• Text node. See #1701
• CPP binding. See Forum
457
• Optimize font decompression

• Need coverage report for tests
• Need static analyze (via coverity.io or somehing else)
• Support dot_begin and dot_middle long modes for labels
• Add new label alignment modes. #1656
• Support larger images: #1892
9.3 v8
• Create an extra folder for complex widgets

– It makes the core LVGL leaner
– In extra we can have a lot and specific widgets
– Good place for contributions
• New scrolling:
– See feat/new-scroll branch and #1614) issue.
– Remove lv_page and support scrolling on lv_obj
– Support "elastic" scrolling when scrolled in
– Support scroll chaining among any objects types (not only lv_pagess)
– Remove lv_drag. Similar effect can be achieved by setting the position in LV_EVENT_PRESSING
– Add snapping
– Add snap stop to scroll max 1 snap point
– Already working
• New layouts:
– See #1615 issue
– CSS Grid-like layout support
– CSS Flexbox-like layout support
– Remove lv_cont and support layouts on lv_obj
• Simplified File system interface (feat/new_fs_api branch) to make porting easier
– Work in progress
• Remove the align parameter from lv_canvas_draw_text
• Remove the copy parameter from create functions
• Optimize and simplifie styles #1832
• Use a more generic inheritenace #1919
• Allow adding multiple events to an obejct
9.3. v8 458
INDEX
Symbols _lv_disp_draw_buf_t::buf1 (C++ member), 37

_lv_anim_core_init (C++ function), 190 _lv_disp_draw_buf_t::buf2 (C++ member), 37
_lv_anim_t (C++ struct), 194 _lv_disp_draw_buf_t::buf_act (C++ mem-
_lv_anim_t::act_time (C++ member), 194 ber), 37
_lv_anim_t::current_value (C++ member), _lv_disp_draw_buf_t::flushing (C++ mem-
194 ber), 37
_lv_anim_t::early_apply (C++ member), 195 _lv_disp_draw_buf_t::flushing_last (C++
_lv_anim_t::end_value (C++ member), 194 member), 37
_lv_anim_t::exec_cb (C++ member), 194 _lv_disp_draw_buf_t::last_area (C++ mem-
_lv_anim_t::get_value_cb (C++ member), 194 ber), 37
_lv_anim_t::path_cb (C++ member), 194 _lv_disp_draw_buf_t::last_part (C++ mem-
_lv_anim_t::playback_delay (C++ member), ber), 37
194 _lv_disp_draw_buf_t::size (C++ member), 37
_lv_anim_t::playback_now (C++ member), 195 _lv_disp_drv_t (C++ struct), 37
_lv_anim_t::playback_time (C++ member), _lv_disp_drv_t::antialiasing (C++ mem-
195 ber), 37
_lv_anim_t::ready_cb (C++ member), 194 _lv_disp_drv_t::clean_dcache_cb (C++
_lv_anim_t::repeat_cnt (C++ member), 195 member), 38
_lv_anim_t::repeat_delay (C++ member), 195 _lv_disp_drv_t::color_chroma_key (C++
_lv_anim_t::run_round (C++ member), 195 member), 38
_lv_anim_t::start_cb (C++ member), 194 _lv_disp_drv_t::dpi (C++ member), 38
_lv_anim_t::start_cb_called (C++ member), _lv_disp_drv_t::draw_buf (C++ member), 37
195 _lv_disp_drv_t::drv_update_cb (C++ mem-
_lv_anim_t::start_value (C++ member), 194 ber), 38
_lv_anim_t::time (C++ member), 194 _lv_disp_drv_t::flush_cb (C++ member), 38
_lv_anim_t::time_orig (C++ member), 195 _lv_disp_drv_t::full_refresh (C++ mem-
_lv_anim_t::user_data (C++ member), 194 ber), 37
_lv_anim_t::var (C++ member), 194 _lv_disp_drv_t::gpu_fill_cb (C++ member),
_lv_bar_anim_t (C++ struct), 233 38
_lv_bar_anim_t::anim_end (C++ member), 233 _lv_disp_drv_t::gpu_wait_cb (C++ member),
_lv_bar_anim_t::anim_start (C++ member), 38
233 _lv_disp_drv_t::hor_res (C++ member), 37
_lv_bar_anim_t::anim_state (C++ member), _lv_disp_drv_t::monitor_cb (C++ member),
233 38
_lv_bar_anim_t::bar (C++ member), 233 _lv_disp_drv_t::rotated (C++ member), 37
_lv_color_filter_dsc_t (C++ struct), 156 _lv_disp_drv_t::rounder_cb (C++ member),
_lv_color_filter_dsc_t::filter_cb (C++ 38
member), 156 _lv_disp_drv_t::screen_transp (C++ mem-
_lv_color_filter_dsc_t::user_data (C++ ber), 37
member), 156 _lv_disp_drv_t::set_px_cb (C++ member), 38
_lv_disp_draw_buf_t (C++ struct), 36 _lv_disp_drv_t::sw_rotate (C++ member), 37
_lv_disp_draw_buf_t::area (C++ member), 37 _lv_disp_drv_t::user_data (C++ member), 38
459
_lv_disp_drv_t::ver_res (C++ member), 37 _lv_img_buf_transform (C++ function), 175

_lv_disp_drv_t::wait_cb (C++ member), 38 _lv_img_buf_transform_anti_alias (C++
_lv_disp_get_refr_timer (C++ function), 148 function), 175
_lv_disp_t (C++ struct), 38 _lv_img_buf_transform_init (C++ function),
_lv_disp_t::act_scr (C++ member), 39 175
_lv_disp_t::bg_color (C++ member), 39 _lv_indev_drv_t (C++ struct), 46
_lv_disp_t::bg_img (C++ member), 39 _lv_indev_drv_t::disp (C++ member), 46
_lv_disp_t::bg_opa (C++ member), 39 _lv_indev_drv_t::feedback_cb (C++ mem-
_lv_disp_t::del_prev (C++ member), 39 ber), 46
_lv_disp_t::driver (C++ member), 39 _lv_indev_drv_t::gesture_limit (C++ mem-
_lv_disp_t::inv_area_joined (C++ member), ber), 46
40 _lv_indev_drv_t::gesture_min_velocity
_lv_disp_t::inv_areas (C++ member), 39 (C++ member), 46
_lv_disp_t::inv_p (C++ member), 40 _lv_indev_drv_t::long_press_repeat_time
_lv_disp_t::last_activity_time (C++ mem- (C++ member), 47
ber), 40 _lv_indev_drv_t::long_press_time (C++
_lv_disp_t::prev_scr (C++ member), 39 member), 47
_lv_disp_t::refr_timer (C++ member), 39 _lv_indev_drv_t::read_cb (C++ member), 46
_lv_disp_t::scr_to_load (C++ member), 39 _lv_indev_drv_t::read_timer (C++ member),
_lv_disp_t::screen_cnt (C++ member), 39 46
_lv_disp_t::screens (C++ member), 39 _lv_indev_drv_t::scroll_limit (C++ mem-
_lv_disp_t::sys_layer (C++ member), 39 ber), 46
_lv_disp_t::theme (C++ member), 39 _lv_indev_drv_t::scroll_throw (C++ mem-
_lv_disp_t::top_layer (C++ member), 39 ber), 46
_lv_fs_drv_t (C++ struct), 184 _lv_indev_drv_t::type (C++ member), 46
_lv_fs_drv_t::close_cb (C++ member), 184 _lv_indev_drv_t::user_data (C++ member),
_lv_fs_drv_t::dir_close_cb (C++ member), 46
184 _lv_indev_proc_t (C++ struct), 47
_lv_fs_drv_t::dir_open_cb (C++ member), _lv_indev_proc_t (C++ type), 44
184 _lv_indev_proc_t::act_obj (C++ member), 47
_lv_fs_drv_t::dir_read_cb (C++ member), _lv_indev_proc_t::act_point (C++ member),
184 47
_lv_fs_drv_t::letter (C++ member), 184 _lv_indev_proc_t::disabled (C++ member),
_lv_fs_drv_t::open_cb (C++ member), 184 47
_lv_fs_drv_t::read_cb (C++ member), 184 _lv_indev_proc_t::gesture_dir (C++ mem-
_lv_fs_drv_t::ready_cb (C++ member), 184 ber), 47
_lv_fs_drv_t::seek_cb (C++ member), 184 _lv_indev_proc_t::gesture_sent (C++ mem-
_lv_fs_drv_t::tell_cb (C++ member), 184 ber), 47
_lv_fs_drv_t::user_data (C++ member), 184 _lv_indev_proc_t::gesture_sum (C++ mem-
_lv_fs_drv_t::write_cb (C++ member), 184 ber), 47
_lv_fs_init (C++ function), 181 _lv_indev_proc_t::keypad (C++ member), 48
_lv_group_init (C++ function), 140 _lv_indev_proc_t::last_key (C++ member),
_lv_group_t (C++ struct), 142 48
_lv_group_t::editing (C++ member), 143 _lv_indev_proc_t::last_obj (C++ member),
_lv_group_t::focus_cb (C++ member), 143 47
_lv_group_t::frozen (C++ member), 143 _lv_indev_proc_t::last_point (C++ mem-
_lv_group_t::obj_focus (C++ member), 143 ber), 47
_lv_group_t::obj_ll (C++ member), 143 _lv_indev_proc_t::last_pressed (C++ mem-
_lv_group_t::refocus_policy (C++ member), ber), 47
143 _lv_indev_proc_t::last_raw_point (C++
_lv_group_t::user_data (C++ member), 143 member), 47
_lv_group_t::wrap (C++ member), 143 _lv_indev_proc_t::last_state (C++ mem-
_lv_img_buf_get_transformed_area (C++ ber), 48
function), 176 _lv_indev_proc_t::long_pr_sent (C++ mem-
Index 460
ber), 47 member), 218

_lv_indev_proc_t::longpr_rep_timestamp _lv_obj_spec_attr_t::scrollbar_mode
(C++ member), 48 (C++ member), 217
_lv_indev_proc_t::pointer (C++ member), 48 _lv_obj_t (C++ struct), 218
_lv_indev_proc_t::pr_timestamp (C++ mem- _lv_obj_t::class_p (C++ member), 218
ber), 48 _lv_obj_t::coords (C++ member), 218
_lv_indev_proc_t::reset_query (C++ mem- _lv_obj_t::flags (C++ member), 218
ber), 47 _lv_obj_t::h_layout (C++ member), 218
_lv_indev_proc_t::scroll_area (C++ mem- _lv_obj_t::layout_inv (C++ member), 218
ber), 47 _lv_obj_t::parent (C++ member), 218
_lv_indev_proc_t::scroll_dir (C++ mem- _lv_obj_t::scr_layout_inv (C++ member),
ber), 47 218
_lv_indev_proc_t::scroll_obj (C++ mem- _lv_obj_t::skip_trans (C++ member), 218
ber), 47 _lv_obj_t::spec_attr (C++ member), 218
_lv_indev_proc_t::scroll_sum (C++ mem- _lv_obj_t::state (C++ member), 218
ber), 47 _lv_obj_t::style_cnt (C++ member), 218
_lv_indev_proc_t::scroll_throw_vect _lv_obj_t::styles (C++ member), 218
(C++ member), 47 _lv_obj_t::user_data (C++ member), 218
_lv_indev_proc_t::scroll_throw_vect_ori _lv_obj_t::w_layout (C++ member), 218
(C++ member), 47 _lv_style_get_prop_group (C++ function), 89
_lv_indev_proc_t::state (C++ member), 47 _lv_theme_t (C++ struct), 92
_lv_indev_proc_t::types (C++ member), 48 _lv_theme_t::apply_cb (C++ member), 92
_lv_indev_proc_t::vect (C++ member), 47 _lv_theme_t::color_primary (C++ member),
_lv_indev_proc_t::wait_until_release 92
(C++ member), 47 _lv_theme_t::color_secondary (C++ mem-
_lv_indev_read (C++ function), 45 ber), 92
_lv_indev_t (C++ struct), 48 _lv_theme_t::disp (C++ member), 92
_lv_indev_t::btn_points (C++ member), 48 _lv_theme_t::flags (C++ member), 92
_lv_indev_t::cursor (C++ member), 48 _lv_theme_t::font_large (C++ member), 92
_lv_indev_t::driver (C++ member), 48 _lv_theme_t::font_normal (C++ member), 92
_lv_indev_t::group (C++ member), 48 _lv_theme_t::font_small (C++ member), 92
_lv_indev_t::proc (C++ member), 48 _lv_theme_t::parent (C++ member), 92
_lv_obj_spec_attr_t (C++ struct), 217 _lv_theme_t::user_data (C++ member), 92
_lv_obj_spec_attr_t::child_cnt (C++ mem- _lv_timer_core_init (C++ function), 197
ber), 217 _lv_timer_t (C++ struct), 199
_lv_obj_spec_attr_t::children (C++ mem- _lv_timer_t::last_run (C++ member), 199
ber), 217 _lv_timer_t::paused (C++ member), 199
_lv_obj_spec_attr_t::event_dsc (C++ mem- _lv_timer_t::period (C++ member), 199
ber), 217 _lv_timer_t::repeat_count (C++ member),
_lv_obj_spec_attr_t::event_dsc_cnt (C++ 199
member), 218 _lv_timer_t::timer_cb (C++ member), 199
_lv_obj_spec_attr_t::ext_click_pad (C++ _lv_timer_t::user_data (C++ member), 199
member), 217 [anonymous] (C++ enum), 84, 85, 140, 152, 172, 180,
_lv_obj_spec_attr_t::ext_draw_size (C++ 181, 212, 213, 222, 231, 244, 282, 294, 300,
member), 217 310, 319, 346, 356, 365, 389
_lv_obj_spec_attr_t::group_p (C++ mem- [anonymous]::LV_ARC_MODE_NORMAL (C++
ber), 217 enumerator), 222
_lv_obj_spec_attr_t::scroll (C++ member), [anonymous]::LV_ARC_MODE_REVERSE (C++
217 enumerator), 222
_lv_obj_spec_attr_t::scroll_dir (C++ [anonymous]::LV_ARC_MODE_SYMMETRICAL
member), 218 (C++ enumerator), 222
_lv_obj_spec_attr_t::scroll_snap_x (C++ [anonymous]::LV_BAR_MODE_NORMAL (C++
member), 217 enumerator), 231
_lv_obj_spec_attr_t::scroll_snap_y (C++
Index 461
[anonymous]::LV_BAR_MODE_RANGE (C++ enu- [anonymous]::LV_CHART_TYPE_NONE (C++

merator), 231 enumerator), 346
[anonymous]::LV_BAR_MODE_SYMMETRICAL [anonymous]::LV_CHART_TYPE_SCATTER (C++
(C++ enumerator), 231 enumerator), 346
[anonymous]::LV_BLEND_MODE_ADDITIVE [anonymous]::LV_CHART_UPDATE_MODE_CIRCULAR
(C++ enumerator), 84 (C++ enumerator), 346
[anonymous]::LV_BLEND_MODE_NORMAL (C++ [anonymous]::LV_CHART_UPDATE_MODE_SHIFT
enumerator), 84 (C++ enumerator), 346
[anonymous]::LV_BLEND_MODE_SUBTRACTIVE [anonymous]::LV_COLORWHEEL_MODE_HUE
[anonymous]::LV_BORDER_SIDE_BOTTOM (C++ [anonymous]::LV_COLORWHEEL_MODE_SATURATION
[anonymous]::LV_BORDER_SIDE_FULL (C++ [anonymous]::LV_COLORWHEEL_MODE_VALUE
[anonymous]::LV_BORDER_SIDE_INTERNAL [anonymous]::LV_FS_MODE_RD (C++ enumera-
(C++ enumerator), 85 tor), 181
[anonymous]::LV_BORDER_SIDE_LEFT (C++ [anonymous]::LV_FS_MODE_WR (C++ enumera-
enumerator), 84 tor), 181
[anonymous]::LV_BORDER_SIDE_NONE (C++ [anonymous]::LV_FS_RES_BUSY (C++ enumera-
[anonymous]::LV_BORDER_SIDE_RIGHT (C++ [anonymous]::LV_FS_RES_DENIED (C++ enu-
enumerator), 84 merator), 181
[anonymous]::LV_BORDER_SIDE_TOP (C++ [anonymous]::LV_FS_RES_FS_ERR (C++ enu-
[anonymous]::LV_BTNMATRIX_CTRL_CHECKABLE[anonymous]::LV_FS_RES_FULL (C++ enumera-
[anonymous]::LV_BTNMATRIX_CTRL_CHECKED [anonymous]::LV_FS_RES_HW_ERR (C++ enu-
(C++ enumerator), 244 merator), 180
[anonymous]::LV_BTNMATRIX_CTRL_CLICK_TRIG[anonymous]::LV_FS_RES_INV_PARAM (C++
[anonymous]::LV_BTNMATRIX_CTRL_CUSTOM_1 [anonymous]::LV_FS_RES_LOCKED (C++ enu-
[anonymous]::LV_BTNMATRIX_CTRL_CUSTOM_2 [anonymous]::LV_FS_RES_NOT_EX (C++ enu-
[anonymous]::LV_BTNMATRIX_CTRL_DISABLED [anonymous]::LV_FS_RES_NOT_IMP (C++ enu-
[anonymous]::LV_BTNMATRIX_CTRL_HIDDEN [anonymous]::LV_FS_RES_OK (C++ enumerator),
(C++ enumerator), 244 180
[anonymous]::LV_BTNMATRIX_CTRL_NO_REPEAT[anonymous]::LV_FS_RES_OUT_OF_MEM (C++
[anonymous]::LV_BTNMATRIX_CTRL_RECOLOR [anonymous]::LV_FS_RES_TOUT (C++ enumera-
[anonymous]::LV_CHART_AXIS_PRIMARY_X [anonymous]::LV_FS_RES_UNKNOWN (C++ enu-
[anonymous]::LV_CHART_AXIS_PRIMARY_Y [anonymous]::LV_GRAD_DIR_HOR (C++ enumer-
(C++ enumerator), 346 ator), 85
[anonymous]::LV_CHART_AXIS_SECONDARY_X [anonymous]::LV_GRAD_DIR_NONE (C++ enu-
[anonymous]::LV_CHART_AXIS_SECONDARY_Y [anonymous]::LV_GRAD_DIR_VER (C++ enumer-
(C++ enumerator), 346 ator), 85
[anonymous]::LV_CHART_TYPE_BAR (C++ enu- [anonymous]::LV_IMG_CF_ALPHA_1BIT (C++
merator), 346 enumerator), 172
[anonymous]::LV_CHART_TYPE_LINE (C++ [anonymous]::LV_IMG_CF_ALPHA_2BIT (C++
enumerator), 346 enumerator), 172
Index 462
[anonymous]::LV_IMG_CF_ALPHA_4BIT (C++ [anonymous]::LV_IMG_CF_USER_ENCODED_5

[anonymous]::LV_IMG_CF_ALPHA_8BIT (C++ [anonymous]::LV_IMG_CF_USER_ENCODED_6
[anonymous]::LV_IMG_CF_INDEXED_1BIT [anonymous]::LV_IMG_CF_USER_ENCODED_7
[anonymous]::LV_IMG_CF_INDEXED_2BIT [anonymous]::LV_KEYBOARD_MODE_NUMBER
[anonymous]::LV_IMG_CF_INDEXED_4BIT [anonymous]::LV_KEYBOARD_MODE_SPECIAL
[anonymous]::LV_IMG_CF_INDEXED_8BIT [anonymous]::LV_KEYBOARD_MODE_TEXT_LOWER
[anonymous]::LV_IMG_CF_RAW (C++ enumera- [anonymous]::LV_KEYBOARD_MODE_TEXT_UPPER
tor), 172 (C++ enumerator), 365
[anonymous]::LV_IMG_CF_RAW_ALPHA (C++ [anonymous]::LV_KEY_BACKSPACE (C++ enu-
[anonymous]::LV_IMG_CF_RAW_CHROMA_KEYED [anonymous]::LV_KEY_DEL (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_15 (C++ [anonymous]::LV_KEY_DOWN (C++ enumerator),
enumerator), 172 140
[anonymous]::LV_IMG_CF_RESERVED_16 (C++ [anonymous]::LV_KEY_END (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_17 (C++ [anonymous]::LV_KEY_ENTER (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_18 (C++ [anonymous]::LV_KEY_ESC (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_19 (C++ [anonymous]::LV_KEY_HOME (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_20 (C++ [anonymous]::LV_KEY_LEFT (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_21 (C++ [anonymous]::LV_KEY_NEXT (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_22 (C++ [anonymous]::LV_KEY_PREV (C++ enumerator),
[anonymous]::LV_IMG_CF_RESERVED_23 (C++ [anonymous]::LV_KEY_RIGHT (C++ enumerator),
[anonymous]::LV_IMG_CF_TRUE_COLOR (C++ [anonymous]::LV_KEY_UP (C++ enumerator), 140
enumerator), 172 [anonymous]::LV_LABEL_LONG_CLIP (C++
[anonymous]::LV_IMG_CF_TRUE_COLOR_ALPHA enumerator), 282
(C++ enumerator), 172 [anonymous]::LV_LABEL_LONG_DOT (C++ enu-
[anonymous]::LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED merator), 282
(C++ enumerator), 172 [anonymous]::LV_LABEL_LONG_SCROLL (C++
[anonymous]::LV_IMG_CF_UNKNOWN (C++ enu- enumerator), 282
merator), 172 [anonymous]::LV_LABEL_LONG_SCROLL_CIRCULAR
[anonymous]::LV_IMG_CF_USER_ENCODED_0 (C++ enumerator), 282
(C++ enumerator), 173 [anonymous]::LV_LABEL_LONG_WRAP (C++
[anonymous]::LV_IMG_CF_USER_ENCODED_1 enumerator), 282
(C++ enumerator), 173 [anonymous]::LV_OBJ_FLAG_ADV_HITTEST
[anonymous]::LV_IMG_CF_USER_ENCODED_2 (C++ enumerator), 214
(C++ enumerator), 173 [anonymous]::LV_OBJ_FLAG_CHECKABLE (C++
(C++ enumerator), 173 [anonymous]::LV_OBJ_FLAG_CLICKABLE (C++
(C++ enumerator), 173 [anonymous]::LV_OBJ_FLAG_CLICK_FOCUSABLE
Index 463
(C++ enumerator), 213 [anonymous]::LV_OPA_90 (C++ enumerator), 152

[anonymous]::LV_OBJ_FLAG_EVENT_BUBBLE [anonymous]::LV_OPA_COVER (C++ enumerator),
[anonymous]::LV_OBJ_FLAG_FLOATING (C++ [anonymous]::LV_OPA_TRANSP (C++ enumera-
[anonymous]::LV_OBJ_FLAG_GESTURE_BUBBLE [anonymous]::LV_PART_ANY (C++ enumerator),
[anonymous]::LV_OBJ_FLAG_HIDDEN (C++ [anonymous]::LV_PART_CURSOR (C++ enumera-
[anonymous]::LV_OBJ_FLAG_IGNORE_LAYOUT [anonymous]::LV_PART_CUSTOM_FIRST (C++
[anonymous]::LV_OBJ_FLAG_LAYOUT_1 (C++ [anonymous]::LV_PART_INDICATOR (C++ enu-
[anonymous]::LV_OBJ_FLAG_LAYOUT_2 (C++ [anonymous]::LV_PART_ITEMS (C++ enumera-
[anonymous]::LV_OBJ_FLAG_PRESS_LOCK [anonymous]::LV_PART_KNOB (C++ enumerator),
[anonymous]::LV_OBJ_FLAG_SCROLLABLE [anonymous]::LV_PART_MAIN (C++ enumerator),
[anonymous]::LV_OBJ_FLAG_SCROLL_CHAIN [anonymous]::LV_PART_SCROLLBAR (C++ enu-
[anonymous]::LV_OBJ_FLAG_SCROLL_ELASTIC [anonymous]::LV_PART_SELECTED (C++ enu-
[anonymous]::LV_OBJ_FLAG_SCROLL_MOMENTUM[anonymous]::LV_PART_TEXTAREA_PLACEHOLDER
[anonymous]::LV_OBJ_FLAG_SCROLL_ONE [anonymous]::LV_PART_TICKS (C++ enumera-
[anonymous]::LV_OBJ_FLAG_SCROLL_ON_FOCUS[anonymous]::LV_ROLLER_MODE_INFINITE
[anonymous]::LV_OBJ_FLAG_SNAPABLE (C++ [anonymous]::LV_ROLLER_MODE_NORMAL (C++
[anonymous]::LV_OBJ_FLAG_USER_1 (C++ [anonymous]::LV_SLIDER_MODE_NORMAL (C++
[anonymous]::LV_OBJ_FLAG_USER_2 (C++ [anonymous]::LV_SLIDER_MODE_RANGE (C++
[anonymous]::LV_OBJ_FLAG_USER_3 (C++ [anonymous]::LV_SLIDER_MODE_SYMMETRICAL
[anonymous]::LV_OBJ_FLAG_USER_4 (C++ [anonymous]::LV_SPAN_MODE_BREAK (C++
[anonymous]::LV_OBJ_FLAG_WIDGET_1 (C++ [anonymous]::LV_SPAN_MODE_EXPAND (C++
[anonymous]::LV_OBJ_FLAG_WIDGET_2 (C++ [anonymous]::LV_SPAN_MODE_FIXED (C++
[anonymous]::LV_OPA_0 (C++ enumerator), 152 [anonymous]::LV_SPAN_OVERFLOW_CLIP (C++
[anonymous]::LV_OPA_10 (C++ enumerator), 152 enumerator), 389
[anonymous]::LV_OPA_100 (C++ enumerator), [anonymous]::LV_SPAN_OVERFLOW_ELLIPSIS
153 (C++ enumerator), 389
[anonymous]::LV_OPA_20 (C++ enumerator), 152 [anonymous]::LV_STATE_ANY (C++ enumerator),
[anonymous]::LV_OPA_30 (C++ enumerator), 152 212
[anonymous]::LV_OPA_40 (C++ enumerator), 152 [anonymous]::LV_STATE_CHECKED (C++ enu-
[anonymous]::LV_OPA_50 (C++ enumerator), 152 merator), 212
[anonymous]::LV_OPA_60 (C++ enumerator), 152 [anonymous]::LV_STATE_DEFAULT (C++ enu-
[anonymous]::LV_OPA_70 (C++ enumerator), 152 merator), 212
[anonymous]::LV_OPA_80 (C++ enumerator), 152 [anonymous]::LV_STATE_DISABLED (C++ enu-
Index 464
merator), 212 lv_anim_enable_t::LV_ANIM_OFF (C++ enu-

[anonymous]::LV_STATE_EDITED (C++ enumer- merator), 189
ator), 212 lv_anim_enable_t::LV_ANIM_ON (C++ enumer-
[anonymous]::LV_STATE_FOCUSED (C++ enu- ator), 189
merator), 212 lv_anim_exec_xcb_t (C++ type), 189
[anonymous]::LV_STATE_FOCUS_KEY (C++ lv_anim_get (C++ function), 192
enumerator), 212 lv_anim_get_delay (C++ function), 192
[anonymous]::LV_STATE_HOVERED (C++ enu- lv_anim_get_value_cb_t (C++ type), 189
merator), 212 lv_anim_init (C++ function), 190
[anonymous]::LV_STATE_PRESSED (C++ enu- lv_anim_path_bounce (C++ function), 193
merator), 212 lv_anim_path_cb_t (C++ type), 189
[anonymous]::LV_STATE_SCROLLED (C++ enu- lv_anim_path_ease_in (C++ function), 193
merator), 212 lv_anim_path_ease_in_out (C++ function), 193
[anonymous]::LV_STATE_USER_1 (C++ enumer- lv_anim_path_ease_out (C++ function), 193
ator), 212 lv_anim_path_linear (C++ function), 193
[anonymous]::LV_STATE_USER_2 (C++ enumer- lv_anim_path_overshoot (C++ function), 193
ator), 212 lv_anim_path_step (C++ function), 194
[anonymous]::LV_STATE_USER_3 (C++ enumer- lv_anim_ready_cb_t (C++ type), 189
ator), 212 lv_anim_refr_now (C++ function), 193
[anonymous]::LV_STATE_USER_4 (C++ enumer- lv_anim_set_custom_exec_cb (C++ function),
ator), 212 190
[anonymous]::LV_TABLE_CELL_CTRL_CUSTOM_1lv_anim_set_delay (C++ function), 190
(C++ enumerator), 310 lv_anim_set_early_apply (C++ function), 192
[anonymous]::LV_TABLE_CELL_CTRL_CUSTOM_2lv_anim_set_exec_cb (C++ function), 190
(C++ enumerator), 310 lv_anim_set_get_value_cb (C++ function), 191
[anonymous]::LV_TABLE_CELL_CTRL_CUSTOM_3lv_anim_set_path_cb (C++ function), 191
(C++ enumerator), 310 lv_anim_set_playback_delay (C++ function),
[anonymous]::LV_TABLE_CELL_CTRL_CUSTOM_4 191
(C++ enumerator), 310 lv_anim_set_playback_time (C++ function),
[anonymous]::LV_TABLE_CELL_CTRL_MERGE_RIGHT 191
(C++ enumerator), 310 lv_anim_set_ready_cb (C++ function), 191
[anonymous]::LV_TABLE_CELL_CTRL_TEXT_CROP lv_anim_set_repeat_count (C++ function), 191
(C++ enumerator), 310 lv_anim_set_repeat_delay (C++ function), 192
[anonymous]::LV_TEXT_DECOR_NONE (C++ lv_anim_set_start_cb (C++ function), 191
enumerator), 84 lv_anim_set_time (C++ function), 190
[anonymous]::LV_TEXT_DECOR_STRIKETHROUGHlv_anim_set_values (C++ function), 190
(C++ enumerator), 84 lv_anim_set_var (C++ function), 190
[anonymous]::LV_TEXT_DECOR_UNDERLINE lv_anim_speed_to_time (C++ function), 193
(C++ enumerator), 84 lv_anim_start (C++ function), 192
[anonymous]::_LV_BTNMATRIX_CTRL_RESERVEDlv_anim_start_cb_t (C++ type), 189
(C++ enumerator), 244 lv_anim_t (C++ type), 189
[anonymous]::_LV_BTNMATRIX_WIDTH (C++ lv_arc_class (C++ member), 225
enumerator), 244 lv_arc_create (C++ function), 222
[anonymous]::_LV_CHART_AXIS_LAST (C++ lv_arc_get_angle_end (C++ function), 224
enumerator), 347 lv_arc_get_angle_start (C++ function), 224
lv_arc_get_bg_angle_end (C++ function), 224
L lv_arc_get_bg_angle_start (C++ function),
lv_anim_count_running (C++ function), 193 224
lv_anim_custom_del (C++ function), 192 lv_arc_get_max_value (C++ function), 224
lv_anim_custom_exec_cb_t (C++ type), 189 lv_arc_get_min_value (C++ function), 224
lv_anim_del (C++ function), 192 lv_arc_get_mode (C++ function), 224
lv_anim_del_all (C++ function), 192 lv_arc_get_value (C++ function), 224
lv_anim_enable_t (C++ enum), 189 lv_arc_mode_t (C++ type), 222
lv_arc_set_angles (C++ function), 222
Index 465
lv_arc_set_bg_angles (C++ function), 223 lv_blend_mode_t (C++ type), 84

lv_arc_set_bg_end_angle (C++ function), 223 lv_border_side_t (C++ type), 84
lv_arc_set_bg_start_angle (C++ function), lv_btn_class (C++ member), 238
222 lv_btn_create (C++ function), 238
lv_arc_set_change_rate (C++ function), 223 lv_btn_t (C++ struct), 238
lv_arc_set_end_angle (C++ function), 222 lv_btn_t::obj (C++ member), 238
lv_arc_set_mode (C++ function), 223 lv_btnmatrix_btn_draw_cb_t (C++ type), 244
lv_arc_set_range (C++ function), 223 lv_btnmatrix_class (C++ member), 247
lv_arc_set_rotation (C++ function), 223 lv_btnmatrix_clear_btn_ctrl (C++ function),
lv_arc_set_start_angle (C++ function), 222 246
lv_arc_set_value (C++ function), 223 lv_btnmatrix_clear_btn_ctrl_all (C++
lv_arc_t (C++ struct), 225 function), 246
lv_arc_t::bg_angle_end (C++ member), 225 lv_btnmatrix_create (C++ function), 245
lv_arc_t::bg_angle_start (C++ member), 225 lv_btnmatrix_ctrl_t (C++ type), 244
lv_arc_t::chg_rate (C++ member), 225 lv_btnmatrix_get_btn_text (C++ function),
lv_arc_t::dragging (C++ member), 225 247
lv_arc_t::indic_angle_end (C++ member), lv_btnmatrix_get_map (C++ function), 246
225 lv_btnmatrix_get_one_checked (C++ func-
lv_arc_t::indic_angle_start (C++ member), tion), 247
225 lv_btnmatrix_get_selected_btn (C++ func-
lv_arc_t::last_angle (C++ member), 225 tion), 246
lv_arc_t::last_tick (C++ member), 225 lv_btnmatrix_has_btn_ctrl (C++ function),
lv_arc_t::max_value (C++ member), 225 247
lv_arc_t::min_close (C++ member), 225 lv_btnmatrix_set_btn_ctrl (C++ function),
lv_arc_t::min_value (C++ member), 225 245
lv_arc_t::obj (C++ member), 225 lv_btnmatrix_set_btn_ctrl_all (C++ func-
lv_arc_t::rotation (C++ member), 225 tion), 246
lv_arc_t::type (C++ member), 225 lv_btnmatrix_set_btn_width (C++ function),
lv_arc_t::value (C++ member), 225 246
lv_async_call (C++ function), 199 lv_btnmatrix_set_ctrl_map (C++ function),
lv_async_cb_t (C++ type), 199 245
lv_bar_class (C++ member), 233 lv_btnmatrix_set_map (C++ function), 245
lv_bar_create (C++ function), 232 lv_btnmatrix_set_one_checked (C++ func-
lv_bar_get_max_value (C++ function), 233 tion), 246
lv_bar_get_min_value (C++ function), 232 lv_btnmatrix_set_selected_btn (C++ func-
lv_bar_get_mode (C++ function), 233 tion), 245
lv_bar_get_start_value (C++ function), 232 lv_btnmatrix_t (C++ struct), 247
lv_bar_get_value (C++ function), 232 lv_btnmatrix_t::btn_cnt (C++ member), 247
lv_bar_mode_t (C++ type), 231 lv_btnmatrix_t::btn_id_sel (C++ member),
lv_bar_set_mode (C++ function), 232 247
lv_bar_set_range (C++ function), 232 lv_btnmatrix_t::button_areas (C++ mem-
lv_bar_set_start_value (C++ function), 232 ber), 247
lv_bar_set_value (C++ function), 232 lv_btnmatrix_t::ctrl_bits (C++ member),
lv_bar_t (C++ struct), 233 247
lv_bar_t::cur_value (C++ member), 233 lv_btnmatrix_t::map_p (C++ member), 247
lv_bar_t::cur_value_anim (C++ member), 234 lv_btnmatrix_t::obj (C++ member), 247
lv_bar_t::indic_area (C++ member), 233 lv_btnmatrix_t::one_check (C++ member),
lv_bar_t::max_value (C++ member), 233 247
lv_bar_t::min_value (C++ member), 233 lv_calendar_class (C++ member), 329
lv_bar_t::mode (C++ member), 234 lv_calendar_create (C++ function), 327
lv_bar_t::obj (C++ member), 233 lv_calendar_date_t (C++ struct), 329
lv_bar_t::start_value (C++ member), 233 lv_calendar_date_t::day (C++ member), 329
lv_bar_t::start_value_anim (C++ member), lv_calendar_date_t::month (C++ member),
234 329
Index 466
lv_calendar_date_t::year (C++ member), 329 lv_chart_class (C++ member), 353

lv_calendar_get_highlighted_dates (C++ lv_chart_create (C++ function), 347
function), 328 lv_chart_cursor_t (C++ struct), 353
lv_calendar_get_highlighted_dates_num lv_chart_cursor_t::color (C++ member), 353
(C++ function), 328 lv_chart_cursor_t::dir (C++ member), 353
lv_calendar_get_pressed_date (C++ func- lv_chart_cursor_t::point_id (C++ member),
tion), 328 353
lv_calendar_get_showed_date (C++ function), lv_chart_cursor_t::pos (C++ member), 353
328 lv_chart_cursor_t::pos_set (C++ member),
lv_calendar_get_today_date (C++ function), 353
328 lv_chart_cursor_t::ser (C++ member), 353
lv_calendar_set_day_names (C++ function), lv_chart_get_cursor_point (C++ function),
328 350
lv_calendar_set_highlighted_dates (C++ lv_chart_get_point_count (C++ function), 348
function), 327 lv_chart_get_point_pos_by_id (C++ func-
lv_calendar_set_showed_date (C++ function), tion), 349
327 lv_chart_get_pressed_point (C++ function),
lv_calendar_set_today_date (C++ function), 352
327 lv_chart_get_series_next (C++ function), 350
lv_calendar_t (C++ struct), 329 lv_chart_get_type (C++ function), 348
lv_calendar_t::btnm (C++ member), 329 lv_chart_get_x_array (C++ function), 352
lv_calendar_t::highlighted_dates (C++ lv_chart_get_x_start_point (C++ function),
member), 329 349
lv_calendar_t::highlighted_dates_num lv_chart_get_y_array (C++ function), 352
(C++ member), 329 lv_chart_get_zoom_x (C++ function), 348
lv_calendar_t::map (C++ member), 329 lv_chart_get_zoom_y (C++ function), 348
lv_calendar_t::nums (C++ member), 329 lv_chart_hide_series (C++ function), 349
lv_calendar_t::showed_date (C++ member), lv_chart_refresh (C++ function), 349
329 lv_chart_remove_series (C++ function), 349
lv_calendar_t::today (C++ member), 329 lv_chart_series_t (C++ struct), 353
lv_canvas_blur_hor (C++ function), 254 lv_chart_series_t::color (C++ member), 353
lv_canvas_blur_ver (C++ function), 254 lv_chart_series_t::hidden (C++ member),
lv_canvas_class (C++ member), 256 353
lv_canvas_copy_buf (C++ function), 253 lv_chart_series_t::start_point (C++ mem-
lv_canvas_create (C++ function), 252 ber), 353
lv_canvas_draw_arc (C++ function), 255 lv_chart_series_t::x_axis_sec (C++ mem-
lv_canvas_draw_img (C++ function), 255 ber), 353
lv_canvas_draw_line (C++ function), 255 lv_chart_series_t::x_ext_buf_assigned
lv_canvas_draw_polygon (C++ function), 255 (C++ member), 353
lv_canvas_draw_rect (C++ function), 254 lv_chart_series_t::x_points (C++ member),
lv_canvas_draw_text (C++ function), 254 353
lv_canvas_fill_bg (C++ function), 254 lv_chart_series_t::y_axis_sec (C++ mem-
lv_canvas_get_img (C++ function), 253 ber), 353
lv_canvas_get_px (C++ function), 253 lv_chart_series_t::y_ext_buf_assigned
lv_canvas_set_buffer (C++ function), 252 (C++ member), 353
lv_canvas_set_palette (C++ function), 252 lv_chart_series_t::y_points (C++ member),
lv_canvas_set_px (C++ function), 252 353
lv_canvas_t (C++ struct), 256 lv_chart_set_all_value (C++ function), 351
lv_canvas_t::dsc (C++ member), 256 lv_chart_set_axis_tick (C++ function), 348
lv_canvas_t::img (C++ member), 256 lv_chart_set_cursor_point (C++ function),
lv_canvas_transform (C++ function), 253 350
lv_chart_add_cursor (C++ function), 350 lv_chart_set_cursor_pos (C++ function), 350
lv_chart_add_series (C++ function), 349 lv_chart_set_div_line_count (C++ function),
lv_chart_axis_t (C++ type), 346 347
Index 467
lv_chart_set_ext_x_array (C++ function), 352 lv_checkbox_set_text_static (C++ function),

lv_chart_set_ext_y_array (C++ function), 352 258
lv_chart_set_next_value (C++ function), 351 lv_checkbox_t (C++ struct), 259
lv_chart_set_next_value2 (C++ function), 351 lv_checkbox_t::obj (C++ member), 259
lv_chart_set_point_count (C++ function), 347 lv_checkbox_t::static_txt (C++ member),
lv_chart_set_range (C++ function), 347 259
lv_chart_set_series_color (C++ function), lv_checkbox_t::txt (C++ member), 259
349 lv_color16_t (C++ union), 155
lv_chart_set_type (C++ function), 347 lv_color16_t::blue (C++ member), 155
lv_chart_set_update_mode (C++ function), 347 lv_color16_t::ch (C++ member), 155
lv_chart_set_value_by_id (C++ function), 351 lv_color16_t::full (C++ member), 156
lv_chart_set_value_by_id2 (C++ function), lv_color16_t::green (C++ member), 155
351 lv_color16_t::green_h (C++ member), 155
lv_chart_set_x_start_point (C++ function), lv_color16_t::green_l (C++ member), 155
350 lv_color16_t::red (C++ member), 155
lv_chart_set_zoom_x (C++ function), 348 lv_color1_t (C++ union), 155
lv_chart_set_zoom_y (C++ function), 348 lv_color1_t::blue (C++ member), 155
lv_chart_t (C++ struct), 353 lv_color1_t::ch (C++ member), 155
lv_chart_t::cursor_ll (C++ member), 354 lv_color1_t::full (C++ member), 155
lv_chart_t::hdiv_cnt (C++ member), 354 lv_color1_t::green (C++ member), 155
lv_chart_t::obj (C++ member), 354 lv_color1_t::red (C++ member), 155
lv_chart_t::point_cnt (C++ member), 354 lv_color32_t (C++ union), 156
lv_chart_t::pressed_point_id (C++ mem- lv_color32_t::alpha (C++ member), 156
ber), 354 lv_color32_t::blue (C++ member), 156
lv_chart_t::series_ll (C++ member), 354 lv_color32_t::ch (C++ member), 156
lv_chart_t::tick (C++ member), 354 lv_color32_t::full (C++ member), 156
lv_chart_t::type (C++ member), 354 lv_color32_t::green (C++ member), 156
lv_chart_t::update_mode (C++ member), 354 lv_color32_t::red (C++ member), 156
lv_chart_t::vdiv_cnt (C++ member), 354 lv_color8_t (C++ union), 155
lv_chart_t::xmax (C++ member), 354 lv_color8_t::blue (C++ member), 155
lv_chart_t::xmin (C++ member), 354 lv_color8_t::ch (C++ member), 155
lv_chart_t::ymax (C++ member), 354 lv_color8_t::full (C++ member), 155
lv_chart_t::ymin (C++ member), 354 lv_color8_t::green (C++ member), 155
lv_chart_t::zoom_x (C++ member), 354 lv_color8_t::red (C++ member), 155
lv_chart_t::zoom_y (C++ member), 354 lv_color_black (C++ function), 155
lv_chart_tick_dsc_t (C++ struct), 353 lv_color_brightness (C++ function), 154
lv_chart_tick_dsc_t::draw_size (C++ mem- lv_color_change_lightness (C++ function),
ber), 353 154
lv_chart_tick_dsc_t::label_en (C++ mem- lv_color_chroma_key (C++ function), 154
ber), 353 lv_color_darken (C++ function), 154
lv_chart_tick_dsc_t::major_cnt (C++ mem- lv_color_filter_cb_t (C++ type), 152
ber), 353 lv_color_filter_dsc_init (C++ function), 154
lv_chart_tick_dsc_t::major_len (C++ mem- lv_color_filter_dsc_t (C++ type), 152
ber), 353 lv_color_hex (C++ function), 154
lv_chart_tick_dsc_t::minor_cnt (C++ mem- lv_color_hex3 (C++ function), 154
ber), 353 lv_color_hsv_t (C++ struct), 156
lv_chart_tick_dsc_t::minor_len (C++ mem- lv_color_hsv_t::h (C++ member), 156
ber), 353 lv_color_hsv_t::s (C++ member), 156
lv_chart_type_t (C++ type), 346 lv_color_hsv_t::v (C++ member), 156
lv_chart_update_mode_t (C++ type), 346 lv_color_hsv_to_rgb (C++ function), 154
lv_checkbox_class (C++ member), 259 lv_color_lighten (C++ function), 154
lv_checkbox_create (C++ function), 258 lv_color_make (C++ function), 154
lv_checkbox_get_text (C++ function), 259 lv_color_rgb_to_hsv (C++ function), 154
lv_checkbox_set_text (C++ function), 258 lv_color_to1 (C++ function), 153
Index 468
lv_color_to16 (C++ function), 153 lv_disp_get_scr_act (C++ function), 146

lv_color_to32 (C++ function), 153 lv_disp_get_scr_prev (C++ function), 146
lv_color_to8 (C++ function), 153 lv_disp_get_theme (C++ function), 147
lv_color_to_hsv (C++ function), 154 lv_disp_get_ver_res (C++ function), 35
lv_color_white (C++ function), 155 lv_disp_load_scr (C++ function), 146
lv_colorwheel_class (C++ member), 358 lv_disp_remove (C++ function), 35
lv_colorwheel_create (C++ function), 357 lv_disp_rot_t (C++ enum), 34
lv_colorwheel_get_color_mode (C++ func- lv_disp_rot_t::LV_DISP_ROT_180 (C++ enu-
tion), 357 merator), 34
lv_colorwheel_get_color_mode_fixed (C++ lv_disp_rot_t::LV_DISP_ROT_270 (C++ enu-
function), 358 merator), 34
lv_colorwheel_get_hsv (C++ function), 357 lv_disp_rot_t::LV_DISP_ROT_90 (C++ enu-
lv_colorwheel_get_rgb (C++ function), 357 merator), 34
lv_colorwheel_mode_t (C++ type), 356 lv_disp_rot_t::LV_DISP_ROT_NONE (C++
lv_colorwheel_set_hsv (C++ function), 357 enumerator), 34
lv_colorwheel_set_mode (C++ function), 357 lv_disp_set_bg_color (C++ function), 147
lv_colorwheel_set_mode_fixed (C++ func- lv_disp_set_bg_image (C++ function), 147
tion), 357 lv_disp_set_bg_opa (C++ function), 147
lv_colorwheel_set_rgb (C++ function), 357 lv_disp_set_default (C++ function), 35
lv_colorwheel_t (C++ struct), 358 lv_disp_set_rotation (C++ function), 36
lv_colorwheel_t::hsv (C++ member), 358 lv_disp_set_theme (C++ function), 147
lv_colorwheel_t::knob (C++ member), 358 lv_disp_t (C++ type), 34
lv_colorwheel_t::last_change_time (C++ lv_disp_trig_activity (C++ function), 147
member), 358 lv_dpx (C++ function), 148
lv_colorwheel_t::last_click_time (C++ lv_dropdown_add_option (C++ function), 265
member), 358 lv_dropdown_class (C++ member), 267
lv_colorwheel_t::last_press_point (C++ lv_dropdown_clear_options (C++ function),
member), 358 265
lv_colorwheel_t::mode (C++ member), 358 lv_dropdown_close (C++ function), 267
lv_colorwheel_t::mode_fixed (C++ member), lv_dropdown_create (C++ function), 264
358 lv_dropdown_get_dir (C++ function), 267
lv_colorwheel_t::obj (C++ member), 358 lv_dropdown_get_list (C++ function), 266
lv_colorwheel_t::pos (C++ member), 358 lv_dropdown_get_option_cnt (C++ function),
lv_colorwheel_t::recolor (C++ member), 358 266
lv_deinit (C++ function), 214 lv_dropdown_get_options (C++ function), 266
lv_disp_clean_dcache (C++ function), 148 lv_dropdown_get_selected (C++ function), 266
lv_disp_dpx (C++ function), 148 lv_dropdown_get_selected_highlight (C++
lv_disp_draw_buf_init (C++ function), 35 function), 266
lv_disp_draw_buf_t (C++ type), 34 lv_dropdown_get_selected_str (C++ func-
lv_disp_drv_init (C++ function), 35 tion), 266
lv_disp_drv_register (C++ function), 35 lv_dropdown_get_symbol (C++ function), 266
lv_disp_drv_t (C++ type), 34 lv_dropdown_get_text (C++ function), 266
lv_disp_drv_update (C++ function), 35 lv_dropdown_list_t (C++ struct), 268
lv_disp_get_antialiasing (C++ function), 36 lv_dropdown_list_t::dropdown (C++ mem-
lv_disp_get_default (C++ function), 35 ber), 268
lv_disp_get_dpi (C++ function), 36 lv_dropdown_list_t::obj (C++ member), 268
lv_disp_get_draw_buf (C++ function), 36 lv_dropdown_open (C++ function), 267
lv_disp_get_hor_res (C++ function), 35 lv_dropdown_set_dir (C++ function), 265
lv_disp_get_inactive_time (C++ function), lv_dropdown_set_options (C++ function), 264
147 lv_dropdown_set_options_static (C++ func-
lv_disp_get_layer_sys (C++ function), 146 tion), 265
lv_disp_get_layer_top (C++ function), 146 lv_dropdown_set_selected (C++ function), 265
lv_disp_get_next (C++ function), 36 lv_dropdown_set_selected_highlight (C++
lv_disp_get_rotation (C++ function), 36 function), 266
Index 469
lv_dropdown_set_symbol (C++ function), 265 lv_fs_close (C++ function), 182

lv_dropdown_set_text (C++ function), 264 lv_fs_dir_close (C++ function), 183
lv_dropdown_t (C++ struct), 267 lv_fs_dir_open (C++ function), 183
lv_dropdown_t::dir (C++ member), 268 lv_fs_dir_read (C++ function), 183
lv_dropdown_t::list (C++ member), 267 lv_fs_dir_t (C++ struct), 184
lv_dropdown_t::obj (C++ member), 267 lv_fs_dir_t::dir_d (C++ member), 184
lv_dropdown_t::option_cnt (C++ member), lv_fs_dir_t::drv (C++ member), 184
267 lv_fs_drv_init (C++ function), 181
lv_dropdown_t::options (C++ member), 267 lv_fs_drv_register (C++ function), 181
lv_dropdown_t::pr_opt_id (C++ member), 268 lv_fs_drv_t (C++ type), 180
lv_dropdown_t::sel_opt_id (C++ member), lv_fs_file_t (C++ struct), 184
267 lv_fs_file_t::drv (C++ member), 184
lv_dropdown_t::sel_opt_id_orig (C++ mem- lv_fs_file_t::file_d (C++ member), 184
ber), 267 lv_fs_get_drv (C++ function), 181
lv_dropdown_t::selected_highlight (C++ lv_fs_get_ext (C++ function), 183
member), 268 lv_fs_get_last (C++ function), 183
lv_dropdown_t::static_txt (C++ member), lv_fs_get_letters (C++ function), 183
268 lv_fs_is_ready (C++ function), 182
lv_dropdown_t::symbol (C++ member), 267 lv_fs_mode_t (C++ type), 180
lv_dropdown_t::text (C++ member), 267 lv_fs_open (C++ function), 182
lv_dropdownlist_class (C++ member), 267 lv_fs_read (C++ function), 182
LV_EXPORT_CONST_INT (C++ function), 88, 190, lv_fs_res_t (C++ type), 180
245, 264, 282, 310, 319, 347, 417, 427 lv_fs_seek (C++ function), 182
lv_flex_align_t (C++ enum), 416 lv_fs_tell (C++ function), 183
lv_flex_align_t::LV_FLEX_ALIGN_CENTER lv_fs_up (C++ function), 183
(C++ enumerator), 416 lv_fs_whence_t (C++ enum), 181
lv_flex_align_t::LV_FLEX_ALIGN_END (C++ lv_fs_whence_t::LV_FS_SEEK_CUR (C++ enu-
lv_flex_align_t::LV_FLEX_ALIGN_SPACE_AROUND lv_fs_whence_t::LV_FS_SEEK_END (C++ enu-
lv_flex_align_t::LV_FLEX_ALIGN_SPACE_BETWEEN lv_fs_whence_t::LV_FS_SEEK_SET (C++ enu-
lv_flex_align_t::LV_FLEX_ALIGN_SPACE_EVENLY lv_fs_write (C++ function), 182
(C++ enumerator), 416 lv_grad_dir_t (C++ type), 84
lv_flex_align_t::LV_FLEX_ALIGN_START lv_grid_align_t (C++ enum), 427
(C++ enumerator), 416 lv_grid_align_t::LV_GRID_ALIGN_CENTER
lv_flex_flow_t (C++ enum), 416 (C++ enumerator), 427
lv_flex_flow_t::LV_FLEX_FLOW_COLUMN lv_grid_align_t::LV_GRID_ALIGN_END (C++
lv_flex_flow_t::LV_FLEX_FLOW_COLUMN_REVERSE lv_grid_align_t::LV_GRID_ALIGN_SPACE_AROUND
lv_flex_flow_t::LV_FLEX_FLOW_COLUMN_WRAPlv_grid_align_t::LV_GRID_ALIGN_SPACE_BETWEEN
lv_flex_flow_t::LV_FLEX_FLOW_COLUMN_WRAP_REVERSE
lv_grid_align_t::LV_GRID_ALIGN_SPACE_EVENLY
lv_flex_flow_t::LV_FLEX_FLOW_ROW (C++ lv_grid_align_t::LV_GRID_ALIGN_START
lv_flex_flow_t::LV_FLEX_FLOW_ROW_REVERSElv_grid_align_t::LV_GRID_ALIGN_STRETCH
lv_flex_flow_t::LV_FLEX_FLOW_ROW_WRAP lv_grid_fr (C++ function), 428
(C++ enumerator), 416 lv_grid_init (C++ function), 427
lv_flex_flow_t::LV_FLEX_FLOW_ROW_WRAP_REVERSE lv_group_add_obj (C++ function), 140
(C++ enumerator), 416 lv_group_create (C++ function), 140
lv_flex_init (C++ function), 417 lv_group_del (C++ function), 140
Index 470
lv_group_focus_cb_t (C++ type), 139 lv_img_header_t::reserved (C++ member),

lv_group_focus_freeze (C++ function), 141 176
lv_group_focus_next (C++ function), 141 lv_img_header_t::w (C++ member), 176
lv_group_focus_obj (C++ function), 141 lv_img_set_angle (C++ function), 275
lv_group_focus_prev (C++ function), 141 lv_img_set_antialias (C++ function), 276
lv_group_get_default (C++ function), 140 lv_img_set_offset_x (C++ function), 275
lv_group_get_editing (C++ function), 142 lv_img_set_offset_y (C++ function), 275
lv_group_get_focus_cb (C++ function), 142 lv_img_set_pivot (C++ function), 275
lv_group_get_focused (C++ function), 142 lv_img_set_src (C++ function), 275
lv_group_get_obj_count (C++ function), 142 lv_img_set_zoom (C++ function), 275
lv_group_get_wrap (C++ function), 142 lv_img_t (C++ struct), 277
lv_group_refocus_policy_t (C++ enum), 140 lv_img_t::angle (C++ member), 277
lv_img_t::antialias (C++ member), 277
lv_group_refocus_policy_t::LV_GROUP_REFOCUS_POLICY_NEXT
(C++ enumerator), 140 lv_img_t::cf (C++ member), 277
lv_img_t::h (C++ member), 277
lv_group_refocus_policy_t::LV_GROUP_REFOCUS_POLICY_PREV
(C++ enumerator), 140 lv_img_t::obj (C++ member), 277
lv_group_remove_all_objs (C++ function), 141 lv_img_t::offset (C++ member), 277
lv_group_remove_obj (C++ function), 141 lv_img_t::pivot (C++ member), 277
lv_group_send_data (C++ function), 141 lv_img_t::src (C++ member), 277
lv_group_set_default (C++ function), 140 lv_img_t::src_type (C++ member), 277
lv_group_set_editing (C++ function), 142 lv_img_t::w (C++ member), 277
lv_group_set_focus_cb (C++ function), 141 lv_img_t::zoom (C++ member), 277
lv_group_set_refocus_policy (C++ function), lv_img_transform_dsc_t (C++ struct), 177
141 lv_img_transform_dsc_t::angle (C++ mem-
lv_group_set_wrap (C++ function), 142 ber), 177
lv_group_t (C++ type), 139 lv_img_transform_dsc_t::antialias (C++
lv_img_buf_alloc (C++ function), 174 member), 177
lv_img_buf_free (C++ function), 175 lv_img_transform_dsc_t::cf (C++ member),
lv_img_buf_get_img_size (C++ function), 175 177
lv_img_buf_get_px_alpha (C++ function), 174 lv_img_transform_dsc_t::cfg (C++ member),
lv_img_buf_get_px_color (C++ function), 174 177
lv_img_buf_set_palette (C++ function), 175 lv_img_transform_dsc_t::chroma_keyed
lv_img_buf_set_px_alpha (C++ function), 174 (C++ member), 177
lv_img_buf_set_px_color (C++ function), 174 lv_img_transform_dsc_t::color (C++ mem-
lv_img_cf_t (C++ type), 171 ber), 177
lv_img_class (C++ member), 277 lv_img_transform_dsc_t::cosma (C++ mem-
lv_img_create (C++ function), 275 ber), 177
lv_img_dsc_t (C++ struct), 176 lv_img_transform_dsc_t::has_alpha (C++
lv_img_dsc_t::data (C++ member), 177 member), 177
lv_img_dsc_t::data_size (C++ member), 177 lv_img_transform_dsc_t::img_dsc (C++
lv_img_dsc_t::header (C++ member), 177 member), 177
lv_img_get_angle (C++ function), 276 lv_img_transform_dsc_t::native_color
lv_img_get_antialias (C++ function), 276 (C++ member), 177
lv_img_get_offset_x (C++ function), 276 lv_img_transform_dsc_t::opa (C++ member),
lv_img_get_offset_y (C++ function), 276 177
lv_img_get_pivot (C++ function), 276 lv_img_transform_dsc_t::pivot_x (C++
lv_img_get_src (C++ function), 276 member), 177
lv_img_get_zoom (C++ function), 276 lv_img_transform_dsc_t::pivot_x_256
lv_img_header_t (C++ struct), 176 (C++ member), 177
lv_img_header_t::always_zero (C++ mem- lv_img_transform_dsc_t::pivot_y (C++
ber), 176 member), 177
lv_img_header_t::cf (C++ member), 176 lv_img_transform_dsc_t::pivot_y_256
lv_img_header_t::h (C++ member), 176 (C++ member), 177
lv_img_transform_dsc_t::px_size (C++
Index 471
member), 178 362

lv_img_transform_dsc_t::pxi (C++ member), lv_imgbtn_t::obj (C++ member), 362
178 lv_indev_data_t (C++ struct), 45
lv_img_transform_dsc_t::res (C++ member), lv_indev_data_t::btn_id (C++ member), 46
177 lv_indev_data_t::continue_reading (C++
lv_img_transform_dsc_t::sinma (C++ mem- member), 46
ber), 177 lv_indev_data_t::enc_diff (C++ member), 46
lv_img_transform_dsc_t::src (C++ member), lv_indev_data_t::key (C++ member), 46
177 lv_indev_data_t::point (C++ member), 46
lv_img_transform_dsc_t::src_h (C++ mem- lv_indev_data_t::state (C++ member), 46
ber), 177 lv_indev_drv_init (C++ function), 45
lv_img_transform_dsc_t::src_w (C++ mem- lv_indev_drv_register (C++ function), 45
ber), 177 lv_indev_drv_t (C++ type), 44
lv_img_transform_dsc_t::tmp (C++ member), lv_indev_drv_update (C++ function), 45
178 lv_indev_enable (C++ function), 137
lv_img_transform_dsc_t::xs (C++ member), lv_indev_get_act (C++ function), 137
177 lv_indev_get_gesture_dir (C++ function), 138
lv_img_transform_dsc_t::xs_int (C++ mem- lv_indev_get_key (C++ function), 138
ber), 177 lv_indev_get_next (C++ function), 45
lv_img_transform_dsc_t::ys (C++ member), lv_indev_get_obj_act (C++ function), 139
177 lv_indev_get_point (C++ function), 138
lv_img_transform_dsc_t::ys_int (C++ mem- lv_indev_get_read_timer (C++ function), 139
ber), 178 lv_indev_get_scroll_dir (C++ function), 138
lv_img_transform_dsc_t::zoom (C++ mem- lv_indev_get_scroll_obj (C++ function), 139
ber), 177 lv_indev_get_type (C++ function), 137
lv_img_transform_dsc_t::zoom_inv (C++ lv_indev_get_vect (C++ function), 139
member), 177 lv_indev_read_timer_cb (C++ function), 137
lv_imgbtn_class (C++ member), 362 lv_indev_reset (C++ function), 138
lv_imgbtn_create (C++ function), 361 lv_indev_reset_long_press (C++ function),
lv_imgbtn_get_src_left (C++ function), 361 138
lv_imgbtn_get_src_middle (C++ function), 362 lv_indev_search_obj (C++ function), 139
lv_imgbtn_get_src_right (C++ function), 362 lv_indev_set_button_points (C++ function),
lv_imgbtn_set_src (C++ function), 361 138
lv_imgbtn_state_t (C++ enum), 361 lv_indev_set_cursor (C++ function), 138
lv_imgbtn_state_t::_LV_IMGBTN_STATE_NUM lv_indev_set_group (C++ function), 138
(C++ enumerator), 361 lv_indev_state_t (C++ enum), 45
lv_imgbtn_state_t::LV_IMGBTN_STATE_CHECKED_DISABLED
lv_indev_state_t::LV_INDEV_STATE_PRESSED
lv_imgbtn_state_t::LV_IMGBTN_STATE_CHECKED_PRESSED
lv_indev_state_t::LV_INDEV_STATE_RELEASED
lv_indev_t (C++ type), 44
lv_imgbtn_state_t::LV_IMGBTN_STATE_CHECKED_RELEASED
(C++ enumerator), 361 lv_indev_type_t (C++ enum), 44
lv_imgbtn_state_t::LV_IMGBTN_STATE_DISABLED lv_indev_type_t::LV_INDEV_TYPE_BUTTON
lv_imgbtn_state_t::LV_IMGBTN_STATE_PRESSED lv_indev_type_t::LV_INDEV_TYPE_ENCODER
lv_imgbtn_state_t::LV_IMGBTN_STATE_RELEASED lv_indev_type_t::LV_INDEV_TYPE_KEYPAD
lv_imgbtn_t (C++ struct), 362 lv_indev_type_t::LV_INDEV_TYPE_NONE
lv_imgbtn_t::act_cf (C++ member), 362 (C++ enumerator), 44
lv_imgbtn_t::img_src_left (C++ member), lv_indev_type_t::LV_INDEV_TYPE_POINTER
lv_imgbtn_t::img_src_mid (C++ member), 362 lv_indev_wait_release (C++ function), 139
lv_imgbtn_t::img_src_right (C++ member), lv_init (C++ function), 214
Index 472
lv_key_t (C++ type), 139 lv_label_t::tmp (C++ member), 285

lv_keyboard_class (C++ member), 366 lv_label_t::tmp_ptr (C++ member), 285
lv_keyboard_create (C++ function), 365 lv_layer_sys (C++ function), 148
lv_keyboard_def_event_cb (C++ function), 366 lv_layer_top (C++ function), 148
lv_keyboard_get_map_array (C++ function), LV_LAYOUT_FLEX (C++ member), 418
366 LV_LAYOUT_GRID (C++ member), 429
lv_keyboard_get_mode (C++ function), 365 lv_led_class (C++ member), 369
lv_keyboard_get_textarea (C++ function), 365 lv_led_create (C++ function), 368
lv_keyboard_mode_t (C++ type), 364 lv_led_get_brightness (C++ function), 368
lv_keyboard_set_map (C++ function), 365 lv_led_off (C++ function), 368
lv_keyboard_set_mode (C++ function), 365 lv_led_on (C++ function), 368
lv_keyboard_set_textarea (C++ function), 365 lv_led_set_brightness (C++ function), 368
lv_keyboard_t (C++ struct), 366 lv_led_set_color (C++ function), 368
lv_keyboard_t::btnm (C++ member), 366 lv_led_t (C++ struct), 369
lv_keyboard_t::mode (C++ member), 366 lv_led_t::bright (C++ member), 369
lv_keyboard_t::ta (C++ member), 366 lv_led_t::color (C++ member), 369
lv_label_class (C++ member), 285 lv_led_t::obj (C++ member), 369
lv_label_create (C++ function), 282 lv_led_toggle (C++ function), 368
lv_label_cut_text (C++ function), 284 lv_line_class (C++ member), 288
lv_label_get_letter_on (C++ function), 284 lv_line_create (C++ function), 287
lv_label_get_letter_pos (C++ function), 284 lv_line_get_y_invert (C++ function), 288
lv_label_get_long_mode (C++ function), 283 lv_line_set_points (C++ function), 287
lv_label_get_recolor (C++ function), 283 lv_line_set_y_invert (C++ function), 288
lv_label_get_text (C++ function), 283 lv_line_t (C++ struct), 288
lv_label_get_text_selection_end (C++ lv_line_t::obj (C++ member), 288
function), 284 lv_line_t::point_array (C++ member), 288
lv_label_get_text_selection_start (C++ lv_line_t::point_num (C++ member), 288
function), 284 lv_line_t::y_inv (C++ member), 288
lv_label_ins_text (C++ function), 284 lv_list_add_btn (C++ function), 371
lv_label_is_char_under_pos (C++ function), lv_list_add_text (C++ function), 371
284 lv_list_btn_class (C++ member), 371
lv_label_long_mode_t (C++ type), 282 lv_list_class (C++ member), 371
lv_label_set_long_mode (C++ function), 283 lv_list_create (C++ function), 371
lv_label_set_recolor (C++ function), 283 lv_list_get_btn_text (C++ function), 371
lv_label_set_text (C++ function), 282 lv_list_text_class (C++ member), 371
lv_label_set_text_sel_end (C++ function), lv_meter_add_arc (C++ function), 381
283 lv_meter_add_needle_img (C++ function), 380
lv_label_set_text_sel_start (C++ function), lv_meter_add_needle_line (C++ function), 380
283 lv_meter_add_scale (C++ function), 379
lv_label_t (C++ struct), 285 lv_meter_add_scale_lines (C++ function), 381
lv_label_t::dot (C++ member), 285 lv_meter_class (C++ member), 382
lv_label_t::dot_end (C++ member), 285 lv_meter_create (C++ function), 379
lv_label_t::dot_tmp_alloc (C++ member), lv_meter_indicator_t (C++ struct), 382
285 lv_meter_indicator_t::arc (C++ member),
lv_label_t::expand (C++ member), 285 383
lv_label_t::hint (C++ member), 285 lv_meter_indicator_t::color (C++ member),
lv_label_t::long_mode (C++ member), 285 383
lv_label_t::obj (C++ member), 285 lv_meter_indicator_t::color_end (C++
lv_label_t::offset (C++ member), 285 member), 383
lv_label_t::recolor (C++ member), 285 lv_meter_indicator_t::color_start (C++
lv_label_t::sel_end (C++ member), 285 member), 383
lv_label_t::sel_start (C++ member), 285 lv_meter_indicator_t::end_value (C++
lv_label_t::static_txt (C++ member), 285 member), 383
lv_label_t::text (C++ member), 285
Index 473
lv_meter_indicator_t::local_grad (C++ ber), 382

member), 383 lv_meter_scale_t::tick_major_color (C++
lv_meter_indicator_t::needle_img (C++ member), 382
member), 383 lv_meter_scale_t::tick_major_length
lv_meter_indicator_t::needle_line (C++ (C++ member), 382
member), 383 lv_meter_scale_t::tick_major_nth (C++
lv_meter_indicator_t::opa (C++ member), member), 382
383 lv_meter_scale_t::tick_major_width (C++
lv_meter_indicator_t::pivot (C++ member), member), 382
383 lv_meter_scale_t::tick_width (C++ mem-
lv_meter_indicator_t::r_mod (C++ member), ber), 382
383 lv_meter_set_indicator_end_value (C++
lv_meter_indicator_t::scale (C++ member), function), 382
383 lv_meter_set_indicator_start_value (C++
lv_meter_indicator_t::scale_lines (C++ function), 381
member), 383 lv_meter_set_indicator_value (C++ func-
lv_meter_indicator_t::src (C++ member), tion), 381
383 lv_meter_set_scale_major_ticks (C++ func-
lv_meter_indicator_t::start_value (C++ tion), 379
member), 383 lv_meter_set_scale_range (C++ function), 380
lv_meter_indicator_t::type (C++ member), lv_meter_set_scale_ticks (C++ function), 379
383 lv_meter_t (C++ struct), 383
lv_meter_indicator_t::type_data (C++ lv_meter_t::indicator_ll (C++ member), 383
member), 383 lv_meter_t::obj (C++ member), 383
lv_meter_indicator_t::width (C++ member), lv_meter_t::scale_ll (C++ member), 383
383 lv_msgbox_class (C++ member), 386
lv_meter_indicator_t::width_mod (C++ lv_msgbox_close (C++ function), 386
member), 383 lv_msgbox_create (C++ function), 385
lv_meter_indicator_type_t (C++ enum), 379 lv_msgbox_get_active_btn_text (C++ func-
tion), 386
lv_meter_indicator_type_t::LV_METER_INDICATOR_TYPE_ARC
(C++ enumerator), 379 lv_msgbox_get_btns (C++ function), 386
lv_msgbox_get_close_btn (C++ function), 386
lv_meter_indicator_type_t::LV_METER_INDICATOR_TYPE_NEEDLE_IMG
(C++ enumerator), 379 lv_msgbox_get_text (C++ function), 386
lv_msgbox_get_title (C++ function), 386
lv_meter_indicator_type_t::LV_METER_INDICATOR_TYPE_NEEDLE_LINE
(C++ enumerator), 379 lv_obj_add_flag (C++ function), 215
lv_obj_add_state (C++ function), 215
lv_meter_indicator_type_t::LV_METER_INDICATOR_TYPE_SCALE_LINES
(C++ enumerator), 379 lv_obj_allocate_spec_attr (C++ function),
lv_meter_scale_t (C++ struct), 382 216
lv_meter_scale_t::angle_range (C++ mem- lv_obj_check_type (C++ function), 216
ber), 382 lv_obj_class (C++ member), 217
lv_meter_scale_t::label_color (C++ mem- lv_obj_clear_flag (C++ function), 215
ber), 382 lv_obj_clear_state (C++ function), 215
lv_meter_scale_t::label_gap (C++ member), lv_obj_create (C++ function), 214
382 lv_obj_dpx (C++ function), 217
lv_meter_scale_t::max (C++ member), 382 lv_obj_flag_t (C++ type), 211
lv_meter_scale_t::min (C++ member), 382 lv_obj_get_class (C++ function), 216
lv_meter_scale_t::r_mod (C++ member), 382 lv_obj_get_group (C++ function), 216
lv_meter_scale_t::rotation (C++ member), lv_obj_get_state (C++ function), 216
382 lv_obj_get_style_align (C++ function), 93
lv_meter_scale_t::tick_cnt (C++ member), lv_obj_get_style_anim_speed (C++ function),
382 94
lv_meter_scale_t::tick_color (C++ mem- lv_obj_get_style_anim_time (C++ function),
ber), 382 94
lv_meter_scale_t::tick_length (C++ mem-
Index 474
lv_obj_get_style_arc_color (C++ function), lv_obj_get_style_color_filter_dsc (C++

97 function), 94
lv_obj_get_style_arc_color_filtered lv_obj_get_style_color_filter_opa (C++
(C++ function), 97 function), 94
lv_obj_get_style_arc_img_src (C++ func- lv_obj_get_style_flex_cross_place (C++
tion), 97 function), 418
lv_obj_get_style_arc_opa (C++ function), 97 lv_obj_get_style_flex_flow (C++ function),
lv_obj_get_style_arc_rounded (C++ func- 418
tion), 97 lv_obj_get_style_flex_grow (C++ function),
lv_obj_get_style_arc_width (C++ function), 418
97 lv_obj_get_style_flex_main_place (C++
lv_obj_get_style_base_dir (C++ function), 94 function), 418
lv_obj_get_style_bg_color (C++ function), 94 lv_obj_get_style_flex_track_place (C++
lv_obj_get_style_bg_color_filtered (C++ function), 418
function), 94 lv_obj_get_style_grid_cell_column_pos
lv_obj_get_style_bg_grad_color (C++ func- (C++ function), 429
tion), 94 lv_obj_get_style_grid_cell_column_span
lv_obj_get_style_bg_grad_color_filtered (C++ function), 429
(C++ function), 94 lv_obj_get_style_grid_cell_row_pos (C++
lv_obj_get_style_bg_grad_dir (C++ func- function), 429
tion), 94 lv_obj_get_style_grid_cell_row_span
lv_obj_get_style_bg_grad_stop (C++ func- (C++ function), 429
tion), 94 lv_obj_get_style_grid_cell_x_align (C++
lv_obj_get_style_bg_img_opa (C++ function), function), 429
94 lv_obj_get_style_grid_cell_y_align (C++
lv_obj_get_style_bg_img_recolor (C++ function), 429
function), 95 lv_obj_get_style_grid_column_align (C++
lv_obj_get_style_bg_img_recolor_filtered function), 429
(C++ function), 95 lv_obj_get_style_grid_column_dsc_array
lv_obj_get_style_bg_img_recolor_opa (C++ function), 429
(C++ function), 95 lv_obj_get_style_grid_row_align (C++
lv_obj_get_style_bg_img_src (C++ function), function), 429
94 lv_obj_get_style_grid_row_dsc_array
lv_obj_get_style_bg_img_tiled (C++ func- (C++ function), 429
tion), 95 lv_obj_get_style_height (C++ function), 93
lv_obj_get_style_bg_main_stop (C++ func- lv_obj_get_style_img_opa (C++ function), 95
tion), 94 lv_obj_get_style_img_recolor (C++ func-
lv_obj_get_style_bg_opa (C++ function), 94 tion), 95
lv_obj_get_style_blend_mode (C++ function), lv_obj_get_style_img_recolor_filtered
94 (C++ function), 96
lv_obj_get_style_border_color (C++ func- lv_obj_get_style_img_recolor_opa (C++
lv_obj_get_style_border_color_filtered lv_obj_get_style_layout (C++ function), 94
(C++ function), 95 lv_obj_get_style_line_color (C++ function),
lv_obj_get_style_border_opa (C++ function), 96
95 lv_obj_get_style_line_color_filtered
lv_obj_get_style_border_post (C++ func- (C++ function), 96
tion), 95 lv_obj_get_style_line_dash_gap (C++ func-
lv_obj_get_style_border_side (C++ function), 96
tion), 95 lv_obj_get_style_line_dash_width (C++
lv_obj_get_style_border_width (C++ func- function), 96
tion), 95 lv_obj_get_style_line_opa (C++ function), 97
lv_obj_get_style_clip_corner (C++ func- lv_obj_get_style_line_rounded (C++ func-
tion), 94 tion), 96
Index 475
lv_obj_get_style_line_width (C++ function), 95

96 lv_obj_get_style_text_letter_space (C++
lv_obj_get_style_max_height (C++ function), function), 95
93 lv_obj_get_style_text_line_space (C++
lv_obj_get_style_max_width (C++ function), function), 95
93 lv_obj_get_style_text_opa (C++ function), 95
lv_obj_get_style_min_height (C++ function), lv_obj_get_style_transform_angle (C++
93 function), 93
lv_obj_get_style_min_width (C++ function), lv_obj_get_style_transform_height (C++
93 function), 93
lv_obj_get_style_opa (C++ function), 94 lv_obj_get_style_transform_width (C++
lv_obj_get_style_outline_color (C++ func- function), 93
tion), 96 lv_obj_get_style_transform_zoom (C++
lv_obj_get_style_outline_color_filtered function), 93
(C++ function), 96 lv_obj_get_style_transition (C++ function),
lv_obj_get_style_outline_opa (C++ func- 94
tion), 96 lv_obj_get_style_translate_x (C++ func-
lv_obj_get_style_outline_pad (C++ function), 93
tion), 96 lv_obj_get_style_translate_y (C++ func-
lv_obj_get_style_outline_width (C++ function), 93
tion), 96 lv_obj_get_style_width (C++ function), 93
lv_obj_get_style_pad_bottom (C++ function), lv_obj_get_style_x (C++ function), 93
93 lv_obj_get_style_y (C++ function), 93
lv_obj_get_style_pad_column (C++ function), lv_obj_get_user_data (C++ function), 216
93 lv_obj_has_class (C++ function), 216
lv_obj_get_style_pad_left (C++ function), 93 lv_obj_has_flag (C++ function), 215
lv_obj_get_style_pad_right (C++ function), lv_obj_has_flag_any (C++ function), 215
93 lv_obj_has_state (C++ function), 216
lv_obj_get_style_pad_row (C++ function), 93 lv_obj_is_valid (C++ function), 216
lv_obj_get_style_pad_top (C++ function), 93 lv_obj_set_flex_align (C++ function), 417
lv_obj_get_style_radius (C++ function), 93 lv_obj_set_flex_flow (C++ function), 417
lv_obj_get_style_shadow_color (C++ func- lv_obj_set_flex_grow (C++ function), 417
tion), 96 lv_obj_set_grid_align (C++ function), 427
lv_obj_get_style_shadow_color_filtered lv_obj_set_grid_cell (C++ function), 427
(C++ function), 96 lv_obj_set_grid_dsc_array (C++ function),
lv_obj_get_style_shadow_ofs_x (C++ func- 427
tion), 96 lv_obj_set_style_align (C++ function), 97
lv_obj_get_style_shadow_ofs_y (C++ func- lv_obj_set_style_anim_speed (C++ function),
tion), 96 98
lv_obj_get_style_shadow_opa (C++ function), lv_obj_set_style_anim_time (C++ function),
96 98
lv_obj_get_style_shadow_spread (C++ func- lv_obj_set_style_arc_color (C++ function),
tion), 96 101
lv_obj_get_style_shadow_width (C++ func- lv_obj_set_style_arc_color_filtered
tion), 96 (C++ function), 101
lv_obj_get_style_text_align (C++ function), lv_obj_set_style_arc_img_src (C++ func-
95 tion), 102
lv_obj_get_style_text_color (C++ function), lv_obj_set_style_arc_opa (C++ function), 102
95 lv_obj_set_style_arc_rounded (C++ func-
lv_obj_get_style_text_color_filtered tion), 101
(C++ function), 95 lv_obj_set_style_arc_width (C++ function),
lv_obj_get_style_text_decor (C++ function), 101
95 lv_obj_set_style_base_dir (C++ function), 98
lv_obj_get_style_text_font (C++ function), lv_obj_set_style_bg_color (C++ function), 99
Index 476
lv_obj_set_style_bg_color_filtered (C++ function), 418

function), 99 lv_obj_set_style_grid_cell_column_pos
lv_obj_set_style_bg_grad_color (C++ func- (C++ function), 428
tion), 99 lv_obj_set_style_grid_cell_column_span
lv_obj_set_style_bg_grad_color_filtered (C++ function), 428
(C++ function), 99 lv_obj_set_style_grid_cell_row_pos (C++
lv_obj_set_style_bg_grad_dir (C++ func- function), 428
tion), 99 lv_obj_set_style_grid_cell_row_span
lv_obj_set_style_bg_grad_stop (C++ func- (C++ function), 428
tion), 99 lv_obj_set_style_grid_cell_x_align (C++
lv_obj_set_style_bg_img_opa (C++ function), function), 429
99 lv_obj_set_style_grid_cell_y_align (C++
lv_obj_set_style_bg_img_recolor (C++ function), 429
function), 99 lv_obj_set_style_grid_column_align (C++
lv_obj_set_style_bg_img_recolor_filtered function), 428
(C++ function), 99 lv_obj_set_style_grid_column_dsc_array
lv_obj_set_style_bg_img_recolor_opa (C++ function), 428
(C++ function), 99 lv_obj_set_style_grid_row_align (C++
lv_obj_set_style_bg_img_src (C++ function), function), 428
99 lv_obj_set_style_grid_row_dsc_array
lv_obj_set_style_bg_img_tiled (C++ func- (C++ function), 428
tion), 99 lv_obj_set_style_height (C++ function), 97
lv_obj_set_style_bg_main_stop (C++ func- lv_obj_set_style_img_opa (C++ function), 100
tion), 99 lv_obj_set_style_img_recolor (C++ func-
lv_obj_set_style_bg_opa (C++ function), 99 tion), 100
lv_obj_set_style_blend_mode (C++ function), lv_obj_set_style_img_recolor_filtered
98 (C++ function), 100
lv_obj_set_style_border_color (C++ func- lv_obj_set_style_img_recolor_opa (C++
lv_obj_set_style_border_color_filtered lv_obj_set_style_layout (C++ function), 98
(C++ function), 99 lv_obj_set_style_line_color (C++ function),
lv_obj_set_style_border_opa (C++ function), 101
99 lv_obj_set_style_line_color_filtered
lv_obj_set_style_border_post (C++ func- (C++ function), 101
tion), 100 lv_obj_set_style_line_dash_gap (C++ func-
lv_obj_set_style_border_side (C++ function), 101
tion), 99 lv_obj_set_style_line_dash_width (C++
lv_obj_set_style_border_width (C++ func- function), 101
tion), 99 lv_obj_set_style_line_opa (C++ function),
lv_obj_set_style_clip_corner (C++ func- 101
tion), 98 lv_obj_set_style_line_rounded (C++ func-
lv_obj_set_style_color_filter_dsc (C++ tion), 101
function), 98 lv_obj_set_style_line_width (C++ function),
lv_obj_set_style_color_filter_opa (C++ 101
function), 98 lv_obj_set_style_max_height (C++ function),
lv_obj_set_style_flex_cross_place (C++ 97
function), 418 lv_obj_set_style_max_width (C++ function),
lv_obj_set_style_flex_flow (C++ function), 97
417 lv_obj_set_style_min_height (C++ function),
lv_obj_set_style_flex_grow (C++ function), 97
418 lv_obj_set_style_min_width (C++ function),
lv_obj_set_style_flex_main_place (C++ 97
function), 418 lv_obj_set_style_opa (C++ function), 98
lv_obj_set_style_flex_track_place (C++ lv_obj_set_style_outline_color (C++ func-
Index 477

lv_obj_set_style_outline_color_filtered lv_obj_set_style_transform_zoom (C++
(C++ function), 100 function), 98
lv_obj_set_style_outline_opa (C++ func- lv_obj_set_style_transition (C++ function),
tion), 100 98
lv_obj_set_style_outline_pad (C++ func- lv_obj_set_style_translate_x (C++ func-
tion), 101 tion), 97
lv_obj_set_style_outline_width (C++ func- lv_obj_set_style_translate_y (C++ func-
tion), 100 tion), 97
lv_obj_set_style_pad_bottom (C++ function), lv_obj_set_style_width (C++ function), 97
98 lv_obj_set_style_x (C++ function), 97
lv_obj_set_style_pad_column (C++ function), lv_obj_set_style_y (C++ function), 97
98 lv_obj_set_tile (C++ function), 404
lv_obj_set_style_pad_left (C++ function), 98 lv_obj_set_tile_id (C++ function), 404
lv_obj_set_style_pad_right (C++ function), lv_obj_set_user_data (C++ function), 215
98 lv_obj_t (C++ type), 211
lv_obj_set_style_pad_row (C++ function), 98 lv_palette_darken (C++ function), 155
lv_obj_set_style_pad_top (C++ function), 98 lv_palette_lighten (C++ function), 155
lv_obj_set_style_radius (C++ function), 98 lv_palette_main (C++ function), 155
lv_obj_set_style_shadow_color (C++ func- lv_palette_t (C++ enum), 153
tion), 101 lv_palette_t::_LV_PALETTE_LAST (C++ enu-
lv_obj_set_style_shadow_color_filtered merator), 153
(C++ function), 101 lv_palette_t::LV_PALETTE_AMBER (C++ enu-
lv_obj_set_style_shadow_ofs_x (C++ func- merator), 153
tion), 101 lv_palette_t::LV_PALETTE_BLUE (C++ enu-
lv_obj_set_style_shadow_ofs_y (C++ func- merator), 153
tion), 101 lv_palette_t::LV_PALETTE_BLUE_GREY (C++
lv_obj_set_style_shadow_opa (C++ function), enumerator), 153
101 lv_palette_t::LV_PALETTE_BROWN (C++ enu-
lv_obj_set_style_shadow_spread (C++ func- merator), 153
tion), 101 lv_palette_t::LV_PALETTE_CYAN (C++ enu-
lv_obj_set_style_shadow_width (C++ func- merator), 153
tion), 101 lv_palette_t::LV_PALETTE_DEEP_ORANGE
lv_obj_set_style_text_align (C++ function), (C++ enumerator), 153
100 lv_palette_t::LV_PALETTE_DEEP_PURPLE
lv_obj_set_style_text_color (C++ function), (C++ enumerator), 153
100 lv_palette_t::LV_PALETTE_GREEN (C++ enu-
lv_obj_set_style_text_color_filtered merator), 153
(C++ function), 100 lv_palette_t::LV_PALETTE_GREY (C++ enu-
lv_obj_set_style_text_decor (C++ function), merator), 153
100 lv_palette_t::LV_PALETTE_INDIGO (C++
lv_obj_set_style_text_font (C++ function), enumerator), 153
100 lv_palette_t::LV_PALETTE_LIGHT_BLUE
lv_obj_set_style_text_letter_space (C++ (C++ enumerator), 153
function), 100 lv_palette_t::LV_PALETTE_LIGHT_GREEN
lv_obj_set_style_text_line_space (C++ (C++ enumerator), 153
function), 100 lv_palette_t::LV_PALETTE_LIME (C++ enu-
lv_obj_set_style_text_opa (C++ function), merator), 153
100 lv_palette_t::LV_PALETTE_NONE (C++ enu-
lv_obj_set_style_transform_angle (C++ merator), 153
function), 98 lv_palette_t::LV_PALETTE_ORANGE (C++
lv_obj_set_style_transform_height (C++ enumerator), 153
function), 97 lv_palette_t::LV_PALETTE_PINK (C++ enu-
lv_obj_set_style_transform_width (C++ merator), 153
Index 478
lv_palette_t::LV_PALETTE_PURPLE (C++ lv_slider_create (C++ function), 301

enumerator), 153 lv_slider_get_left_value (C++ function), 301
lv_palette_t::LV_PALETTE_RED (C++ enumer- lv_slider_get_max_value (C++ function), 302
ator), 153 lv_slider_get_min_value (C++ function), 301
lv_palette_t::LV_PALETTE_TEAL (C++ enu- lv_slider_get_mode (C++ function), 302
merator), 153 lv_slider_get_value (C++ function), 301
lv_palette_t::LV_PALETTE_YELLOW (C++ lv_slider_is_dragged (C++ function), 302
enumerator), 153 lv_slider_mode_t (C++ type), 300
lv_part_t (C++ type), 211 lv_slider_set_left_value (C++ function), 301
lv_roller_class (C++ member), 295 lv_slider_set_mode (C++ function), 301
lv_roller_create (C++ function), 294 lv_slider_set_range (C++ function), 301
lv_roller_get_option_cnt (C++ function), 295 lv_slider_set_value (C++ function), 301
lv_roller_get_options (C++ function), 295 lv_slider_t (C++ struct), 302
lv_roller_get_selected (C++ function), 295 lv_slider_t::bar (C++ member), 302
lv_roller_get_selected_str (C++ function), lv_slider_t::dragging (C++ member), 302
295 lv_slider_t::left_knob_area (C++ member),
lv_roller_mode_t (C++ type), 294 302
lv_roller_set_options (C++ function), 294 lv_slider_t::left_knob_focus (C++ mem-
lv_roller_set_selected (C++ function), 294 ber), 302
lv_roller_set_visible_row_count (C++ lv_slider_t::right_knob_area (C++ mem-
function), 294 ber), 302
lv_roller_t (C++ struct), 295 lv_slider_t::value_to_set (C++ member),
lv_roller_t::mode (C++ member), 296 302
lv_roller_t::moved (C++ member), 296 lv_span_mode_t (C++ type), 389
lv_roller_t::obj (C++ member), 295 lv_span_overflow_t (C++ type), 389
lv_roller_t::option_cnt (C++ member), 295 lv_span_set_text (C++ function), 390
lv_roller_t::sel_opt_id (C++ member), 295 lv_span_set_text_static (C++ function), 390
lv_roller_t::sel_opt_id_ori (C++ member), lv_span_t (C++ struct), 392
295 lv_span_t::spangroup (C++ member), 392
lv_scr_act (C++ function), 148 lv_span_t::static_flag (C++ member), 392
lv_scr_load (C++ function), 148 lv_span_t::style (C++ member), 392
lv_scr_load_anim (C++ function), 147 lv_span_t::txt (C++ member), 392
lv_scr_load_anim_t (C++ enum), 146 lv_spangroup_class (C++ member), 392
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_FADE_ON lv_spangroup_create (C++ function), 390
(C++ enumerator), 146 lv_spangroup_del_span (C++ function), 390
lv_spangroup_get_align (C++ function), 391
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_MOVE_BOTTOM
(C++ enumerator), 146 lv_spangroup_get_expand_height (C++ func-
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_MOVE_LEFT tion), 391
(C++ enumerator), 146 lv_spangroup_get_expand_width (C++ func-
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_MOVE_RIGHTtion), 391
(C++ enumerator), 146 lv_spangroup_get_indent (C++ function), 391
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_MOVE_TOPlv_spangroup_get_max_line_h (C++ function),
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_NONE lv_spangroup_get_mode (C++ function), 391
(C++ enumerator), 146 lv_spangroup_get_overflow (C++ function),
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_OVER_BOTTOM 391
(C++ enumerator), 146 lv_spangroup_new_span (C++ function), 390
lv_spangroup_refr_mode (C++ function), 391
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_OVER_LEFT
(C++ enumerator), 146 lv_spangroup_set_align (C++ function), 390
lv_spangroup_set_indent (C++ function), 390
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_OVER_RIGHT
(C++ enumerator), 146 lv_spangroup_set_mode (C++ function), 391
lv_scr_load_anim_t::LV_SCR_LOAD_ANIM_OVER_TOPlv_spangroup_set_overflow (C++ function),
lv_slider_class (C++ member), 302 lv_spangroup_t (C++ struct), 392
Index 479
lv_spangroup_t::cache_h (C++ member), 392 LV_STYLE_GRID_CELL_COLUMN_SPAN (C++ mem-

lv_spangroup_t::cache_w (C++ member), 392 ber), 429
lv_spangroup_t::child_ll (C++ member), 392 LV_STYLE_GRID_CELL_ROW_POS (C++ member),
lv_spangroup_t::indent (C++ member), 392 429
lv_spangroup_t::mode (C++ member), 392 LV_STYLE_GRID_CELL_ROW_SPAN (C++ member),
lv_spangroup_t::obj (C++ member), 392 429
lv_spangroup_t::overflow (C++ member), 392 LV_STYLE_GRID_CELL_X_ALIGN (C++ member),
lv_spangroup_t::refresh (C++ member), 392 429
lv_spinbox_class (C++ member), 396 LV_STYLE_GRID_CELL_Y_ALIGN (C++ member),
lv_spinbox_create (C++ function), 395 429
lv_spinbox_decrement (C++ function), 396 LV_STYLE_GRID_COLUMN_ALIGN (C++ member),
lv_spinbox_get_rollover (C++ function), 395 429
lv_spinbox_get_step (C++ function), 396 LV_STYLE_GRID_COLUMN_DSC_ARRAY (C++ mem-
lv_spinbox_get_value (C++ function), 396 ber), 429
lv_spinbox_increment (C++ function), 396 LV_STYLE_GRID_ROW_ALIGN (C++ member), 429
lv_spinbox_set_digit_format (C++ function), LV_STYLE_GRID_ROW_DSC_ARRAY (C++ member),
395 429
lv_spinbox_set_range (C++ function), 395 lv_style_init (C++ function), 88
lv_spinbox_set_rollover (C++ function), 395 lv_style_is_empty (C++ function), 89
lv_spinbox_set_step (C++ function), 395 lv_style_prop_get_default (C++ function), 89
lv_spinbox_set_value (C++ function), 395 lv_style_prop_t (C++ enum), 85
lv_spinbox_step_next (C++ function), 396 lv_style_prop_t::_LV_STYLE_LAST_BUILT_IN_PROP
lv_spinbox_step_prev (C++ function), 396 (C++ enumerator), 87
lv_spinbox_t (C++ struct), 396 lv_style_prop_t::LV_STYLE_ALIGN (C++
lv_spinbox_t::dec_point_pos (C++ member), enumerator), 85
396 lv_style_prop_t::LV_STYLE_ANIM_SPEED
lv_spinbox_t::digit_count (C++ member), (C++ enumerator), 87
396 lv_style_prop_t::LV_STYLE_ANIM_TIME
lv_spinbox_t::range_max (C++ member), 396 (C++ enumerator), 87
lv_spinbox_t::range_min (C++ member), 396 lv_style_prop_t::LV_STYLE_ARC_COLOR
lv_spinbox_t::rollover (C++ member), 396 (C++ enumerator), 87
lv_spinbox_t::step (C++ member), 396 lv_style_prop_t::LV_STYLE_ARC_COLOR_FILTERED
lv_spinbox_t::ta (C++ member), 396 (C++ enumerator), 87
lv_spinbox_t::value (C++ member), 396 lv_style_prop_t::LV_STYLE_ARC_IMG_SRC
lv_spinner_class (C++ member), 398 (C++ enumerator), 87
lv_spinner_create (C++ function), 398 lv_style_prop_t::LV_STYLE_ARC_OPA (C++
lv_state_t (C++ type), 211 enumerator), 87
lv_style_const_prop_t (C++ struct), 90 lv_style_prop_t::LV_STYLE_ARC_ROUNDED
lv_style_const_prop_t::prop (C++ member), (C++ enumerator), 87
91 lv_style_prop_t::LV_STYLE_ARC_WIDTH
lv_style_const_prop_t::value (C++ mem- (C++ enumerator), 87
ber), 91 lv_style_prop_t::LV_STYLE_BASE_DIR (C++
LV_STYLE_FLEX_CROSS_PLACE (C++ member), enumerator), 87
418 lv_style_prop_t::LV_STYLE_BG_COLOR (C++
LV_STYLE_FLEX_FLOW (C++ member), 418 enumerator), 86
LV_STYLE_FLEX_GROW (C++ member), 418 lv_style_prop_t::LV_STYLE_BG_COLOR_FILTERED
LV_STYLE_FLEX_MAIN_PLACE (C++ member), 418 (C++ enumerator), 86
LV_STYLE_FLEX_TRACK_PLACE (C++ member), lv_style_prop_t::LV_STYLE_BG_GRAD_COLOR
lv_style_get_prop (C++ function), 88 lv_style_prop_t::LV_STYLE_BG_GRAD_COLOR_FILTERED
lv_style_get_prop_inlined (C++ function), 89 (C++ enumerator), 86
LV_STYLE_GRID_CELL_COLUMN_POS (C++ mem- lv_style_prop_t::LV_STYLE_BG_GRAD_DIR
ber), 429 (C++ enumerator), 86
lv_style_prop_t::LV_STYLE_BG_GRAD_STOP
Index 480

lv_style_prop_t::LV_STYLE_BG_IMG_OPA lv_style_prop_t::LV_STYLE_LINE_DASH_WIDTH
lv_style_prop_t::LV_STYLE_BG_IMG_RECOLORlv_style_prop_t::LV_STYLE_LINE_OPA (C++
lv_style_prop_t::LV_STYLE_BG_IMG_RECOLOR_FILTERED
lv_style_prop_t::LV_STYLE_LINE_ROUNDED
lv_style_prop_t::LV_STYLE_BG_IMG_RECOLOR_OPA
lv_style_prop_t::LV_STYLE_LINE_WIDTH
lv_style_prop_t::LV_STYLE_BG_IMG_SRC lv_style_prop_t::LV_STYLE_MAX_HEIGHT
lv_style_prop_t::LV_STYLE_BG_IMG_TILED lv_style_prop_t::LV_STYLE_MAX_WIDTH
lv_style_prop_t::LV_STYLE_BG_MAIN_STOP lv_style_prop_t::LV_STYLE_MIN_HEIGHT
lv_style_prop_t::LV_STYLE_BG_OPA (C++ lv_style_prop_t::LV_STYLE_MIN_WIDTH
lv_style_prop_t::LV_STYLE_BLEND_MODE lv_style_prop_t::LV_STYLE_OPA (C++ enu-
lv_style_prop_t::LV_STYLE_BORDER_COLOR lv_style_prop_t::LV_STYLE_OUTLINE_COLOR
lv_style_prop_t::LV_STYLE_BORDER_COLOR_FILTERED
lv_style_prop_t::LV_STYLE_OUTLINE_COLOR_FILTERED
lv_style_prop_t::LV_STYLE_BORDER_OPA lv_style_prop_t::LV_STYLE_OUTLINE_OPA
lv_style_prop_t::LV_STYLE_BORDER_POST lv_style_prop_t::LV_STYLE_OUTLINE_PAD
lv_style_prop_t::LV_STYLE_BORDER_SIDE lv_style_prop_t::LV_STYLE_OUTLINE_WIDTH
lv_style_prop_t::LV_STYLE_BORDER_WIDTH lv_style_prop_t::LV_STYLE_PAD_BOTTOM
lv_style_prop_t::LV_STYLE_CLIP_CORNER lv_style_prop_t::LV_STYLE_PAD_COLUMN
lv_style_prop_t::LV_STYLE_PAD_LEFT (C++
lv_style_prop_t::LV_STYLE_COLOR_FILTER_DSC
lv_style_prop_t::LV_STYLE_COLOR_FILTER_OPA
lv_style_prop_t::LV_STYLE_PAD_RIGHT
lv_style_prop_t::LV_STYLE_HEIGHT (C++ lv_style_prop_t::LV_STYLE_PAD_ROW (C++
lv_style_prop_t::LV_STYLE_IMG_OPA (C++ lv_style_prop_t::LV_STYLE_PAD_TOP (C++
lv_style_prop_t::LV_STYLE_IMG_RECOLOR lv_style_prop_t::LV_STYLE_PROP_ANY (C++
lv_style_prop_t::LV_STYLE_PROP_INV (C++
lv_style_prop_t::LV_STYLE_IMG_RECOLOR_FILTERED
lv_style_prop_t::LV_STYLE_RADIUS (C++
lv_style_prop_t::LV_STYLE_IMG_RECOLOR_OPA
lv_style_prop_t::LV_STYLE_LAYOUT (C++ lv_style_prop_t::LV_STYLE_SHADOW_COLOR
lv_style_prop_t::LV_STYLE_LINE_COLOR lv_style_prop_t::LV_STYLE_SHADOW_COLOR_FILTERED
lv_style_prop_t::LV_STYLE_LINE_COLOR_FILTERED
lv_style_prop_t::LV_STYLE_SHADOW_OFS_X
lv_style_prop_t::LV_STYLE_LINE_DASH_GAP lv_style_prop_t::LV_STYLE_SHADOW_OFS_Y
Index 481
(C++ enumerator), 86 lv_style_set_arc_rounded (C++ function), 106

lv_style_prop_t::LV_STYLE_SHADOW_OPA lv_style_set_arc_width (C++ function), 106
(C++ enumerator), 86 lv_style_set_base_dir (C++ function), 103
lv_style_prop_t::LV_STYLE_SHADOW_SPREAD lv_style_set_bg_color (C++ function), 103
(C++ enumerator), 86 lv_style_set_bg_color_filtered (C++ func-
lv_style_prop_t::LV_STYLE_SHADOW_WIDTH tion), 103
(C++ enumerator), 86 lv_style_set_bg_grad_color (C++ function),
lv_style_prop_t::LV_STYLE_TEXT_ALIGN 103
(C++ enumerator), 87 lv_style_set_bg_grad_color_filtered
lv_style_prop_t::LV_STYLE_TEXT_COLOR (C++ function), 103
(C++ enumerator), 87 lv_style_set_bg_grad_dir (C++ function), 103
lv_style_prop_t::LV_STYLE_TEXT_COLOR_FILTERED lv_style_set_bg_grad_stop (C++ function),
lv_style_prop_t::LV_STYLE_TEXT_DECOR lv_style_set_bg_img_opa (C++ function), 104
(C++ enumerator), 87 lv_style_set_bg_img_recolor (C++ function),
lv_style_prop_t::LV_STYLE_TEXT_FONT 104
(C++ enumerator), 87 lv_style_set_bg_img_recolor_filtered
lv_style_prop_t::LV_STYLE_TEXT_LETTER_SPACE (C++ function), 104
(C++ enumerator), 87 lv_style_set_bg_img_recolor_opa (C++
lv_style_prop_t::LV_STYLE_TEXT_LINE_SPACE function), 104
(C++ enumerator), 87 lv_style_set_bg_img_src (C++ function), 104
lv_style_prop_t::LV_STYLE_TEXT_OPA (C++ lv_style_set_bg_img_tiled (C++ function),
enumerator), 87 104
lv_style_prop_t::LV_STYLE_TRANSFORM_ANGLE lv_style_set_bg_main_stop (C++ function),
lv_style_prop_t::LV_STYLE_TRANSFORM_HEIGHT lv_style_set_bg_opa (C++ function), 103
(C++ enumerator), 85 lv_style_set_blend_mode (C++ function), 103
lv_style_prop_t::LV_STYLE_TRANSFORM_WIDTH lv_style_set_border_color (C++ function),
lv_style_prop_t::LV_STYLE_TRANSFORM_ZOOMlv_style_set_border_color_filtered (C++
(C++ enumerator), 85 function), 104
lv_style_prop_t::LV_STYLE_TRANSITION lv_style_set_border_opa (C++ function), 104
(C++ enumerator), 87 lv_style_set_border_post (C++ function), 104
lv_style_prop_t::LV_STYLE_TRANSLATE_X lv_style_set_border_side (C++ function), 104
(C++ enumerator), 85 lv_style_set_border_width (C++ function),
lv_style_prop_t::LV_STYLE_TRANSLATE_Y 104
(C++ enumerator), 85 lv_style_set_clip_corner (C++ function), 103
lv_style_prop_t::LV_STYLE_WIDTH (C++ lv_style_set_color_filter_dsc (C++ func-
enumerator), 85 tion), 103
lv_style_prop_t::LV_STYLE_X (C++ enumera- lv_style_set_color_filter_opa (C++ func-
tor), 85 tion), 103
lv_style_prop_t::LV_STYLE_Y (C++ enumera- lv_style_set_flex_cross_place (C++ func-
tor), 85 tion), 417
lv_style_register_prop (C++ function), 88 lv_style_set_flex_flow (C++ function), 417
lv_style_remove_prop (C++ function), 88 lv_style_set_flex_grow (C++ function), 417
lv_style_reset (C++ function), 88 lv_style_set_flex_main_place (C++ func-
lv_style_set_align (C++ function), 102 tion), 417
lv_style_set_anim_speed (C++ function), 103 lv_style_set_flex_track_place (C++ func-
lv_style_set_anim_time (C++ function), 103 tion), 417
lv_style_set_arc_color (C++ function), 106 lv_style_set_grid_cell_column_pos (C++
lv_style_set_arc_color_filtered (C++ function), 428
function), 106 lv_style_set_grid_cell_column_span (C++
lv_style_set_arc_img_src (C++ function), 106 function), 428
lv_style_set_arc_opa (C++ function), 106 lv_style_set_grid_cell_row_pos (C++ func-
Index 482
tion), 428 lv_style_set_pad_row (C++ function), 103

lv_style_set_grid_cell_row_span (C++ lv_style_set_pad_top (C++ function), 102
function), 428 lv_style_set_pad_ver (C++ function), 89
lv_style_set_grid_cell_x_align (C++ func- lv_style_set_prop (C++ function), 88
tion), 428 lv_style_set_radius (C++ function), 103
lv_style_set_grid_cell_y_align (C++ func- lv_style_set_shadow_color (C++ function),
tion), 428 105
lv_style_set_grid_column_align (C++ func- lv_style_set_shadow_color_filtered (C++
lv_style_set_grid_column_dsc_array (C++ lv_style_set_shadow_ofs_x (C++ function),
function), 428 105
lv_style_set_grid_row_align (C++ function), lv_style_set_shadow_ofs_y (C++ function),
428 105
lv_style_set_grid_row_dsc_array (C++ lv_style_set_shadow_opa (C++ function), 105
function), 428 lv_style_set_shadow_spread (C++ function),
lv_style_set_height (C++ function), 102 105
lv_style_set_img_opa (C++ function), 105 lv_style_set_shadow_width (C++ function),
lv_style_set_img_recolor (C++ function), 105 105
lv_style_set_img_recolor_filtered (C++ lv_style_set_size (C++ function), 90
function), 105 lv_style_set_text_align (C++ function), 104
lv_style_set_img_recolor_opa (C++ func- lv_style_set_text_color (C++ function), 104
tion), 105 lv_style_set_text_color_filtered (C++
lv_style_set_layout (C++ function), 103 function), 104
lv_style_set_line_color (C++ function), 105 lv_style_set_text_decor (C++ function), 104
lv_style_set_line_color_filtered (C++ lv_style_set_text_font (C++ function), 104
function), 106 lv_style_set_text_letter_space (C++ func-
lv_style_set_line_dash_gap (C++ function), tion), 104
105 lv_style_set_text_line_space (C++ func-
lv_style_set_line_dash_width (C++ function), 104
tion), 105 lv_style_set_text_opa (C++ function), 104
lv_style_set_line_opa (C++ function), 106 lv_style_set_transform_angle (C++ func-
lv_style_set_line_rounded (C++ function), tion), 102
105 lv_style_set_transform_height (C++ func-
lv_style_set_line_width (C++ function), 105 tion), 102
lv_style_set_max_height (C++ function), 102 lv_style_set_transform_width (C++ func-
lv_style_set_max_width (C++ function), 102 tion), 102
lv_style_set_min_height (C++ function), 102 lv_style_set_transform_zoom (C++ function),
lv_style_set_min_width (C++ function), 102 102
lv_style_set_opa (C++ function), 103 lv_style_set_transition (C++ function), 103
lv_style_set_outline_color (C++ function), lv_style_set_translate_x (C++ function), 102
105 lv_style_set_translate_y (C++ function), 102
lv_style_set_outline_color_filtered lv_style_set_width (C++ function), 102
(C++ function), 105 lv_style_set_x (C++ function), 102
lv_style_set_outline_opa (C++ function), 105 lv_style_set_y (C++ function), 102
lv_style_set_outline_pad (C++ function), 105 lv_style_t (C++ struct), 91
lv_style_set_outline_width (C++ function), lv_style_t::const_props (C++ member), 91
105 lv_style_t::has_group (C++ member), 91
lv_style_set_pad_all (C++ function), 89 lv_style_t::is_const (C++ member), 91
lv_style_set_pad_bottom (C++ function), 102 lv_style_t::prop1 (C++ member), 91
lv_style_set_pad_column (C++ function), 103 lv_style_t::prop_cnt (C++ member), 91
lv_style_set_pad_gap (C++ function), 89 lv_style_t::sentinel (C++ member), 91
lv_style_set_pad_hor (C++ function), 89 lv_style_t::v_p (C++ member), 91
lv_style_set_pad_left (C++ function), 102 lv_style_t::value1 (C++ member), 91
lv_style_set_pad_right (C++ function), 103
Index 483
lv_style_t::values_and_props (C++ mem- lv_tabview_get_tab_act (C++ function), 402

ber), 91 lv_tabview_get_tab_btns (C++ function), 401
lv_style_transition_dsc_init (C++ func- lv_tabview_set_act (C++ function), 402
tion), 89 lv_tabview_t (C++ struct), 402
lv_style_transition_dsc_t (C++ struct), 90 lv_tabview_t::map (C++ member), 402
lv_style_transition_dsc_t::delay (C++ lv_tabview_t::obj (C++ member), 402
member), 90 lv_tabview_t::tab_cnt (C++ member), 402
lv_style_transition_dsc_t::path_xcb lv_tabview_t::tab_cur (C++ member), 402
(C++ member), 90 lv_tabview_t::tab_pos (C++ member), 402
lv_style_transition_dsc_t::props (C++ lv_text_decor_t (C++ type), 84
member), 90 lv_textarea_add_char (C++ function), 319
lv_style_transition_dsc_t::time (C++ lv_textarea_add_text (C++ function), 319
member), 90 lv_textarea_class (C++ member), 323
lv_style_transition_dsc_t::user_data lv_textarea_clear_selection (C++ function),
(C++ member), 90 323
lv_style_value_t (C++ union), 90 lv_textarea_create (C++ function), 319
lv_style_value_t::color (C++ member), 90 lv_textarea_cursor_down (C++ function), 323
lv_style_value_t::num (C++ member), 90 lv_textarea_cursor_left (C++ function), 323
lv_style_value_t::ptr (C++ member), 90 lv_textarea_cursor_right (C++ function), 323
lv_switch_class (C++ member), 305 lv_textarea_cursor_up (C++ function), 323
lv_switch_create (C++ function), 304 lv_textarea_del_char (C++ function), 320
lv_switch_t (C++ struct), 305 lv_textarea_del_char_forward (C++ func-
lv_switch_t::obj (C++ member), 305 tion), 320
lv_table_add_cell_ctrl (C++ function), 311 lv_textarea_get_accepted_chars (C++ func-
lv_table_cell_ctrl_t (C++ type), 310 tion), 322
lv_table_class (C++ member), 313 lv_textarea_get_cursor_click_pos (C++
lv_table_clear_cell_ctrl (C++ function), 311 function), 322
lv_table_create (C++ function), 310 lv_textarea_get_cursor_pos (C++ function),
lv_table_get_cell_value (C++ function), 312 322
lv_table_get_col_cnt (C++ function), 312 lv_textarea_get_label (C++ function), 322
lv_table_get_col_width (C++ function), 312 lv_textarea_get_max_length (C++ function),
lv_table_get_row_cnt (C++ function), 312 322
lv_table_get_selected_cell (C++ function), lv_textarea_get_one_line (C++ function), 322
312 lv_textarea_get_password_mode (C++ func-
lv_table_has_cell_ctrl (C++ function), 312 tion), 322
lv_table_set_cell_value (C++ function), 310 lv_textarea_get_password_show_time (C++
lv_table_set_cell_value_fmt (C++ function), function), 323
311 lv_textarea_get_placeholder_text (C++
lv_table_set_col_cnt (C++ function), 311 function), 322
lv_table_set_col_width (C++ function), 311 lv_textarea_get_text (C++ function), 321
lv_table_set_row_cnt (C++ function), 311 lv_textarea_get_text_selection (C++ func-
lv_table_t (C++ struct), 313 tion), 322
lv_table_t::cell_data (C++ member), 313 lv_textarea_set_accepted_chars (C++ func-
lv_table_t::col_act (C++ member), 313 tion), 321
lv_table_t::col_cnt (C++ member), 313 lv_textarea_set_align (C++ function), 321
lv_table_t::col_w (C++ member), 313 lv_textarea_set_cursor_click_pos (C++
lv_table_t::obj (C++ member), 313 function), 320
lv_table_t::row_act (C++ member), 313 lv_textarea_set_cursor_pos (C++ function),
lv_table_t::row_cnt (C++ member), 313 320
lv_table_t::row_h (C++ member), 313 lv_textarea_set_insert_replace (C++ func-
lv_tabview_add_tab (C++ function), 401 tion), 321
lv_tabview_class (C++ member), 402 lv_textarea_set_max_length (C++ function),
lv_tabview_create (C++ function), 401 321
lv_tabview_get_content (C++ function), 401 lv_textarea_set_one_line (C++ function), 320
Index 484
lv_textarea_set_password_mode (C++ func- lv_tileview_add_tile (C++ function), 404

tion), 320 lv_tileview_class (C++ member), 405
lv_textarea_set_password_show_time (C++ lv_tileview_create (C++ function), 404
function), 321 lv_tileview_get_tile_act (C++ function), 404
lv_textarea_set_placeholder_text (C++ lv_tileview_t (C++ struct), 405
function), 320 lv_tileview_t::obj (C++ member), 405
lv_textarea_set_text (C++ function), 320 lv_tileview_t::tile_act (C++ member), 405
lv_textarea_set_text_selection (C++ func- lv_tileview_tile_class (C++ member), 405
tion), 321 lv_tileview_tile_t (C++ struct), 405
lv_textarea_t (C++ struct), 323 lv_tileview_tile_t::dir (C++ member), 405
lv_textarea_t::accepted_chars (C++ mem- lv_tileview_tile_t::obj (C++ member), 405
ber), 323 lv_timer_cb_t (C++ type), 197
lv_textarea_t::area (C++ member), 323 lv_timer_create (C++ function), 197
lv_textarea_t::click_pos (C++ member), 324 lv_timer_create_basic (C++ function), 197
lv_textarea_t::cursor (C++ member), 324 lv_timer_del (C++ function), 197
lv_textarea_t::label (C++ member), 323 lv_timer_enable (C++ function), 198
lv_textarea_t::max_length (C++ member), lv_timer_get_idle (C++ function), 198
323 lv_timer_get_next (C++ function), 198
lv_textarea_t::obj (C++ member), 323 lv_timer_pause (C++ function), 198
lv_textarea_t::one_line (C++ member), 324 lv_timer_ready (C++ function), 198
lv_textarea_t::placeholder_txt (C++ mem- lv_timer_reset (C++ function), 198
ber), 323 lv_timer_resume (C++ function), 198
lv_textarea_t::pos (C++ member), 323 lv_timer_set_cb (C++ function), 198
lv_textarea_t::pwd_mode (C++ member), 324 lv_timer_set_period (C++ function), 198
lv_textarea_t::pwd_show_time (C++ mem- lv_timer_set_repeat_count (C++ function),
ber), 323 198
lv_textarea_t::pwd_tmp (C++ member), 323 lv_timer_t (C++ type), 197
lv_textarea_t::sel_end (C++ member), 324 lv_win_add_btn (C++ function), 407
lv_textarea_t::sel_start (C++ member), 324 lv_win_add_title (C++ function), 407
lv_textarea_t::show (C++ member), 324 lv_win_class (C++ member), 408
lv_textarea_t::text_sel_en (C++ member), lv_win_create (C++ function), 407
324 lv_win_get_content (C++ function), 408
lv_textarea_t::text_sel_in_prog (C++ lv_win_get_header (C++ function), 407
member), 324 lv_win_t (C++ struct), 408
lv_textarea_t::txt_byte_pos (C++ member), lv_win_t::obj (C++ member), 408
323
lv_textarea_t::valid_x (C++ member), 323
lv_textarea_text_is_selected (C++ func-
tion), 322
lv_theme_apply (C++ function), 91
lv_theme_apply_cb_t (C++ type), 91
lv_theme_get_color_primary (C++ function),
92
lv_theme_get_color_secondary (C++ func-
tion), 92
lv_theme_get_font_large (C++ function), 92
lv_theme_get_font_normal (C++ function), 92
lv_theme_get_font_small (C++ function), 92
lv_theme_get_from_obj (C++ function), 91
lv_theme_set_apply_cb (C++ function), 91
lv_theme_set_parent (C++ function), 91
lv_theme_t (C++ type), 91
lv_tick_elaps (C++ function), 49
lv_tick_get (C++ function), 49
Index 485

LVGL

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

LVGL

Uploaded by

Copyright:

Available Formats

LVGL Documentation 8.

Jan 10, 2022

PDF version: LVGL.pdf

1.1 Key features

1.4 Repository layout

All repositories of the LVGL project are hosted on GitHub: https://github.com/lvgl

1.5 Release policy

The core repositories follow the rules of Semantic versioning:

1.5.1 Release cycle

• Bugfixes: Released on demand even weekly

The core repositories have at least the following branches:

The changes are recorded in CHANGELOG.md.

1.5.4 Version support

1.6.1 Where can I ask questions?

You can ask questions in the forum: https://forum.lvgl.io/.

1.6.2 Is my MCU/hardware supported?

1.6.3 Is my display supported?

1.6.6 Why do I see only garbage on the screen?

lv_color_t buf[BUF_W * BUF_H];

1.6.7 Why I see nonsense colors on the screen?

1.6.8 How to speed up my UI?

• Turn on compiler optimization and enable cache if your MCU has

1.6.9 How to reduce flash/ROM usage?

1.6.10 How to reduce the RAM usage

• Lower the size of the Display buffer

1.6.11 How to work with an operating system?

2.1 Quick overview

2.1.1 Get started in a simulator

2.1.2 Add LVGL into your project

lv_disp_draw_buf_init(&draw_buf, buf1, NULL, MY_DISP_HOR_RES * MY_DISP_VER_SER / 10);␣

void my_disp_flush(lv_disp_drv_t * disp, const lv_area_t * area, lv_color_t * color_p)

lv_disp_flush_ready(disp); /* Indicate you are ready with the flushing*/

2.1. Quick overview 8

(continued from previous page)

void my_touchpad_read(lv_indev_t * indev, lv_indev_data_t * data)

2.1.3 Learn the basics

lv_obj_t * slider1 = lv_slider_create(lv_scr_act());

lv_slider_set_value(slider1, 70, LV_ANIM_ON);

2.1. Quick overview 9

lv_obj_add_event_cb(btn, btn_event_cb, LV_EVENT_CLICKED, NULL); /*Assign a callback␣

lv_event_code_t code = lv_event_get_code(e);

The object that triggered the event can be retrieved with

lv_obj_t * obj = lv_event_get_target(e);

To learn all features of the events go to the Event overview section.

The objects can be in a combination of the following states:

2.1. Quick overview 10

static lv_style_t style1;

See the full list of properties here.

lv_obj_add_style(slider1, &style1, LV_PART_INDICATOR | LV_STATE_PRESSED);

If the part is LV_PART_MAIN it can be omitted:

lv_obj_add_style(btn1, &style1, LV_STATE_PRESSED); /*Equal to LV_PART_MAIN | LV_STATE_

Similarly, LV_STATE_DEFAULT can be omitted too:

lv_obj_add_style(slider1, &style1, LV_PART_INDICATOR); /*Equal to LV_PART_INDICATOR |␣

For LV_STATE_DEFAULT and LV_PART_MAIN simply write 0:

lv_obj_add_style(btn1, &style1, 0); /*Equal to LV_PART_MAIN | LV_STATE_DEFAULT*/

lv_obj_add_style(btn1, &style_btn, 0);

2.1. Quick overview 11

lv_obj_set_style_bg_color(slider1, lv_color_hex(0x2080bb), LV_PART_INDICATOR | LV_

A button with a label and react on click event

static void btn_event_cb(lv_event_t * e)

lv_obj_set_pos(btn, 10, 10); /*Set its position*/

lv_obj_t * label = lv_label_create(btn); /*Add a label to the button*/

2.1. Quick overview 12

(continued from previous page)

lv_obj_add_style(btn1, &style1, 0); /Equal to LV_PART_MAIN | LV_STATE_DEFAULT/

lv_obj_set_pos(btn, 10, 10); /Set its position/

lv_obj_t * label = lv_label_create(btn); /Add a label to the button/

/Create a red style. Change only some colors./

/Create a button and use the new styles/

/Add a label to the button/

/Create an other button and use the red style too/

/Refresh the text/

/Create a label below the slider/