diff --git a/docs/README_jp.md b/docs/README_jp.md index 2e8197d236..5d210e66a6 100644 --- a/docs/README_jp.md +++ b/docs/README_jp.md @@ -61,7 +61,7 @@ LVGL LLC では、グラフィックデザイン、UI実装、コンサルティ **ウィジェット、スタイル、レイアウトなど** - 30以上の組み込み [ウィジェット](https://docs-lvgl-io.translate.goog/master/widgets/index.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja): ボタン、ラベル、スライダー、グラフ、キーボード、メーター、円弧、表など。 - - ウィジェットの任意の部分を任意の状態にカスタマイズ可能な豊富なスタイルプロパティを備えた柔軟な [スタイルシステム](https://docs-lvgl-io.translate.goog/master/overview/style.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja)。 + - ウィジェットの任意の部分を任意の状態にカスタマイズ可能な豊富なスタイルプロパティを備えた柔軟な [スタイルシステム](https://docs-lvgl-io.translate.goog/master/overview/styles.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja)。 - [Flexbox](https://docs-lvgl-io.translate.goog/master/layouts/flex.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja) および [グリッド](https://docs-lvgl-io.translate.goog/master/layouts/grid.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja) 風のレイアウトエンジンにより、ウィジェットのサイズと位置を自動的に設定。 - テキスト表示(UTF-8対応)は、中国語、日本語、韓国語、タイ語、ヒンディー語、アラビア語、ペルシア語をサポート。 - ワードラッピング、カーニング、テキストスクロール、サブピクセルレンダリング、ピンイン-IME中国語入力、テキスト中の絵文字に対応。 diff --git a/docs/README_zh.md b/docs/README_zh.md index 94345f5f71..663143be2e 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -56,7 +56,7 @@ * 不依赖特定的硬件平台，可以在任何显示屏上运行 * 配置可裁剪（最低资源占用：64 kB Flash，16 kB RAM） * 基于UTF-8的多语种支持，例如中文、日文、韩文、阿拉伯文等 -* 可以通过[类CSS](https://docs.lvgl.io/master/overview/style.html)的方式来设计、布局图形界面（例如：[Flex](https://docs.lvgl.io/master/layouts/flex.html)、[Grid](https://docs.lvgl.io/master/layouts/grid.html)） +* 可以通过[类CSS](https://docs.lvgl.io/master/overview/styles.html)的方式来设计、布局图形界面（例如：[Flex](https://docs.lvgl.io/master/layouts/flex.html)、[Grid](https://docs.lvgl.io/master/layouts/grid.html)） * 支持操作系统、外置内存、以及硬件加速（LVGL已内建支持STM32 DMA2D、SWM341 DMA2D、NXP PXP和VGLite） * 即便仅有[单缓冲区(frame buffer)](https://docs.lvgl.io/master/porting/display.html)的情况下，也可保证渲染如丝般顺滑 * 全部由C编写完成，并支持C++调用 diff --git a/docs/src/CHANGELOG.rst b/docs/src/CHANGELOG.rst index a7402360e1..a8d5c55ca2 100644 --- a/docs/src/CHANGELOG.rst +++ b/docs/src/CHANGELOG.rst @@ -15,7 +15,7 @@ It's huge release with many interesting updates: - Matrix transformations during rendering - New :ref:`file system interfaces `: LittleFS, ESP LittleFS, Arduino FS - SDL renderer improvements (supporting all draw task types and improving speed) -- Radial, Conic, and Skew `gradients supported `__ by software rendering and VG-Lite +- Radial, Conic, and Skew `gradients supported `__ by software rendering and VG-Lite - :ref:`qnx` and :ref:`mqx` support - :ref:`Mouse hover handling ` - :ref:`lv_lottie` support diff --git a/docs/src/conf.py b/docs/src/conf.py index b71925b45c..4062c2e0f5 100755 --- a/docs/src/conf.py +++ b/docs/src/conf.py @@ -426,7 +426,7 @@ redirects = { "overview/renderers/vg_lite": "../../details/integration/renderers/vg_lite.html" , "overview/renderers/vglite": "../../details/integration/renderers/nxp_vglite_gpu.html" , "overview/scroll": "../details/common-widget-features/scroll.html" , - "overview/style": "../details/common-widget-features/styles/style.html" , + "overview/style": "../details/common-widget-features/styles/styles.html" , "overview/style-props": "../details/common-widget-features/styles/style-properties.html" , "overview/timer": "../details/main-modules/timer.html" , "porting/display": "../details/main-modules/display.html" , diff --git a/docs/src/details/common-widget-features/events.rst b/docs/src/details/common-widget-features/events.rst index c7c8938656..cf64d1d0a5 100644 --- a/docs/src/details/common-widget-features/events.rst +++ b/docs/src/details/common-widget-features/events.rst @@ -41,7 +41,7 @@ In the example :cpp:enumerator:`LV_EVENT_CLICKED` means that only the click even call ``my_event_cb``. See the :ref:`list of event codes ` for all the options. :cpp:enumerator:`LV_EVENT_ALL` can be used to receive all events. -The last parameter of :cpp:func:`lv_obj_add_event` is a pointer to any custom +The last parameter of :cpp:func:`lv_obj_add_event_cb` is a pointer to any custom data that will be available in the event. NULL may be passed for this argument if there is no need to use that data when the event is processed. You can retrieve the pointer passed when setting the callback function like this: @@ -168,7 +168,7 @@ Special Events -------------- - :cpp:enumerator:`LV_EVENT_VALUE_CHANGED`: Widget's value has changed (i.e. slider moved) -- :cpp:enumerator:`LV_EVENT_INSERT`: A text is inserted to Widget. The event data is ``char `*`` being inserted. +- :cpp:enumerator:`LV_EVENT_INSERT`: A text is inserted to Widget. The event data is ``char *`` being inserted. - :cpp:enumerator:`LV_EVENT_REFRESH`: Notify Widget to refresh something on it (for the user) - :cpp:enumerator:`LV_EVENT_READY`: A process has finished - :cpp:enumerator:`LV_EVENT_CANCEL`: A process has been cancelled @@ -247,8 +247,8 @@ contains all data about the event. The following values can be gotten from it: - :cpp:expr:`lv_event_get_code(e)`: get the event code - :cpp:expr:`lv_event_get_current_target(e)`: get Widget to which an event was sent. I.e. the Widget whose event handler is being called. - :cpp:expr:`lv_event_get_target(e)`: get Widget that originally triggered the event (different from :cpp:func:`lv_event_get_target` if :ref:`event bubbling ` is enabled) -- :cpp:expr:`lv_event_get_user_data(e)`: get the pointer passed as the last parameter of :cpp:func:`lv_obj_add_event`. -- :cpp:expr:`lv_event_get_param(e)`: get the parameter passed as the last parameter of :cpp:func:`lv_obj_send_event` +- :cpp:expr:`lv_event_get_user_data(e)`: get the pointer passed as the last parameter of :cpp:func:`lv_obj_add_event_cb`. +- :cpp:expr:`lv_event_get_param(e)`: get the parameter passed as the last parameter of :cpp:func:`lv_obj_send_event_cb` .. _event_bubbling: @@ -278,3 +278,23 @@ Examples API *** + +.. API equals: + lv_cover_check_info_t + lv_display_add_event_cb + lv_event_get_code + lv_event_get_target_obj + lv_event_get_user_data + lv_event_register_id + LV_EVENT_RENDER_START + lv_event_t + lv_indev_active + lv_indev_add_event_cb + lv_indev_get_gesture_dir + lv_indev_get_key + lv_obj_add_event_cb + lv_obj_add_flag + lv_obj_get_event_count + lv_obj_remove_event + lv_obj_send_event + diff --git a/docs/src/details/common-widget-features/styles/index.rst b/docs/src/details/common-widget-features/styles/index.rst index abfadaf66c..cfbc2efd6c 100644 --- a/docs/src/details/common-widget-features/styles/index.rst +++ b/docs/src/details/common-widget-features/styles/index.rst @@ -7,5 +7,5 @@ Styles .. toctree:: :maxdepth: 2 - style + styles style-properties diff --git a/docs/src/details/common-widget-features/styles/style.rst b/docs/src/details/common-widget-features/styles/styles.rst similarity index 99% rename from docs/src/details/common-widget-features/styles/style.rst rename to docs/src/details/common-widget-features/styles/styles.rst index 713994cf41..9de48e4533 100644 --- a/docs/src/details/common-widget-features/styles/style.rst +++ b/docs/src/details/common-widget-features/styles/styles.rst @@ -592,3 +592,7 @@ Examples API *** + +.. API equals: lv_style_init, lv_style_t, lv_obj_add_style, LV_PART_MAIN, LV_STATE_DEFAULT + +.. API startswith: lv_style_set_, lv_obj_set_ diff --git a/docs/src/details/integration/renderers/sw.rst b/docs/src/details/integration/renderers/sw.rst index d5afcdbb22..9b931ca930 100644 --- a/docs/src/details/integration/renderers/sw.rst +++ b/docs/src/details/integration/renderers/sw.rst @@ -5,8 +5,4 @@ Software Renderer API *** -:ref:`lv_draw_sw_h` - -:ref:`lv_draw_sw_blend_h` - -:ref:`lv_draw_sw_gradient_h` +.. API startswith: lv_draw_sw diff --git a/docs/src/details/main-modules/display/color_format.rst b/docs/src/details/main-modules/display/color_format.rst index 94331ed650..4923db4c94 100644 --- a/docs/src/details/main-modules/display/color_format.rst +++ b/docs/src/details/main-modules/display/color_format.rst @@ -151,3 +151,18 @@ In summary, to enable transparent screens and displays for OSD menu-like UIs: :cpp:expr:`lv_obj_set_style_bg_opa(lv_layer_bottom(), LV_OPA_TRANSP, LV_PART_MAIN)` - Set a color format with alpha channel. E.g. :cpp:expr:`lv_display_set_color_format(disp, LV_COLOR_FORMAT_ARGB8888)` + + + +API +*** + +.. API equals: + LV_COLOR_DEPTH + LV_COLOR_FORMAT_ARGB8888 + lv_display_set_buffers + lv_display_set_color_depth + lv_display_set_color_format + lv_draw_sw_i1_convert_to_vtiled + lv_draw_sw_rgb565_swap + lv_obj_set_style_bg_opa diff --git a/docs/src/details/main-modules/display/display_events.rst b/docs/src/details/main-modules/display/display_events.rst index 4abf05e06d..3ab7c05805 100644 --- a/docs/src/details/main-modules/display/display_events.rst +++ b/docs/src/details/main-modules/display/display_events.rst @@ -18,3 +18,10 @@ If you added ``user_data`` to the Display, you can retrieve it in an event like The following events are sent for Display (lv_display_t) objects: .. include:: display_events_list.txt + + + +API +*** + +.. API equals: lv_display_add_event_cb diff --git a/docs/src/details/main-modules/display/inactivity.rst b/docs/src/details/main-modules/display/inactivity.rst index fd30d2e1d2..3d45bdc4a7 100644 --- a/docs/src/details/main-modules/display/inactivity.rst +++ b/docs/src/details/main-modules/display/inactivity.rst @@ -21,3 +21,10 @@ You can manually trigger an activity using - `lv_port_disp_template.c `__ for a template for your own driver. - :ref:`Drawing ` to learn more about how rendering works in LVGL. + + + +API +*** + +.. API equals: lv_display_get_inactive_time diff --git a/docs/src/details/main-modules/display/overview.rst b/docs/src/details/main-modules/display/overview.rst index 14edef281f..3d10d4eda7 100644 --- a/docs/src/details/main-modules/display/overview.rst +++ b/docs/src/details/main-modules/display/overview.rst @@ -67,3 +67,10 @@ with ``lv_display_t`` object. This pointer can be used later, e.g. in :ref:`display_events`. See code example for how to do this in :ref:`display_events`. + +API +*** + +.. API equals: + lv_display_set_dpi + lv_display_set_user_data diff --git a/docs/src/details/main-modules/display/redraw_area.rst b/docs/src/details/main-modules/display/redraw_area.rst index 45f7a8bb07..5af493049a 100644 --- a/docs/src/details/main-modules/display/redraw_area.rst +++ b/docs/src/details/main-modules/display/redraw_area.rst @@ -26,3 +26,11 @@ The size of the invalidated (redrawn) area can be controlled as follows: ... lv_display_add_event_cb(disp, rounder_event_cb, LV_EVENT_INVALIDATE_AREA, NULL); + + + +API +*** + +.. API equals: + lv_event_get_invalidated_area diff --git a/docs/src/details/main-modules/display/refreshing.rst b/docs/src/details/main-modules/display/refreshing.rst index b32798080d..1f6c47a8a0 100644 --- a/docs/src/details/main-modules/display/refreshing.rst +++ b/docs/src/details/main-modules/display/refreshing.rst @@ -63,3 +63,15 @@ which might take longer. The parameter of :cpp:func:`lv_refr_now` is a pointer to the display to refresh. If ``NULL`` is passed, all displays that have active refresh timers will be refreshed. + + + +API +*** + +.. API equals: + LV_DEF_REFR_PERIOD + lv_display_refr_timer + lv_display_set_default + lv_refr_now + lv_timer_handler diff --git a/docs/src/details/main-modules/display/resolution.rst b/docs/src/details/main-modules/display/resolution.rst index f0bdda9240..6c0c9cc9be 100644 --- a/docs/src/details/main-modules/display/resolution.rst +++ b/docs/src/details/main-modules/display/resolution.rst @@ -14,3 +14,14 @@ the active LVGL display area. So the physical resolution and the offset of the active area can be set with :cpp:expr:`lv_display_set_physical_resolution(disp, hor_res, ver_res)` and :cpp:expr:`lv_display_set_offset(disp, x, y)` + + + +API +*** + +.. API equals: + lv_display_set_resolution, + lv_display_set_physical_resolution, + lv_display_set_offset + diff --git a/docs/src/details/main-modules/display/rotation.rst b/docs/src/details/main-modules/display/rotation.rst index caaf192d3a..a2889cb81d 100644 --- a/docs/src/details/main-modules/display/rotation.rst +++ b/docs/src/details/main-modules/display/rotation.rst @@ -94,3 +94,10 @@ into a **frame buffer of the LCD peripheral**. lv_draw_sw_rotate(px_map, fb_start, src_w, src_h, src_stride, fb_stride, rotation, cf); } } + + + +API +*** + +.. API equals: lv_display_set_rotation diff --git a/docs/src/details/main-modules/display/screen_layers.rst b/docs/src/details/main-modules/display/screen_layers.rst index c7b251b443..40cbbef3ce 100644 --- a/docs/src/details/main-modules/display/screen_layers.rst +++ b/docs/src/details/main-modules/display/screen_layers.rst @@ -87,3 +87,17 @@ Active Screen's background opacity is < 255. :ref:`transparent_screens`. + + +API +*** + +.. API equals: + lv_screen_active, + lv_layer_top, + lv_layer_sys, + lv_layer_bottom, + lv_display_get_screen_active, + lv_display_get_layer_top, + lv_display_get_layer_sys, + lv_display_get_layer_bottom diff --git a/docs/src/details/main-modules/display/setup.rst b/docs/src/details/main-modules/display/setup.rst index 2e6e4fdca1..109a53d113 100644 --- a/docs/src/details/main-modules/display/setup.rst +++ b/docs/src/details/main-modules/display/setup.rst @@ -190,4 +190,15 @@ However, if a Flush-Wait Callback is not set, LVGL assumes that :cpp:func:`lv_display_flush_ready` is called after the flush has completed. +API +*** +.. API equals: + lv_display_create, + lv_display_flush_is_last, + lv_display_flush_ready, + lv_display_set_buffers, + lv_display_set_default, + lv_display_set_flush_cb, + lv_display_set_flush_wait_cb + lv_display_t, diff --git a/docs/src/details/main-modules/display/tiling.rst b/docs/src/details/main-modules/display/tiling.rst index 0abef8d61a..05154e4d65 100644 --- a/docs/src/details/main-modules/display/tiling.rst +++ b/docs/src/details/main-modules/display/tiling.rst @@ -55,3 +55,10 @@ there are 2 tiles, then 1/20th + 1/20th of the screen area will be rendered at o Tiled rendering only affects the rendering process, and the :ref:`flush_callback` is called once for each invalidated area. Therefore, tiling is not visible from the flushing point of view. + + + +API +*** + +.. API equals: lv_display_set_tile_cnt, LV_DISPLAY_RENDER_MODE_FULL diff --git a/docs/src/details/main-modules/image.rst b/docs/src/details/main-modules/image.rst index ccf0bb157d..c17e54cf58 100644 --- a/docs/src/details/main-modules/image.rst +++ b/docs/src/details/main-modules/image.rst @@ -641,3 +641,6 @@ following code to replace the LVGL built-in cache manager: API *** + +.. API startswith: + lv_image_ diff --git a/docs/src/intro/getting_started.rst b/docs/src/intro/getting_started.rst index ae202efac0..090d052864 100644 --- a/docs/src/intro/getting_started.rst +++ b/docs/src/intro/getting_started.rst @@ -441,3 +441,7 @@ advancing your knowledge: +API +*** +.. API equals: lv_screen_load, lv_obj_delete, lv_obj_add_event_cb, lv_event_get_code, + lv_obj_has_state, lv_style_init diff --git a/docs/src/intro/introduction.rst b/docs/src/intro/introduction.rst index 10117de8f7..b84268edac 100644 --- a/docs/src/intro/introduction.rst +++ b/docs/src/intro/introduction.rst @@ -164,7 +164,8 @@ Be sure you are calling :cpp:expr:`lv_display_flush_ready(drv)` at the end of yo Why do I see only garbage on the screen? ---------------------------------------- -There is probably a bug in your display driver. Try the following code without using LVGL. You should see a square with red-blue gradient. +There is probably a bug in your display driver. Try the following code without using +LVGL. You should see a square with red-blue gradient. .. code-block:: c @@ -193,7 +194,8 @@ There is probably a bug in your display driver. Try the following code without u Why do I see nonsense colors on the screen? ------------------------------------------- -The configured LVGL color format is probably not compatible with your display's color format. Check :c:macro:`LV_COLOR_DEPTH` in *lv_conf.h*. +The configured LVGL color format is probably not compatible with your display's color +format. Check :c:macro:`LV_COLOR_DEPTH` in *lv_conf.h*. How do I speed up my UI? @@ -323,3 +325,9 @@ Starting from v8, every minor release is supported for 1 year. +---------+--------------+--------------+--------+ + +API +*** +.. API equals: LV_MEM_SIZE, lv_timer_handler, lv_tick_inc, lv_display_flush_ready, + LV_COLOR_DEPTH + diff --git a/lv_conf_template.h b/lv_conf_template.h index e6c1d444bf..17a6f6738c 100644 --- a/lv_conf_template.h +++ b/lv_conf_template.h @@ -673,7 +673,7 @@ /*================== * WIDGETS *================*/ -/* Documentation for widgets can be found here: https://docs.lvgl.io/latest/en/html/widgets/index.html . */ +/* Documentation for widgets can be found here: https://docs.lvgl.io/master/details/widgets/index.html . */ /** 1: Causes these widgets to be given default values at creation time. * - lv_buttonmatrix_t: Get default maps: {"Btn1", "Btn2", "Btn3", "\n", "Btn4", "Btn5", ""}, else map not set. @@ -776,7 +776,7 @@ /*================== * THEMES *==================*/ -/* Documentation for themes can be found here: https://docs.lvgl.io/master/overview/style.html#themes . */ +/* Documentation for themes can be found here: https://docs.lvgl.io/master/details/common-widget-features/styles/style.html#themes . */ /** A simple, impressive and very complete theme */ #define LV_USE_THEME_DEFAULT 1 @@ -800,7 +800,7 @@ /*================== * LAYOUTS *==================*/ -/* Documentation for layouts can be found here: https://docs.lvgl.io/master/layouts/index.html . */ +/* Documentation for layouts can be found here: https://docs.lvgl.io/master/details/common-widget-features/layouts/index.html . */ /** A layout similar to Flexbox in CSS. */ #define LV_USE_FLEX 1 @@ -811,13 +811,13 @@ /*==================== * 3RD PARTS LIBRARIES *====================*/ -/* Documentation for libraries can be found here: https://docs.lvgl.io/master/libs/index.html . */ +/* Documentation for libraries can be found here: https://docs.lvgl.io/master/details/libs/index.html . */ /* File system interfaces for common APIs */ /** Setting a default driver letter allows skipping the driver prefix in filepaths. * Documentation about how to use the below driver-identifier letters can be found at - * https://docs.lvgl.io/master/details/main-components/fs.html#lv-fs-identifier-letters . */ + * https://docs.lvgl.io/master/details/main-modules/fs.html#lv-fs-identifier-letters . */ #define LV_FS_DEFAULT_DRIVER_LETTER '\0' /** API for fopen, fread, etc. */ @@ -981,7 +981,7 @@ /*================== * OTHERS *==================*/ -/* Documentation for several of the below items can be found here: https://docs.lvgl.io/master/others/index.html . */ +/* Documentation for several of the below items can be found here: https://docs.lvgl.io/master/details/auxiliary-modules/index.html . */ /** 1: Enable API to take snapshot for object */ #define LV_USE_SNAPSHOT 0 diff --git a/src/lv_conf_internal.h b/src/lv_conf_internal.h index db907458a6..2b6de9cdc9 100644 --- a/src/lv_conf_internal.h +++ b/src/lv_conf_internal.h @@ -1956,7 +1956,7 @@ /*================== * WIDGETS *================*/ -/* Documentation for widgets can be found here: https://docs.lvgl.io/latest/en/html/widgets/index.html . */ +/* Documentation for widgets can be found here: https://docs.lvgl.io/master/details/widgets/index.html . */ /** 1: Causes these widgets to be given default values at creation time. * - lv_buttonmatrix_t: Get default maps: {"Btn1", "Btn2", "Btn3", "\n", "Btn4", "Btn5", ""}, else map not set. @@ -2473,7 +2473,7 @@ /*================== * THEMES *==================*/ -/* Documentation for themes can be found here: https://docs.lvgl.io/master/overview/style.html#themes . */ +/* Documentation for themes can be found here: https://docs.lvgl.io/master/details/common-widget-features/styles/style.html#themes . */ /** A simple, impressive and very complete theme */ #ifndef LV_USE_THEME_DEFAULT @@ -2549,7 +2549,7 @@ /*================== * LAYOUTS *==================*/ -/* Documentation for layouts can be found here: https://docs.lvgl.io/master/layouts/index.html . */ +/* Documentation for layouts can be found here: https://docs.lvgl.io/master/details/common-widget-features/layouts/index.html . */ /** A layout similar to Flexbox in CSS. */ #ifndef LV_USE_FLEX @@ -2580,13 +2580,13 @@ /*==================== * 3RD PARTS LIBRARIES *====================*/ -/* Documentation for libraries can be found here: https://docs.lvgl.io/master/libs/index.html . */ +/* Documentation for libraries can be found here: https://docs.lvgl.io/master/details/libs/index.html . */ /* File system interfaces for common APIs */ /** Setting a default driver letter allows skipping the driver prefix in filepaths. * Documentation about how to use the below driver-identifier letters can be found at - * https://docs.lvgl.io/master/details/main-components/fs.html#lv-fs-identifier-letters . */ + * https://docs.lvgl.io/master/details/main-modules/fs.html#lv-fs-identifier-letters . */ #ifndef LV_FS_DEFAULT_DRIVER_LETTER #ifdef CONFIG_LV_FS_DEFAULT_DRIVER_LETTER #define LV_FS_DEFAULT_DRIVER_LETTER CONFIG_LV_FS_DEFAULT_DRIVER_LETTER @@ -3104,7 +3104,7 @@ /*================== * OTHERS *==================*/ -/* Documentation for several of the below items can be found here: https://docs.lvgl.io/master/others/index.html . */ +/* Documentation for several of the below items can be found here: https://docs.lvgl.io/master/details/auxiliary-modules/index.html . */ /** 1: Enable API to take snapshot for object */ #ifndef LV_USE_SNAPSHOT