Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

LVGL 9.4 documentation

Toggle table of contents sidebar

Select LVGL version

Introduction
Toggle navigation of Introduction
Getting started
Toggle navigation of Getting started

Examples
Integrating LVGL
Toggle navigation of Integrating LVGL
- Overview
  Toggle navigation of Overview
- Running on PC
  Toggle navigation of Running on PC
  - Linux
  - Windows
  - macOS
  - Browser
  - SDL Driver
  - UEFI
- Running under Embedded Linux
  Toggle navigation of Running under Embedded Linux
  - Overview
  - OpenGL Overview
  - OS Support
    Toggle navigation of OS Support
    - Buildroot
      Toggle navigation of Buildroot
    - Yocto
      Toggle navigation of Yocto
    - Torizon OS
  - Drivers
    Toggle navigation of Drivers
- RTOS Support
  Toggle navigation of RTOS Support
  - FreeRTOS
  - MQX RTOS
  - NuttX RTOS
  - PX5 RTOS
  - QNX
  - RT-Thread RTOS
  - Zephyr
- Framework Support
  Toggle navigation of Framework Support
- Board Support
  Toggle navigation of Board Support
  - LVGL Supported
  - Partner Supported
  - Boards
    Toggle navigation of Boards
    - ICOP
    - Toradex
    - Riverdi
    - Viewe
- Chip Vendor Support
  Toggle navigation of Chip Vendor Support
  - Alif
    Toggle navigation of Alif
    - Overview
    - Dave2D GPU
  - Arm
    Toggle navigation of Arm
    - Overview
    - Arm-2D GPU
  - Espressif
    Toggle navigation of Espressif
  - NXP
    Toggle navigation of NXP
  - Renesas
    Toggle navigation of Renesas
  - STM32
    Toggle navigation of STM32
- Display Controller Support
  Toggle navigation of Display Controller Support
  - EVE
    Toggle navigation of EVE
    - EVE (FT81x)
    - EVE External GPU Renderer
  - Generic MIPI DCS compatible LCD Controller driver
  - ILI9341 LCD Controller driver
  - ST7735 LCD Controller driver
  - ST7789 LCD Controller driver
  - ST7796 LCD Controller driver
- Build System Support
  Toggle navigation of Build System Support
  - make
  - CMake
- Bindings
  Toggle navigation of Bindings
Common Widget Features
Toggle navigation of Common Widget Features
- Overview
- API Conventions
- Widget Tree
- Screens
- Position and Size
- Parts and States
- Layers
- Styles
  Toggle navigation of Styles
- Events
- Flags
- Layouts
  Toggle navigation of Layouts
  - Overview
  - Flex
  - Grid
- Scrolling
All Widgets
Toggle navigation of All Widgets
Main Modules
Toggle navigation of Main Modules
- Display (lv_display)
  Toggle navigation of Display (lv_display)
- Input devices (lv_indev)
  Toggle navigation of Input devices (lv_indev)
- Color (lv_color)
- Font (lv_font)
- Images (lv_image)
- Timer (lv_timer)
- Animation (lv_anim)
- File System (lv_fs_drv)
- Drawing
  Toggle navigation of Drawing
UI Editor and XML
Toggle navigation of UI Editor and XML
- Introduction
- Learn by Examples
- UI Editor
  Toggle navigation of UI Editor
- XML Overview
  Toggle navigation of XML Overview
  - Overview
  - Syntax
- Integration
  Toggle navigation of Integration
  - Using the Exported C Code
  - Loading XML Files at Runtime
- UI Elements
  Toggle navigation of UI Elements
  - Components
  - Widgets
  - Screens
  - Animations
  - API
  - Constants
  - Events
  - Preview
  - Styles
  - View
- Assets
  Toggle navigation of Assets
  - Images
  - Fonts
- Features
  Toggle navigation of Features
- Tools
  Toggle navigation of Tools
- Licenses
  Toggle navigation of Licenses
  - XML License
  - Editor license
Auxiliary Modules
Toggle navigation of Auxiliary Modules
- File Explorer
- Font Manager
- Fragment
- Grid navigation
- Pinyin IME
- Image font
- Monkey
- Widget ID
- Widget Properties
- Observer
  Toggle navigation of Observer
  - How to Use
  - Examples
- Snapshot
- System Monitor (sysmon)
- UI Testing
- Translation
3rd-Party Libraries
Toggle navigation of 3rd-Party Libraries
Debugging
Toggle navigation of Debugging

Contributing
Toggle navigation of Contributing
Change Log
API
Toggle navigation of API
- lv_api_map_v8.h
- lv_api_map_v9_0.h
- lv_api_map_v9_1.h
- lv_api_map_v9_2.h
- lv_api_map_v9_3.h
- lv_conf_internal.h
- lv_conf_kconfig.h
- lv_init.h
- lvgl.h
- lvgl_private.h
- core
  Toggle navigation of core
- display
  Toggle navigation of display
  - lv_display.h
  - lv_display_private.h
- draw
  Toggle navigation of draw
  - lv_draw.h
  - lv_draw_3d.h
  - lv_draw_arc.h
  - lv_draw_buf.h
  - lv_draw_buf_private.h
  - lv_draw_image.h
  - lv_draw_image_private.h
  - lv_draw_label.h
  - lv_draw_label_private.h
  - lv_draw_line.h
  - lv_draw_mask.h
  - lv_draw_mask_private.h
  - lv_draw_private.h
  - lv_draw_rect.h
  - lv_draw_rect_private.h
  - lv_draw_triangle.h
  - lv_draw_triangle_private.h
  - lv_draw_vector.h
  - lv_draw_vector_private.h
  - lv_image_decoder.h
  - lv_image_decoder_private.h
  - lv_image_dsc.h
  - convert
    Toggle navigation of convert
    - lv_draw_buf_convert.h
    - helium
      Toggle navigation of helium
      - lv_draw_buf_convert_helium.h
    - neon
      Toggle navigation of neon
      - lv_draw_buf_convert_neon.h
  - dma2d
    Toggle navigation of dma2d
    - lv_draw_dma2d.h
    - lv_draw_dma2d_private.h
  - espressif
    Toggle navigation of espressif
    - ppa
      Toggle navigation of ppa
      - lv_draw_ppa.h
      - lv_draw_ppa_private.h
  - eve
    Toggle navigation of eve
  - nema_gfx
    Toggle navigation of nema_gfx
  - nxp
    Toggle navigation of nxp
    - g2d
      Toggle navigation of g2d
    - pxp
      Toggle navigation of pxp
  - opengles
    Toggle navigation of opengles
    - lv_draw_opengles.h
  - renesas
    Toggle navigation of renesas
    - dave2d
      Toggle navigation of dave2d
      - lv_draw_dave2d.h
      - lv_draw_dave2d_utils.h
  - sdl
    Toggle navigation of sdl
    - lv_draw_sdl.h
  - sw
    Toggle navigation of sw
    - lv_draw_sw.h
    - lv_draw_sw_grad.h
    - lv_draw_sw_mask.h
    - lv_draw_sw_mask_private.h
    - lv_draw_sw_private.h
    - lv_draw_sw_utils.h
    - arm2d
      Toggle navigation of arm2d
      - lv_draw_sw_arm2d.h
      - lv_draw_sw_helium.h
    - blend
      Toggle navigation of blend
      - lv_draw_sw_blend.h
      - lv_draw_sw_blend_private.h
      - lv_draw_sw_blend_to_al88.h
      - lv_draw_sw_blend_to_argb8888.h
      - lv_draw_sw_blend_to_argb8888_premultiplied.h
      - lv_draw_sw_blend_to_i1.h
      - lv_draw_sw_blend_to_l8.h
      - lv_draw_sw_blend_to_rgb565.h
      - lv_draw_sw_blend_to_rgb565_swapped.h
      - lv_draw_sw_blend_to_rgb888.h
      - arm2d
        Toggle navigation of arm2d
        
        lv_blend_arm2d.h
      - helium
        Toggle navigation of helium
        
        lv_blend_helium.h
      - neon
        Toggle navigation of neon
        
        lv_blend_neon.h
        
        lv_draw_sw_blend_neon_to_rgb565.h
        
        lv_draw_sw_blend_neon_to_rgb888.h
  - vg_lite
    Toggle navigation of vg_lite
- drivers
  Toggle navigation of drivers
  - lv_drivers.h
  - display
    Toggle navigation of display
    - drm
      Toggle navigation of drm
      - lv_linux_drm.h
      - lv_linux_drm_egl_private.h
    - fb
      Toggle navigation of fb
      - lv_linux_fbdev.h
    - ft81x
      Toggle navigation of ft81x
      - lv_ft81x.h
      - lv_ft81x_defines.h
    - ili9341
      Toggle navigation of ili9341
      - lv_ili9341.h
    - lcd
      Toggle navigation of lcd
      - lv_lcd_generic_mipi.h
    - lovyan_gfx
      Toggle navigation of lovyan_gfx
      - lv_lgfx_user.hpp
      - lv_lovyan_gfx.h
    - nxp_elcdif
      Toggle navigation of nxp_elcdif
      - lv_nxp_elcdif.h
    - renesas_glcdc
      Toggle navigation of renesas_glcdc
      - lv_renesas_glcdc.h
    - st7735
      Toggle navigation of st7735
      - lv_st7735.h
    - st7789
      Toggle navigation of st7789
      - lv_st7789.h
    - st7796
      Toggle navigation of st7796
      - lv_st7796.h
    - st_ltdc
      Toggle navigation of st_ltdc
      - lv_st_ltdc.h
    - tft_espi
      Toggle navigation of tft_espi
      - lv_tft_espi.h
  - draw
    Toggle navigation of draw
    - eve
      Toggle navigation of eve
      - lv_draw_eve_display.h
      - lv_draw_eve_display_defines.h
  - evdev
    Toggle navigation of evdev
    - lv_evdev.h
    - lv_evdev_private.h
  - libinput
    Toggle navigation of libinput
  - nuttx
    Toggle navigation of nuttx
  - opengles
    Toggle navigation of opengles
    - lv_opengles_debug.h
    - lv_opengles_driver.h
    - lv_opengles_egl.h
    - lv_opengles_egl_private.h
    - lv_opengles_glfw.h
    - lv_opengles_private.h
    - lv_opengles_texture.h
    - lv_opengles_texture_private.h
    - lv_opengles_window.h
    - assets
      Toggle navigation of assets
      - lv_opengles_standard_shader.h
    - opengl_shader
      Toggle navigation of opengl_shader
      - lv_opengl_shader_internal.h
  - qnx
    Toggle navigation of qnx
    - lv_qnx.h
  - sdl
    Toggle navigation of sdl
  - uefi
    Toggle navigation of uefi
  - wayland
    Toggle navigation of wayland
  - windows
    Toggle navigation of windows
  - x11
    Toggle navigation of x11
    - lv_x11.h
- font
  Toggle navigation of font
- indev
  Toggle navigation of indev
- layouts
  Toggle navigation of layouts
  - lv_layout.h
  - lv_layout_private.h
  - flex
    Toggle navigation of flex
    - lv_flex.h
  - grid
    Toggle navigation of grid
    - lv_grid.h
- libs
  Toggle navigation of libs
  - barcode
    Toggle navigation of barcode
    - lv_barcode.h
    - lv_barcode_private.h
  - bin_decoder
    Toggle navigation of bin_decoder
    - lv_bin_decoder.h
  - bmp
    Toggle navigation of bmp
    - lv_bmp.h
  - ffmpeg
    Toggle navigation of ffmpeg
    - lv_ffmpeg.h
    - lv_ffmpeg_private.h
  - freetype
    Toggle navigation of freetype
    - lv_freetype.h
    - lv_freetype_private.h
  - fsdrv
    Toggle navigation of fsdrv
    - lv_fsdrv.h
  - gif
    Toggle navigation of gif
    - lv_gif.h
  - gltf
    Toggle navigation of gltf
    - gltf_data
      Toggle navigation of gltf_data
    - gltf_view
      Toggle navigation of gltf_view
      - lv_gltf.h
      - lv_gltf_view_internal.h
      - assets
        Toggle navigation of assets
        
        lv_gltf_view_shader.h
      - ibl
        Toggle navigation of ibl
        
        lv_gltf_ibl_sampler.h
    - math
      Toggle navigation of math
      - lv_gltf_math.hpp
  - gstreamer
    Toggle navigation of gstreamer
    - lv_gstreamer.h
    - lv_gstreamer_internal.h
  - libjpeg_turbo
    Toggle navigation of libjpeg_turbo
    - lv_libjpeg_turbo.h
  - libpng
    Toggle navigation of libpng
    - lv_libpng.h
  - lodepng
    Toggle navigation of lodepng
    - lv_lodepng.h
  - qrcode
    Toggle navigation of qrcode
    - lv_qrcode.h
    - lv_qrcode_private.h
  - rle
    Toggle navigation of rle
    - lv_rle.h
  - rlottie
    Toggle navigation of rlottie
    - lv_rlottie.h
    - lv_rlottie_private.h
  - svg
    Toggle navigation of svg
  - tiny_ttf
    Toggle navigation of tiny_ttf
    - lv_tiny_ttf.h
  - tjpgd
    Toggle navigation of tjpgd
    - lv_tjpgd.h
- misc
  Toggle navigation of misc
  - lv_anim.h
  - lv_anim_private.h
  - lv_anim_timeline.h
  - lv_anim_timeline_private.h
  - lv_area.h
  - lv_area_private.h
  - lv_array.h
  - lv_assert.h
  - lv_async.h
  - lv_bidi.h
  - lv_bidi_private.h
  - lv_circle_buf.h
  - lv_color.h
  - lv_color_op.h
  - lv_color_op_private.h
  - lv_event.h
  - lv_event_private.h
  - lv_fs.h
  - lv_fs_private.h
  - lv_grad.h
  - lv_iter.h
  - lv_ll.h
  - lv_log.h
  - lv_lru.h
  - lv_math.h
  - lv_matrix.h
  - lv_palette.h
  - lv_profiler.h
  - lv_profiler_builtin.h
  - lv_profiler_builtin_private.h
  - lv_rb.h
  - lv_rb_private.h
  - lv_style.h
  - lv_style_gen.h
  - lv_style_private.h
  - lv_templ.h
  - lv_text.h
  - lv_text_ap.h
  - lv_text_private.h
  - lv_timer.h
  - lv_timer_private.h
  - lv_tree.h
  - lv_utils.h
  - cache
    Toggle navigation of cache
    - lv_cache.h
    - lv_cache_entry.h
    - lv_cache_entry_private.h
    - lv_cache_private.h
    - class
      Toggle navigation of class
    - instance
      Toggle navigation of instance
- osal
  Toggle navigation of osal
- others
  Toggle navigation of others
  - file_explorer
    Toggle navigation of file_explorer
    - lv_file_explorer.h
    - lv_file_explorer_private.h
  - font_manager
    Toggle navigation of font_manager
    - lv_font_manager.h
    - lv_font_manager_recycle.h
  - fragment
    Toggle navigation of fragment
    - lv_fragment.h
    - lv_fragment_private.h
  - gridnav
    Toggle navigation of gridnav
    - lv_gridnav.h
  - ime
    Toggle navigation of ime
    - lv_ime_pinyin.h
    - lv_ime_pinyin_private.h
  - imgfont
    Toggle navigation of imgfont
    - lv_imgfont.h
  - monkey
    Toggle navigation of monkey
    - lv_monkey.h
    - lv_monkey_private.h
  - observer
    Toggle navigation of observer
    - lv_observer.h
    - lv_observer_private.h
  - snapshot
    Toggle navigation of snapshot
    - lv_snapshot.h
  - sysmon
    Toggle navigation of sysmon
    - lv_sysmon.h
    - lv_sysmon_private.h
  - test
    Toggle navigation of test
  - translation
    Toggle navigation of translation
    - lv_translation.h
    - lv_translation_private.h
  - xml
    Toggle navigation of xml
- stdlib
  Toggle navigation of stdlib
  - lv_mem.h
  - lv_mem_private.h
  - lv_sprintf.h
  - lv_string.h
  - builtin
    Toggle navigation of builtin
    - lv_tlsf.h
    - lv_tlsf_private.h
- themes
  Toggle navigation of themes
  - lv_theme.h
  - lv_theme_private.h
  - default
    Toggle navigation of default
    - lv_theme_default.h
  - mono
    Toggle navigation of mono
    - lv_theme_mono.h
  - simple
    Toggle navigation of simple
    - lv_theme_simple.h
- tick
  Toggle navigation of tick
  - lv_tick.h
  - lv_tick_private.h
- widgets
  Toggle navigation of widgets
  - 3dtexture
    Toggle navigation of 3dtexture
    - lv_3dtexture.h
    - lv_3dtexture_private.h
  - animimage
    Toggle navigation of animimage
    - lv_animimage.h
    - lv_animimage_private.h
  - arc
    Toggle navigation of arc
    - lv_arc.h
    - lv_arc_private.h
  - arclabel
    Toggle navigation of arclabel
    - lv_arclabel.h
    - lv_arclabel_private.h
  - bar
    Toggle navigation of bar
    - lv_bar.h
    - lv_bar_private.h
  - button
    Toggle navigation of button
    - lv_button.h
    - lv_button_private.h
  - buttonmatrix
    Toggle navigation of buttonmatrix
    - lv_buttonmatrix.h
    - lv_buttonmatrix_private.h
  - calendar
    Toggle navigation of calendar
  - canvas
    Toggle navigation of canvas
    - lv_canvas.h
    - lv_canvas_private.h
  - chart
    Toggle navigation of chart
    - lv_chart.h
    - lv_chart_private.h
  - checkbox
    Toggle navigation of checkbox
    - lv_checkbox.h
    - lv_checkbox_private.h
  - dropdown
    Toggle navigation of dropdown
    - lv_dropdown.h
    - lv_dropdown_private.h
  - image
    Toggle navigation of image
    - lv_image.h
    - lv_image_private.h
  - imagebutton
    Toggle navigation of imagebutton
    - lv_imagebutton.h
    - lv_imagebutton_private.h
  - keyboard
    Toggle navigation of keyboard
    - lv_keyboard.h
    - lv_keyboard_private.h
  - label
    Toggle navigation of label
    - lv_label.h
    - lv_label_private.h
  - led
    Toggle navigation of led
    - lv_led.h
    - lv_led_private.h
  - line
    Toggle navigation of line
    - lv_line.h
    - lv_line_private.h
  - list
    Toggle navigation of list
    - lv_list.h
  - lottie
    Toggle navigation of lottie
    - lv_lottie.h
    - lv_lottie_private.h
  - menu
    Toggle navigation of menu
    - lv_menu.h
    - lv_menu_private.h
  - msgbox
    Toggle navigation of msgbox
    - lv_msgbox.h
    - lv_msgbox_private.h
  - objx_templ
    Toggle navigation of objx_templ
    - lv_objx_templ.h
  - property
    Toggle navigation of property
    - lv_obj_property_names.h
    - lv_style_properties.h
  - roller
    Toggle navigation of roller
    - lv_roller.h
    - lv_roller_private.h
  - scale
    Toggle navigation of scale
    - lv_scale.h
    - lv_scale_private.h
  - slider
    Toggle navigation of slider
    - lv_slider.h
    - lv_slider_private.h
  - span
    Toggle navigation of span
    - lv_span.h
    - lv_span_private.h
  - spinbox
    Toggle navigation of spinbox
    - lv_spinbox.h
    - lv_spinbox_private.h
  - spinner
    Toggle navigation of spinner
    - lv_spinner.h
  - switch
    Toggle navigation of switch
    - lv_switch.h
    - lv_switch_private.h
  - table
    Toggle navigation of table
    - lv_table.h
    - lv_table_private.h
  - tabview
    Toggle navigation of tabview
    - lv_tabview.h
    - lv_tabview_private.h
  - textarea
    Toggle navigation of textarea
    - lv_textarea.h
    - lv_textarea_private.h
  - tileview
    Toggle navigation of tileview
    - lv_tileview.h
    - lv_tileview_private.h
  - win
    Toggle navigation of win
    - lv_win.h
    - lv_win_private.h

Toggle table of contents sidebar

Editor license¶

Auxiliary Modules

Copyright © 2021-2025, LVGL Kft

Made with Furo

Last updated on Oct 01, 2025