bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Added generic display interface to API doc

Browse Source 
Added generic display interface to Display Interfaces APIs
documentation

Signed-off-by: Jan Van Winkel <jan.van_winkel@dxplore.eu>
This commit is contained in:
Jan Van Winkel 2018-10-30 23:52:57 +01:00 committed by Anas Nashif
parent b23bcaf406
commit ca66c8ea41
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/display_api.rst
View File

@ -3,9 +3,11 @@
Display Interface APIs
######################
.. comment
not documenting
.. doxygengroup:: display_interfaces
Generic Display Interface
*************************
.. doxygengroup:: display_interface
:project: Zephyr
Grove LCD Display
*****************

24
include/display.h
View File

@ -14,8 +14,8 @@
/**
* @brief Display Interface
* @defgroup display_interface display Interface
* @ingroup io_interfaces
* @defgroup display_interface Display Interface
* @ingroup display_interfaces
* @{
*/
@ -66,22 +66,22 @@ enum display_orientation {
* @struct display_capabilities
* @brief Structure holding display capabilities
*
* @var display_capabilities::x_resolution
* @var u16_t display_capabilities::x_resolution
* Display resolution in the X direction
*
* @var display_capabilities::y_resolution
* @var u16_t display_capabilities::y_resolution
* Display resolution in the Y direction
*
* @var display_capabilities::supported_pixel_formats
* @var u32_t display_capabilities::supported_pixel_formats
* Bitwise or of pixel formats supported by the display
*
* @var display_capabilities::screen_info
* @var u32_t display_capabilities::screen_info
* Information about display panel
*
* @var display_capabilities::current_pixel_format
* @var enum display_pixel_format display_capabilities::current_pixel_format
* Currently active pixel format for the display
*
* @var display_capabilities::current_orientation
* @var enum display_orientation display_capabilities::current_orientation
* Current display orientation
*
*/
@ -98,16 +98,16 @@ struct display_capabilities {
* @struct display_buffer_descriptor
* @brief Structure to describe display data buffer layout
*
* @var display_buffer_descriptor::buf_size
* @var u32_t display_buffer_descriptor::buf_size
* Data buffer size in bytes
*
* @var display_buffer_descriptor::width
* @var u16_t display_buffer_descriptor::width
* Data buffer row width in pixels
*
* @var display_buffer_descriptor::height
* @var u16_t display_buffer_descriptor::height
* Data buffer column height in pixels
*
* @var display_buffer_descriptor::pitch
* @var u16_t display_buffer_descriptor::pitch
* Number of pixels between consecutive rows in the data buffer
*
*/