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

This group describes the Display Manager APIs. More...

Functions

int ADL2_Adapter_AMDAndNonAMDDIsplayClone_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpHasAMDAndNonAMDDIsplays)
 ADL local interface. Retrieves GPU information of any AMD and non-AMD displays cloned for given GPU or all OS-known GPUs. More...
 
int ADL2_Adapter_CloneTypes_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCloneTypes)
 ADL local interface. Retrieves GPU information of special clone types for given GPU or all OS-known GPUs. More...
 
int ADL2_Adapter_CrossGPUClone_Disable (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iOptions)
 ADL local interface. Disable all cross-GPU clone for given GPU or all OS-known GPUs. More...
 
int ADL2_Adapter_Display_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumDisplayCaps, ADLAdapterDisplayCap **lppAdapterDisplayCaps)
 Function to retrieve the adapter display manner capabilities based on ADL index. More...
 
int ADL2_Adapter_NumberOfActivatableSources_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumSources, ADLActivatableSource **lppSources)
 Function to retrieve the number of Activatable sources based on ADL Index. More...
 
int ADL2_Display_DisplayMapConfig_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumDisplayMap, ADLDisplayMap **lppDisplayMap, int *lpNumDisplayTarget, ADLDisplayTarget **lppDisplayTarget, int iOptions)
 Function to retrieve current display map configurations. More...
 
int ADL2_Display_DisplayMapConfig_PossibleAddAndRemove (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumDisplayMap, ADLDisplayMap *lpDisplayMap, int iNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget, int *lpNumPossibleAddTarget, ADLDisplayTarget **lppPossibleAddTarget, int *lpNumPossibleRemoveTarget, ADLDisplayTarget **lppPossibleRemoveTarget)
 Function to validate a list of display configurations. More...
 
int ADL2_Display_DisplayMapConfig_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumDisplayMap, ADLDisplayMap *lpDisplayMap, int iNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget)
 Function to set the current display configuration. More...
 
int ADL2_Display_DisplayMapConfig_Validate (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumPossibleMap, ADLPossibleMap *lpPossibleMaps, int *lpNumPossibleMapResult, ADLPossibleMapResult **lppPossibleMapResult)
 Function to validate the list of the display configurations based on ADL Index. More...
 
int ADL2_Display_ForcibleDisplay_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpStatus)
 Function to retrieve the forcible connected status of a display. More...
 
int ADL2_Display_ForcibleDisplay_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iStatus)
 Function to set the forcible connected status of a display. More...
 
int ADL2_Display_Modes_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the display mode information. More...
 
int ADL2_Display_Modes_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iNumModes, ADLMode *lpModes)
 Function to set display mode information. More...
 
int ADL2_Display_PossibleMapping_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumberOfPresetMapping, ADLPossibleMapping *lpPresetMappings, int iEnquiryControllerIndex, int *lpNumberOfEnquiryPossibleMappings, ADLPossibleMapping **lppEnquiryPossibleMappings)
 Function to retrieve the possible display mappings. More...
 
int ADL2_Display_PossibleMode_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the OS possible modes list for an adapter (all OS platforms). More...
 
int ADL2_Workstation_EnableUnsupportedDisplayModes (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to set the Registry key "UnsupportedMonitorModesAllowed" when 10bit Pixel format is enabled from workstation aspect. More...
 
int ADL_Adapter_Display_Caps (int iAdapterIndex, int *lpNumDisplayCaps, ADLAdapterDisplayCap **lppAdapterDisplayCaps)
 Function to retrieve the adapter display manner capabilities based on ADL index. More...
 
int ADL_Adapter_NumberOfActivatableSources_Get (int iAdapterIndex, int *lpNumSources, ADLActivatableSource **lppSources)
 Function to retrieve the number of Activatable sources based on ADL Index. More...
 
int ADL_Display_DisplayMapConfig_Get (int iAdapterIndex, int *lpNumDisplayMap, ADLDisplayMap **lppDisplayMap, int *lpNumDisplayTarget, ADLDisplayTarget **lppDisplayTarget, int iOptions)
 Function to retrieve current display map configurations. More...
 
int ADL_Display_DisplayMapConfig_PossibleAddAndRemove (int iAdapterIndex, int iNumDisplayMap, ADLDisplayMap *lpDisplayMap, int iNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget, int *lpNumPossibleAddTarget, ADLDisplayTarget **lppPossibleAddTarget, int *lpNumPossibleRemoveTarget, ADLDisplayTarget **lppPossibleRemoveTarget)
 Function to validate a list of display configurations. More...
 
int ADL_Display_DisplayMapConfig_Set (int iAdapterIndex, int iNumDisplayMap, ADLDisplayMap *lpDisplayMap, int iNumDisplayTarget, ADLDisplayTarget *lpDisplayTarget)
 Function to set the current display configuration. More...
 
int ADL_Display_DisplayMapConfig_Validate (int iAdapterIndex, int iNumPossibleMap, ADLPossibleMap *lpPossibleMaps, int *lpNumPossibleMapResult, ADLPossibleMapResult **lppPossibleMapResult)
 Function to validate the list of the display configurations based on ADL Index. More...
 
int ADL_Display_ForcibleDisplay_Get (int iAdapterIndex, int iDisplayIndex, int *lpStatus)
 Function to retrieve the forcible connected status of a display. More...
 
int ADL_Display_ForcibleDisplay_Set (int iAdapterIndex, int iDisplayIndex, int iStatus)
 Function to set the forcible connected status of a display. More...
 
int ADL_Display_Modes_Get (int iAdapterIndex, int iDisplayIndex, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the display mode information. More...
 
int ADL_Display_Modes_Set (int iAdapterIndex, int iDisplayIndex, int iNumModes, ADLMode *lpModes)
 Function to set display mode information. More...
 
int ADL_Display_PossibleMapping_Get (int iAdapterIndex, int iNumberOfPresetMapping, ADLPossibleMapping *lpPresetMappings, int iEnquiryControllerIndex, int *lpNumberOfEnquiryPossibleMappings, ADLPossibleMapping **lppEnquiryPossibleMappings)
 Function to retrieve the possible display mappings. More...
 
int ADL_Display_PossibleMode_Get (int iAdapterIndex, int *lpNumModes, ADLMode **lppModes)
 Function to retrieve the OS possible modes list for an adapter (all OS platforms). More...
 
int ADL_Workstation_EnableUnsupportedDisplayModes (int iAdapterIndex)
 Function to set the Registry key "UnsupportedMonitorModesAllowed" when 10bit Pixel format is enabled from workstation aspect. More...
 

Detailed Description

This group describes the Display Manager APIs.

Function Documentation

◆ ADL2_Adapter_AMDAndNonAMDDIsplayClone_Get()

int ADL2_Adapter_AMDAndNonAMDDIsplayClone_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpHasAMDAndNonAMDDIsplays 
)

ADL local interface. Retrieves GPU information of any AMD and non-AMD displays cloned for given GPU or all OS-known GPUs.

This function retrieves information for passed adapter or -1 for all GPUs.

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(one of GPU adapter index) or -1 if all GPUs are desired. For A+I system, please pass -1 only.
[out]lpHasAMDAndNonAMDDIsplayspointer to an integer. It is 1 if there is any AMd and non-AMD displays cloned in the GPU or the system
Supported Platforms:
\WIn7 or above
Returns
If the function valid, the return value is 1. Otherwise it is 0.
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_Adapter_CloneTypes_Get()

int ADL2_Adapter_CloneTypes_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpCloneTypes 
)

ADL local interface. Retrieves GPU information of special clone types for given GPU or all OS-known GPUs.

This function retrieves special clone types information for passed adapter or -1 for all GPUs. Currently, cross-GPU-clone and corss-GPU-clone-AMDWithNonAMD

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(one of GPU adapter index) or -1 if all GPUs are desired. For A+I system, please pass -1 only.
[out]lpCloneTypespointer to an integer. It is bit vector. If the first bit is 1, the clone is cross-GPU-clone. It is may AMD with AMD or AMD with non-AMD. If The second bit is 1, the clone is cross-GPU-clone, but with non-AMD displays. It is available in WIN10 and WIN 8.1 PX A+I system
Supported Platforms:
\WIn7 or above
Returns
If the function valid, the return value is 1. Otherwise it is 0.
Remarks
if iAdapterIndex is not -1 and if there is one of cross-GPU clones found in the GPU, then cross-GPU clone is true
if the iAdapertIndex is -1 and if there is one of cross-GPU clones found in the system, then cross-GPU clone is true

◆ ADL2_Adapter_CrossGPUClone_Disable()

int ADL2_Adapter_CrossGPUClone_Disable ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iOptions 
)

ADL local interface. Disable all cross-GPU clone for given GPU or all OS-known GPUs.

This function disables the cross-GPU clone for passed adapter(GPU) or -1 for all GPUs.

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(one of GPU adapter index) or -1 if all GPUs are desired. For A+I system, please pass -1 only.
[in]iOptionsis an integer, which decides the displays from other GPUs will be disabled or changed to extended mode. Currently, the API only supports the "disabled". This filed is just for extension for future useage.
Supported Platforms:
\WIn7 or above
Returns
If the function valid, the return value is 1. Otherwise it is 0.
Remarks
iOption support only 0 currently.

◆ ADL2_Adapter_Display_Caps()

int ADL2_Adapter_Display_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumDisplayCaps,
ADLAdapterDisplayCap **  lppAdapterDisplayCaps 
)

Function to retrieve the adapter display manner capabilities based on ADL index.

This function retrieves the adapter display manner capabilities (e.g., single, clone, extended desktop, and stretch mode).

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 handle of the desired adapter. A value of -1 returns all adapter manner information for the system across all GPUs.
[out]lpNumDisplayCapsThe Number of display manner capabilities.
[out]lppAdapterDisplayCapsThe lists of display manner capabilities across all GPUs. Refer to the ADLAdapterDisplayCap 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_Adapter_NumberOfActivatableSources_Get()

int ADL2_Adapter_NumberOfActivatableSources_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumSources,
ADLActivatableSource **  lppSources 
)

Function to retrieve the number of Activatable sources based on ADL Index.

This function retrieves the activatable sources list for a specified input adapter. ActivatableSources is the number of displays that can be turned on simultaneously for the same GPU. For example, for AMD Radeon HD 4xxx Series and earlier this number is 2 while for ATI Radeon HD 5xxx Series the number could be 6 or 4.

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]lpNumSourcesThe pointer to the number of sources that can be activated.
[out]lppSourcesThe pointer to the pointer to the retrieved activatable sources buffer. Refer to the ADLActivatableSource 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_DisplayMapConfig_Get()

int ADL2_Display_DisplayMapConfig_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumDisplayMap,
ADLDisplayMap **  lppDisplayMap,
int *  lpNumDisplayTarget,
ADLDisplayTarget **  lppDisplayTarget,
int  iOptions 
)

Function to retrieve current display map configurations.

This function retrieves the current display map configurations, including the controllers and adapters mapped to each display.

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 handle of the desired adapter. A value of -1 returns all display configurations for the system across multiple GPUs.
[out]lpNumDisplayMapThe pointer to the number of retrieved display maps.
[out]lppDisplayMapThe pointer to the pointer to the display manner information. Refer to the ADLDisplayMap structure for more information.
[out]lpNumDisplayTargetThe pointer to the display target sets retrieved.
[out]lppDisplayTargetThe pointer to the pointer to the display target buffer. Refer to the ADLDisplayTarget structure for more information.
[in]iOptionsThe function option. ADL_DISPLAY_DISPLAYMAP_OPTION_GPUINFO.
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_DisplayMapConfig_PossibleAddAndRemove()

int ADL2_Display_DisplayMapConfig_PossibleAddAndRemove ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumDisplayMap,
ADLDisplayMap lpDisplayMap,
int  iNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget,
int *  lpNumPossibleAddTarget,
ADLDisplayTarget **  lppPossibleAddTarget,
int *  lpNumPossibleRemoveTarget,
ADLDisplayTarget **  lppPossibleRemoveTarget 
)

Function to validate a list of display configurations.

This function allows the user to input a potential displays map and its targets. The function can also be used to obtain a list of display targets that can be added to this given topology and a list of display targets that can be removed from this given topology.

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 handle of the desired adapter. This function does not support the -1 value to test topologies across multiple GPUs.
[in]iNumDisplayMapThe number of display maps in this configuration.
[in]lpDisplayMapThe pointer to the display map information. Refer to the ADLDisplayMap structure for more information.
[in]iNumDisplayTargetThe number of display target sets in this configuration.
[in]lpDisplayTargetThe pointer to the display target information. Refer to the ADLDisplayTarget structure for more information.
[out]lpNumPossibleAddTargetThe pointer to the number of items in the array of lppPossibleAddTarget.
[out]lppPossibleAddTargetThe pointer to the array of the display targets that can be added in the given topology. Refer to the ADLDisplayTarget structure for more information. The user is responsible for freeing the memory for this array when it is no longer needed.
[out]lpNumPossibleRemoveTargetThe pointer to the number of items in the array of lppPossibleRemoveTarget.
[out]lppPossibleRemoveTargetThe pointer to the array of the display targets that can be removed from the given topology. Refer to the ADLDisplayTarget structure for more information. The user is responsible for freeing the memory for this array when it is no longer needed.
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_DisplayMapConfig_Set()

int ADL2_Display_DisplayMapConfig_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumDisplayMap,
ADLDisplayMap lpDisplayMap,
int  iNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget 
)

Function to set the current display configuration.

This function sets the current display configurations for each display, including the controller and adapter mapped to each display. Possible display configurations are single, clone, extended desktop, and stretch mode. If clone mode is desired and the current display configuration is extended desktop mode, the function disables extended desktop mode in order to enable clone mode. If extended display mode is desired and the current display configuration is single mode, this function enables extended desktop.

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 handle of the desired adapter. A value of -1 sets the displays in the system across multiple GPUs.
[in]iNumDisplayMapThe number of display maps to be set.
[in]lpDisplayMapThe pointer to the retrieved display map information. Refer to the ADLDisplayMap structure for more information.
[in]iNumDisplayTargetThe number of display target sets to be set.
[in]lpDisplayTargetThe pointer to the display target information. Refer to the ADLDisplayTarget 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.
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_DisplayMapConfig_Validate()

int ADL2_Display_DisplayMapConfig_Validate ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumPossibleMap,
ADLPossibleMap lpPossibleMaps,
int *  lpNumPossibleMapResult,
ADLPossibleMapResult **  lppPossibleMapResult 
)

Function to validate the list of the display configurations based on ADL Index.

This function validate the list of the display configurations for a specified input adapter. This function is applicable to all OS platforms.

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 handle of the desired adapter.
[in]iNumPossibleMapThe number of possible maps to be validated.
[in]lpPossibleMapsThe list of possible maps to be validated. Refer to the ADLPossibleMap structure for more information.
[out]lpNumPossibleMapResultThe pointer to the number of validate result list.
[out]lppPossibleMapResultThe pointer to the pointer to validation result list. Refer to the ADLPossibleMapResult 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_ForcibleDisplay_Get()

int ADL2_Display_ForcibleDisplay_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpStatus 
)

Function to retrieve the forcible connected status of a display.

This function determines whether or not a display (i.e. CV) is set to be forcibly connected.

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.
[in]iDisplayIndexThe desired display index.
[out]lpStatusThe forcible connected status of the display. ADL_TRUE : forced connected; ADL_FALSE : otherwise.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
A display can be forcibly connected without being actually connected or not recognized as connected. For example, some old 50 ohm TVs are not detected properly and need to be forcibly connected in order to be turned on.
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_ForcibleDisplay_Set()

int ADL2_Display_ForcibleDisplay_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iStatus 
)

Function to set the forcible connected status of a display.

This function sets a display (i.e. TV) to be either forcibly connected or not forcibly connected.

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.
[in]iDisplayIndexThe desired display index.
[in]iStatusThe desired connection status. ADL_TRUE : forced connected; ADL_FALSE : otherwise.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
A display can be forcibly connected without being actually connected or not recognized as connected. For example, some old 50 ohm TVs are not detected properly and need to be forcibly connected in order to be turned on.
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_Modes_Get()

int ADL2_Display_Modes_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the display mode information.

This function retrieves the current display mode 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. A value of -1 retrieves all modes for the system across multiple GPUs.
[in]iDisplayIndexThe desired display index. If the index is -1, this field is ignored.
[out]lpNumModesThe pointer to the number of modes retrieved.
[out]lppModesThe pointer to the pointer to the retrieved display modes. Refer to the Display 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.
On Linux platform iXPos,iYPos,iColourDepth,iOrientation & iModeFlag are not supported. iXPos and iYPos can be retrieved from xrandr.
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_Modes_Set()

int ADL2_Display_Modes_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iNumModes,
ADLMode lpModes 
)

Function to set display mode information.

This function sets the current display mode information.

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 handle of the desired adapter. A value of -1 sets the modes across multiple GPUs.
[in]iDisplayIndexThe desired display index. If the index is -1, this field is ignored.
[in]iNumModesThe number of modes to be set.
[in]lpModesThe pointer to the display mode information to be set. 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
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_PossibleMapping_Get()

int ADL2_Display_PossibleMapping_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iNumberOfPresetMapping,
ADLPossibleMapping lpPresetMappings,
int  iEnquiryControllerIndex,
int *  lpNumberOfEnquiryPossibleMappings,
ADLPossibleMapping **  lppEnquiryPossibleMappings 
)

Function to retrieve the possible display mappings.

This function retrieves possible display mappings for an 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 handle of the desired adapter.
[in]iNumberOfPresetMappingThe current number of preset mappings from the lpPresetMappings array.
[in]lpPresetMappingsThe pointer to the buffer storing the current preset mappings. Refer to the ADLPossibleMapping structure for more information.
[in]iEnquiryControllerIndexThe desired controller index for mapping.
[out]lpNumberOfEnquiryPossibleMappingsThe pointer to the number of possible mappings from the lppEnquiryPossibleMappings array.
[out]lppEnquiryPossibleMappingsThe pointer to the pointer to the retrieved possible mapping buffer. Refer to the ADLPossibleMapping 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_PossibleMode_Get()

int ADL2_Display_PossibleMode_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the OS possible modes list for an adapter (all OS platforms).

This function retrieves the OS possible modes list for a specified 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 handle of the desired adapter.
[out]lpNumModesThe pointer to the number of display modes from the lppModes array.
[out]lppModesThe pointer to the pointer to the retrieved 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_Workstation_EnableUnsupportedDisplayModes()

int ADL2_Workstation_EnableUnsupportedDisplayModes ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex 
)

Function to set the Registry key "UnsupportedMonitorModesAllowed" when 10bit Pixel format is enabled from workstation aspect.

This function sets the above registry key to 1.

Supported Platforms:
\Win7
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.
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.
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_Display_Caps()

int ADL_Adapter_Display_Caps ( int  iAdapterIndex,
int *  lpNumDisplayCaps,
ADLAdapterDisplayCap **  lppAdapterDisplayCaps 
)

Function to retrieve the adapter display manner capabilities based on ADL index.

This function retrieves the adapter display manner capabilities (e.g., single, clone, extended desktop, and stretch mode).

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. A value of -1 returns all adapter manner information for the system across all GPUs.
[out]lpNumDisplayCapsThe Number of display manner capabilities.
[out]lppAdapterDisplayCapsThe lists of display manner capabilities across all GPUs. Refer to the ADLAdapterDisplayCap 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_Adapter_NumberOfActivatableSources_Get()

int ADL_Adapter_NumberOfActivatableSources_Get ( int  iAdapterIndex,
int *  lpNumSources,
ADLActivatableSource **  lppSources 
)

Function to retrieve the number of Activatable sources based on ADL Index.

This function retrieves the activatable sources list for a specified input adapter. ActivatableSources is the number of displays that can be turned on simultaneously for the same GPU. For example, for AMD Radeon HD 4xxx Series and earlier this number is 2 while for ATI Radeon HD 5xxx Series the number could be 6 or 4.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpNumSourcesThe pointer to the number of sources that can be activated.
[out]lppSourcesThe pointer to the pointer to the retrieved activatable sources buffer. Refer to the ADLActivatableSource 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_DisplayMapConfig_Get()

int ADL_Display_DisplayMapConfig_Get ( int  iAdapterIndex,
int *  lpNumDisplayMap,
ADLDisplayMap **  lppDisplayMap,
int *  lpNumDisplayTarget,
ADLDisplayTarget **  lppDisplayTarget,
int  iOptions 
)

Function to retrieve current display map configurations.

This function retrieves the current display map configurations, including the controllers and adapters mapped to each display.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. A value of -1 returns all display configurations for the system across multiple GPUs.
[out]lpNumDisplayMapThe pointer to the number of retrieved display maps.
[out]lppDisplayMapThe pointer to the pointer to the display manner information. Refer to the ADLDisplayMap structure for more information.
[out]lpNumDisplayTargetThe pointer to the display target sets retrieved.
[out]lppDisplayTargetThe pointer to the pointer to the display target buffer. Refer to the ADLDisplayTarget structure for more information.
[in]iOptionsThe function option. ADL_DISPLAY_DISPLAYMAP_OPTION_GPUINFO.
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_DisplayMapConfig_PossibleAddAndRemove()

int ADL_Display_DisplayMapConfig_PossibleAddAndRemove ( int  iAdapterIndex,
int  iNumDisplayMap,
ADLDisplayMap lpDisplayMap,
int  iNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget,
int *  lpNumPossibleAddTarget,
ADLDisplayTarget **  lppPossibleAddTarget,
int *  lpNumPossibleRemoveTarget,
ADLDisplayTarget **  lppPossibleRemoveTarget 
)

Function to validate a list of display configurations.

This function allows the user to input a potential displays map and its targets. The function can also be used to obtain a list of display targets that can be added to this given topology and a list of display targets that can be removed from this given topology.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. This function does not support the -1 value to test topologies across multiple GPUs.
[in]iNumDisplayMapThe number of display maps in this configuration.
[in]lpDisplayMapThe pointer to the display map information. Refer to the ADLDisplayMap structure for more information.
[in]iNumDisplayTargetThe number of display target sets in this configuration.
[in]lpDisplayTargetThe pointer to the display target information. Refer to the ADLDisplayTarget structure for more information.
[out]lpNumPossibleAddTargetThe pointer to the number of items in the array of lppPossibleAddTarget.
[out]lppPossibleAddTargetThe pointer to the array of the display targets that can be added in the given topology. Refer to the ADLDisplayTarget structure for more information. The user is responsible for freeing the memory for this array when it is no longer needed.
[out]lpNumPossibleRemoveTargetThe pointer to the number of items in the array of lppPossibleRemoveTarget.
[out]lppPossibleRemoveTargetThe pointer to the array of the display targets that can be removed from the given topology. Refer to the ADLDisplayTarget structure for more information. The user is responsible for freeing the memory for this array when it is no longer needed.
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_DisplayMapConfig_Set()

int ADL_Display_DisplayMapConfig_Set ( int  iAdapterIndex,
int  iNumDisplayMap,
ADLDisplayMap lpDisplayMap,
int  iNumDisplayTarget,
ADLDisplayTarget lpDisplayTarget 
)

Function to set the current display configuration.

This function sets the current display configurations for each display, including the controller and adapter mapped to each display. Possible display configurations are single, clone, extended desktop, and stretch mode. If clone mode is desired and the current display configuration is extended desktop mode, the function disables extended desktop mode in order to enable clone mode. If extended display mode is desired and the current display configuration is single mode, this function enables extended desktop.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. A value of -1 sets the displays in the system across multiple GPUs.
[in]iNumDisplayMapThe number of display maps to be set.
[in]lpDisplayMapThe pointer to the retrieved display map information. Refer to the ADLDisplayMap structure for more information.
[in]iNumDisplayTargetThe number of display target sets to be set.
[in]lpDisplayTargetThe pointer to the display target information. Refer to the ADLDisplayTarget 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.
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_DisplayMapConfig_Validate()

int ADL_Display_DisplayMapConfig_Validate ( int  iAdapterIndex,
int  iNumPossibleMap,
ADLPossibleMap lpPossibleMaps,
int *  lpNumPossibleMapResult,
ADLPossibleMapResult **  lppPossibleMapResult 
)

Function to validate the list of the display configurations based on ADL Index.

This function validate the list of the display configurations for a specified input adapter. This function is applicable to all OS platforms.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iNumPossibleMapThe number of possible maps to be validated.
[in]lpPossibleMapsThe list of possible maps to be validated. Refer to the ADLPossibleMap structure for more information.
[out]lpNumPossibleMapResultThe pointer to the number of validate result list.
[out]lppPossibleMapResultThe pointer to the pointer to validation result list. Refer to the ADLPossibleMapResult 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_ForcibleDisplay_Get()

int ADL_Display_ForcibleDisplay_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpStatus 
)

Function to retrieve the forcible connected status of a display.

This function determines whether or not a display (i.e. CV) is set to be forcibly connected.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index.
[out]lpStatusThe forcible connected status of the display. ADL_TRUE : forced connected; ADL_FALSE : otherwise.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
A display can be forcibly connected without being actually connected or not recognized as connected. For example, some old 50 ohm TVs are not detected properly and need to be forcibly connected in order to be turned on.

◆ ADL_Display_ForcibleDisplay_Set()

int ADL_Display_ForcibleDisplay_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iStatus 
)

Function to set the forcible connected status of a display.

This function sets a display (i.e. TV) to be either forcibly connected or not forcibly connected.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index.
[in]iStatusThe desired connection status. ADL_TRUE : forced connected; ADL_FALSE : otherwise.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
A display can be forcibly connected without being actually connected or not recognized as connected. For example, some old 50 ohm TVs are not detected properly and need to be forcibly connected in order to be turned on.
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_Modes_Get()

int ADL_Display_Modes_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the display mode information.

This function retrieves the current display mode information.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. A value of -1 retrieves all modes for the system across multiple GPUs.
[in]iDisplayIndexThe desired display index. If the index is -1, this field is ignored.
[out]lpNumModesThe pointer to the number of modes retrieved.
[out]lppModesThe pointer to the pointer to the retrieved display modes. Refer to the Display 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.
On Linux platform iXPos,iYPos,iColourDepth,iOrientation & iModeFlag are not supported. iXPos and iYPos can be retrieved from xrandr.

◆ ADL_Display_Modes_Set()

int ADL_Display_Modes_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iNumModes,
ADLMode lpModes 
)

Function to set display mode information.

This function sets the current display mode information.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter. A value of -1 sets the modes across multiple GPUs.
[in]iDisplayIndexThe desired display index. If the index is -1, this field is ignored.
[in]iNumModesThe number of modes to be set.
[in]lpModesThe pointer to the display mode information to be set. 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
Call ADL_Flush_Driver_Data() after to persist settings on reboot.

◆ ADL_Display_PossibleMapping_Get()

int ADL_Display_PossibleMapping_Get ( int  iAdapterIndex,
int  iNumberOfPresetMapping,
ADLPossibleMapping lpPresetMappings,
int  iEnquiryControllerIndex,
int *  lpNumberOfEnquiryPossibleMappings,
ADLPossibleMapping **  lppEnquiryPossibleMappings 
)

Function to retrieve the possible display mappings.

This function retrieves possible display mappings for an adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iNumberOfPresetMappingThe current number of preset mappings from the lpPresetMappings array.
[in]lpPresetMappingsThe pointer to the buffer storing the current preset mappings. Refer to the ADLPossibleMapping structure for more information.
[in]iEnquiryControllerIndexThe desired controller index for mapping.
[out]lpNumberOfEnquiryPossibleMappingsThe pointer to the number of possible mappings from the lppEnquiryPossibleMappings array.
[out]lppEnquiryPossibleMappingsThe pointer to the pointer to the retrieved possible mapping buffer. Refer to the ADLPossibleMapping 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_PossibleMode_Get()

int ADL_Display_PossibleMode_Get ( int  iAdapterIndex,
int *  lpNumModes,
ADLMode **  lppModes 
)

Function to retrieve the OS possible modes list for an adapter (all OS platforms).

This function retrieves the OS possible modes list for a specified input adapter.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpNumModesThe pointer to the number of display modes from the lppModes array.
[out]lppModesThe pointer to the pointer to the retrieved 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_Workstation_EnableUnsupportedDisplayModes()

int ADL_Workstation_EnableUnsupportedDisplayModes ( int  iAdapterIndex)

Function to set the Registry key "UnsupportedMonitorModesAllowed" when 10bit Pixel format is enabled from workstation aspect.

This function sets the above registry key to 1.

Supported Platforms:
\Win7
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

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