diff --git a/docs/doc_builder.py b/docs/doc_builder.py index c22ba52fb..fca486c2f 100644 --- a/docs/doc_builder.py +++ b/docs/doc_builder.py @@ -1096,7 +1096,7 @@ def iter_src(n, p): html_files[name] = html_file with open(rst_file, 'w') as f: - f.write('.. _{0}:'.format(name)) + f.write('.. _{0}_h:'.format(name)) f.write('\n\n') f.write('=' * len(file)) f.write('\n') @@ -1331,7 +1331,7 @@ def run(project_path, temp_directory, *doc_paths): if html_includes: html_includes = list( - ':ref:`{0}`\n'.format(inc) + ':ref:`{0}_h`\n'.format(inc) for inc, _ in html_includes ) diff --git a/docs/intro/index.rst b/docs/intro/index.rst index 396e4111f..2e3ecd4b2 100644 --- a/docs/intro/index.rst +++ b/docs/intro/index.rst @@ -212,7 +212,7 @@ My display driver is not called. What have I missed? Be sure you are calling :cpp:expr:`lv_tick_inc(x)` in an interrupt and :cpp:func:`lv_timer_handler` in your main ``while(1)``. -Learn more in the :ref:`tick` and :ref:`timer` sections. +Learn more in the :ref:`tick` and :ref:`timer_handler` sections. Why is the display driver called only once? Only the upper part of the display is refreshed. diff --git a/docs/libs/barcode.rst b/docs/libs/barcode.rst index 72569faf3..99e5e0345 100644 --- a/docs/libs/barcode.rst +++ b/docs/libs/barcode.rst @@ -20,8 +20,8 @@ Use :cpp:func:`lv_barcode_create` to create a barcode object, and use Call :cpp:func:`lv_barcode_set_scale` to adjust scaling, call :cpp:func:`lv_barcode_set_dark_color` and :cpp:func:`lv_barcode_set_light_color` -adjust color, call :cpp:func:`lv_barcode_set_direction` will set -direction to display, and call :cpp:func:`lv_barcode_update` again to regenerate +adjust color, call :cpp:func:`lv_barcode_set_direction` will set +direction to display, and call :cpp:func:`lv_barcode_update` again to regenerate the barcode. Notes @@ -46,5 +46,5 @@ Example API --- -:ref:`code128` +:ref:`code128_h` diff --git a/docs/libs/freetype.rst b/docs/libs/freetype.rst index 46bdf0f5c..135b07f92 100644 --- a/docs/libs/freetype.rst +++ b/docs/libs/freetype.rst @@ -115,7 +115,7 @@ Learn more API --- -:ref:`ftoption` +:ref:`ftoption_h` -:ref:`ftmodule` +:ref:`ftmodule_h` diff --git a/docs/libs/gif.rst b/docs/libs/gif.rst index ae3d0750a..8ae64d4d4 100644 --- a/docs/libs/gif.rst +++ b/docs/libs/gif.rst @@ -39,7 +39,7 @@ Memory requirements ------------------- To decode and display a GIF animation the following amount of RAM is -required: +required: - :c:macro:`LV_COLOR_DEPTH` ``8``: 3 x image width x image height - :c:macro:`LV_COLOR_DEPTH` ``16``: 4 x image width x image height @@ -57,5 +57,5 @@ Example API --- -:ref:`gifdec` +:ref:`gifdec_h` diff --git a/docs/libs/libjpeg_turbo.rst b/docs/libs/libjpeg_turbo.rst index aa04de7a5..75995e19f 100644 --- a/docs/libs/libjpeg_turbo.rst +++ b/docs/libs/libjpeg_turbo.rst @@ -4,7 +4,7 @@ libjpeg-turbo decoder ===================== -**libjpeg-turbo** is a JPEG image codec that uses SIMD instructions to accelerate baseline JPEG compression and decompression on x86, +**libjpeg-turbo** is a JPEG image codec that uses SIMD instructions to accelerate baseline JPEG compression and decompression on x86, x86-64, Arm, PowerPC, and MIPS systems, as well as progressive JPEG compression on x86, x86-64, and Arm systems. Detailed introduction: https://libjpeg-turbo.org @@ -37,7 +37,7 @@ Usage Enable :c:macro:`LV_USE_LIBJPEG_TURBO` in ``lv_conf.h``. See the examples below. -It should be noted that each image of this decoder needs to consume ``image width x image height x 3`` bytes of RAM, +It should be noted that each image of this decoder needs to consume ``image width x image height x 3`` bytes of RAM, and it needs to be combined with the :ref:`overview_image_caching` feature to ensure that the memory usage is within a reasonable range. .. _libjpeg_example: @@ -52,5 +52,5 @@ Example API --- -:ref:`libjpeg_turbo` +:ref:`lv_libjpeg_turbo_h` diff --git a/docs/libs/lodepng.rst b/docs/libs/lodepng.rst index 795d85316..719f71057 100644 --- a/docs/libs/lodepng.rst +++ b/docs/libs/lodepng.rst @@ -46,5 +46,5 @@ Example API --- -:ref:`lodepng` +:ref:`lodepng_h` diff --git a/docs/libs/qrcode.rst b/docs/libs/qrcode.rst index 55c1bde45..027346cc2 100644 --- a/docs/libs/qrcode.rst +++ b/docs/libs/qrcode.rst @@ -19,7 +19,7 @@ Use :cpp:func:`lv_qrcode_create` to create a qrcode object, and use :cpp:func:`lv_qrcode_update` to generate a QR code. If you need to re-modify the size and color, use -:cpp:func:`lv_qrcode_set_size` and :cpp:func:`lv_qrcode_set_dark_color` or +:cpp:func:`lv_qrcode_set_size` and :cpp:func:`lv_qrcode_set_dark_color` or :cpp:func:`lv_qrcode_set_light_color`, and call :cpp:func:`lv_qrcode_update` again to regenerate the QR code. @@ -41,5 +41,5 @@ Example API --- -:ref:`qrcodegen` +:ref:`qrcodegen_h` diff --git a/docs/libs/tiny_ttf.rst b/docs/libs/tiny_ttf.rst index 42ffeeaba..137d519d9 100644 --- a/docs/libs/tiny_ttf.rst +++ b/docs/libs/tiny_ttf.rst @@ -50,6 +50,6 @@ Example API --- -:ref:`stb_rect_pack` +:ref:`stb_rect_pack_h` -:ref:`stb_truetype_htcw` +:ref:`stb_truetype_htcw_h` diff --git a/docs/libs/tjpgd.rst b/docs/libs/tjpgd.rst index c1049336f..223d22a09 100644 --- a/docs/libs/tjpgd.rst +++ b/docs/libs/tjpgd.rst @@ -59,8 +59,8 @@ Example API --- -:ref:`lv_tjpgd` +:ref:`lv_tjpgd_h` -:ref:`tjpgd` +:ref:`tjpgd_h` -:ref:`tjpgdcnf` +:ref:`tjpgdcnf_h` diff --git a/docs/overview/renderers/arm2d.rst b/docs/overview/renderers/arm2d.rst index 4d4b5cfee..2492fed74 100644 --- a/docs/overview/renderers/arm2d.rst +++ b/docs/overview/renderers/arm2d.rst @@ -10,6 +10,7 @@ Cortex-M0 to the latest Cortex-M85. Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and **Asynchronous Mode**. + - When **Helium** and **ACI (Arm Custom Instruction)** are available, it is recommend to use **Synchronous Mode** to accelerate LVGL. - When Arm-2D backed 2D-GPUs are available, for example, **DMAC-350 based 2D @@ -18,10 +19,12 @@ Arm-2D accelerates LVGL9 with two modes: **Synchronous Mode** and Arm-2D is an open-source project on GitHub. For more, please refer to: https://github.com/ARM-software/Arm-2D. + How to Use ********** In general: + - you can set the macro :c:macro:`LV_USE_DRAW_ARM2D_SYNC` to ``1`` and :c:macro:`LV_DRAW_SW_ASM` to ``LV_DRAW_SW_ASM_HELIUM`` in ``lv_conf.h`` to enable Arm-2D synchronous acceleration for LVGL. @@ -62,4 +65,6 @@ Examples API *** -:ref:`lv_gpu_arm2d` +:ref:`lv_draw_sw_arm2d_h` + +:ref:`lv_blend_arm2d_h` diff --git a/docs/overview/renderers/pxp.rst b/docs/overview/renderers/pxp.rst index 423e9519b..427755708 100644 --- a/docs/overview/renderers/pxp.rst +++ b/docs/overview/renderers/pxp.rst @@ -5,10 +5,11 @@ NXP PXP GPU API --- -:ref:`lv_draw_pxp` +:ref:`lv_draw_pxp_h` -:ref:`lv_draw_pxp_blend` +:ref:`lv_pxp_cfg_h` -:ref:`lv_gpu_nxp_pxp` +:ref:`lv_pxp_osa_h` + +:ref:`lv_pxp_utils_h` -:ref:`lv_gpu_nxp_pxp_osa` diff --git a/docs/overview/renderers/sdl.rst b/docs/overview/renderers/sdl.rst index 600bd2fa8..6785c1187 100644 --- a/docs/overview/renderers/sdl.rst +++ b/docs/overview/renderers/sdl.rst @@ -5,22 +5,5 @@ SDL renderer API --- -:ref:`lv_draw_sdl` +:ref:`lv_draw_sdl_h` -:ref:`lv_draw_sdl_composite` - -:ref:`lv_draw_sdl_img` - -:ref:`lv_draw_sdl_layer` - -:ref:`lv_draw_sdl_mask` - -:ref:`lv_draw_sdl_priv` - -:ref:`lv_draw_sdl_rect` - -:ref:`lv_draw_sdl_stack_blur` - -:ref:`lv_draw_sdl_texture_cache` - -:ref:`lv_draw_sdl_utils` diff --git a/docs/overview/renderers/stm32_dma2d.rst b/docs/overview/renderers/stm32_dma2d.rst index b4f8c3c27..82c689e05 100644 --- a/docs/overview/renderers/stm32_dma2d.rst +++ b/docs/overview/renderers/stm32_dma2d.rst @@ -5,4 +5,5 @@ DMA2D GPU API --- -:ref:`lv_gpu_stm32_dma2d` +:ref:`lv_draw_dma2d_h` + diff --git a/docs/overview/renderers/sw.rst b/docs/overview/renderers/sw.rst index cf6b90c86..ee2fe51d0 100644 --- a/docs/overview/renderers/sw.rst +++ b/docs/overview/renderers/sw.rst @@ -5,10 +5,8 @@ Software renderer API --- -:ref:`lv_draw_sw` +:ref:`lv_draw_sw_h` -:ref:`lv_draw_sw_blend` +:ref:`lv_draw_sw_blend_h` -:ref:`lv_draw_sw_dither` - -:ref:`lv_draw_sw_gradient` +:ref:`lv_draw_sw_gradient_h` diff --git a/docs/overview/renderers/vglite.rst b/docs/overview/renderers/vglite.rst index 15e4d24c7..8b67ca211 100644 --- a/docs/overview/renderers/vglite.rst +++ b/docs/overview/renderers/vglite.rst @@ -5,13 +5,13 @@ NXP VGLite GPU API --- -:ref:`lv_draw_vglite` +:ref:`lv_draw_vglite_h` -:ref:`lv_draw_vglite_arc` +:ref:`lv_vglite_buf_h` -:ref:`lv_draw_vglite_blend` +:ref:`lv_vglite_matrix_h` -:ref:`lv_draw_vglite_line` +:ref:`lv_vglite_path_h` -:ref:`lv_draw_vglite_rect` +:ref:`lv_vglite_utils_h` diff --git a/docs/overview/timer.rst b/docs/overview/timer.rst index 0e8b12db2..ea526e104 100644 --- a/docs/overview/timer.rst +++ b/docs/overview/timer.rst @@ -1,4 +1,4 @@ -.. _timer: +.. _timers: ====== Timers diff --git a/docs/porting/os.rst b/docs/porting/os.rst index c7561bed0..1f6b998a1 100644 --- a/docs/porting/os.rst +++ b/docs/porting/os.rst @@ -10,7 +10,7 @@ However, in the following conditions it's valid to call LVGL related functions: - In *events*. Learn more in :ref:`events`. -- In *lv_timer*. Learn more in :ref:`timer`. +- In *lv_timer*. Learn more in :ref:`timers`. Tasks and threads ----------------- diff --git a/docs/porting/timer_handler.rst b/docs/porting/timer_handler.rst index 1a40a62f7..ac28261ba 100644 --- a/docs/porting/timer_handler.rst +++ b/docs/porting/timer_handler.rst @@ -1,4 +1,4 @@ -.. _timer: +.. _timer_handler: ============= Timer Handler @@ -48,11 +48,11 @@ In an OS environment, you can use it together with the **delay** or .. code:: c while (1) { - uint32_t time_till_next = lv_timer_handler(); + uint32_t time_till_next = lv_timer_handler(); os_delay_ms(time_till_next); /* delay to avoid unnecessary polling */ } -To learn more about timers visit the :ref:`timer` +To learn more about timers visit the :ref:`timers` section. API