The Display provides functions for getting display information.

Required Header

#include <hal-device-display.h>

Overview

The Display provides getter/setter properties related to display. It also supports the API for an application to receive the display event by callback function from the system.

The Display functions provide display information including:

Load/Unload for display hal-backend module
Getter/Setter for brightness
Getter/Setter for display state
Getter/Setter for display panel mode
Getter/Setter for display image effect
Getter/Setter for display frame rate
Getter/Setter for display white balancing
Getter/Setter for display rotation angle
Getter for max brightness
Getter for min/max frame rate
Getter for aod brightness
Getter for aod mode
Getter for auto brightness
Setter for multi brightness

For more information on the Display features and the macros, see HAL Display programming guides and tutorials.

Typedefs
typedef struct _hal_backend_device_display_funcs	hal_backend_device_display_funcs
	Structure for Display functions.

Data Structure Documentation

struct _hal_backend_device_display_funcs

Structure for Display functions.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Data Fields
int(*	get_max_brightness )(int *brightness)
int(*	get_brightness )(int *brightness)
int(*	set_brightness )(int brightness)
int(*	set_multi_brightness )(int brightness, int step, int delay)
int(*	get_auto_brightness )(float lmax, float lmin, float light, int *brightness)
int(*	get_state )(hal_device_display_state_e *state)
int(*	set_state )(hal_device_display_state_e state)
int(*	get_image_effect )(hal_device_display_image_effect_e *effect)
int(*	set_image_effect )(hal_device_display_image_effect_e effect)
int(*	get_panel_mode )(hal_device_display_panel_mode_e *mode)
int(*	set_panel_mode )(hal_device_display_panel_mode_e mode)
int(*	get_aod_mode )(hal_device_display_aod_mode_e *mode)
int(*	get_aod_brightness )(int max, int normal, int min, int charging)
int(*	get_max_frame_rate )(int *rate)
int(*	get_min_frame_rate )(int *rate)
int(*	get_frame_rate )(int *rate)
int(*	set_frame_rate )(int rate)
int(*	set_white_balance )(hal_device_display_white_balance_e white_balance_type, int value)
int(*	get_white_balance )(hal_device_display_white_balance_e white_balance_type, int *value)
int(*	get_rotation_angle )(int display_index, hal_device_display_rotation_angle_e *angle)
int(*	set_rotation_angle )(int display_index, hal_device_display_rotation_angle_e angle, hal_device_display_rotation_direction_e direction)

Field Documentation

int(* _hal_backend_device_display_funcs::get_aod_brightness)(int *max, int *normal, int *min, int *charging)

Get Always On Display brightness

int(* _hal_backend_device_display_funcs::get_aod_mode)(hal_device_display_aod_mode_e *mode)

Get Always On Display mode

int(* _hal_backend_device_display_funcs::get_auto_brightness)(float lmax, float lmin, float light, int *brightness)

Get auto brightness by sensor

int(* _hal_backend_device_display_funcs::get_brightness)(int *brightness)

Get current brightness

int(* _hal_backend_device_display_funcs::get_frame_rate)(int *rate)

Get display frame rate

int(* _hal_backend_device_display_funcs::get_image_effect)(hal_device_display_image_effect_e *effect)

Get display image effect

int(* _hal_backend_device_display_funcs::get_max_brightness)(int *brightness)

Get max brightness

int(* _hal_backend_device_display_funcs::get_max_frame_rate)(int *rate)

Get display max frame rate

int(* _hal_backend_device_display_funcs::get_min_frame_rate)(int *rate)

Get display min frame rate

int(* _hal_backend_device_display_funcs::get_panel_mode)(hal_device_display_panel_mode_e *mode)

Get display panel mode

int(* _hal_backend_device_display_funcs::get_rotation_angle)(int display_index, hal_device_display_rotation_angle_e *angle)

Get display rotation angle

int(* _hal_backend_device_display_funcs::get_state)(hal_device_display_state_e *state)

Get display state

int(* _hal_backend_device_display_funcs::get_white_balance)(hal_device_display_white_balance_e white_balance_type, int *value)

Get display white balance

int(* _hal_backend_device_display_funcs::set_brightness)(int brightness)

Set brightness

int(* _hal_backend_device_display_funcs::set_frame_rate)(int rate)

Set display frame rate

int(* _hal_backend_device_display_funcs::set_image_effect)(hal_device_display_image_effect_e effect)

Set display image effect

int(* _hal_backend_device_display_funcs::set_multi_brightness)(int brightness, int step, int delay)

Set multi brightness

int(* _hal_backend_device_display_funcs::set_panel_mode)(hal_device_display_panel_mode_e mode)

Set display panel mode

int(* _hal_backend_device_display_funcs::set_rotation_angle)(int display_index, hal_device_display_rotation_angle_e angle, hal_device_display_rotation_direction_e direction)

Set display rotation angle

int(* _hal_backend_device_display_funcs::set_state)(hal_device_display_state_e state)

Set display state

int(* _hal_backend_device_display_funcs::set_white_balance)(hal_device_display_white_balance_e white_balance_type, int value)

Set display white balance

Typedef Documentation

typedef struct _hal_backend_device_display_funcs hal_backend_device_display_funcs

Structure for Display functions.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumeration Type Documentation

enum hal_device_display_aod_mode_e

Enumeration for Display aod mode.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_AOD_MODE_OFF	Aod mode off
HAL_DEVICE_DISPLAY_AOD_MODE_ON	Aod mode on

enum hal_device_display_image_effect_e

Enumeration for Display image effect.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_IMAGE_EFFECT_STANDARD	No effect
HAL_DEVICE_DISPLAY_IMAGE_EFFECT_NEGATIVE	Negative effect
HAL_DEVICE_DISPLAY_IMAGE_EFFECT_GREY	Grey effect
HAL_DEVICE_DISPLAY_IMAGE_EFFECT_GREY_NEGATIVE	Grey Negative effect

enum hal_device_display_panel_mode_e

Enumeration for Display panel mode.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_PANEL_MODE_STANDARD	Standard mode
HAL_DEVICE_DISPLAY_PANEL_MODE_OUTDOOR	Outdoor mode
HAL_DEVICE_DISPLAY_PANEL_MODE_CONTENTS	Contents adaptive brightness control mode
HAL_DEVICE_DISPLAY_PANEL_MODE_LOWPOWER	Low power mode

enum hal_device_display_rotation_angle_e

Enumeration for Display rotation angle.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_ROTATION_ANGLE_UNKNOWN	Unknown rotation angle
HAL_DEVICE_DISPLAY_ROTATION_ANGLE_DEGREE_0	Rotation angle degree 0
HAL_DEVICE_DISPLAY_ROTATION_ANGLE_DEGREE_90	Rotation angle degree 90
HAL_DEVICE_DISPLAY_ROTATION_ANGLE_DEGREE_180	Rotation angle degree 180
HAL_DEVICE_DISPLAY_ROTATION_ANGLE_DEGREE_270	Rotation angle degree 270

enum hal_device_display_rotation_direction_e

Enumeration for Display rotation direction.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_ROTATION_DIRECTION_CLOCKWISE	Clockwise rotation
HAL_DEVICE_DISPLAY_ROTATION_DIRECTION_COUNTER_CLOCKWISE	Counter clockwise rotation

enum hal_device_display_state_e

Enumeration for Display state.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_ON	In use
HAL_DEVICE_DISPLAY_STANDBY	Blanked, low power
HAL_DEVICE_DISPLAY_SUSPEND	Blanked, lower power
HAL_DEVICE_DISPLAY_OFF	Shut off, awaiting activity
HAL_DEVICE_DISPLAY_DETACH	Detached display at runtime

enum hal_device_display_white_balance_e

Enumeration for Display white balance value.

Since:: HAL_MODULE_DEVICE_DISPLAY 1.0

Enumerator:

HAL_DEVICE_DISPLAY_WHITE_BALANCE_R_GAIN	White balance R gain
HAL_DEVICE_DISPLAY_WHITE_BALANCE_G_GAIN	White balance G gain
HAL_DEVICE_DISPLAY_WHITE_BALANCE_B_GAIN	White balance B gain
HAL_DEVICE_DISPLAY_WHITE_BALANCE_R_OFFSET	White balance R offset
HAL_DEVICE_DISPLAY_WHITE_BALANCE_G_OFFSET	White balance G offset
HAL_DEVICE_DISPLAY_WHITE_BALANCE_B_OFFSET	White balance B offset

Required Header

Overview

Typedefs

Data Structure Documentation

Data Fields

Field Documentation

Typedef Documentation

Enumeration Type Documentation