This group describes the CrossFire APIs. More...

Functions
int	ADL2_Adapter_Crossfire_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int lpPreferred, int lpNumComb, ADLCrossfireComb **ppCrossfireComb)

int	ADL2_Adapter_Crossfire_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb lpCrossfireComb, ADLCrossfireInfo lpCrossfireInfo)

int	ADL2_Adapter_Crossfire_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
	Function to set CrossfireX combination settings. More...

int	ADL2_Adapter_CrossfireX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb lpCrossfireComb, ADLCrossfireInfo lpCrossfireInfo)
	Function to get current CrossfireX settings for both QUAD and Software crossfire. More...

int	ADL2_Adapter_MVPU_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iState)
	Function to set CrossfireX status. More...

int	ADL_Adapter_Crossfire_Caps (int iAdapterIndex, int lpPreferred, int lpNumComb, ADLCrossfireComb **ppCrossfireComb)
	Function to retrieve CrossfireX capabilities of the system. More...

int	ADL_Adapter_Crossfire_Get (int iAdapterIndex, ADLCrossfireComb lpCrossfireComb, ADLCrossfireInfo lpCrossfireInfo)

int	ADL_Adapter_Crossfire_Set (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
	Function to set CrossfireX combination settings. More...

int	ADL_Adapter_CrossfireX2_Get (int iAdapterIndex, ADLCrossfireComb lpCrossfireComb, ADLCrossfireInfo lpCrossfireInfo)
	Function to get current CrossfireX settings for both QUAD and Software crossfire. More...

Detailed Description

This group describes the CrossFire APIs.

Function to retrieve CrossfireX capabilities of the system.

This function is used to determine if the system is capable of doing CrossfireX, regardless if the system is setup properly.

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 to query CrossfireX capabilities
[out]	lpPreferred	The index of the preferred CrossfireX chain. The index is a zero based index reference in the ADLCrossfireComb list.
[out]	lpNumComb	The integer value indicating the number of ADLCrossfireComb structures in the lpCrossfireComb buffer
[out]	ppCrossfireComb	The Pointer to an empty memory buffer(NULL). This function will use the callback to allocate the appropriate buffer size. This buffer will contain a list of supported CrossfireX combinations if the adapter supports CrossfireX. If the adapter does not support CrossfireX, this memory buffer will remain empty, or NULL.

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: 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.

Function Documentation

◆ ADL2_Adapter_Crossfire_Caps()

int ADL2_Adapter_Crossfire_Caps	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	lpPreferred,
		int *	lpNumComb,
		ADLCrossfireComb **	ppCrossfireComb
	)

◆ ADL2_Adapter_Crossfire_Get()

int ADL2_Adapter_Crossfire_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb,
		ADLCrossfireInfo *	lpCrossfireInfo
	)

Function to get current CrossfireX combination settings.

This function is used to retrieve the current information about a particular CrossfireX combination. A CrossfireX combination includes the CrossfireX capable adapter and its CrossfireX chain (a list of other adapters that will work with the CrossfireX capable adapter). The possible CrossfireX chain combinations for an adapter is retrieved from the ADL_Adapter_Crossfire_Caps function.

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 of the CrossfireX capable adapter to query the CrossfireX state and current information
[in]	lpCrossfireComb	The CrossfireX chain to get information about.
[out]	lpCrossfireInfo	State and error information about the CrossfireX combination.

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.

◆ ADL2_Adapter_Crossfire_Set()

int ADL2_Adapter_Crossfire_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb
	)

Function to set CrossfireX combination settings.

This function is used to enable or disable CrossfireX on a particular adapter (pointed to by iAdapterIndex), along with the indicated CrossfireX chain. The CrossfireX chain combination for the adapter must be one returned by ADL_Adapter_Crossfire_Caps().

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 in which to enable or disable CrossfireX
[in]	lpCrossfireComb	the CrossfireX chain combination to enable or disable for the master adapter. If this parameter is not NULL, it will enable CrossfireX with the indicated combination. If this parameter is NULL, it will disable CrossfireX on that particular 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.

◆ ADL2_Adapter_CrossfireX2_Get()

int ADL2_Adapter_CrossfireX2_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb,
		ADLCrossfireInfo *	lpCrossfireInfo
	)

Function to get current CrossfireX settings for both QUAD and Software crossfire.

On QUAD Crossfire systems this function is used to retrieve the current information about a particular CrossfireX combination. A CrossfireX combination includes the CrossfireX capable adapter and its CrossfireX chain (a list of other adapters that will work with the CrossfireX capable adapter). The possible CrossfireX chain combinations for an adapter is retrieved from the ADL_Adapter_Crossfire_Caps function. On Software Crossfire systems this function is used to query support and status of Crossfire.

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 of the CrossfireX capable adapter to query the CrossfireX state and current information
[in]	lpCrossfireComb	The CrossfireX chain to get information about. Ignored when called for Software crossfire
[out]	lpCrossfireInfo	State and error information about the CrossfireX combination.

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.

◆ ADL2_Adapter_MVPU_Set()

int ADL2_Adapter_MVPU_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iState
	)

Function to set CrossfireX status.

This function is used to enable or disable CrossfireX on a particular adapter (pointed to by iAdapterIndex).

Supported Platforms:: Windows 7, 10 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 in which to enable or disable CrossfireX
[in]	iState	the requested CrossfireX state to be set

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.

◆ ADL_Adapter_Crossfire_Caps()

int ADL_Adapter_Crossfire_Caps	(	int	iAdapterIndex,
		int *	lpPreferred,
		int *	lpNumComb,
		ADLCrossfireComb **	ppCrossfireComb
	)

Function to retrieve CrossfireX capabilities of the system.

This function is used to determine if the system is capable of doing CrossfireX, regardless if the system is setup properly.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter to query CrossfireX capabilities
[out]	lpPreferred	The index of the preferred CrossfireX chain. The index is a zero based index reference in the ADLCrossfireComb list.
[out]	lpNumComb	The integer value indicating the number of ADLCrossfireComb structures in the lpCrossfireComb buffer
[out]	ppCrossfireComb	The Pointer to an empty memory buffer(NULL). This function will use the callback to allocate the appropriate buffer size. This buffer will contain a list of supported CrossfireX combinations if the adapter supports CrossfireX. If the adapter does not support CrossfireX, this memory buffer will remain empty, or NULL.

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: This API uses the memory allocation callback function provided by the user.

◆ ADL_Adapter_Crossfire_Get()

int ADL_Adapter_Crossfire_Get	(	int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb,
		ADLCrossfireInfo *	lpCrossfireInfo
	)

Function to get current CrossfireX combination settings.

This function is used to retrieve the current information about a particular CrossfireX combination. A CrossfireX combination includes the CrossfireX capable adapter and its CrossfireX chain (a list of other adapters that will work with the CrossfireX capable adapter). The possible CrossfireX chain combinations for an adapter is retrieved from the ADL_Adapter_Crossfire_Caps function.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index of the CrossfireX capable adapter to query the CrossfireX state and current information
[in]	lpCrossfireComb	The CrossfireX chain to get information about.
[out]	lpCrossfireInfo	State and error information about the CrossfireX combination.

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

◆ ADL_Adapter_Crossfire_Set()

int ADL_Adapter_Crossfire_Set	(	int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb
	)

Function to set CrossfireX combination settings.

This function is used to enable or disable CrossfireX on a particular adapter (pointed to by iAdapterIndex), along with the indicated CrossfireX chain. The CrossfireX chain combination for the adapter must be one returned by ADL_Adapter_Crossfire_Caps().

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The adapter in which to enable or disable CrossfireX
[in]	lpCrossfireComb	the CrossfireX chain combination to enable or disable for the master adapter. If this parameter is not NULL, it will enable CrossfireX with the indicated combination. If this parameter is NULL, it will disable CrossfireX on that particular 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

◆ ADL_Adapter_CrossfireX2_Get()

int ADL_Adapter_CrossfireX2_Get	(	int	iAdapterIndex,
		ADLCrossfireComb *	lpCrossfireComb,
		ADLCrossfireInfo *	lpCrossfireInfo
	)

Function to get current CrossfireX settings for both QUAD and Software crossfire.

On QUAD Crossfire systems this function is used to retrieve the current information about a particular CrossfireX combination. A CrossfireX combination includes the CrossfireX capable adapter and its CrossfireX chain (a list of other adapters that will work with the CrossfireX capable adapter). The possible CrossfireX chain combinations for an adapter is retrieved from the ADL_Adapter_Crossfire_Caps function. On Software Crossfire systems this function is used to query support and status of Crossfire.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index of the CrossfireX capable adapter to query the CrossfireX state and current information
[in]	lpCrossfireComb	The CrossfireX chain to get information about. Ignored when called for Software crossfire
[out]	lpCrossfireInfo	State and error information about the CrossfireX combination.

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

Functions

Detailed Description

Function Documentation

◆ ADL2_Adapter_Crossfire_Caps()

◆ ADL2_Adapter_Crossfire_Get()

◆ ADL2_Adapter_Crossfire_Set()

◆ ADL2_Adapter_CrossfireX2_Get()

◆ ADL2_Adapter_MVPU_Set()

◆ ADL_Adapter_Crossfire_Caps()

◆ ADL_Adapter_Crossfire_Get()

◆ ADL_Adapter_Crossfire_Set()

◆ ADL_Adapter_CrossfireX2_Get()