docs: fix links, add references, rename files (#5138)
This commit is contained in:
@@ -260,9 +260,9 @@ Further reading
|
||||
|
||||
- `lv_port_disp_template.c <https://github.com/lvgl/lvgl/blob/master/examples/porting/lv_port_disp_template.c>`__
|
||||
for a template for your own driver.
|
||||
- `Drawing </overview/drawing>`__ to learn more about how rendering
|
||||
- :ref:`Drawing <drawing>` to learn more about how rendering
|
||||
works in LVGL.
|
||||
- `Display features </overview/display>`__ to learn more about higher
|
||||
- :ref:`display_features` to learn more about higher
|
||||
level display features.
|
||||
|
||||
API
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _porting_indev:
|
||||
|
||||
======================
|
||||
Input device interface
|
||||
======================
|
||||
@@ -24,7 +26,7 @@ The ``type`` member can be:
|
||||
``read_cb`` is a function pointer which will be called periodically to
|
||||
report the current state of an input device.
|
||||
|
||||
Visit `Input devices </overview/indev>`__ to learn more about input
|
||||
Visit :ref:`Input devices <indev>` to learn more about input
|
||||
devices in general.
|
||||
|
||||
Touchpad, mouse or any pointer
|
||||
@@ -187,6 +189,8 @@ should look like ``const lv_point_t points_array[] = { {12,30},{60,90}, ...}``
|
||||
When the ``button_read`` callback in the example above changes the ``data->btn_id`` to ``0``
|
||||
a press/release action at the first index of the ``points_array`` will be performed (``{12,30}``).
|
||||
|
||||
.. _porting_indev_other_features:
|
||||
|
||||
Other features
|
||||
**************
|
||||
|
||||
@@ -258,7 +262,7 @@ Further reading
|
||||
***************
|
||||
|
||||
- `lv_port_indev_template.c <https://github.com/lvgl/lvgl/blob/master/examples/porting/lv_port_indev_template.c>`__ for a template for your own driver.
|
||||
- `INdev features </overview/display>`__ to learn more about higher level input device features.
|
||||
- `INdev features <indev>` to learn more about higher level input device features.
|
||||
|
||||
API
|
||||
***
|
||||
|
||||
@@ -9,7 +9,7 @@ Porting
|
||||
:maxdepth: 2
|
||||
|
||||
project
|
||||
disp
|
||||
display
|
||||
indev
|
||||
tick
|
||||
timer_handler
|
||||
|
||||
@@ -8,7 +8,7 @@ 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 :ref:`events`. -
|
||||
In *lv_timer*. Learn more in `Timers </overview/timer>`__.
|
||||
In *lv_timer*. Learn more in :ref:`timer`.
|
||||
|
||||
Tasks and threads
|
||||
-----------------
|
||||
|
||||
@@ -127,7 +127,7 @@ Initialization
|
||||
To use the graphics library you have to initialize it and setup required
|
||||
components. The order of the initialization is:
|
||||
|
||||
1. Call :cpp:func:`lv_init()`.
|
||||
1. Call :cpp:func:`lv_init`.
|
||||
2. Initialize your drivers.
|
||||
3. Register the display and input devices drivers in LVGL. Learn more
|
||||
about `Display </porting/display>`__ and `Input
|
||||
|
||||
@@ -52,7 +52,7 @@ In an OS environment, you can use it together with the **delay** or
|
||||
os_delay_ms(time_till_next); /* delay to avoid unnecessary polling */
|
||||
}
|
||||
|
||||
To learn more about timers visit the `Timer </overview/timer>`__
|
||||
To learn more about timers visit the :ref:`timer`
|
||||
section.
|
||||
|
||||
API
|
||||
|
||||
Reference in New Issue
Block a user