README.rst
1.. zephyr:code-sample:: lvgl-demos
2 :name: LVGL demos
3 :relevant-api: display_interface
4
5 Run LVGL built-in demos.
6
7Overview
8********
9
10A sample showcasing upstream LVGL demos.
11
12* Music
13 The music player demo shows what kind of modern, smartphone-like user interfaces can be created on LVGL.
14* Benchmark
15 The benchmark demo tests the performance in various cases. For example rectangle, border, shadow, text, image blending, image transformation, blending modes, etc.
16* Stress
17 A stress test for LVGL. It contains a lot of object creation, deletion, animations, styles usage, and so on. It can be used if there is any memory corruption during heavy usage or any memory leaks.
18* Widgets
19 Shows how the widgets look like out of the box using the built-in material theme.
20
21Requirements
22************
23
24* A board with display, ideally with 480x272 resolution or higher.
25
26Building and Running
27********************
28
29These demos can be built as follows:
30
31.. zephyr-app-commands::
32 :zephyr-app: samples/modules/lvgl/demos
33 :host-os: unix
34 :board: native_sim
35 :gen-args: -DCONFIG_LV_Z_DEMO_MUSIC=y
36 :goals: run
37 :compact:
38
39.. zephyr-app-commands::
40 :zephyr-app: samples/modules/lvgl/demos
41 :host-os: unix
42 :board: native_sim
43 :gen-args: -DCONFIG_LV_Z_DEMO_BENCHMARK=y
44 :goals: run
45 :compact:
46
47.. zephyr-app-commands::
48 :zephyr-app: samples/modules/lvgl/demos
49 :host-os: unix
50 :board: native_sim
51 :gen-args: -DCONFIG_LV_Z_DEMO_STRESS=y
52 :goals: run
53 :compact:
54
55.. zephyr-app-commands::
56 :zephyr-app: samples/modules/lvgl/demos
57 :host-os: unix
58 :board: native_sim
59 :gen-args: -DCONFIG_LV_Z_DEMO_WIDGETS=y
60 :goals: run
61 :compact:
62
