Tizen Native API
5.5
|
The Display API provides functions to control the display status.
Required Header
#include <device/display.h>
#include <device/callback.h>
Overview
The Display API provides the way to get supported display count and the display brightness. It also supports the API to set the display brightness. Application can receive the display event by callback function from the system.
Related Features
This API is related with the following features:
- http://tizen.org/feature/display
- http://tizen.org/feature/display.state
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from feature element description.
Functions | |
int | device_display_get_numbers (int *device_number) |
Gets the number of display devices. | |
int | device_display_get_max_brightness (int display_index, int *max_brightness) |
Gets the maximum brightness value that can be set. | |
int | device_display_get_brightness (int display_index, int *brightness) |
Gets the display brightness value. | |
int | device_display_set_brightness (int display_index, int brightness) |
Sets the display brightness value. | |
int | device_display_get_state (display_state_e *state) |
Gets the current display state. | |
int | device_display_change_state (display_state_e state) |
Changes the display state by force. |
Enumeration Type Documentation
enum display_state_e |
Enumeration for the available display states.
- Since :
- 2.3
- Remarks:
- DISPLAY_STATE_SCREEN_DIM may be ignored if the DIM state is disabled on the platform.
Function Documentation
int device_display_change_state | ( | display_state_e | state | ) |
Changes the display state by force.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- This API triggers display change process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display.state.
- Parameters:
-
[in] state The display state
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device
- See also:
- device_power_request_lock()
- device_power_release_lock()
- device_add_callback
- device_remove_callback
- DEVICE_CALLBACK_DISPLAY_STATE
- Example
... result = device_display_change_state(DISPLAY_STATE_SCREEN_OFF); if (result < 0) dlog_print(DLOG_ERROR, LOG_TAG, "[ERROR] return value result =%d, \n",result); else dlog_print(DLOG_DEBUG, LOG_TAG, "[SUCCESS] return value result =%d \n",result); ...
int device_display_get_brightness | ( | int | display_index, |
int * | brightness | ||
) |
Gets the display brightness value.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display
- Parameters:
-
[in] display_index The index of the display
It can be greater than or equal to0
and less than the number of displays returned by device_display_get_numbers().
The index zero is always assigned to the main display[out] brightness The current brightness value of the display
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device
int device_display_get_max_brightness | ( | int | display_index, |
int * | max_brightness | ||
) |
Gets the maximum brightness value that can be set.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display
- Parameters:
-
[in] display_index The index of the display
It can be greater than or equal to0
and less than the number of displays returned by device_display_get_numbers().
The index zero is always assigned to the main display[out] max_brightness The maximum brightness value of the display
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device
int device_display_get_numbers | ( | int * | device_number | ) |
Gets the number of display devices.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display
- Parameters:
-
[out] device_number The total number of displays
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device
int device_display_get_state | ( | display_state_e * | state | ) |
Gets the current display state.
- Since :
- 2.3
- Remarks:
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display
- Parameters:
-
[out] state The display state
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device
int device_display_set_brightness | ( | int | display_index, |
int | brightness | ||
) |
Sets the display brightness value.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Remarks:
- DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: http://tizen.org/feature/display
- Parameters:
-
[in] display_index The index of the display
It can be greater than or equal to0
and less than the number of displays returned by device_display_get_numbers().
The index zero is always assigned to the main display[in] brightness The new brightness value to set
The maximum value can be represented by device_display_get_max_brightness()
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
DEVICE_ERROR_NONE Successful DEVICE_ERROR_INVALID_PARAMETER Invalid parameter DEVICE_ERROR_PERMISSION_DENIED Permission denied DEVICE_ERROR_OPERATION_FAILED Operation failed DEVICE_ERROR_NOT_SUPPORTED Not supported device