Main Group of APIs


Functions

int ADL_Main_ControlX2_Create (ADL_MAIN_MALLOC_CALLBACK callback, int iEnumConnectedAdapters, ADLThreadingModel threadingModel)
 Function to initialize the ADL interface. This function should be called first.
int ADL2_Main_ControlX2_Create (ADL_MAIN_MALLOC_CALLBACK callback, int iEnumConnectedAdapters, ADL_CONTEXT_HANDLE *context, ADLThreadingModel threadingModel)
 Function to initialize the ADL2 interface and issue client's context handle.
int ADL_Main_Control_Create (ADL_MAIN_MALLOC_CALLBACK callback, int iEnumConnectedAdapters)
 Function to initialize the ADL interface. This function should be called first.
int ADL2_Main_Control_Create (ADL_MAIN_MALLOC_CALLBACK callback, int iEnumConnectedAdapters, ADL_CONTEXT_HANDLE *context)
 Function to initialize the ADL2 interface and to obtain client's context handle.
int ADL2_Main_Control_Refresh (ADL_CONTEXT_HANDLE context)
 Function to refresh adapter information. This function generates an adapter index value for all logical adapters that have ever been present in the system.
int ADL_Main_Control_Refresh ()
 Function to refresh adapter information. This function generates an adapter index value for all logical adapters that have ever been present in the system.
int ADL_Main_Control_Destroy ()
 Function to destroy ADL global pointers. This function should be called last.
int ADL2_Main_Control_Destroy (ADL_CONTEXT_HANDLE context)
 Destroy client's ADL context.
void * ADL2_Main_Control_GetProcAddress (ADL_CONTEXT_HANDLE context, void *lpModule, char *lpProcName)
 ADL local interface. Function to determine the validity of and retrieve the function pointer (similar to the GetProcAdress API) for a specified function.
void * ADL_Main_Control_GetProcAddress (void *lpModule, char *lpProcName)
 ADL local interface. Function to determine the validity of and retrieve the function pointer (similar to the GetProcAdress API) for a specified function.
int ADL2_Graphics_Versions_Get (ADL_CONTEXT_HANDLE context, ADLVersionsInfo *lpVersionsInfo)
 Function to retrieve version information.
int ADL_Graphics_Versions_Get (ADLVersionsInfo *lpVersionsInfo)
 Function to retrieve version information.
int ADL2_Graphics_VersionsX2_Get (ADL_CONTEXT_HANDLE context, ADLVersionsInfoX2 *lpVersionsInfo)
 Function to retrieve s version information.
int ADL2_Graphics_Platform_Get (ADL_CONTEXT_HANDLE context, int *lpPlatForm)
int ADL_Graphics_Platform_Get (int *lpPlatForm)

Detailed Description

This group describes the APIs for initializing, refreshing and destroying ADL

Function Documentation

int ADL_Main_ControlX2_Create ( ADL_MAIN_MALLOC_CALLBACK  callback,
int  iEnumConnectedAdapters,
ADLThreadingModel  threadingModel 
)

Function to initialize the ADL interface. This function should be called first.

This function initializes the ADL library. Allows the client to specify desired threading behavior of ADL APIs. It also initializes global pointers and, at the same time, calls the ADL_Main_Control_Refresh function.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] callback,: The memory allocation function for memory buffer allocation. This must be provided by the user. This must be provided by the user. ADL internally uses this callback to allocate memory for the output parameters returned to the user and user is responsible to free the memory once used for these parameters. ADL internal takes care of allocating and de allocating the memory for its local variables.
[in] iEnumConnectedAdapters,: Specify a value of 0 to retrieve adapter information for all adapters that have ever been present in the system. Specify a value of 1 to retrieve adapter information only for adapters that are physically present and enabled in the system.
[in] threadingModel,: Specify ADL threading behavior.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL2_Main_ControlX2_Create ( ADL_MAIN_MALLOC_CALLBACK  callback,
int  iEnumConnectedAdapters,
ADL_CONTEXT_HANDLE context,
ADLThreadingModel  threadingModel 
)

Function to initialize the ADL2 interface and issue client's context handle.

Clients can use ADL2 versions of ADL APIs 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. ADL2_Main_ControlX2_Create allows the client to specify desired threading behavior of ADL APIs.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] callback,: The memory allocation function for memory buffer allocation. This must be provided by the user. This must be provided by the user. ADL internally uses this callback to allocate memory for the output parameters returned to the user and user is responsible to free the memory once used for these parameters. ADL internal takes care of allocating and de allocating the memory for its local variables.
[in] iEnumConnectedAdapters,: Specify a value of 0 to retrieve adapter information for all adapters that have ever been present in the system. Specify a value of 1 to retrieve adapter information only for adapters that are physically present and enabled in the system.
[out] context,: ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
[in] threadingModel,: Specify ADL threading behavior.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Main_Control_Create ( ADL_MAIN_MALLOC_CALLBACK  callback,
int  iEnumConnectedAdapters 
)

Function to initialize the ADL interface. This function should be called first.

This function initializes the ADL library. ADL initialized using ADL_Main_Control_Create will not enforce serialization of ADL API executions by multiple threads. Multiple threads will be allowed to enter to ADL at the same time. Note that ADL library is not guaranteed to be thread-safe. Client that calls ADL_Main_Control_Create have to provide its own mechanism for ADL calls serialization. It also initializes global pointers and, at the same time, calls the ADL_Main_Control_Refresh function.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] callback,: The memory allocation function for memory buffer allocation. This must be provided by the user. ADL internally uses this callback to allocate memory for the output parameters returned to the user and user is responsible to free the memory once used for these parameters. ADL internal takes care of allocating and de allocating the memory for its local variables.
[in] iEnumConnectedAdapters,: Specify a value of 0 to retrieve adapter information for all adapters that have ever been present in the system. Specify a value of 1 to retrieve adapter information only for adapters that are physically present and enabled in the system.
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_Main_Control_Create ( ADL_MAIN_MALLOC_CALLBACK  callback,
int  iEnumConnectedAdapters,
ADL_CONTEXT_HANDLE context 
)

Function to initialize the ADL2 interface and to obtain client's context handle.

Clients can use ADL2 versions of ADL APIs 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. ADL initialized using ADL2_Main_Control_Create will not enforce serialization of ADL API executions by multiple threads. Multiple threads will be allowed to enter to ADL at the same time. Note that ADL library is not guaranteed to be thread-safe. Client that calls ADL2_Main_Control_Create have to provide its own mechanism for ADL calls serialization.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] callback,: The memory allocation function for memory buffer allocation. This must be provided by the user. ADL internally uses this callback to allocate memory for the output parameters returned to the user and user is responsible to free the memory once used for these parameters. ADL internal takes care of allocating and de allocating the memory for its local variables.
[in] iEnumConnectedAdapters,: Specify a value of 0 to retrieve adapter information for all adapters that have ever been present in the system. Specify a value of 1 to retrieve adapter information only for adapters that are physically present and enabled in the system.
[out] context,: ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.
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, and PowerXPress/PowerXPress.cpp.

int ADL2_Main_Control_Refresh ( ADL_CONTEXT_HANDLE  context  ) 

Function to refresh adapter information. This function generates an adapter index value for all logical adapters that have ever been present in the system.

This function updates the adapter information based on the logical adapters currently in the system. The adapter index and UDID mappings remain unchanged for each refresh call.

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
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_Main_Control_Refresh (  ) 

Function to refresh adapter information. This function generates an adapter index value for all logical adapters that have ever been present in the system.

This function updates the adapter information based on the logical adapters currently in the system. The adapter index and UDID mappings remain unchanged for each refresh call.

Supported Platforms:
Linux and Windows(XP, Vista and above); 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 ADL_Main_Control_Destroy (  ) 

Function to destroy ADL global pointers. This function should be called last.

All ADL global buffers and resources are released after this function is called.

Supported Platforms:
Linux and Windows(XP, Vista and above); 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
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_Main_Control_Destroy ( ADL_CONTEXT_HANDLE  context  ) 

Destroy client's ADL context.

Clients can use ADL2 versions of ADL APIs to assure that there is no interference with other ADL clients that are running in the same process and to assure that ADL APIs are thread-safe. 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.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: ADL_CONTEXT_HANDLE instance to destroy.
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, and PowerXPress/PowerXPress.cpp.

void* ADL2_Main_Control_GetProcAddress ( ADL_CONTEXT_HANDLE  context,
void *  lpModule,
char *  lpProcName 
)

ADL local interface. Function to determine the validity of and retrieve the function pointer (similar to the GetProcAdress API) for a specified function.

This function returns the function pointer of a specified function if it is valid (defined and exposed in a DLL module). Call this function to ensure that a function is valid before calling it.

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] lpModule The pointer to the desired handle of the DLL.
[in] lpProcName The pointer to the desired function name.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
If the specified function is valid, the return value is a function pointer. Otherwise it is NULL.
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.

void* ADL_Main_Control_GetProcAddress ( void *  lpModule,
char *  lpProcName 
)

ADL local interface. Function to determine the validity of and retrieve the function pointer (similar to the GetProcAdress API) for a specified function.

This function returns the function pointer of a specified function if it is valid (defined and exposed in a DLL module). Call this function to ensure that a function is valid before calling it.

Parameters:
[in] lpModule The pointer to the desired handle of the DLL.
[in] lpProcName The pointer to the desired function name.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
If the specified function is valid, the return value is a function pointer. Otherwise it is NULL.
Examples:
Sample-Managed/ADL.cs.

int ADL2_Graphics_Versions_Get ( ADL_CONTEXT_HANDLE  context,
ADLVersionsInfo lpVersionsInfo 
)

Function to retrieve version information.

This function retrieves software version information and a web link to an XML file with information about the latest web-posted Catalyst drivers

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out] lpVersionsInfo The pointer to ADLVersionsInfo structure with the retrieved version information.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER
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_Graphics_Versions_Get ( ADLVersionsInfo lpVersionsInfo  ) 

Function to retrieve version information.

This function retrieves software version information and a web link to an XML file with information about the latest web-posted Catalyst drivers

Parameters:
[out] lpVersionsInfo The pointer to ADLVersionsInfo structure with the retrieved version information.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns:
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER

int ADL2_Graphics_VersionsX2_Get ( ADL_CONTEXT_HANDLE  context,
ADLVersionsInfoX2 lpVersionsInfo 
)

Function to retrieve s version information.

This function retrieves software version information and a web link to an XML file with information about the latest web-posted Catalyst drivers

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out] lpVersionsInfo The pointer to ADLVersionsInfoX2 structure with the retrieved version information.
Supported Platforms:
Windows (XP, Vista and above); 32bit and 64bit
Returns:
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER
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 ADL2_Graphics_Platform_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpPlatForm 
)

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
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_Graphics_Platform_Get ( int *  lpPlatForm  ) 


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