General Adapter APIs
[Adapter Related APIs]


Functions

int ADL2_Adapter_Active_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not.
int ADL_Adapter_Active_Get (int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not.
int ADL2_Adapter_Aspects_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, char *lpAspects, int iSize)
 ADL local interface. Function to retrieve the supported aspects list.
int ADL_Adapter_Aspects_Get (int iAdapterIndex, char *lpAspects, int iSize)
 ADL local interface. Function to retrieve the supported aspects list.
int ADL2_Adapter_NumberOfAdapters_Get (ADL_CONTEXT_HANDLE context, int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters.
int ADL_Adapter_NumberOfAdapters_Get (int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters.
int ADL2_Flush_Driver_Data (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to save driver data.
int ADL_Flush_Driver_Data (int iAdapterIndex)
 Function to save driver data.
int ADL2_Adapter_AdapterInfo_Get (ADL_CONTEXT_HANDLE context, LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information.
int ADL2_Adapter_VerndorID_Int_get (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Retrieves adapter vendor id.
int ADL_Adapter_AdapterInfo_Get (LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information.
int ADL2_Adapter_AdapterInfoX2_Get (ADL_CONTEXT_HANDLE context, AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information.
int ADL_Adapter_AdapterInfoX2_Get (AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information.
int ADL_Adapter_RegValueString_Get (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to query a string registry value set by driver.
int ADL_Adapter_RegValueString_Set (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to set a driver registry string value.
int ADL2_Adapter_RegValueString_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to set a driver registry string value.
int ADL2_Adapter_RegValueString_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to query a string registry value set by driver.
int ADL2_Adapter_ASICFamilyType_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter.
int ADL_Adapter_ASICFamilyType_Get (int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter.
int ADL2_Adapter_Speed_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCaps, int *lpValid)
 Function to get the current Force3DClock setting from the adapter.
int ADL_Adapter_Speed_Caps (int iAdapterIndex, int *lpCaps, int *lpValid)
 Function to get the current Force3DClock setting from the adapter.
int ADL2_Adapter_Speed_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCurrent, int *lpDefault)
 Function to get the current Speed setting from the adapter.
int ADL_Adapter_Speed_Get (int iAdapterIndex, int *lpCurrent, int *lpDefault)
 Function to get the current Speed setting from the adapter.
int ADL2_Adapter_Speed_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSpeed)
 Function to set the current Speed setting from the adapter.
int ADL_Adapter_Speed_Set (int iAdapterIndex, int iSpeed)
 Function to set the current Speed setting from the adapter.
int ADL2_Adapter_Accessibility_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAccessibility)
 Function to check if the GPU is accessible or not at the time of this call.
int ADL_Adapter_Accessibility_Get (int iAdapterIndex, int *lpAccessibility)
 Function to check if the GPU is accessible or not at the time of this call.
int ADL2_Adapter_VideoBiosInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information.
int ADL_Adapter_VideoBiosInfo_Get (int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information.
int ADL2_Adapter_ID_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter.
int ADL_Adapter_ID_Get (int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter.
int ADL2_AdapterX2_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information.
int ADL_AdapterX2_Caps (int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information.

Detailed Description

This group describes general Adapter APIs.

Function Documentation

int ADL2_Adapter_Active_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpStatus 
)

Function to determine if the adapter is active or not.

The function is used to check if the adapter associated with iAdapterIndex is active. Logic is different for Windows and Linux!

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpStatus The pointer to the retrieved status. ADL_TRUE : Active; ADL_FALSE : Disabled.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
Examples:
Adl2/Adl2_Sample.cpp, ASDR/ASDR.cpp, Overdrive8/Overdrive8.cpp, OverdriveN/OverdriveN.cpp, PMLog/PMLog.cpp, and PowerXPress/PowerXPress.cpp.

int ADL_Adapter_Active_Get ( int  iAdapterIndex,
int *  lpStatus 
)

Function to determine if the adapter is active or not.

The function is used to check if the adapter associated with iAdapterIndex is active. Logic is different for Windows and Linux!

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpStatus The pointer to the retrieved status. ADL_TRUE : Active; ADL_FALSE : Disabled.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Overdrive/Overdrive_Sample.cpp, and Sample-Managed/ADL.cs.

int ADL2_Adapter_Aspects_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
char *  lpAspects,
int  iSize 
)

ADL local interface. Function to retrieve the supported aspects list.

This function retrieves the list of supported aspects for a specified adapter.

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAspects The pointer to the buffer storing the list of aspects supported for the specified adapter.
[in] iSize The size of the lpAspects buffer.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
Examples:
PowerXPress/PowerXPress.cpp.

int ADL_Adapter_Aspects_Get ( int  iAdapterIndex,
char *  lpAspects,
int  iSize 
)

ADL local interface. Function to retrieve the supported aspects list.

This function retrieves the list of supported aspects for a specified adapter.

Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAspects The pointer to the buffer storing the list of aspects supported for the specified adapter.
[in] iSize The size of the lpAspects buffer.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.

int ADL2_Adapter_NumberOfAdapters_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpNumAdapters 
)

Function to retrieve the number of OS-known adapters.

This function retrieves the number of graphics adapters recognized by the OS (OS-known adapters). OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out] lpNumAdapters The pointer to the number of OS-known adapters.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
Examples:
PowerXPress/PowerXPress.cpp.

int ADL_Adapter_NumberOfAdapters_Get ( int *  lpNumAdapters  ) 

Function to retrieve the number of OS-known adapters.

This function retrieves the number of graphics adapters recognized by the OS (OS-known adapters). OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[out] lpNumAdapters The pointer to the number of OS-known adapters.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Adl2/Adl2_Sample.cpp, ASDR/ASDR.cpp, ColorCaps/main.cpp, NativeAUX/AUX_Sample.cpp, Overdrive/Overdrive_Sample.cpp, Overdrive8/Overdrive8.cpp, OverdriveN/OverdriveN.cpp, PMLog/PMLog.cpp, and Sample-Managed/ADL.cs.

int ADL2_Flush_Driver_Data ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex 
)

Function to save driver data.

This function saves all required data from driver to persist updated settings

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The adapter index to be flushed.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Flush_Driver_Data ( int  iAdapterIndex  ) 

Function to save driver data.

This function saves all required data from driver to persist updated settings

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The adapter index to be flushed.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL2_Adapter_AdapterInfo_Get ( ADL_CONTEXT_HANDLE  context,
LPAdapterInfo  lpInfo,
int  iInputSize 
)

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iInputSize The size of the lpInfo buffer.
[out] lpInfo The pointer to the buffer containing the retrieved adapter information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API take a fixed-size output array. For dynamic-size output, use ADL_Adapter_AdapterInfoX2_Get function.

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

Examples:
PowerXPress/PowerXPress.cpp.

int ADL2_Adapter_VerndorID_Int_get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex 
)

Retrieves adapter vendor id.

This function retrieves the parsed hex vendor id

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Adapter_AdapterInfo_Get ( LPAdapterInfo  lpInfo,
int  iInputSize 
)

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iInputSize The size of the lpInfo buffer.
[out] lpInfo The pointer to the buffer containing the retrieved adapter information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API take a fixed-size output array. For dynamic-size output, use ADL_Adapter_AdapterInfoX2_Get function.
Examples:
ASDR/ASDR.cpp, ColorCaps/main.cpp, NativeAUX/AUX_Sample.cpp, Overdrive/Overdrive_Sample.cpp, Overdrive8/Overdrive8.cpp, OverdriveN/OverdriveN.cpp, PMLog/PMLog.cpp, and Sample-Managed/ADL.cs.

int ADL2_Adapter_AdapterInfoX2_Get ( ADL_CONTEXT_HANDLE  context,
AdapterInfo **  lppAdapterInfo 
)

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out] lppAdapterInfo is pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API uses the memory allocation callback function provided by the user.

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_AdapterInfoX2_Get ( AdapterInfo **  lppAdapterInfo  ) 

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[out] lppAdapterInfo is pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API uses the memory allocation callback function provided by the user.

int ADL_Adapter_RegValueString_Get ( int  iAdapterIndex,
int  iDriverPathOption,
char *  szSubKey,
char *  szKeyName,
int  iSize,
char *  lpKeyValue 
)

ADL local interface. Function to query a string registry value set by driver.

This function queries a driver registry string value for a specified adapter by specifying the subkey path and key name.

Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDriverPathOption The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device.
[in] szSubKey The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL.
[in] szKeyName The name of registry value to be got. This is a null terminated string.
[in] iSize The size of registry value to be got.
[out] lpKeyValue The pointer to registry value to be got.
Supported Platforms:
Windows (XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.

int ADL_Adapter_RegValueString_Set ( int  iAdapterIndex,
int  iDriverPathOption,
char *  szSubKey,
char *  szKeyName,
int  iSize,
char *  lpKeyValue 
)

ADL local interface. Function to set a driver registry string value.

This function sets a driver registry string value for a specified adapter by specifying the subkey path and key name.

Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDriverPathOption The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device.
[in] szSubKey The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL.
[in] szKeyName The name of registry value to be set. This is a null terminated string.
[in] iSize The size of registry value to be set.
[in] lpKeyValue The pointer to registry value to be set.
Supported Platforms:
Windows (XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.

int ADL2_Adapter_RegValueString_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDriverPathOption,
char *  szSubKey,
char *  szKeyName,
int  iSize,
char *  lpKeyValue 
)

ADL local interface. Function to set a driver registry string value.

This function sets a driver registry string value for a specified adapter by specifying the subkey path and key name.

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDriverPathOption The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device.
[in] szSubKey The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL.
[in] szKeyName The name of registry value to be set. This is a null terminated string.
[in] iSize The size of registry value to be set.
[in] lpKeyValue The pointer to registry value to be set.
Supported Platforms:
Windows (XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL2_Adapter_RegValueString_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDriverPathOption,
char *  szSubKey,
char *  szKeyName,
int  iSize,
char *  lpKeyValue 
)

ADL local interface. Function to query a string registry value set by driver.

This function queries a driver registry string value for a specified adapter by specifying the subkey path and key name.

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDriverPathOption The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device.
[in] szSubKey The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL.
[in] szKeyName The name of registry value to be got. This is a null terminated string.
[in] iSize The size of registry value to be got.
[out] lpKeyValue The pointer to registry value to be got.
Supported Platforms:
Windows (XP, Vista and above); 32bit and 64bit
Returns:
If the function valid, the return value is 1. Otherwise it is 0.
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL2_Adapter_ASICFamilyType_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpAsicTypes,
int *  lpValids 
)

Function to get the ASICFamilyType from the adapter.

This function retrieves the ASIC family types for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAsicTypes The pointer to the Detailed asic types information retrieved from the driver.
[out] lpValids The pointer to the bit vector indicating which bit is valid on the lpAsicTypes returned.
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_ASICFamilyType_Get ( int  iAdapterIndex,
int *  lpAsicTypes,
int *  lpValids 
)

Function to get the ASICFamilyType from the adapter.

This function retrieves the ASIC family types for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAsicTypes The pointer to the Detailed asic types information retrieved from the driver.
[out] lpValids The pointer to the bit vector indicating which bit is valid on the lpAsicTypes returned.
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

int ADL2_Adapter_Speed_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpCaps,
int *  lpValid 
)

Function to get the current Force3DClock setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return valud can be ADL_ADAPTER_SPEEDCAPS_SUPPORTED or “0”

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpCaps The caps of adapter speed settings
[out] lpValid The valid bits of adapter speed settings
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_Speed_Caps ( int  iAdapterIndex,
int *  lpCaps,
int *  lpValid 
)

Function to get the current Force3DClock setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return valud can be ADL_ADAPTER_SPEEDCAPS_SUPPORTED or “0”

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpCaps The caps of adapter speed settings
[out] lpValid The valid bits of adapter speed settings
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

int ADL2_Adapter_Speed_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpCurrent,
int *  lpDefault 
)

Function to get the current Speed setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpCurrent The current speed setting
[out] lpDefault The default speed setting
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_Speed_Get ( int  iAdapterIndex,
int *  lpCurrent,
int *  lpDefault 
)

Function to get the current Speed setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpCurrent The current speed setting
[out] lpDefault The default speed setting
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

int ADL2_Adapter_Speed_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSpeed 
)

Function to set the current Speed setting from the adapter.

This function set the adapter speed information for a specified adapter. Input value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iSpeed The speed to set on specified adapter
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_Speed_Set ( int  iAdapterIndex,
int  iSpeed 
)

Function to set the current Speed setting from the adapter.

This function set the adapter speed information for a specified adapter. Input value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iSpeed The speed to set on specified adapter
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

int ADL2_Adapter_Accessibility_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpAccessibility 
)

Function to check if the GPU is accessible or not at the time of this call.

Some GPUs enter into various power savings mode when not in use, and during this time, direct access to the GPU can result in failures. Access through proper channels (such as via ADL) always works because the software accounts for the GPU's accessibility. However, direct access outside of authorised mechanisms may fail. Use this API to find out if the GPU is currently accessible or not. If API returns GPU accessible, this status will be maintained for 2 seconds.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAccessibility The pointer to an int value which indicates if the adapter is accessible or not (ADL_TRUE : Accessible, ADL_FALSE : Not accessible)
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_Accessibility_Get ( int  iAdapterIndex,
int *  lpAccessibility 
)

Function to check if the GPU is accessible or not at the time of this call.

Some GPUs enter into various power savings mode when not in use, and during this time, direct access to the GPU can result in failures. Access through proper channels (such as via ADL) always works because the software accounts for the GPU's accessibility. However, direct access outside of authorised mechanisms may fail. Use this API to find out if the GPU is currently accessible or not. If API returns GPU accessible, this status will be maintained for 2 seconds.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAccessibility The pointer to an int value which indicates if the adapter is accessible or not (ADL_TRUE : Accessible, ADL_FALSE : Not accessible)
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL2_Adapter_VideoBiosInfo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLBiosInfo lpBiosInfo 
)

ADL local interface. Function to retrieve BIOS information.

This function retrieves the BIOS information for a specified adapter.

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpBiosInfo The pointer to the structure storing the retrieved BIOs information.
Supported Platforms:
Linux; 32bit and 64bit
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
Examples:
PowerXPress/PowerXPress.cpp.

int ADL_Adapter_VideoBiosInfo_Get ( int  iAdapterIndex,
ADLBiosInfo lpBiosInfo 
)

ADL local interface. Function to retrieve BIOS information.

This function retrieves the BIOS information for a specified adapter.

Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpBiosInfo The pointer to the structure storing the retrieved BIOs information.
Supported Platforms:
Linux; 32bit and 64bit
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL2_Adapter_ID_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpAdapterID 
)

Function to get the unique identifier of an adapter.

This function retrieves the unique identifier of a specified adapter.
The adapter ID is a unique value and will be used to determine what other controllers share the same adapter.
The desktop will use this to find which HDCs are associated with an adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAdapterID The pointer to the adapter identifier. Zero means: The adapter is not AMD.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API is a duplicate to ADL_Display_AdapterID_Get()

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_ID_Get ( int  iAdapterIndex,
int *  lpAdapterID 
)

Function to get the unique identifier of an adapter.

This function retrieves the unique identifier of a specified adapter.
The adapter ID is a unique value and will be used to determine what other controllers share the same adapter.
The desktop will use this to find which HDCs are associated with an adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpAdapterID The pointer to the adapter identifier. Zero means: The adapter is not AMD.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API is a duplicate to ADL_Display_AdapterID_Get()

int ADL2_AdapterX2_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLAdapterCapsX2 adapterCaps 
)

Function to retrieve adapter caps information.

This function implements a DI call to retrieve adapter capability information .

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] adapterCaps The pointer to the structure storing the retrieved adapter capability information.
Returns:
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_AdapterX2_Caps ( int  iAdapterIndex,
ADLAdapterCapsX2 adapterCaps 
)

Function to retrieve adapter caps information.

This function implements a DI call to retrieve adapter capability information .

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] adapterCaps The pointer to the structure storing the retrieved adapter capability information.
Returns:
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes
Examples:
ASDR/ASDR.cpp, Overdrive8/Overdrive8.cpp, and OverdriveN/OverdriveN.cpp.


Copyright © 2009-2016 Advanced Micro Devices, Inc. All rights reserved.