Display Driver Backend API

Data Structures
struct	display_driver_api
	Driver Operations Display driver operations More...

Typedefs
typedef int(*	display_blanking_on_api) (const struct device *dev)
	Callback API to turn on display blanking.
typedef int(*	display_blanking_off_api) (const struct device *dev)
	Callback API to turn off display blanking.
typedef int(*	display_write_api) (const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, const void *buf)
	Callback API for writing data to the display.
typedef int(*	display_read_api) (const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, void *buf)
	Callback API for reading data from the display.
typedef int(*	display_clear_api) (const struct device *dev)
	Callback API for clearing the screen of the display.
typedef void *(*	display_get_framebuffer_api) (const struct device *dev)
	Callback API to get framebuffer pointer.
typedef int(*	display_set_brightness_api) (const struct device *dev, const uint8_t brightness)
	Callback API to set display brightness.
typedef int(*	display_set_contrast_api) (const struct device *dev, const uint8_t contrast)
	Callback API to set display contrast.
typedef void(*	display_get_capabilities_api) (const struct device *dev, struct display_capabilities *capabilities)
	Callback API to get display capabilities.
typedef int(*	display_set_pixel_format_api) (const struct device *dev, const enum display_pixel_format pixel_format)
	Callback API to set pixel format used by the display.
typedef int(*	display_set_orientation_api) (const struct device *dev, const enum display_orientation orientation)
	Callback API to set orientation used by the display.
typedef int(*	display_register_event_cb_api) (const struct device *dev, display_event_cb_t cb, void *user_data, uint32_t event_mask, bool in_isr, uint32_t *out_reg_handle)
	Callback API to register display event callback.
typedef int(*	display_unregister_event_cb_api) (const struct device *dev, uint32_t reg_handle)
	Callback API to unregister display event callback.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Display driver.

Typedef Documentation

display_blanking_off_api

typedef int(* display_blanking_off_api) (const struct device *dev)

#include <zephyr/drivers/display.h>

Callback API to turn off display blanking.

See display_blanking_off() for argument description

display_blanking_on_api

typedef int(* display_blanking_on_api) (const struct device *dev)

#include <zephyr/drivers/display.h>

Callback API to turn on display blanking.

See display_blanking_on() for argument description

display_clear_api

typedef int(* display_clear_api) (const struct device *dev)

#include <zephyr/drivers/display.h>

Callback API for clearing the screen of the display.

See display_clear() for argument description

display_get_capabilities_api

typedef void(* display_get_capabilities_api) (const struct device *dev, struct display_capabilities *capabilities)

#include <zephyr/drivers/display.h>

Callback API to get display capabilities.

See display_get_capabilities() for argument description

display_get_framebuffer_api

typedef void *(* display_get_framebuffer_api) (const struct device *dev)

#include <zephyr/drivers/display.h>

Callback API to get framebuffer pointer.

See display_get_framebuffer() for argument description

display_read_api

typedef int(* display_read_api) (const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, void *buf)

#include <zephyr/drivers/display.h>

Callback API for reading data from the display.

See display_read() for argument description

display_register_event_cb_api

typedef int(* display_register_event_cb_api) (const struct device *dev, display_event_cb_t cb, void *user_data, uint32_t event_mask, bool in_isr, uint32_t *out_reg_handle)

#include <zephyr/drivers/display.h>

Callback API to register display event callback.

See display_register_event_cb for argument description

display_set_brightness_api

typedef int(* display_set_brightness_api) (const struct device *dev, const uint8_t brightness)

#include <zephyr/drivers/display.h>

Callback API to set display brightness.

See display_set_brightness() for argument description

display_set_contrast_api

typedef int(* display_set_contrast_api) (const struct device *dev, const uint8_t contrast)

#include <zephyr/drivers/display.h>

Callback API to set display contrast.

See display_set_contrast() for argument description

display_set_orientation_api

typedef int(* display_set_orientation_api) (const struct device *dev, const enum display_orientation orientation)

#include <zephyr/drivers/display.h>

Callback API to set orientation used by the display.

See display_set_orientation() for argument description

display_set_pixel_format_api

typedef int(* display_set_pixel_format_api) (const struct device *dev, const enum display_pixel_format pixel_format)

#include <zephyr/drivers/display.h>

Callback API to set pixel format used by the display.

See display_set_pixel_format() for argument description

display_unregister_event_cb_api

typedef int(* display_unregister_event_cb_api) (const struct device *dev, uint32_t reg_handle)

#include <zephyr/drivers/display.h>

Callback API to unregister display event callback.

See display_unregister_event_cb for argument description

display_write_api

typedef int(* display_write_api) (const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, const void *buf)

#include <zephyr/drivers/display.h>

Callback API for writing data to the display.

See display_write() for argument description