Driver Operations Display driver operations More...

#include <zephyr/drivers/display.h>

Data Fields
display_blanking_on_api	blanking_on
	OPT Turn display blanking on.
display_blanking_off_api	blanking_off
	OPT Turn display blanking off.
display_write_api	write
	REQ Write data to display.
display_read_api	read
	OPT Read data from display.
display_clear_api	clear
	OPT Clear the screen of the display device.
display_get_framebuffer_api	get_framebuffer
	OPT Get pointer to framebuffer for direct access.
display_set_brightness_api	set_brightness
	OPT Set the brightness of the display.
display_set_contrast_api	set_contrast
	OPT Set the contrast of the display.
display_get_capabilities_api	get_capabilities
	REQ Get display capabilities.
display_set_pixel_format_api	set_pixel_format
	OPT Set pixel format used by the display.
display_set_orientation_api	set_orientation
	OPT Set display orientation.
display_register_event_cb_api	register_event_cb
	OPT Register event callback for a display device.
display_unregister_event_cb_api	unregister_event_cb
	OPT Unregister event callback for a display device.

Detailed Description

Driver Operations Display driver operations

This is the driver API structure any Display driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ blanking_off

display_blanking_off_api display_driver_api::blanking_off

OPT Turn display blanking off.

◆ blanking_on

display_blanking_on_api display_driver_api::blanking_on

OPT Turn display blanking on.

◆ clear

display_clear_api display_driver_api::clear

OPT Clear the screen of the display device.

◆ get_capabilities

display_get_capabilities_api display_driver_api::get_capabilities

REQ Get display capabilities.

◆ get_framebuffer

display_get_framebuffer_api display_driver_api::get_framebuffer

OPT Get pointer to framebuffer for direct access.

◆ read

display_read_api display_driver_api::read

OPT Read data from display.

◆ register_event_cb

display_register_event_cb_api display_driver_api::register_event_cb

OPT Register event callback for a display device.

◆ set_brightness

display_set_brightness_api display_driver_api::set_brightness

OPT Set the brightness of the display.

◆ set_contrast

display_set_contrast_api display_driver_api::set_contrast

OPT Set the contrast of the display.

◆ set_orientation

display_set_orientation_api display_driver_api::set_orientation

OPT Set display orientation.

◆ set_pixel_format

display_set_pixel_format_api display_driver_api::set_pixel_format

OPT Set pixel format used by the display.

◆ unregister_event_cb

display_unregister_event_cb_api display_driver_api::unregister_event_cb

OPT Unregister event callback for a display device.

◆ write

display_write_api display_driver_api::write

REQ Write data to display.

The documentation for this struct was generated from the following file:

zephyr/drivers/display.h

Data Fields