Color related APIs
[Display Related APIs]


Functions

int ADL_Display_ColorCaps_Get (int iAdapterIndex, int iDisplayIndex, int *lpCaps, int *lpValids)
 Function to get the Color Caps display information.
int ADL_Display_Color_Set (int iAdapterIndex, int iDisplayIndex, int iColorType, int iCurrent)
 Function to set the current value of a specific color and type.
int ADL_Display_Color_Get (int iAdapterIndex, int iDisplayIndex, int iColorType, int *lpCurrent, int *lpDefault, int *lpMin, int *lpMax, int *lpStep)
 Function to retrieve the detailed information a specified display color item.
int ADL_Display_ColorTemperatureSource_Get (int iAdapterIndex, int iDisplayIndex, int *lpTempSource)
 Function to get color temperature source.
int ADL_Display_ColorTemperatureSource_Set (int iAdapterIndex, int iDisplayIndex, int iTempSource)
 Function to set the color temperature source.

Detailed Description

This group describes the Color related APIs

Function Documentation

int ADL_Display_ColorCaps_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCaps,
int *  lpValids 
)

Function to get the Color Caps display information.

This function retrieves the display Color Caps information for a specified adapter and display.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out] lpCaps The pointer to the Color Caps information retrieved from the driver. Display Color Type and Source
[out] lpValids The pointer to the bit vector indicating which bit is valid on the lpCaps returned.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Sample/main.c.

int ADL_Display_Color_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iColorType,
int  iCurrent 
)

Function to set the current value of a specific color and type.

This function sets the display color for a specified adapter, display, and color type.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in] iColorType The desired color type. It can be any of the defined type. Display Color Type and Source
[in] iCurrent The desired color value.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
Examples:
Sample/main.c.

int ADL_Display_Color_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int  iColorType,
int *  lpCurrent,
int *  lpDefault,
int *  lpMin,
int *  lpMax,
int *  lpStep 
)

Function to retrieve the detailed information a specified display color item.

This function retrieves the detailed information for a specified display color.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in] iColorType The desired color type. It can be any of the defined type. Display Color Type and Source
[out] lpCurrent The pointer to the current color value.
[out] lpDefault The pointer to the default color value.
[out] lpMin The pointer to the minimum color value.
[out] lpMax The pointer to the maximum color value.
[out] lpStep The pointer to the increment of the color setting.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Sample/main.c.

int ADL_Display_ColorTemperatureSource_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpTempSource 
)

Function to get color temperature source.

This function retrieves the current color temperature source.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out] lpTempSource The pointer of the retrieved current color temperature source. Display Color Type and Source
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Display_ColorTemperatureSource_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iTempSource 
)

Function to set the color temperature source.

This function sets the current color temperature source.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in] iTempSource The desired color temperature source. Display Color Type and Source
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Call ADL_Flush_Driver_Data() after to persist settings on reboot.


Copyright © 2009-2013 Advanced Micro Devices, Inc. All rights reserved.  AMD Developer