CrossDisplay APIs

This group describes the CrossDisplay APIs. More...

Functions
int	ADL2_Adapter_CrossdisplayAdapterRole_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCrossDisplaySupport, int *lpAdapterRole, int *lpNumPossDisplayAdapters, int **lppPossDisplayAdapters, int *lpNnumPosRenderingAdapters, int **lppPosRenderingAdapters, int *lpErrorStatus)
int	ADL2_Adapter_CrossdisplayInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterRole, int *lpCrossdisplayMode, int *lpNumDisplayAdapters, int **lppDisplayAdapters, int *lpNumRenderingAdapters, int **lppRenderingAdapters, int *lpErrorCodeStatus)
	Function to retrieve CrossDisplay state information. More...
int	ADL2_Adapter_CrossdisplayInfo_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayAdapterIndex, int iRenderingAdapterIndex, int iCrossdisplayMode, int *lpErrorCode)
	Function to set the system configuration to CrossDisplay mode or multi-adapter mode. More...
int	ADL2_Adapter_CrossdisplayInfoX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayAdapterIndex, int iRenderingAdapterIndex, int iCrossdisplayMode, int iCrossdisplayOption, int *lpErrorCode)
	Function to set the system configuration to CrossDisplay mode or multi-adapter mode. More...
int	ADL2_Adapter_CrossDisplayPlatformInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpXDPlatformInfoMask, int *lpXDPlatformInfoValue)
	Function to get the graphics platform information of of an adapter. More...
int	ADL_Adapter_CrossdisplayAdapterRole_Caps (int iAdapterIndex, int *lpCrossDisplaySupport, int *lpAdapterRole, int *lpNumPossDisplayAdapters, int **lppPossDisplayAdapters, int *lpNnumPosRenderingAdapters, int **lppPosRenderingAdapters, int *lpErrorStatus)
	Function to retrieve CrossDisplay capabilities. More...
int	ADL_Adapter_CrossdisplayInfo_Get (int iAdapterIndex, int *lpAdapterRole, int *lpCrossdisplayMode, int *lpNumDisplayAdapters, int **lppDisplayAdapters, int *lpNumRenderingAdapters, int **lppRenderingAdapters, int *lpErrorCodeStatus)
int	ADL_Adapter_CrossdisplayInfo_Set (int iAdapterIndex, int iDisplayAdapterIndex, int iRenderingAdapterIndex, int iCrossdisplayMode, int *lpErrorCode)
	Function to set the system configuration to CrossDisplay mode or multi-adapter mode. More...
int	ADL_Adapter_CrossdisplayInfoX2_Set (int iAdapterIndex, int iDisplayAdapterIndex, int iRenderingAdapterIndex, int iCrossdisplayMode, int iCrossdisplayOption, int *lpErrorCode)
	Function to set the system configuration to CrossDisplay mode or multi-adapter mode. More...
int	ADL_Adapter_CrossDisplayPlatformInfo_Get (int iAdapterIndex, int *lpXDPlatformInfoMask, int *lpXDPlatformInfoValue)
	Function to get the graphics platform information of of an adapter. More...

Detailed Description

This group describes the CrossDisplay APIs.

Function to retrieve CrossDisplay capabilities.

The output parameters of the function include the CrossDisplay supported flag, supported CrossDisplay roles of an adapter, and its partner adapters. If the adapter is capable of playing a display role, the number of possible rendering adapters (lpNnumPosRenderingAdapters) and possible rendering adapters (lppPosRenderingAdapters) parameters are valid. If the adapter is capable of playing a rendering role, the number of possible display adapters (lpNumPossDisplayAdapters) and the possible display adapters (lppPossDisplayAdapters) parameters are valid. If the adapter is capable of playing a display-rendering role, all the output parameters are valid.

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 adapter to which the CrossDisplay capability information is applied.
[out]	lpCrossDisplaySupport	The pointer to the address of the flag representing CrossDisplay support. If the system supports CrossDisplay and the input adapter has or will have a role in the CrossDisplay configuration, the content of the pointer is 1, otherwise it is 0. This pointer should be initialized by the user.
[out]	lpAdapterRole	The pointer to the supported roles of the input adapter. This pointer should be initialized by the user. Possible output values are 0, 1, 2, and 3. 0: The input adapter does not support any CrossDisplay roles. 1: The input adapter supports a rendering role. 2: The input adpater supports a display role. 3: The input adapter supports both rendering and display roles.
[out]	lpNumPossDisplayAdapters	The pointer to the number of possible display adapters. This pointer should be initialized by the user.
[out]	lppPossDisplayAdapters	The pointer to the pointer to the first possible display adapter address. This pointer does not need to be initialized by the user.
[out]	lpNnumPosRenderingAdapters	The pointer to the number of possible rendering adapters. This pointer should be initialized by the user.
[out]	lppPosRenderingAdapters	The pointer to the pointer to the first possible rendering adapter address. This pointer does not need to be initialized by the user.
[out]	lpErrorStatus	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned 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.

Function Documentation

ADL2_Adapter_CrossdisplayAdapterRole_Caps()

int ADL2_Adapter_CrossdisplayAdapterRole_Caps	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	lpCrossDisplaySupport,
		int *	lpAdapterRole,
		int *	lpNumPossDisplayAdapters,
		int **	lppPossDisplayAdapters,
		int *	lpNnumPosRenderingAdapters,
		int **	lppPosRenderingAdapters,
		int *	lpErrorStatus
	)

ADL2_Adapter_CrossdisplayInfo_Get()

int ADL2_Adapter_CrossdisplayInfo_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	lpAdapterRole,
		int *	lpCrossdisplayMode,
		int *	lpNumDisplayAdapters,
		int **	lppDisplayAdapters,
		int *	lpNumRenderingAdapters,
		int **	lppRenderingAdapters,
		int *	lpErrorCodeStatus
	)

Function to retrieve CrossDisplay state information.

The output parameters of the function include the adapter role, the CrossDisplay mode and its partner adapters. If the adapter is in CrossDisplay mode and the adapter role is display, the number of rendering adapters (lpNnumPosRenderingAdapters) and rendering adapters (lppPosRenderingAdapters) parameters are valid. If the adapter is in CrossDisplay mode and the adapter role is rendering, the number of display adapters (lpNumPossDisplayAdapters) and display adapters (lppPossDisplayAdapters) parameters are valid. If the adapter is in multi-adapter mode, only the the adapter role (lpAdapterRole) and CrossDisplay mode (lpCrossDisplaySupport) parameters are valid.

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 adapter to which the CrossDisplay state information is applied.
[out]	lpAdapterRole	The pointer to the retrieved adapter role. This pointer should be initialized by the user. Possible output values are 0, 1, and 2. 0: The input adapter does not support any CrossDisplay roles. 1: The input adapter supports a rendering role. 2: The input adpater supports a display role.
[out]	lpCrossdisplayMode	The pointer to the retrieved CrossDisplay mode. This pointer should be initialized by the user. Possible output values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[out]	lpNumDisplayAdapters	The pointer to the number of retrieved display adapters. This pointer should be initialized by the user.
[out]	lppDisplayAdapters	The pointer to the pointer to the first display adapter address. This pointer does not need to be initialized by the user.
[out]	lpNumRenderingAdapters	The pointer to the number of possible rendering adapters. This pointer should be initialized by the user.
[out]	lppRenderingAdapters	The pointer to the pointer to the first rendering adapter address. This pointer does not need to be initialized by the user.
[out]	lpErrorCodeStatus	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned 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.

ADL2_Adapter_CrossdisplayInfo_Set()

int ADL2_Adapter_CrossdisplayInfo_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayAdapterIndex,
		int	iRenderingAdapterIndex,
		int	iCrossdisplayMode,
		int *	lpErrorCode
	)

Function to set the system configuration to CrossDisplay mode or multi-adapter mode.

This public function enables/disables CrossDisplay mode configuration

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 adapter to which the CrossDisplay configuration change is applied.
[in]	iDisplayAdapterIndex	The display adapter index.
[in]	iRenderingAdapterIndex	The rendering adapter index.
[in]	iCrossdisplayMode	The desired configuration. Possible values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[out]	lpErrorCode	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK or ADL_OK_WAIT. Otherwise, the return value is 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.

ADL2_Adapter_CrossdisplayInfoX2_Set()

int ADL2_Adapter_CrossdisplayInfoX2_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayAdapterIndex,
		int	iRenderingAdapterIndex,
		int	iCrossdisplayMode,
		int	iCrossdisplayOption,
		int *	lpErrorCode
	)

Function to set the system configuration to CrossDisplay mode or multi-adapter mode.

This public function enables/disables CrossDisplay mode configuration

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 adapter to which the CrossDisplay configuration change is applied.
[in]	iDisplayAdapterIndex	The display adapter index.
[in]	iRenderingAdapterIndex	The rendering adapter index.
[in]	iCrossdisplayMode	The desired configuration. Possible values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[in]	iCrossdisplayOption	The value contains extra option bits used in cross display switching. ADL_CROSSDISPLAY_OPTION_XXX ADL_CROSSDISPLAY_OPTION_NONE: Checking if 3D application is runnning. If yes, not to do switch, return ADL_OK_WAIT; otherwise do switch. ADL_CROSSDISPLAY_OPTION_FORCESWITCH: Force switching without checking for running 3D applications.
[out]	lpErrorCode	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK or ADL_OK_WAIT. Otherwise, the return value is 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.

ADL2_Adapter_CrossDisplayPlatformInfo_Get()

int ADL2_Adapter_CrossDisplayPlatformInfo_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	lpXDPlatformInfoMask,
		int *	lpXDPlatformInfoValue
	)

Function to get the graphics platform information of of an adapter.

This function retrieves the graphics platform information of a specified adapter.

Supported Platforms:

\Win7Vista

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]	lpXDPlatformInfoMask	The pointer to the graphics platform information mask. ADL_CROSSDISPLAY_PLATFORM_XXX
[out]	lpXDPlatformInfoValue	The pointer to the graphics platform information value. ADL_CROSSDISPLAY_PLATFORM_XXX.

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.

ADL_Adapter_CrossdisplayAdapterRole_Caps()

int ADL_Adapter_CrossdisplayAdapterRole_Caps	(	int	iAdapterIndex,
		int *	lpCrossDisplaySupport,
		int *	lpAdapterRole,
		int *	lpNumPossDisplayAdapters,
		int **	lppPossDisplayAdapters,
		int *	lpNnumPosRenderingAdapters,
		int **	lppPosRenderingAdapters,
		int *	lpErrorStatus
	)

Function to retrieve CrossDisplay capabilities.

The output parameters of the function include the CrossDisplay supported flag, supported CrossDisplay roles of an adapter, and its partner adapters. If the adapter is capable of playing a display role, the number of possible rendering adapters (lpNnumPosRenderingAdapters) and possible rendering adapters (lppPosRenderingAdapters) parameters are valid. If the adapter is capable of playing a rendering role, the number of possible display adapters (lpNumPossDisplayAdapters) and the possible display adapters (lppPossDisplayAdapters) parameters are valid. If the adapter is capable of playing a display-rendering role, all the output parameters are valid.

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The ADL index handle of the adapter to which the CrossDisplay capability information is applied.
[out]	lpCrossDisplaySupport	The pointer to the address of the flag representing CrossDisplay support. If the system supports CrossDisplay and the input adapter has or will have a role in the CrossDisplay configuration, the content of the pointer is 1, otherwise it is 0. This pointer should be initialized by the user.
[out]	lpAdapterRole	The pointer to the supported roles of the input adapter. This pointer should be initialized by the user. Possible output values are 0, 1, 2, and 3. 0: The input adapter does not support any CrossDisplay roles. 1: The input adapter supports a rendering role. 2: The input adpater supports a display role. 3: The input adapter supports both rendering and display roles.
[out]	lpNumPossDisplayAdapters	The pointer to the number of possible display adapters. This pointer should be initialized by the user.
[out]	lppPossDisplayAdapters	The pointer to the pointer to the first possible display adapter address. This pointer does not need to be initialized by the user.
[out]	lpNnumPosRenderingAdapters	The pointer to the number of possible rendering adapters. This pointer should be initialized by the user.
[out]	lppPosRenderingAdapters	The pointer to the pointer to the first possible rendering adapter address. This pointer does not need to be initialized by the user.
[out]	lpErrorStatus	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK. Otherwise, the return value is an ADL error code. Result Codes

ADL_Adapter_CrossdisplayInfo_Get()

int ADL_Adapter_CrossdisplayInfo_Get	(	int	iAdapterIndex,
		int *	lpAdapterRole,
		int *	lpCrossdisplayMode,
		int *	lpNumDisplayAdapters,
		int **	lppDisplayAdapters,
		int *	lpNumRenderingAdapters,
		int **	lppRenderingAdapters,
		int *	lpErrorCodeStatus
	)

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The ADL index handle of the adapter to which the CrossDisplay state information is applied.
[out]	lpAdapterRole	The pointer to the retrieved adapter role. This pointer should be initialized by the user. Possible output values are 0, 1, and 2. 0: The input adapter does not support any CrossDisplay roles. 1: The input adapter supports a rendering role. 2: The input adpater supports a display role.
[out]	lpCrossdisplayMode	The pointer to the retrieved CrossDisplay mode. This pointer should be initialized by the user. Possible output values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[out]	lpNumDisplayAdapters	The pointer to the number of retrieved display adapters. This pointer should be initialized by the user.
[out]	lppDisplayAdapters	The pointer to the pointer to the first display adapter address. This pointer does not need to be initialized by the user.
[out]	lpNumRenderingAdapters	The pointer to the number of possible rendering adapters. This pointer should be initialized by the user.
[out]	lppRenderingAdapters	The pointer to the pointer to the first rendering adapter address. This pointer does not need to be initialized by the user.
[out]	lpErrorCodeStatus	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Adapter_CrossdisplayInfo_Set()

int ADL_Adapter_CrossdisplayInfo_Set	(	int	iAdapterIndex,
		int	iDisplayAdapterIndex,
		int	iRenderingAdapterIndex,
		int	iCrossdisplayMode,
		int *	lpErrorCode
	)

Function to set the system configuration to CrossDisplay mode or multi-adapter mode.

This public function enables/disables CrossDisplay mode configuration

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The ADL index handle of the adapter to which the CrossDisplay configuration change is applied.
[in]	iDisplayAdapterIndex	The display adapter index.
[in]	iRenderingAdapterIndex	The rendering adapter index.
[in]	iCrossdisplayMode	The desired configuration. Possible values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[out]	lpErrorCode	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK or ADL_OK_WAIT. Otherwise, the return value is an ADL error code otherwise. Result Codes

ADL_Adapter_CrossdisplayInfoX2_Set()

int ADL_Adapter_CrossdisplayInfoX2_Set	(	int	iAdapterIndex,
		int	iDisplayAdapterIndex,
		int	iRenderingAdapterIndex,
		int	iCrossdisplayMode,
		int	iCrossdisplayOption,
		int *	lpErrorCode
	)

Function to set the system configuration to CrossDisplay mode or multi-adapter mode.

This public function enables/disables CrossDisplay mode configuration

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The ADL index handle of the adapter to which the CrossDisplay configuration change is applied.
[in]	iDisplayAdapterIndex	The display adapter index.
[in]	iRenderingAdapterIndex	The rendering adapter index.
[in]	iCrossdisplayMode	The desired configuration. Possible values are 0 and 1. 0: Multi-adapter mode. 1: CrossDisplay mode.
[in]	iCrossdisplayOption	The value contains extra option bits used in cross display switching. ADL_CROSSDISPLAY_OPTION_XXX ADL_CROSSDISPLAY_OPTION_NONE: Checking if 3D application is runnning. If yes, not to do switch, return ADL_OK_WAIT; otherwise do switch. ADL_CROSSDISPLAY_OPTION_FORCESWITCH: Force switching without checking for running 3D applications.
[out]	lpErrorCode	The pointer to the driver error or warning code. This pointer should be initialized by the user.

Returns

If the function succeeds, the returned value is ADL_OK or ADL_OK_WAIT. Otherwise, the return value is an ADL error code otherwise. Result Codes

ADL_Adapter_CrossDisplayPlatformInfo_Get()

int ADL_Adapter_CrossDisplayPlatformInfo_Get	(	int	iAdapterIndex,
		int *	lpXDPlatformInfoMask,
		int *	lpXDPlatformInfoValue
	)

Function to get the graphics platform information of of an adapter.

This function retrieves the graphics platform information of a specified adapter.

Supported Platforms:

\Win7Vista

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[out]	lpXDPlatformInfoMask	The pointer to the graphics platform information mask. ADL_CROSSDISPLAY_PLATFORM_XXX
[out]	lpXDPlatformInfoValue	The pointer to the graphics platform information value. ADL_CROSSDISPLAY_PLATFORM_XXX.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes