display_api_t Struct Reference

#include <r_display_api.h>

Data Fields
ssp_err_t(*	open )(display_ctrl_t *const p_ctrl, display_cfg_t const *const p_cfg)
ssp_err_t(*	close )(display_ctrl_t *const p_ctrl)
ssp_err_t(*	start )(display_ctrl_t *const p_ctrl)
ssp_err_t(*	stop )(display_ctrl_t *const p_ctrl)
ssp_err_t(*	layerChange )(display_ctrl_t const *const p_ctrl, display_runtime_cfg_t const *const p_cfg, display_frame_layer_t frame)
ssp_err_t(*	correction )(display_ctrl_t const *const p_ctrl, display_correction_t const *const p_param)
ssp_err_t(*	clut )(display_ctrl_t const *const p_ctrl, display_clut_cfg_t const *const p_clut_cfg, display_frame_layer_t frame)
ssp_err_t(*	statusGet )(display_ctrl_t const *const p_ctrl, display_status_t *const p_status)
ssp_err_t(*	versionGet )(ssp_version_t *p_version)

Detailed Description

Shared Interface definition for display peripheral

Field Documentation

close

ssp_err_t(* display_api_t::close) (display_ctrl_t *const p_ctrl)

Close display device.

Implemented as

• R_GLCD_Close()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

clut

ssp_err_t(* display_api_t::clut) (display_ctrl_t const *const p_ctrl, display_clut_cfg_t const *const p_clut_cfg, display_frame_layer_t frame)

Set CLUT for display device.

Implemented as

• R_GLCD_ClutUpdate()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	p_clut_cfg	Pointer to CLUT configuration structure.
[in]	frame	Number of frame buffer corresponding to the CLUT.

correction

ssp_err_t(* display_api_t::correction) (display_ctrl_t const *const p_ctrl, display_correction_t const *const p_param)

Color correction.

Implemented as

• R_GLCD_ColorCorrection()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	param	Pointer to color correction configuration structure.

layerChange

ssp_err_t(* display_api_t::layerChange) (display_ctrl_t const *const p_ctrl, display_runtime_cfg_t const *const p_cfg, display_frame_layer_t frame)

Change layer parameters at runtime.

Implemented as

• R_GLCD_LayerChange()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	p_cfg	Pointer to run-time layer configuration structure.
[in]	frame	Number of graphic frames.

open

ssp_err_t(* display_api_t::open) (display_ctrl_t *const p_ctrl, display_cfg_t const *const p_cfg)

Open display device.

Implemented as

• R_GLCD_Open()

Parameters

[in,out]	p_ctrl	Pointer to display interface control block. Must be declared by user. Value set here.
[in]	p_cfg	Pointer to display configuration structure. All elements of this structure must be set by user.

start

ssp_err_t(* display_api_t::start) (display_ctrl_t *const p_ctrl)

Display start.

Implemented as

• R_GLCD_Start()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

statusGet

ssp_err_t(* display_api_t::statusGet) (display_ctrl_t const *const p_ctrl, display_status_t *const p_status)

Get status for display device.

Implemented as

• R_GLCD_StatusGet()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	status	Pointer to display interface status structure.

stop

ssp_err_t(* display_api_t::stop) (display_ctrl_t *const p_ctrl)

Display stop.

Implemented as

• R_GLCD_Stop()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

versionGet

ssp_err_t(* display_api_t::versionGet) (ssp_version_t *p_version)

Get version.

Implemented as

• R_GLCD_VersionGet()

Parameters

[in]

p_version

Pointer to the memory to store the version information.

---

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

• r_display_api.h