RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/screen_dev: add a bit of documentation

Browse Source
This commit is contained in:
Alexandre Abadie 2021-03-03 18:04:42 +01:00
parent 77021732db
commit d227a117a2
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
drivers/include/screen_dev.h
View File

@ -11,6 +11,17 @@
* @ingroup drivers_display * @ingroup drivers_display
* @brief Define the generic API of a screen device * @brief Define the generic API of a screen device
* *
* The screen device API is a generic API built on top of display and touch
* device APIs.
*
* Each display/touch device driver implementing this interface has to expose
* a set of predefined functions and it has to register itself to the central
* display/touch device registry. From here devices can be found, listed, and
* accessed.
*
* The display and touch devices are linked to a screen by providing the
* screen id (basically an index) they correspond to.
*
* @see drivers_disp_dev @see drivers_touch_dev * @see drivers_disp_dev @see drivers_touch_dev
* *
* @experimental This API is experimental and in an early state - expect * @experimental This API is experimental and in an early state - expect