ADL (AMD Display Library) Public APIs  Version 17.0
Functions
Graphics Related APIs

This group outlines Graphics version and architechture specific APIs. More...

Functions

int ADL2_Adapter_Graphic_Core_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLGraphicCoreInfo *pGraphicCoreInfo)
 Function to retrieve Graphic Core Info. More...
 
int ADL2_Driver_Path_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSize, char *lpDriverPath)
 
int ADL2_Graphics_IsDetachableGraphicsPlatform_Get (ADL_CONTEXT_HANDLE context, int *lpStatus)
 
int ADL2_Graphics_IsGfx9AndAbove (ADL_CONTEXT_HANDLE context)
 
int ADL2_Graphics_MantleVersion_Get (ADL_CONTEXT_HANDLE context, ADLMantleAppInfo *mantleAppInfo)
 
int ADL2_Graphics_Platform_Get (ADL_CONTEXT_HANDLE context, int *lpPlatForm)
 Function to retrieve the type of graphics platform the system is currently running. More...
 
int ADL2_Graphics_Versions_Get (ADL_CONTEXT_HANDLE context, ADLVersionsInfo *lpVersionsInfo)
 
int ADL2_Graphics_VersionsX2_Get (ADL_CONTEXT_HANDLE context, ADLVersionsInfoX2 *lpVersionsInfo)
 Function to retrieve s version information. More...
 
int ADL2_Graphics_VersionsX3_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLVersionsInfoX2 *lpVersionsInfo)
 
int ADL2_Graphics_VulkanVersion_Get (ADL_CONTEXT_HANDLE context, ADLVulkanAppInfo *vulkanAppInfo)
 Function to get Vulkan versions. More...
 
int ADL2_Graphics_VulkanVersionX2_Get (ADL_CONTEXT_HANDLE context, ADLVulkanAppInfo *vulkanAppInfo)
 Function to get Vulkan versions. More...
 
int ADL2_Graphics_VulkanVersionX3_Get (ADL_CONTEXT_HANDLE context, ADLVulkanAppInfo *vulkanAppInfo, int iAdapterIndex)
 Function to get Vulkan versions of different GPUs. More...
 
int ADL2_SmartDC_Active_State_Get (ADL_CONTEXT_HANDLE context, int *lpSmartDCActiveState)
 
int ADL2_SmartDC_Caps (ADL_CONTEXT_HANDLE context, int *lpSupported, int *lpDefault)
 
int ADL2_SmartDC_Status_Get (ADL_CONTEXT_HANDLE context, int *lpSmartDCState)
 
int ADL2_SmartDC_Status_Set (ADL_CONTEXT_HANDLE context, int enable, int *lpSmartDCState)
 
int ADL_Graphics_Platform_Get (int *lpPlatForm)
 Function to retrieve the type of graphics platform the system is currently running. More...
 
int ADL_Graphics_Versions_Get (ADLVersionsInfo *lpVersionsInfo)
 Function to retrieve version information. More...
 

Detailed Description

This group outlines Graphics version and architechture specific APIs.

Function to retrieve version information.

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

Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpVersionsInfoThe pointer to ADLVersionsInfo structure with the retrieved version information.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

Function Documentation

◆ ADL2_Adapter_Graphic_Core_Info_Get()

int ADL2_Adapter_Graphic_Core_Info_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLGraphicCoreInfo pGraphicCoreInfo 
)

Function to retrieve Graphic Core Info.

This function implements a call to retrieve Graphic Core Info.

Supported Platforms:
Windows Vista and Windows 7; 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]pGraphicCoreInfoThe pointer to Graphic Core Info
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Driver_Path_Get()

int ADL2_Driver_Path_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSize,
char *  lpDriverPath 
)
return disk location of graphics driver that corresponds to given adapter index.

On the Windows 10 system with multiple GPUs it is possible to have different driver versions installed on for each GPU. Each GPUís driver binaries will be located in dedicated disk location inside systemís driver store. This function can be used to find location of the driver for given GPU designated by its adapter index.

Supported Platforms:
Windows 10; 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]iSizesize of lpDriverPath output buffer in the single byte characters.
[out]iSizesize of lpDriverPath output buffer in the single byte characters.
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Graphics_IsDetachableGraphicsPlatform_Get()

int ADL2_Graphics_IsDetachableGraphicsPlatform_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpStatus 
)
Function to discover if the current platform is a detachable graphics one or not.

This function determines whether the current graphics platform is detachable graphics one 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.
[out]lpStatusThe pointer to the retrieved graphics platform for the system.
lpStatus will be either 1 (for detachable graphics platforms) or 0 (for non-detachable graphics platforms)
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_Graphics_IsGfx9AndAbove()

int ADL2_Graphics_IsGfx9AndAbove ( ADL_CONTEXT_HANDLE  context)
Function to retrieve the Family ID of a GPU.

This function determines what is the Family ID of a GPU and based on that, find if it is Gfx9 and above GPU 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.
Returns
TRUE: if Family ID is Gfx9 or above; FALSE: otherwise.

◆ ADL2_Graphics_MantleVersion_Get()

int ADL2_Graphics_MantleVersion_Get ( ADL_CONTEXT_HANDLE  context,
ADLMantleAppInfo mantleAppInfo 
)
Function to get mantle versions.

This function gets mantle versions.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]context: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]mantleAppInfo: The ADLMantleAppInfo structure.

◆ ADL2_Graphics_Platform_Get()

int ADL2_Graphics_Platform_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpPlatForm 
)

Function to retrieve the type of graphics platform the system is currently running.

This function determines whether the current graphics platform is a mobile, 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.
[out]lpPlatFormThe pointer to the retrieved graphics platform for the system.
lpPlatForm will be either GRAPHICS_PLATFORM_DESKTOP (for desktop platforms) or GRAPHICS_PLATFORM_MOBILE (for mobile platforms)
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_Graphics_Versions_Get()

int ADL2_Graphics_Versions_Get ( ADL_CONTEXT_HANDLE  context,
ADLVersionsInfo lpVersionsInfo 
)

◆ ADL2_Graphics_VersionsX2_Get()

int ADL2_Graphics_VersionsX2_Get ( ADL_CONTEXT_HANDLE  context,
ADLVersionsInfoX2 lpVersionsInfo 
)

Function to retrieve s version information.

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

Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpVersionsInfoThe pointer to ADLVersionsInfoX2 structure with the retrieved version information.
Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Returns
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Graphics_VersionsX3_Get()

int ADL2_Graphics_VersionsX3_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLVersionsInfoX2 lpVersionsInfo 
)
Function to retrieve version information for graphics driver installed on specific GPU.

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

Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexAdapter index that belongs to the GPU.
[out]lpVersionsInfoThe pointer to ADLVersionsInfo2 structure with the retrieved version information.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Returns
The function returns ADL_OK or ADL_OK_WARNING (if any of the version strings could not be retrieved from the system, for example "Catalyst Version"). If ADL is not initialized properly the function will return ADL_ERR_DISABLED_ADAPTER
Remarks
On hybrid system with multiple GPUs (A+A) each GPU has different driver version installed. This call will allow the application to discover driver version for each GPU.

◆ ADL2_Graphics_VulkanVersion_Get()

int ADL2_Graphics_VulkanVersion_Get ( ADL_CONTEXT_HANDLE  context,
ADLVulkanAppInfo *  vulkanAppInfo 
)

Function to get Vulkan versions.

This function gets Vulkan versions. No longer used by RSX, but kept to preserve third party vendor support.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]context: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]vulkanAppInfo: The ADLAppVersionInfo structure.

◆ ADL2_Graphics_VulkanVersionX2_Get()

int ADL2_Graphics_VulkanVersionX2_Get ( ADL_CONTEXT_HANDLE  context,
ADLVulkanAppInfo *  vulkanAppInfo 
)

Function to get Vulkan versions.

SWDEV-261137 - This X2 function gets the Vulkan version of the currently connected display devices instead of all previously connected display devices. This X2 version is used by RSX currently, however the original function is kept to preserve third party vendor support.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]context: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]vulkanAppInfo: The ADLAppVersionInfo structure.

◆ ADL2_Graphics_VulkanVersionX3_Get()

int ADL2_Graphics_VulkanVersionX3_Get ( ADL_CONTEXT_HANDLE  context,
ADLVulkanAppInfo *  vulkanAppInfo,
int  iAdapterIndex 
)

Function to get Vulkan versions of different GPUs.

Side-by-side allows system to install 2 different drivers at the same time. This function will get the Vulkan version of the GPU passed in via adapter index.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]context: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]vulkanAppInfo: The ADLAppVersionInfo structure.
[in]iAdapterIndex: The adapter index of the GPU

◆ ADL2_SmartDC_Active_State_Get()

int ADL2_SmartDC_Active_State_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpSmartDCActiveState 
)
Function to retrieve the SmartDC active state information.

This function retrieves SmartDC current active stats information from Driver.

Supported Platforms:
Windows 10; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpSmartDCStateThe pointer to the integer of SmartDC current state flag. If SmartDC currently is enabled , the value is 1, otherwise it is 0.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_SmartDC_Caps()

int ADL2_SmartDC_Caps ( ADL_CONTEXT_HANDLE  context,
int *  lpSupported,
int *  lpDefault 
)
Function to retrieve SmartDC capabilities information.

This function retrieves SmartDC capabilities information from Driver.

Supported Platforms:
Windows 10; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpSupportedThe int pointer to whether SmartDC is supported on current system. If SmartDC is supported, the value is 1, otherwise it is 0.
[out]lpDefaultThe int pointer to whether SmartDC is enable or disabled by default. If SmartDC is by default enabled, the value is 1, otherwise it is 0.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_SmartDC_Status_Get()

int ADL2_SmartDC_Status_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpSmartDCState 
)
Function to retrieve the SmartDC status information.

This function retrieves SmartDC current status information from Driver.

Supported Platforms:
Windows 10; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpSmartDCStateThe pointer to the integer of SmartDC current state flag. If SmartDC currently is enabled , the value is 1, otherwise it is 0.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_SmartDC_Status_Set()

int ADL2_SmartDC_Status_Set ( ADL_CONTEXT_HANDLE  context,
int  enable,
int *  lpSmartDCState 
)
Function to set SmartDC status.

This function enable/disable SmartDC from Driver.

Supported Platforms:
Windows 10; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]enableThe integer of SmartDC state to be set to driver. 1: Reuqest to enable SmartDC; 0: Request to disable SmartDC.
[out]lpSmartDCStateThe pointer to the integer of SmartDC setted state flag. If SmartDC is enabled , the value is 1, otherwise it is 0.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Graphics_Platform_Get()

int ADL_Graphics_Platform_Get ( int *  lpPlatForm)

Function to retrieve the type of graphics platform the system is currently running.

This function determines whether the current graphics platform is a mobile, desktop.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[out]lpPlatFormThe pointer to the retrieved graphics platform for the system.
lpPlatForm will be either GRAPHICS_PLATFORM_DESKTOP (for desktop platforms) or GRAPHICS_PLATFORM_MOBILE (for mobile platforms)
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Graphics_Versions_Get()

int ADL_Graphics_Versions_Get ( ADLVersionsInfo lpVersionsInfo)

Function to retrieve version information.

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

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

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