MT2523 API Reference  LinkIt SDK v4
DISPLAY_COLOR

This section introduces the display color APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, display color function groups, all enumerations, structures and functions. More...

Overview

This section introduces the display color APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, display color function groups, all enumerations, structures and functions.

Terms and acronyms

Terms Details
Cb Blue chrominance in YCbCr color space.
Cr Red chrominance in YCbCr color space.

Supported features

How to use this driver

Functions

hal_display_color_status_t hal_display_color_init (void)
 This function initializes the display color settings. More...
 
hal_display_color_status_t hal_display_color_set_color_engine (bool enable)
 This function enables or disables the color engine. More...
 
hal_display_color_status_t hal_display_color_get_color_engine (bool *enable)
 This function gets the color engine status (disable or enable), it then returns the bypass configuration status in the parameter "enable". More...
 
hal_display_color_status_t hal_display_color_set_sharpness (hal_display_color_sharpness_t *sharpness)
 This function sets the sharpness settings to color settings. More...
 
hal_display_color_status_t hal_display_color_set_contrast (hal_display_color_contrast_t *contrast)
 This function sets the contrast settings to color settings. More...
 
hal_display_color_status_t hal_display_color_set_saturation (hal_display_color_saturation_t *saturation)
 This function sets the saturation settings to color settings. More...
 
hal_display_color_status_t hal_display_color_set_bypass (bool bypass)
 This function sets the bypass settings to color settings. More...
 
hal_display_color_status_t hal_display_color_set_mode (hal_display_color_mode_t mode)
 This function sets the color mode. More...
 
hal_display_color_status_t hal_display_color_apply_color (uint32_t src_width)
 This function applies the color settings to color hardware engine. More...
 

Modules

 Enum
 
 Struct
 

Function Documentation

hal_display_color_status_t hal_display_color_apply_color ( uint32_t  src_width)

This function applies the color settings to color hardware engine.

Parameters
[in]src_widthis the width of source buffer.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.
hal_display_color_status_t hal_display_color_get_color_engine ( bool *  enable)

This function gets the color engine status (disable or enable), it then returns the bypass configuration status in the parameter "enable".

Parameters
[out]enablespecifies the current enable status.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_POWER_FAILED, the operation has failed due to the power of the color engine is not turned on.
hal_display_color_status_t hal_display_color_init ( void  )

This function initializes the display color settings.

It sets the current mode to default and disables bypass color engine.

Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INITIALIZATION_FAILED, failed to set the default values.
hal_display_color_status_t hal_display_color_set_bypass ( bool  bypass)

This function sets the bypass settings to color settings.

Parameters
[in]bypassspecifies whether to bypass the color engine or not.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.
hal_display_color_status_t hal_display_color_set_color_engine ( bool  enable)

This function enables or disables the color engine.

It sets the bypass configuration in hal_display_color_parameter_t.

Parameters
[in]enablespecifies if the color engine is enabled or not.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_POWER_FAILED, the operation has failed due to the power of the color engine is not turned on.
hal_display_color_status_t hal_display_color_set_contrast ( hal_display_color_contrast_t contrast)

This function sets the contrast settings to color settings.

Parameters
[in]contrastis the contrast setting parameter, please refer to hal_display_color_contrast_t.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.
hal_display_color_status_t hal_display_color_set_mode ( hal_display_color_mode_t  mode)

This function sets the color mode.

Parameters
[in]modeis the color mode to set.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.
hal_display_color_status_t hal_display_color_set_saturation ( hal_display_color_saturation_t saturation)

This function sets the saturation settings to color settings.

Parameters
[in]saturationis the saturation setting parameter, please refer to hal_display_color_saturation_t.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.
hal_display_color_status_t hal_display_color_set_sharpness ( hal_display_color_sharpness_t sharpness)

This function sets the sharpness settings to color settings.

Parameters
[in]sharpnessis the sharpess setting parameter, please refer to hal_display_color_sharpness_t.
Returns
To indicate whether this function call is successful or not. HAL_DISPLAY_COLOR_STATUS_OK, the operation completed successfully. HAL_DISPLAY_COLOR_STATUS_INVALID_PARAMETER, the parameter is out of bound.