ADL (AMD Display Library) Public APIs  Version 17.0
Functions
Eyefinity APIs

This group outlines the Eyefinity related APIs. More...

Functions

int ADL2_Adapter_Desktop_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDesktopCapsValue, int *lpDesktopCapsMask)
 
int ADL2_Adapter_Desktop_SupportedSLSGridTypes_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumOfAvailableDisplays, ADLDisplayTarget *lpAvailableDisplays, int *lpNumSLSGrid, ADLSLSGrid **lppSLSGrid, int iOption)
 
int ADL2_Display_BezelOffset_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int iNumBezelOffset, LPADLSLSOffset lpBezelOffset, ADLSLSMap SLSMap, int iOption)
 Set SLS bezel offsets for each display index. More...
 
int ADL2_Display_BezelOffsetSteppingSize_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumBezelOffsetSteppingSize, ADLBezelOffsetSteppingSize **lppBezelOffsetSteppingSize)
 Get bezel offset stepping size for the input adapter. More...
 
int ADL2_Display_BezelSupported_Validate (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumPossibleSLSMap, LPADLPossibleSLSMap lpPossibleSLSMaps, int *lpNumPossibleSLSMapResult, LPADLPossibleMapResult *lppPossibleMapResult)
 Validate the list of the SLS display configurations to determine if bezel is supported or not. More...
 
int ADL2_Display_Overlap_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int iNumOverlappedModes, LPADLSLSTargetOverlap lpOverlappedModes, int iNumTargetOffsets, LPADLSLSOffset lpTargetOffsets, ADLSLSMap SLSMap)
 Set SLS overlap offsets for each display index. More...
 
int ADL2_Display_PossibleMode_WinXP_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumDisplayTargets, ADLDisplayTarget *lpDisplayTargets, int iLargeDesktopSupportedType, int iDevicePanningControl, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the ATI possible modes list for an adapter and preset mapping (Windows XP). More...
 
int ADL2_Display_SLSBuilder_CommonMode_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumDisplayTarget, ADLSLSTarget *lpSLSTarget, int *lpTotalWidth, int *lpTotalHeight)
 
int ADL2_Display_SLSGrid_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumSLSGrid, ADLSLSGrid **lppSLSGrid, int iOption)
 
int ADL2_Display_SLSMapConfig_Create (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLSLSMap SLSMap, int iNumTarget, ADLSLSTarget *lpSLSTarget, int iBezelModePercent, int *lpSLSMapIndex, int iOption)
 Function to create an SLS configuration. More...
 
int ADL2_Display_SLSMapConfig_Delete (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex)
 Function to delete an SLS map from the driver database. More...
 
int ADL2_Display_SLSMapConfig_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, ADLSLSMap *lpSLSMap, int *lpNumSLSTarget, ADLSLSTarget **lppSLSTarget, int *lpNumNativeMode, ADLSLSMode **lppNativeMode, int *lpNumBezelMode, ADLBezelTransientMode **lppBezelMode, int *lpNumTransientMode, ADLBezelTransientMode **lppTransientMode, int *lpNumSLSOffset, ADLSLSOffset **lppSLSOffset, int iOption)
 Function to retrieve an SLS configuration. More...
 
int ADL2_Display_SLSMapConfig_Rearrange (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int iNumDisplayTarget, ADLSLSTarget *lpSLSTarget, ADLSLSMap slsMap, int iOption)
 Function to rearrange display orders in an SLS map. More...
 
int ADL2_Display_SLSMapConfig_SetState (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int iState)
 Function to enable/disable SLS bind. More...
 
int ADL2_Display_SLSMapConfig_Valid (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLSLSMap slsMap, int iNumDisplayTarget, ADLSLSTarget *lpSLSTarget, int *lpSupportedSLSLayoutImageMode, int *lpReasonForNotSupportSLS, int iOption)
 
int ADL2_Display_SLSMapConfigX2_Delete (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumSLSMapIndex, int *lpSLSMapIndexes)
 Function to delete an list of SLS map indexes from the driver database. More...
 
int ADL2_Display_SLSMapConfigX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, ADLSLSMap *lpSLSMap, int *lpNumSLSTarget, ADLSLSTarget **lppSLSTarget, int *lpNumNativeMode, ADLSLSMode **lppNativeMode, int *lpNumNativeModeOffsets, ADLSLSOffset **lppNativeModeOffsets, int *lpNumBezelMode, ADLBezelTransientMode **lppBezelMode, int *lpNumTransientMode, ADLBezelTransientMode **lppTransientMode, int *lpNumSLSOffset, ADLSLSOffset **lppSLSOffset, int iOption)
 Function to retrieve an SLS configuration. More...
 
int ADL2_Display_SLSMapIndex_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iADLNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget, int *lpSLSMapIndex)
 Function to get the SLS map index for a given adapter and a given display device. More...
 
int ADL2_Display_SLSMapIndexList_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumSLSMapIndexList, int **lppSLSMapIndexList, int iOptions)
 Function to get the active SLS map index list for a given GPU. More...
 
int ADL2_Display_SLSMiddleMode_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int *lpMiddleModeSupported, int *lpMaxNumMiddleModeToSet, int *lpNumAvailableSLSMiddleMode, ADLSLSMode **lppAvailableSLSMiddleMode, int *lpNumCurrentSLSMiddleMode, ADLSLSMode **lppCurrentSLSMiddleMode, int *lpNumDefaultSLSMiddleMode, ADLSLSMode **lppDefaultSLSMiddleMode, int iOption)
 Get SLS middle mode for specific adapter. More...
 
int ADL2_Display_SLSMiddleMode_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSLSMapIndex, int iNumCurrentSLSMiddleMode, ADLSLSMode *lpCurrentSLSMiddleMode, int iOption)
 Set SLS middle mode for specific adapter. More...
 
int ADL2_Display_SLSRecords_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDisplayID displayID, int *lpNumOfRecords, int **lppGridIDList)
 Function to Get an SLS records from the driver database. More...
 
int ADL2_MGPUSLS_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iStatus)
 
int ADL_Display_BezelOffset_Set (int iAdapterIndex, int iSLSMapIndex, int iNumBezelOffset, LPADLSLSOffset lpBezelOffset, ADLSLSMap SLSMap, int iOption)
 Set SLS bezel offsets for each display index. More...
 
int ADL_Display_BezelOffsetSteppingSize_Get (int iAdapterIndex, int *lpNumBezelOffsetSteppingSize, ADLBezelOffsetSteppingSize **lppBezelOffsetSteppingSize)
 Get bezel offset stepping size for the input adapter. More...
 
int ADL_Display_BezelSupported_Validate (int iAdapterIndex, int iNumPossibleSLSMap, LPADLPossibleSLSMap lpPossibleSLSMaps, int *lpNumPossibleSLSMapResult, LPADLPossibleMapResult *lppPossibleMapResult)
 Validate the list of the SLS display configurations to determine if bezel is supported or not. More...
 
int ADL_Display_Overlap_Set (int iAdapterIndex, int iSLSMapIndex, int iNumOverlappedModes, LPADLSLSTargetOverlap lpOverlappedModes, int iNumTargetOffsets, LPADLSLSOffset lpTargetOffsets, ADLSLSMap SLSMap)
 Set SLS overlap offsets for each display index. More...
 
int ADL_Display_PossibleMode_WinXP_Get (int iAdapterIndex, int iNumDisplayTargets, ADLDisplayTarget *lpDisplayTargets, int iLargeDesktopSupportedType, int iDevicePanningControl, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the ATI possible modes list for an adapter and preset mapping (Windows XP). More...
 
int ADL_Display_SLSGrid_Caps (int iAdapterIndex, int *lpNumSLSGrid, ADLSLSGrid **lppSLSGrid, int iOption)
 Function to get the current supported SLS grid patterns (MxN) for a GPU. More...
 
int ADL_Display_SLSMapConfig_Create (int iAdapterIndex, ADLSLSMap SLSMap, int iNumTargetTarget, ADLSLSTarget *lpSLSTarget, int iBezelModePercent, int *lpSLSMapIndex, int iOption)
 Function to create an SLS configuration. More...
 
int ADL_Display_SLSMapConfig_Delete (int iAdapterIndex, int iSLSMapIndex)
 Function to delete an SLS map from the driver database. More...
 
int ADL_Display_SLSMapConfig_Get (int iAdapterIndex, int iSLSMapIndex, ADLSLSMap *lpSLSMap, int *lpNumSLSTarget, ADLSLSTarget **lppSLSTarget, int *lpNumNativeMode, ADLSLSMode **lppNativeMode, int *lpNumBezelMode, ADLBezelTransientMode **lppBezelMode, int *lpNumTransientMode, ADLBezelTransientMode **lppTransientMode, int *lpNumSLSOffset, ADLSLSOffset **lppSLSOffset, int iOption)
 Function to retrieve an SLS configuration. More...
 
int ADL_Display_SLSMapConfig_Rearrange (int iAdapterIndex, int iSLSMapIndex, int iNumDisplayTarget, ADLSLSTarget *lpSLSTarget, ADLSLSMap slsMap, int iOption)
 Function to rearrange display orders in an SLS map. More...
 
int ADL_Display_SLSMapConfig_SetState (int iAdapterIndex, int iSLSMapIndex, int iState)
 Function to enable/disable SLS bind. More...
 
int ADL_Display_SLSMapConfigX2_Get (int iAdapterIndex, int iSLSMapIndex, ADLSLSMap *lpSLSMap, int *lpNumSLSTarget, ADLSLSTarget **lppSLSTarget, int *lpNumNativeMode, ADLSLSMode **lppNativeMode, int *lpNumNativeModeOffsets, ADLSLSOffset **lppNativeModeOffsets, int *lpNumBezelMode, ADLBezelTransientMode **lppBezelMode, int *lpNumTransientMode, ADLBezelTransientMode **lppTransientMode, int *lpNumSLSOffset, ADLSLSOffset **lppSLSOffset, int iOption)
 Function to retrieve an SLS configuration. More...
 
int ADL_Display_SLSMapIndex_Get (int iAdapterIndex, int iADLNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget, int *lpSLSMapIndex)
 Function to get the SLS map index for a given adapter and a given display device. More...
 
int ADL_Display_SLSMapIndexList_Get (int iAdapterIndex, int *lpNumSLSMapIndexList, int **lppSLSMapIndexList, int iOptions)
 Function to get the active SLS map index list for a given GPU. More...
 
int ADL_Display_SLSMiddleMode_Get (int iAdapterIndex, int iSLSMapIndex, int *lpMiddleModeSupported, int *lpMaxNumMiddleModeToSet, int *lpNumAvailableSLSMiddleMode, ADLSLSMode **lppAvailableSLSMiddleMode, int *lpNumCurrentSLSMiddleMode, ADLSLSMode **lppCurrentSLSMiddleMode, int *lpNumDefaultSLSMiddleMode, ADLSLSMode **lppDefaultSLSMiddleMode, int iOption)
 Get SLS middle mode for specific adapter. More...
 
int ADL_Display_SLSMiddleMode_Set (int iAdapterIndex, int iSLSMapIndex, int iNumCurrentSLSMiddleMode, ADLSLSMode *lpCurrentSLSMiddleMode, int iOption)
 Set SLS middle mode for specific adapter. More...
 
int ADL_Display_SLSRecords_Get (int iAdapterIndex, ADLDisplayID displayID, int *lpNumOfRecords, int **lppGridIDList)
 Function to Get an SLS records from the driver database. More...
 

Detailed Description

This group outlines the Eyefinity related APIs.

Function to get the current supported SLS grid patterns (MxN) for a GPU.

This function gets a list of supported SLS grids for a specified input adapter based on display devices currently connected to the GPU.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]lpNumSLSGridPointer to a variable that will receive the number of elements in a supported SLS grid list.
[out]lppSLSGridPointer of a pointer to a variable with type ADLSLSGrid, which contains supported SLS grids the adapter supports. Application does not need to allocate memory but it should free the pointer since the memory is allocated by the ADL call back function.
[in]iOptionBit vector, specifies the layout type of SLS grid data and portrait flag. There are two types of SLS layouts: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE). If the current desktop associated with the input adapter is rotated to 90 or 270 degree, set bit ref \ADL_DISPLAY_SLSGRID_PORTAIT_MODE to 1.
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.

Function Documentation

◆ ADL2_Adapter_Desktop_Caps()

int ADL2_Adapter_Desktop_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDesktopCapsValue,
int *  lpDesktopCapsMask 
)
Function to set retrieve active desktop caps information

This function retrieve active desktop caps information

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpDesktopCapsValueDesktop caps value, bit vector. Currently designed for mix mode SLS feature
[out]lpDesktopCapsMaskDesktop caps Mask
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_Desktop_SupportedSLSGridTypes_Get()

int ADL2_Adapter_Desktop_SupportedSLSGridTypes_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumOfAvailableDisplays,
ADLDisplayTarget lpAvailableDisplays,
int *  lpNumSLSGrid,
ADLSLSGrid **  lppSLSGrid,
int  iOption 
)
Fucntion To retrieve active desktop supported SLS grid size.
Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndex- Adapter Index. -1 not supported. Only active desktop adapter index is valid
[in]iNumOfAvailableDisplays- The number of displays can be used to create SLS
[in]lpAvailableDisplays- Displays can be used to create SLS. The first one must be anchor display
[out]lpNumSLSGrid- The number of possible SLS grid types
[out]lppSLSGrid- possible SLS grid types
[out]iOption- Bit vector, specifies the layout type of SLS grid data and portrait flag. There are two types of SLS layouts: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE). If the current desktop associated with the input adapter is rotated to 90 or 270 degree, set bit ref \ADL_DISPLAY_SLSGRID_PORTAIT_MODE to 1
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Display_BezelOffset_Set()

int ADL2_Display_BezelOffset_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumBezelOffset,
LPADLSLSOffset  lpBezelOffset,
ADLSLSMap  SLSMap,
int  iOption 
)

Set SLS bezel offsets for each display index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index to apply bezel offset.
[in]iNumBezelOffsetinput size of the SLS offset per display per mode array.
[in]lpBezelOffsetList of SLS offset information, refer to ADLBezelOffset struct.
[in]SLSMapThe display SLS map information. Refer to the ADLSLSMap structure for more information.
[in]iOptionOption to set bezel offset. Default: ADL_DISPLAY_BEZELOFFSET_COMMIT
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
Clients other than CCC are expected to set SLSMap->iSLSMapMask to 0.
Clients other than CCC are expected to set SLSMap->iSLSMapValue to ADL_DISPLAY_SLSMAP_SLSLAYOUTMODE_FILL
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_Display_BezelOffsetSteppingSize_Get()

int ADL2_Display_BezelOffsetSteppingSize_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumBezelOffsetSteppingSize,
ADLBezelOffsetSteppingSize **  lppBezelOffsetSteppingSize 
)

Get bezel offset stepping size for the input adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]iNumBezelOffsetSteppingSizeThe number of Bezel offset stepping size per adapter.
[out]lppBezelOffsetSteppingSizeintBezel offset stepping size information. Refer to ADLBezelOffsetSteppingSize struct.
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.

◆ ADL2_Display_BezelSupported_Validate()

int ADL2_Display_BezelSupported_Validate ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumPossibleSLSMap,
LPADLPossibleSLSMap  lpPossibleSLSMaps,
int *  lpNumPossibleSLSMapResult,
LPADLPossibleMapResult lppPossibleMapResult 
)

Validate the list of the SLS display configurations to determine if bezel is supported or not.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iNumPossibleSLSMapInput size of SLS map to be validated.
[in]lpPossibleSLSMapsList of possible SLS maps to be validated.
[out]lpNumPossibleSLSMapResultSize of the valid array.
[out]lppPossibleMapResultvalid result list.
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.

◆ ADL2_Display_Overlap_Set()

int ADL2_Display_Overlap_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumOverlappedModes,
LPADLSLSTargetOverlap  lpOverlappedModes,
int  iNumTargetOffsets,
LPADLSLSOffset  lpTargetOffsets,
ADLSLSMap  SLSMap 
)

Set SLS overlap offsets for each display index.

Supported Platforms:
Windows 7; 32bit and 64bit and above
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index to apply Overlap offset.
[in]iNumOverlappedModesthe no. of overlapped modes defined. Each such mode refers to a set of targets in the array of targets
[in]lpOverlappedModesthe list of overlapped modes defined
[in]iNumTargetOffsetsthe no. of targets in the list of targets
[in]lpTargetOffsetsthe list of target offsets for all the overlap modes defined
[in]SLSMapThe display SLS map information. Refer to the ADLSLSMap structure for more information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
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_Display_PossibleMode_WinXP_Get()

int ADL2_Display_PossibleMode_WinXP_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumDisplayTargets,
ADLDisplayTarget lpDisplayTargets,
int  iLargeDesktopSupportedType,
int  iDevicePanningControl,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the ATI possible modes list for an adapter and preset mapping (Windows XP).

This function retrieves the ATI possible modes list based on a specified input adapter and preset mapping. This function is applicable only on Windows XP platforms.

Supported Platforms:
Windows XP; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iNumDisplayTargetsThe number of display target from the lpDisplayTargets array.
[in]lpDisplayTargetsThe pointer to the retrieved display target configurations. Refer to the ADLDisplayTarget structure for more information. E.g. If a CRT and TV are on as extended mode, lpMapConfigs will contain two ADLDisplayTarget structures: one CRT and one TV, both in extended manner.
[in]iLargeDesktopSupportedTypeThe large desktop type. Refer to the ADLLARGEDESKTOPTYPE enum for more information.
[in]iDevicePanningControlThe device panning control mode. Refer to the ADLPanningMode enum for more information.
[out]lpNumModesThe pointer to the number of modes from the lppModes array.
[out]lppModesThe pointer to the pointer to the possible display modes buffer. Refer to the ADLMode structure for more 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 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.

◆ ADL2_Display_SLSBuilder_CommonMode_Get()

int ADL2_Display_SLSBuilder_CommonMode_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumDisplayTarget,
ADLSLSTarget lpSLSTarget,
int *  lpTotalWidth,
int *  lpTotalHeight 
)
Get SLS builder common mode layout size

Get SLS builder common mode layout size

Supported Platforms:
Windows 7; 32bit and 64bit and Above
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndex- Input adapter Index. This function does not support -1 as adapter index.
[in]iNumDisplayTarget- the input size of SLS Target configurations array
[in]lpSLSTarget- a list of SLS Target in the SLS, refer to ADLSLSTargetstruct
[out]lpTotalWidth- Virtual topology view size max width
[out]lpTotalHeight- Virtual topoplogy view size max height
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Display_SLSGrid_Caps()

int ADL2_Display_SLSGrid_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumSLSGrid,
ADLSLSGrid **  lppSLSGrid,
int  iOption 
)

◆ ADL2_Display_SLSMapConfig_Create()

int ADL2_Display_SLSMapConfig_Create ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLSLSMap  SLSMap,
int  iNumTarget,
ADLSLSTarget lpSLSTarget,
int  iBezelModePercent,
int *  lpSLSMapIndex,
int  iOption 
)

Function to create an SLS configuration.

This function creates an SLS configuration with a given grid, targets, and bezel mode percent. It will output an SLS map index if the SLS map is successfully created.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]SLSMapSpecifies the display SLS map data that contains SLS grid and orientation information. Its type is ADLSLSMap
[in]iNumTargetSpecifies the number of displays to be used to create an SLS.
[in]lpSLSTargetArray of displays that are used to create an SLS. The data type is ADLSLSTarget.
[in]iBezelModePercentSpecifies the bezel mode percent. If these displays do not support bezel, set it to 0.
[out]lpSLSMapIndexPointer to a variable that will receive the new created SLS map index. If an SLS grid failed to create, its value is -1, other wise, it is non-negative integer.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts,: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
Clients other than CCC are expected to set SLSMap->iSLSMapValue to ADL_DISPLAY_SLSMAP_SLSLAYOUTMODE_FILL
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_Display_SLSMapConfig_Delete()

int ADL2_Display_SLSMapConfig_Delete ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex 
)

Function to delete an SLS map from the driver database.

This function deletes an SLS map from the driver database based on the input SLS map index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be deleted.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
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_Display_SLSMapConfig_Get()

int ADL2_Display_SLSMapConfig_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
ADLSLSMap lpSLSMap,
int *  lpNumSLSTarget,
ADLSLSTarget **  lppSLSTarget,
int *  lpNumNativeMode,
ADLSLSMode **  lppNativeMode,
int *  lpNumBezelMode,
ADLBezelTransientMode **  lppBezelMode,
int *  lpNumTransientMode,
ADLBezelTransientMode **  lppTransientMode,
int *  lpNumSLSOffset,
ADLSLSOffset **  lppSLSOffset,
int  iOption 
)

Function to retrieve an SLS configuration.

This function retrieves an SLS configuration, which includes the, SLS map, SLS targets, SLS standard modes, bezel modes or a transient mode, and offsets.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexSpecifies the adapter to be queried. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be queried.
[out]lpSLSMapPointer to a variable that contains the SLS map data. The data type is ADLSLSMap.
[out]lpNumSLSTargetPointer to variable that will receive the number of targets in the SLS map.
[out]lppSLSTargetPointer of a pointer to a variable that conations targets in the SLS map. the data type is ADLDisplayTarget Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSNativeModePointer to a variable that will receive the number of native SLS modes supported by the SLS configuration.
[out]lppSLSNativeModePointer of a pointer to a variable that contains the native SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSBezelModePointer to a variable that will receive the number of the bezel modes supported by the SLS configuration.
[out]lppSLSbezelModePointer of a pointer to a variable that contains the bezel SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSTransientModePointer to a variable that will receive the number of the transient modes supported by the SLS configuration.
[out]lppTransientModePointer of a pointer to a variable that contains the transient SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSOffsetPointer to a variable that will receive the number of the SLS offset supported by the SLS configuration.
[out]lppSLSOffsetPointer of a pointer to a variable that contains the SLS offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layout:s, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
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 other than CCC are expected to set "ADL_4KWORKAROUND_CANCEL" environment variable before calling this 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.

◆ ADL2_Display_SLSMapConfig_Rearrange()

int ADL2_Display_SLSMapConfig_Rearrange ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumDisplayTarget,
ADLSLSTarget lpSLSTarget,
ADLSLSMap  slsMap,
int  iOption 
)

Function to rearrange display orders in an SLS map.

This function changes the display orders in an SLS map in order to make the image show on the displays correctly.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexSpecifies the adapter to be operated on. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index that will need to do rearrangement
[in]iNumSLSTargetSpecifies the number of displays in the SLS map.
[in]lpSLSTargetArray of displays that are in the SLS map.
[in]slsMapSpecifies the SLS map info. Its type is ADLSLSMap. The only needed data is the map orientation. All others are ignored by the function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
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.

◆ ADL2_Display_SLSMapConfig_SetState()

int ADL2_Display_SLSMapConfig_SetState ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int  iState 
)

Function to enable/disable SLS bind.

This function enables or disables an SLS bind

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be deleted.
[in]iStateSpecifies the action type. To enable SLS map, sets it to ADL_TRUE. Otherwise set it to ADL_FASLE.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
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_Display_SLSMapConfig_Valid()

int ADL2_Display_SLSMapConfig_Valid ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLSLSMap  slsMap,
int  iNumDisplayTarget,
ADLSLSTarget lpSLSTarget,
int *  lpSupportedSLSLayoutImageMode,
int *  lpReasonForNotSupportSLS,
int  iOption 
)
Set SLS configuration for each display index the controller and the adapter is being mapped to

Set SLS configuration for each display index the controller and the adapter is being mapped to

Supported Platforms:
Windows 7; 32bit and 64bit and Above
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndex- Input adapter Index. This function does not support -1 as adapter index.
[in]slsMap- SLS information, refer to ADLSLSMapstruct
[in]iNumDisplayTarget- the input size of SLS Target configurations array
[in]lpSLSTarget- a list of SLS Target in the SLS, refer to ADLSLSTargetstruct
[out]lpSupportedSLSLayoutImageMode- Bit vector.
[out]lpReasonForNotSupportSLS- Bit vector, if the group of the targets does not some or all of SLS layout image mode, the bit vector will give the reason codes
[in]iOption- Bit vector, specifies the layout type of SLS grid data and portrait flag. There are two types of SLS layouts: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE). If the current desktop associated with the input adapter is rotated to 90 or 270 degree, set bit ref \ADL_DISPLAY_SLSGRID_PORTAIT_MODE to 1
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Display_SLSMapConfigX2_Delete()

int ADL2_Display_SLSMapConfigX2_Delete ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumSLSMapIndex,
int *  lpSLSMapIndexes 
)

Function to delete an list of SLS map indexes from the driver database.

This function deletes all SLS maps in a list from the driver database based on the input SLS map index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iNumSLSMapINdexSpecifies number of SLS Map Indexes for input
[in]lpSLSMapIndexes,arrayof SLSMapIndexes to be deleted
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL2_Display_SLSMapConfigX2_Get()

int ADL2_Display_SLSMapConfigX2_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
ADLSLSMap lpSLSMap,
int *  lpNumSLSTarget,
ADLSLSTarget **  lppSLSTarget,
int *  lpNumNativeMode,
ADLSLSMode **  lppNativeMode,
int *  lpNumNativeModeOffsets,
ADLSLSOffset **  lppNativeModeOffsets,
int *  lpNumBezelMode,
ADLBezelTransientMode **  lppBezelMode,
int *  lpNumTransientMode,
ADLBezelTransientMode **  lppTransientMode,
int *  lpNumSLSOffset,
ADLSLSOffset **  lppSLSOffset,
int  iOption 
)

Function to retrieve an SLS configuration.

This function retrieves an SLS configuration, which includes the, SLS map, SLS targets, SLS standard modes, bezel modes or a transient mode, and offsets.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexSpecifies the adapter to be queried. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be queried.
[out]lpSLSMapPointer to a variable that contains the SLS map data. The data type is ADLSLSMap.
[out]lpNumSLSTargetPointer to variable that will receive the number of targets in the SLS map.
[out]lppSLSTargetPointer of a pointer to a variable that conations targets in the SLS map. the data type is ADLDisplayTarget Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSNativeModePointer to a variable that will receive the number of native SLS modes supported by the SLS configuration.
[out]lppSLSNativeModePointer of a pointer to a variable that contains the native SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumNativeModeOffsetsPointer to a variable that will receive the number of native SLS mode offsets supported by the SLS configuration.
[out]lppNativeModeOffsetsPointer of a pointer to a variable that contains the native SLS mode offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSBezelModePointer to a variable that will receive the number of the bezel modes supported by the SLS configuration.
[out]lppSLSbezelModePointer of a pointer to a variable that contains the bezel SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSTransientModePointer to a variable that will receive the number of the transient modes supported by the SLS configuration.
[out]lppTransientModePointer of a pointer to a variable that contains the transient SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSOffsetPointer to a variable that will receive the number of the SLS offset supported by the SLS configuration.
[out]lppSLSOffsetPointer of a pointer to a variable that contains the SLS offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layout:s, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
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.

◆ ADL2_Display_SLSMapIndex_Get()

int ADL2_Display_SLSMapIndex_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iADLNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget,
int *  lpSLSMapIndex 
)

Function to get the SLS map index for a given adapter and a given display device.

This function to get a SLS map index based on a group of displays that are connected in the given adapter. The driver only searches the active SLS grid database.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iADLNumDisplayTargetSpecifies the number of input displays.
[in]lpDisplayTargetArray of displays that are used to do the query. The array type is ADLDisplayTarget.
[out]

◆ ADL2_Display_SLSMapIndexList_Get()

int ADL2_Display_SLSMapIndexList_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumSLSMapIndexList,
int **  lppSLSMapIndexList,
int  iOptions 
)

Function to get the active SLS map index list for a given GPU.

This function retrieves a list of active SLS map indexes for a specified input GPU.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]lpNumSLSMapIndexListPointer to a variable that will receive the number of elements in active SLS maps index list.
[out]lppSLSMapIndexListPointer of a pointer to a variable with type of integer array. The integer array stores all active SLS map indexes. Application does not need to allocate memory, but it should free the memory since the memory is allocated by ADL call back function.
[in]iOptionsBit vector, specifies the type of SLS map. Currently only ADL_DISPLAY_SLSMAPINDEXLIST_OPTION_ACTIVE is supported.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
The driver does not support the return of all SLS grids. It only supports all active SLS grids. Therefore 0x00000001 is the only valid value for iOption.
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.

◆ ADL2_Display_SLSMiddleMode_Get()

int ADL2_Display_SLSMiddleMode_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int *  lpMiddleModeSupported,
int *  lpMaxNumMiddleModeToSet,
int *  lpNumAvailableSLSMiddleMode,
ADLSLSMode **  lppAvailableSLSMiddleMode,
int *  lpNumCurrentSLSMiddleMode,
ADLSLSMode **  lppCurrentSLSMiddleMode,
int *  lpNumDefaultSLSMiddleMode,
ADLSLSMode **  lppDefaultSLSMiddleMode,
int  iOption 
)

Get SLS middle mode for specific adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index of the desired adapter.
[out]lpMiddleModeSupportedIf SLS middle mode is supported or not. 1: supported; otherwise: not supported.
[out]lpMaxNumMiddleModeToSetThe maximum number of SLS middle modes is allowed to be set.
[out]lpNumAvailableSLSMiddlemodePointer to a variable that will receive the number of elements in a Available SLS middle mode list.
[out]lppAvailableSLSMiddlemodePointer of a pointer to a variable that contains the Available SLS middle modes. the data type is ADLSLSMode.
[out]lpNumCurrentSLSMiddleModePointer to a variable that will receive the number of elements in a Current SLS middle mode list.
[out]lppCurrentSLSMiddleModePointer of a pointer to a variable that contains the Current SLS middle modes. the data type is ADLSLSMode.
[out]lpNumDefaultSLSMiddleModePointer to a variable that will receive the number of elements in a Default SLS middle mode list.
[out]lppDefaultSLSMiddleModePointer of a pointer to a variable that contains the Default SLS middle modes. the data type is ADLSLSMode.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
1. Currently only support one current and one default middle mode.
  1. 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.

◆ ADL2_Display_SLSMiddleMode_Set()

int ADL2_Display_SLSMiddleMode_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumCurrentSLSMiddleMode,
ADLSLSMode lpCurrentSLSMiddleMode,
int  iOption 
)

Set SLS middle mode for specific adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index of the desired adapter.
[in]iNumCurrentSLSMiddleModeThe number of elements in a Current SLS middle mode list to be set.
[in]lpCurrentSLSMiddleModePointer of a variable that contains the Current SLS middle modes. the data type is ADLSLSMode.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
1. Currently only support one current/default middle mode.
  1. Driver may returns CWDDE_OK_MODE_SET_NEEDED and CWDDE_ERR_BAD_MIDDLE_MODE.
    • for return code CWDDE_OK_MODE_SET_NEEDED, ADL needs to do Mode Set in order to make newly set middle mode replacing the old one.
    • for return code CWDDE_ERR_BAD_MIDDLE_MODE, ADL returns ADL_FAIL.
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_Display_SLSRecords_Get()

int ADL2_Display_SLSRecords_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLDisplayID  displayID,
int *  lpNumOfRecords,
int **  lppGridIDList 
)

Function to Get an SLS records from the driver database.

This function to Get an SLS records from the driver database.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]displayIDThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpNumOfRecordsgets the number of SLS Grids for the given adapter and display
[out]lppGridIDListgets the SLS Grid IDs for the given adapter and display
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.

◆ ADL2_MGPUSLS_Status_Set()

int ADL2_MGPUSLS_Status_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iStatus 
)
This function communicates KMD that user changed MGPU SLS feature.
Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe index of the desired adapter.
[in]iStatusADL_TRUE ADL_FALSE
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_Display_BezelOffset_Set()

int ADL_Display_BezelOffset_Set ( int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumBezelOffset,
LPADLSLSOffset  lpBezelOffset,
ADLSLSMap  SLSMap,
int  iOption 
)

Set SLS bezel offsets for each display index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index to apply bezel offset.
[in]iNumBezelOffsetinput size of the SLS offset per display per mode array.
[in]lpBezelOffsetList of SLS offset information, refer to ADLBezelOffset struct.
[in]SLSMapThe display SLS map information. Refer to the ADLSLSMap structure for more information.
[in]iOptionOption to set bezel offset. Default: ADL_DISPLAY_BEZELOFFSET_COMMIT
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
Clients other than CCC are expected to set SLSMap->iSLSMapMask to 0.
Clients other than CCC are expected to set SLSMap->iSLSMapValue to ADL_DISPLAY_SLSMAP_SLSLAYOUTMODE_FILL

◆ ADL_Display_BezelOffsetSteppingSize_Get()

int ADL_Display_BezelOffsetSteppingSize_Get ( int  iAdapterIndex,
int *  lpNumBezelOffsetSteppingSize,
ADLBezelOffsetSteppingSize **  lppBezelOffsetSteppingSize 
)

Get bezel offset stepping size for the input adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]iNumBezelOffsetSteppingSizeThe number of Bezel offset stepping size per adapter.
[out]lppBezelOffsetSteppingSizeintBezel offset stepping size information. Refer to ADLBezelOffsetSteppingSize struct.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_BezelSupported_Validate()

int ADL_Display_BezelSupported_Validate ( int  iAdapterIndex,
int  iNumPossibleSLSMap,
LPADLPossibleSLSMap  lpPossibleSLSMaps,
int *  lpNumPossibleSLSMapResult,
LPADLPossibleMapResult lppPossibleMapResult 
)

Validate the list of the SLS display configurations to determine if bezel is supported or not.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iNumPossibleSLSMapInput size of SLS map to be validated.
[in]lpPossibleSLSMapsList of possible SLS maps to be validated.
[out]lpNumPossibleSLSMapResultSize of the valid array.
[out]lppPossibleMapResultvalid result list.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_Overlap_Set()

int ADL_Display_Overlap_Set ( int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumOverlappedModes,
LPADLSLSTargetOverlap  lpOverlappedModes,
int  iNumTargetOffsets,
LPADLSLSOffset  lpTargetOffsets,
ADLSLSMap  SLSMap 
)

Set SLS overlap offsets for each display index.

Supported Platforms:
Windows 7; 32bit and 64bit and above
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index to apply overlap offset.
[in]iNumOverlappedModesthe no. of overlapped modes defined. Each such mode refers to a set of targets in the array of targets
[in]lpOverlappedModesthe list of overlapped modes defined
[in]iNumTargetOffsetsthe no. of targets in the list of targets
[in]lpTargetOffsetsthe list of target offsets for all the overlap modes defined
[in]SLSMapThe display SLS map information. Refer to the ADLSLSMap structure for more information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_PossibleMode_WinXP_Get()

int ADL_Display_PossibleMode_WinXP_Get ( int  iAdapterIndex,
int  iNumDisplayTargets,
ADLDisplayTarget lpDisplayTargets,
int  iLargeDesktopSupportedType,
int  iDevicePanningControl,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the ATI possible modes list for an adapter and preset mapping (Windows XP).

This function retrieves the ATI possible modes list based on a specified input adapter and preset mapping. This function is applicable only on Windows XP platforms.

Supported Platforms:
Windows XP; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iNumDisplayTargetsThe number of display target from the lpDisplayTargets array.
[in]lpDisplayTargetsThe pointer to the retrieved display target configurations. Refer to the ADLDisplayTarget structure for more information. E.g. If a CRT and TV are on as extended mode, lpMapConfigs will contain two ADLDisplayTarget structures: one CRT and one TV, both in extended manner.
[in]iLargeDesktopSupportedTypeThe large desktop type. Refer to the ADLLARGEDESKTOPTYPE enum for more information.
[in]iDevicePanningControlThe device panning control mode. Refer to the ADLPanningMode enum for more information.
[out]lpNumModesThe pointer to the number of modes from the lppModes array.
[out]lppModesThe pointer to the pointer to the possible display modes buffer. Refer to the ADLMode structure for more 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 uses the memory allocation callback function provided by the user.

◆ ADL_Display_SLSGrid_Caps()

int ADL_Display_SLSGrid_Caps ( int  iAdapterIndex,
int *  lpNumSLSGrid,
ADLSLSGrid **  lppSLSGrid,
int  iOption 
)

Function to get the current supported SLS grid patterns (MxN) for a GPU.

This function gets a list of supported SLS grids for a specified input adapter based on display devices currently connected to the GPU.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]lpNumSLSGridPointer to a variable that will receive the number of elements in a supported SLS grid list.
[out]lppSLSGridPointer of a pointer to a variable with type ADLSLSGrid, which contains supported SLS grids the adapter supports. Application does not need to allocate memory but it should free the pointer since the memory is allocated by the ADL call back function.
[in]iOptionBit vector, specifies the layout type of SLS grid data and portrait flag. There are two types of SLS layouts: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE). If the current desktop associated with the input adapter is rotated to 90 or 270 degree, set bit ref \ADL_DISPLAY_SLSGRID_PORTAIT_MODE to 1.
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.

◆ ADL_Display_SLSMapConfig_Create()

int ADL_Display_SLSMapConfig_Create ( int  iAdapterIndex,
ADLSLSMap  SLSMap,
int  iNumTargetTarget,
ADLSLSTarget lpSLSTarget,
int  iBezelModePercent,
int *  lpSLSMapIndex,
int  iOption 
)

Function to create an SLS configuration.

This function creates an SLS configuration with a given grid, targets, and bezel mode percent. It will output an SLS map index if the SLS map is successfully created.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]SLSMapSpecifies the display SLS map data that contains SLS grid and orientation information. Its type is ADLSLSMap
[in]iNumTargetTargetSpecifies the number of displays to be used to create an SLS.
[in]lpSLSTargetArray of displays that are used to create an SLS. The data type is ADLSLSTarget.
[in]iBezelModePercentSpecifies the bezel mode percent. If these displays do not support bezel, set it to 0.
[out]lpSLSMapIndexPointer to a variable that will receive the new created SLS map index. If an SLS grid failed to create, its value is -1, other wise, it is non-negative integer.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts,: relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.
Clients other than CCC are expected to set SLSMap->iSLSMapValue to ADL_DISPLAY_SLSMAP_SLSLAYOUTMODE_FILL

◆ ADL_Display_SLSMapConfig_Delete()

int ADL_Display_SLSMapConfig_Delete ( int  iAdapterIndex,
int  iSLSMapIndex 
)

Function to delete an SLS map from the driver database.

This function deletes an SLS map from the driver database based on the input SLS map index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be deleted.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_SLSMapConfig_Get()

int ADL_Display_SLSMapConfig_Get ( int  iAdapterIndex,
int  iSLSMapIndex,
ADLSLSMap lpSLSMap,
int *  lpNumSLSTarget,
ADLSLSTarget **  lppSLSTarget,
int *  lpNumNativeMode,
ADLSLSMode **  lppNativeMode,
int *  lpNumBezelMode,
ADLBezelTransientMode **  lppBezelMode,
int *  lpNumTransientMode,
ADLBezelTransientMode **  lppTransientMode,
int *  lpNumSLSOffset,
ADLSLSOffset **  lppSLSOffset,
int  iOption 
)

Function to retrieve an SLS configuration.

This function retrieves an SLS configuration, which includes the, SLS map, SLS targets, SLS standard modes, bezel modes or a transient mode, and offsets.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexSpecifies the adapter to be queried. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be queried.
[out]lpSLSMapPointer to a variable that contains the SLS map data. The data type is ADLSLSMap.
[out]lpNumSLSTargetPointer to variable that will receive the number of targets in the SLS map.
[out]lppSLSTargetPointer of a pointer to a variable that conations targets in the SLS map. the data type is ADLDisplayTarget Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSNativeModePointer to a variable that will receive the number of native SLS modes supported by the SLS configuration.
[out]lppSLSNativeModePointer of a pointer to a variable that contains the native SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSBezelModePointer to a variable that will receive the number of the bezel modes supported by the SLS configuration.
[out]lppSLSbezelModePointer of a pointer to a variable that contains the bezel SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSTransientModePointer to a variable that will receive the number of the transient modes supported by the SLS configuration.
[out]lppTransientModePointer of a pointer to a variable that contains the transient SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSOffsetPointer to a variable that will receive the number of the SLS offset supported by the SLS configuration.
[out]lppSLSOffsetPointer of a pointer to a variable that contains the SLS offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layout:s, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
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 other than CCC are expected to set "ADL_4KWORKAROUND_CANCEL" environment variable before calling this function.

◆ ADL_Display_SLSMapConfig_Rearrange()

int ADL_Display_SLSMapConfig_Rearrange ( int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumDisplayTarget,
ADLSLSTarget lpSLSTarget,
ADLSLSMap  slsMap,
int  iOption 
)

Function to rearrange display orders in an SLS map.

This function changes the display orders in an SLS map in order to make the image show on the displays correctly.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexSpecifies the adapter to be operated on. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index that will need to do rearrangement
[in]iNumSLSTargetSpecifies the number of displays in the SLS map.
[in]lpSLSTargetArray of displays that are in the SLS map.
[in]slsMapSpecifies the SLS map info. Its type is ADLSLSMap. The only needed data is the map orientation. All others are ignored by the function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_SLSMapConfig_SetState()

int ADL_Display_SLSMapConfig_SetState ( int  iAdapterIndex,
int  iSLSMapIndex,
int  iState 
)

Function to enable/disable SLS bind.

This function enables or disables an SLS bind

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be deleted.
[in]iStateSpecifies the action type. To enable SLS map, sets it to ADL_TRUE. Otherwise set it to ADL_FASLE.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_SLSMapConfigX2_Get()

int ADL_Display_SLSMapConfigX2_Get ( int  iAdapterIndex,
int  iSLSMapIndex,
ADLSLSMap lpSLSMap,
int *  lpNumSLSTarget,
ADLSLSTarget **  lppSLSTarget,
int *  lpNumNativeMode,
ADLSLSMode **  lppNativeMode,
int *  lpNumNativeModeOffsets,
ADLSLSOffset **  lppNativeModeOffsets,
int *  lpNumBezelMode,
ADLBezelTransientMode **  lppBezelMode,
int *  lpNumTransientMode,
ADLBezelTransientMode **  lppTransientMode,
int *  lpNumSLSOffset,
ADLSLSOffset **  lppSLSOffset,
int  iOption 
)

Function to retrieve an SLS configuration.

This function retrieves an SLS configuration, which includes the, SLS map, SLS targets, SLS standard modes, bezel modes or a transient mode, and offsets.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexSpecifies the adapter to be queried. This function does not support -1.
[in]iSLSMapIndexSpecifies the SLS map index to be queried.
[out]lpSLSMapPointer to a variable that contains the SLS map data. The data type is ADLSLSMap.
[out]lpNumSLSTargetPointer to variable that will receive the number of targets in the SLS map.
[out]lppSLSTargetPointer of a pointer to a variable that conations targets in the SLS map. the data type is ADLDisplayTarget Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSNativeModePointer to a variable that will receive the number of native SLS modes supported by the SLS configuration.
[out]lppSLSNativeModePointer of a pointer to a variable that contains the native SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumNativeModeOffsetsPointer to a variable that will receive the number of native SLS mode offsets supported by the SLS configuration.
[out]lppNativeModeOffsetsPointer of a pointer to a variable that contains the native SLS mode offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSBezelModePointer to a variable that will receive the number of the bezel modes supported by the SLS configuration.
[out]lppSLSbezelModePointer of a pointer to a variable that contains the bezel SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSTransientModePointer to a variable that will receive the number of the transient modes supported by the SLS configuration.
[out]lppTransientModePointer of a pointer to a variable that contains the transient SLS modes. the data type is ADLSLSMode. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[out]lpNumSLSOffsetPointer to a variable that will receive the number of the SLS offset supported by the SLS configuration.
[out]lppSLSOffsetPointer of a pointer to a variable that contains the SLS offsets. the data type is ADLSLSOffset. Application does not need to allocate memory but it should free the pointer since the memory is allocated by ADL call back function.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layout:s, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
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.

◆ ADL_Display_SLSMapIndex_Get()

int ADL_Display_SLSMapIndex_Get ( int  iAdapterIndex,
int  iADLNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget,
int *  lpSLSMapIndex 
)

Function to get the SLS map index for a given adapter and a given display device.

This function to get a SLS map index based on a group of displays that are connected in the given adapter. The driver only searches the active SLS grid database.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iADLNumDisplayTargetSpecifies the number of input displays.
[in]lpDisplayTargetArray of displays that are used to do the query. The array type is ADLDisplayTarget.
[out]

◆ ADL_Display_SLSMapIndexList_Get()

int ADL_Display_SLSMapIndexList_Get ( int  iAdapterIndex,
int *  lpNumSLSMapIndexList,
int **  lppSLSMapIndexList,
int  iOptions 
)

Function to get the active SLS map index list for a given GPU.

This function retrieves a list of active SLS map indexes for a specified input GPU.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[out]lpNumSLSMapIndexListPointer to a variable that will receive the number of elements in active SLS maps index list.
[out]lppSLSMapIndexListPointer of a pointer to a variable with type of integer array. The integer array stores all active SLS map indexes. Application does not need to allocate memory, but it should free the memory since the memory is allocated by ADL call back function.
[in]iOptionsBit vector, specifies the type of SLS map. Currently only ADL_DISPLAY_SLSMAPINDEXLIST_OPTION_ACTIVE is supported.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
The driver does not support the return of all SLS grids. It only supports all active SLS grids. Therefore 0x00000001 is the only valid value for iOption.
This API uses the memory allocation callback function provided by the user.

◆ ADL_Display_SLSMiddleMode_Get()

int ADL_Display_SLSMiddleMode_Get ( int  iAdapterIndex,
int  iSLSMapIndex,
int *  lpMiddleModeSupported,
int *  lpMaxNumMiddleModeToSet,
int *  lpNumAvailableSLSMiddleMode,
ADLSLSMode **  lppAvailableSLSMiddleMode,
int *  lpNumCurrentSLSMiddleMode,
ADLSLSMode **  lppCurrentSLSMiddleMode,
int *  lpNumDefaultSLSMiddleMode,
ADLSLSMode **  lppDefaultSLSMiddleMode,
int  iOption 
)

Get SLS middle mode for specific adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index of the desired adapter.
[out]lpMiddleModeSupportedIf SLS middle mode is supported or not. 1: supported; otherwise: not supported.
[out]lpMaxNumMiddleModeToSetThe maximum number of SLS middle modes is allowed to be set.
[out]lpNumAvailableSLSMiddlemodePointer to a variable that will receive the number of elements in a Available SLS middle mode list.
[out]lppAvailableSLSMiddlemodePointer of a pointer to a variable that contains the Available SLS middle modes. the data type is ADLSLSMode.
[out]lpNumCurrentSLSMiddleModePointer to a variable that will receive the number of elements in a Current SLS middle mode list.
[out]lppCurrentSLSMiddleModePointer of a pointer to a variable that contains the Current SLS middle modes. the data type is ADLSLSMode.
[out]lpNumDefaultSLSMiddleModePointer to a variable that will receive the number of elements in a Default SLS middle mode list.
[out]lppDefaultSLSMiddleModePointer of a pointer to a variable that contains the Default SLS middle modes. the data type is ADLSLSMode.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
1. Currently only support one current and one default middle mode.
  1. This API uses the memory allocation callback function provided by the user.

◆ ADL_Display_SLSMiddleMode_Set()

int ADL_Display_SLSMiddleMode_Set ( int  iAdapterIndex,
int  iSLSMapIndex,
int  iNumCurrentSLSMiddleMode,
ADLSLSMode lpCurrentSLSMiddleMode,
int  iOption 
)

Set SLS middle mode for specific adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]iSLSMapIndexThe SLS map index of the desired adapter.
[in]iNumCurrentSLSMiddleModeThe number of elements in a Current SLS middle mode list to be set.
[in]lpCurrentSLSMiddleModePointer of a variable that contains the Current SLS middle modes. the data type is ADLSLSMode.
[in]iOptionSpecifies the layout type of SLS grid data. It is bit vector. There are two types of SLS layouts, relative to landscape (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_LANDSCAPE) and relative to current angle (ref \ADL_DISPLAY_SLSGRID_CAP_OPTION_RELATIVETO_CURRENTANGLE).
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
1. Currently only support one current/default middle mode.
  1. Driver may returns CWDDE_OK_MODE_SET_NEEDED and CWDDE_ERR_BAD_MIDDLE_MODE.
    • for return code CWDDE_OK_MODE_SET_NEEDED, ADL needs to do Mode Set in order to make newly set middle mode replacing the old one.
    • for return code CWDDE_ERR_BAD_MIDDLE_MODE, ADL returns ADL_FAIL.

◆ ADL_Display_SLSRecords_Get()

int ADL_Display_SLSRecords_Get ( int  iAdapterIndex,
ADLDisplayID  displayID,
int *  lpNumOfRecords,
int **  lppGridIDList 
)

Function to Get an SLS records from the driver database.

This function to Get an SLS records from the driver database.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index of the desired adapter. This function does not support -1.
[in]displayIDThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpNumOfRecordsgets the number of SLS Grids for the given adapter and display
[out]lppGridIDListgets the SLS Grid IDs for the given adapter and display
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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