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

Functions

int ADL2_Adapter_ConfigMemory_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iScreenWidth, int iScreenHeight, int displayFeatureMask, int numDisplays, ADLMemoryDisplayFeatures *displayFeatureList, int *iNumMemTypes, ADLMemoryRequired **lppMemRequired)
 Function to get the memory configuration of an adapter. More...
 
int ADL2_Adapter_MemoryInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfo *lpMemoryInfo)
 Function to retrieve memory information from the adapter. More...
 
int ADL2_Adapter_Tear_Free_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpTFCap)
 Functions to retreive Tear Free setting capabilities of the system. More...
 
int ADL2_Adapter_Tear_Free_Get (ADL_CONTEXT_HANDLE context, int iAdapter, int *pDefault, int *pRequested, int *pStatus)
 Get the requested tear free desktop setting and current status. More...
 
int ADL2_Adapter_Tear_Free_Set (ADL_CONTEXT_HANDLE context, int iAdapter, int iRequested, int *pStatus)
 Set the requested tear free desktop setting. More...
 
int ADL2_Adapter_XScreenInfo_Get (ADL_CONTEXT_HANDLE context, LPXScreenInfo lpXScreenInfo, int iInputSize)
 Function to retrieve all X Screen information for all OS-known adapters. More...
 
int ADL2_Controller_Color_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iControllerIndex, ADLGamma *lpGammaCurrent, ADLGamma *lpGammaDefault, ADLGamma *lpGammaMin, ADLGamma *lpGammaMax)
 Function to get the current value of gamma for a controller. More...
 
int ADL2_Controller_Color_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iControllerIndex, ADLGamma adlGamma)
 Function to set the current gamma value for a controller. More...
 
int ADL2_DesktopConfig_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDesktopConfig)
 Function to get the Desktop Configuration. More...
 
int ADL2_DesktopConfig_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDesktopConfig)
 Function to set the Desktop Configuration. More...
 
int ADL2_Display_IdentifyDisplay (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iDisplayControllerIndex, int iShow, int iDisplayNum, int iPosX, int iPosY)
 Function to set the desktop configuration. More...
 
int ADL2_Display_LUTColor_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGamma *lpGammaCurrent, ADLGamma *lpGammaDefault, ADLGamma *lpGammaMin, ADLGamma *lpGammaMax)
 Function to get the current value of gamma for a LUT (controller). More...
 
int ADL2_Display_LUTColor_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGamma adlGamma)
 Function to set the current gamma value for a LUT (controller). More...
 
int ADL2_Display_XrandrDisplayName_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, char *lpXrandrDisplayName, int iBuffSize)
 Function to retrieve the name of the Xrandr display. More...
 
int ADL2_DisplayEnable_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDisplayIndexList, int iDisplayListSize, int bPersistOnly)
 Function to dynamically enable displays on a GPU. More...
 
int ADL2_NumberOfDisplayEnable_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumberOfDisplays)
 Function to retrieve the number of enabled displays. More...
 
int ADL_Adapter_ConfigMemory_Get (int iAdapterIndex, int iScreenWidth, int iScreenHeight, int displayFeatureMask, int numDisplays, ADLMemoryDisplayFeatures *displayFeatureList, int *iNumMemTypes, ADLMemoryRequired **lppMemRequired)
 Function to get the memory configuration of an adapter. More...
 
int ADL_Adapter_MemoryInfo_Get (int iAdapterIndex, ADLMemoryInfo *lpMemoryInfo)
 Function to retrieve memory information from the adapter. More...
 
int ADL_Adapter_Tear_Free_Get (int iAdapter, int *pDefault, int *pRequested, int *pStatus)
 Get the requested tear free desktop setting and current status. More...
 
int ADL_Adapter_Tear_Free_Set (int iAdapter, int iRequested, int *pStatus)
 Set the requested tear free desktop setting. More...
 
int ADL_Adapter_XScreenInfo_Get (LPXScreenInfo lpXScreenInfo, int iInputSize)
 Function to retrieve all X Screen information for all OS-known adapters. More...
 
int ADL_Controller_Color_Get (int iAdapterIndex, int iControllerIndex, ADLGamma *lpGammaCurrent, ADLGamma *lpGammaDefault, ADLGamma *lpGammaMin, ADLGamma *lpGammaMax)
 Function to get the current value of gamma for a controller. More...
 
int ADL_Controller_Color_Set (int iAdapterIndex, int iControllerIndex, ADLGamma adlGamma)
 Function to set the current gamma value for a controller. More...
 
int ADL_DesktopConfig_Get (int iAdapterIndex, int *lpDesktopConfig)
 Function to get the Desktop Configuration. More...
 
int ADL_DesktopConfig_Set (int iAdapterIndex, int iDesktopConfig)
 Function to set the Desktop Configuration. More...
 
int ADL_Display_IdentifyDisplay (int iAdapterIndex, int iDisplayIndex, int iDisplayControllerIndex, int iShow, int iDisplayNum, int iPosX, int iPosY)
 Function to set the desktop configuration. More...
 
int ADL_Display_LUTColor_Get (int iAdapterIndex, int iDisplayIndex, ADLGamma *lpGammaCurrent, ADLGamma *lpGammaDefault, ADLGamma *lpGammaMin, ADLGamma *lpGammaMax)
 Function to get the current value of gamma for a LUT (controller). More...
 
int ADL_Display_LUTColor_Set (int iAdapterIndex, int iDisplayIndex, ADLGamma adlGamma)
 Function to set the current gamma value for a LUT (controller). More...
 
int ADL_Display_XrandrDisplayName_Get (int iAdapterIndex, int iDisplayIndex, char *lpXrandrDisplayName, int iBuffSize)
 Function to retrieve the name of the Xrandr display. More...
 
int ADL_DisplayEnable_Set (int iAdapterIndex, int *lpDisplayIndexList, int iDisplayListSize, int bPersistOnly)
 Function to dynamically enable displays on a GPU. More...
 
int ADL_NumberOfDisplayEnable_Get (int iAdapterIndex, int *lpNumberOfDisplays)
 Function to retrieve the number of enabled displays. More...
 

Detailed Description

Function Documentation

◆ ADL2_Adapter_ConfigMemory_Get()

int ADL2_Adapter_ConfigMemory_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iScreenWidth,
int  iScreenHeight,
int  displayFeatureMask,
int  numDisplays,
ADLMemoryDisplayFeatures displayFeatureList,
int *  iNumMemTypes,
ADLMemoryRequired **  lppMemRequired 
)

Function to get the memory configuration of an adapter.

This function retrieves the memory configuration of a specified adapter.

Supported Platforms:
Linux; 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]iScreenWidthThe pixel width of the X screen associated with the adapter.
[in]iScreenHeightThe pixel height of the X screen associated with the adapter.
[in]displayFeatureMaskThe valid define_adl_visiblememoryfeatures features
[in]numDisplaysNumber of displays associated with the XScreen.
[in]displayFeatureListList of display features associated with each display found in the XScreen. Number of entries is numDisplays.
[in]iNumMemTypesSize of lppMemRequired List
[out]lppMemRequiredList of visible memory size required in bytes of specified type
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. If this API is called in Windows the return value is always ADL_ERR_NOT_SUPPORTED
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_MemoryInfo_Get()

int ADL2_Adapter_MemoryInfo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLMemoryInfo lpMemoryInfo 
)

Function to retrieve memory information from the adapter.

This function retrieves the memory information for a specified graphics adapter.

Supported Platforms:
Linux; 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]lpMemoryInfoThe pointer to the structure storing the retrieved memory information.
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_Adapter_Tear_Free_Cap()

int ADL2_Adapter_Tear_Free_Cap ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpTFCap 
)

Functions to retreive Tear Free setting capabilities of the system.

This function determines whether the current system is capable of applying the tear free desktop settings.

Tear free desktop reduces tearing in everything shown on the screen except full screen OGL applications. It double buffers the graphics adapter output ensuring that the image being drawn is not changed while a display is updating.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexIgnored. May be used in the future.
[out]lpTFCapIs either ADL_TRUE or ADL_FALSE to represent if the system is capable of tear free setting or not.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Adapter_Tear_Free_Get()

int ADL2_Adapter_Tear_Free_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapter,
int *  pDefault,
int *  pRequested,
int *  pStatus 
)

Get the requested tear free desktop setting and current status.

Gets the requested setting and current status of all the GPUs on the system.

Tear free desktop reduces tearing in everything shown on the screen except full screen OGL applications. It double buffers the graphics adapter output ensuring that the image being drawn is not changed while a display is updating.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIgnored. May be used in the future.
[out]pDefaultThe default requested value or NULL.
[out]pRequestedThe requested tear free state. ADL_TRUE if it is requested on or ADL_FALSE if it requested off.
[out]pStatusThe current status of tear free Define_adapter_tear_free_status
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_Adapter_Tear_Free_Set()

int ADL2_Adapter_Tear_Free_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapter,
int  iRequested,
int *  pStatus 
)

Set the requested tear free desktop setting.

The tear free desktop setting is applied to all GPUs on the system.

Tear free desktop reduces tearing in everything shown on the screen except full screen OGL applications. It double buffers the graphics adapter output ensuring that the image being drawn is not changed while the display is updating.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIgnored. May be used in the future.
[in]iRequestedThe new requested tear free state. ADL_TRUE to request it on and ADL_FALSE to request it off.
[out]pStatusThe current status of tear free Define_adapter_tear_free_status
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_Adapter_XScreenInfo_Get()

int ADL2_Adapter_XScreenInfo_Get ( ADL_CONTEXT_HANDLE  context,
LPXScreenInfo  lpXScreenInfo,
int  iInputSize 
)

Function to retrieve all X Screen information for all OS-known adapters.

This function retrieves the X Screen information of all OS-known adapters on a Linux system. OS-known adapters can include adapters that currently exist in the system (logical adapters)
as well as ones that no longer exist in the system but are still recognized by the OS.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iInputSizeThe size of lpInfo buffer.
[out]lpXScreenInfoThe pointer to the buffer storing the retrieved X Screen information.
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_Controller_Color_Get()

int ADL2_Controller_Color_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iControllerIndex,
ADLGamma lpGammaCurrent,
ADLGamma lpGammaDefault,
ADLGamma lpGammaMin,
ADLGamma lpGammaMax 
)

Function to get the current value of gamma for a controller.

This function retrieves the current gamma value of the specified controller.

Supported Platforms:
Linux; 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]iControllerIndexThe desired controller index.
[out]lpGammaCurrentThe pointer to the retrieved current gamma information structure.
[out]lpGammaDefaultThe pointer to the retrieved default gamma information structure.
[out]lpGammaMinThe pointer to the retrieved minimum gamma information structure.
[out]lpGammaMaxThe pointer to the retrieved maximum gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because the controller index is no longer used with DAL2. Replaced by ADL_Display_LUTColor_Get
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_Controller_Color_Set()

int ADL2_Controller_Color_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iControllerIndex,
ADLGamma  adlGamma 
)

Function to set the current gamma value for a controller.

This function sets the gamma value of a specified controller.

Supported Platforms:
Linux; 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]iControllerIndexThe desired controller index.
[in]adlGammaThe Gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because the controller index is no longer used with DAL2. Replaced by ADL_Display_LUTColor_Set
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_DesktopConfig_Get()

int ADL2_DesktopConfig_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDesktopConfig 
)

Function to get the Desktop Configuration.

This function retreives current the desktop configuration information.

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]lpDesktopConfigThe pointer to the retrieved desktop configuration information.
Desktop Configuration Flags
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.
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_DesktopConfig_Set()

int ADL2_DesktopConfig_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDesktopConfig 
)

Function to set the Desktop Configuration.

This function sets the current desktop configuration information.

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]iDesktopConfigThe desired Desktop Configuration information.
Desktop Configuration Flags
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.
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_IdentifyDisplay()

int ADL2_Display_IdentifyDisplay ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iDisplayControllerIndex,
int  iShow,
int  iDisplayNum,
int  iPosX,
int  iPosY 
)

Function to set the desktop configuration.

This function sets the desktop configuration.

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]iDisplayControllerIndexThe controller index. A field from ADLDisplayInfo structure
[in]iShowThe instruction to show the display number. Enter 0 to show and 1 to hide.
[in]iDisplayNumThe number to display on screen.
[in]iPosXThe X position on screen to display index in % of screen.
[in]iPosYThe Y position on screen to display index in % of screen.
Supported Platforms:
Linux; 32bit and 64bit
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_LUTColor_Get()

int ADL2_Display_LUTColor_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
ADLGamma lpGammaCurrent,
ADLGamma lpGammaDefault,
ADLGamma lpGammaMin,
ADLGamma lpGammaMax 
)

Function to get the current value of gamma for a LUT (controller).

This function retrieves the current gamma value of the specified display index. Note: This replaces ADL_Controller_Color_Get

Supported Platforms:
Linux; 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]lpGammaCurrentThe pointer to the retrieved current gamma information structure.
[out]lpGammaDefaultThe pointer to the retrieved default gamma information structure.
[out]lpGammaMinThe pointer to the retrieved minimum gamma information structure.
[out]lpGammaMaxThe pointer to the retrieved maximum gamma information structure.
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_LUTColor_Set()

int ADL2_Display_LUTColor_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
ADLGamma  adlGamma 
)

Function to set the current gamma value for a LUT (controller).

This function sets the gamma value of a specified display index (controller) Note: This replaces ADL_Controller_Color_Set

Supported Platforms:
Linux; 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]adlGammaThe Gamma information structure.
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_XrandrDisplayName_Get()

int ADL2_Display_XrandrDisplayName_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
char *  lpXrandrDisplayName,
int  iBuffSize 
)

Function to retrieve the name of the Xrandr display.

This function retrieves the Xrandr display name based on a specified adapter and display.

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 ADL index handle of the desired display.
[out]lpXrandrDisplayNameThe pointer to the buffer storing the retrieved Xrandr display name.
[in]iBuffSizeThe size of the lpXrandrDisplayName buffer.
Supported Platforms:
Linux; 32bit and 64bit
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_DisplayEnable_Set()

int ADL2_DisplayEnable_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDisplayIndexList,
int  iDisplayListSize,
int  bPersistOnly 
)

Function to dynamically enable displays on a GPU.

This function dynamically enables displays on a GPU. Supported on randr 1.1 distributions. This function is not supported on randr 1.2 and newer distributions.

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]lpDisplayIndexListThe pointer to the list of display indexes that will be enabled. All others will be disabled.
[in]iDisplayListSizeThe size of the list.
[in]bPersistOnlyNon-zero value means that settings will not take effect until system restart
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.
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_NumberOfDisplayEnable_Get()

int ADL2_NumberOfDisplayEnable_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumberOfDisplays 
)

Function to retrieve the number of enabled displays.

This function retrieves the current number of enabled displays.

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]lpNumberOfDisplaysThe pointer to the number of enabled displays.
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.
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_ConfigMemory_Get()

int ADL_Adapter_ConfigMemory_Get ( int  iAdapterIndex,
int  iScreenWidth,
int  iScreenHeight,
int  displayFeatureMask,
int  numDisplays,
ADLMemoryDisplayFeatures displayFeatureList,
int *  iNumMemTypes,
ADLMemoryRequired **  lppMemRequired 
)

Function to get the memory configuration of an adapter.

This function retrieves the memory configuration of a specified adapter.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iScreenWidthThe pixel width of the X screen associated with the adapter.
[in]iScreenHeightThe pixel height of the X screen associated with the adapter.
[in]displayFeatureMaskThe valid define_adl_visiblememoryfeatures features
[in]numDisplaysNumber of displays associated with the XScreen.
[in]displayFeatureListList of display features associated with each display found in the XScreen. Number of entries is numDisplays.
[in]iNumMemTypesSize of lppMemRequired List
[out]lppMemRequiredList of visible memory size required in bytes of specified type
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. If this API is called in Windows the return value is always ADL_ERR_NOT_SUPPORTED

◆ ADL_Adapter_MemoryInfo_Get()

int ADL_Adapter_MemoryInfo_Get ( int  iAdapterIndex,
ADLMemoryInfo lpMemoryInfo 
)

Function to retrieve memory information from the adapter.

This function retrieves the memory information for a specified graphics adapter.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpMemoryInfoThe pointer to the structure storing the retrieved memory information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_Tear_Free_Get()

int ADL_Adapter_Tear_Free_Get ( int  iAdapter,
int *  pDefault,
int *  pRequested,
int *  pStatus 
)

Get the requested tear free desktop setting and current status.

Gets the requested setting and current status of all the GPUs on the system.

Tear free desktop reduces tearing in everything shown on the screen except full screen OGL applications. It double buffers the graphics adapter output ensuring that the image being drawn is not changed while a display is updating.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIgnored. May be used in the future.
[out]pDefaultThe default requested value or NULL.
[out]pRequestedThe requested tear free state. ADL_TRUE if it is requested on or ADL_FALSE if it requested off.
[out]pStatusThe current status of tear free Define_adapter_tear_free_status
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_Tear_Free_Set()

int ADL_Adapter_Tear_Free_Set ( int  iAdapter,
int  iRequested,
int *  pStatus 
)

Set the requested tear free desktop setting.

The tear free desktop setting is applied to all GPUs on the system.

Tear free desktop reduces tearing in everything shown on the screen except full screen OGL applications. It double buffers the graphics adapter output ensuring that the image being drawn is not changed while the display is updating.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIgnored. May be used in the future.
[in]iRequestedThe new requested tear free state. ADL_TRUE to request it on and ADL_FALSE to request it off.
[out]pStatusThe current status of tear free Define_adapter_tear_free_status
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_XScreenInfo_Get()

int ADL_Adapter_XScreenInfo_Get ( LPXScreenInfo  lpXScreenInfo,
int  iInputSize 
)

Function to retrieve all X Screen information for all OS-known adapters.

This function retrieves the X Screen information of all OS-known adapters on a Linux system. OS-known adapters can include adapters that currently exist in the system (logical adapters)
as well as ones that no longer exist in the system but are still recognized by the OS.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iInputSizeThe size of lpInfo buffer.
[out]lpXScreenInfoThe pointer to the buffer storing the retrieved X Screen information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Controller_Color_Get()

int ADL_Controller_Color_Get ( int  iAdapterIndex,
int  iControllerIndex,
ADLGamma lpGammaCurrent,
ADLGamma lpGammaDefault,
ADLGamma lpGammaMin,
ADLGamma lpGammaMax 
)

Function to get the current value of gamma for a controller.

This function retrieves the current gamma value of the specified controller.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iControllerIndexThe desired controller index.
[out]lpGammaCurrentThe pointer to the retrieved current gamma information structure.
[out]lpGammaDefaultThe pointer to the retrieved default gamma information structure.
[out]lpGammaMinThe pointer to the retrieved minimum gamma information structure.
[out]lpGammaMaxThe pointer to the retrieved maximum gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because the controller index is no longer used with DAL2. Replaced by ADL_Display_LUTColor_Get

◆ ADL_Controller_Color_Set()

int ADL_Controller_Color_Set ( int  iAdapterIndex,
int  iControllerIndex,
ADLGamma  adlGamma 
)

Function to set the current gamma value for a controller.

This function sets the gamma value of a specified controller.

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iControllerIndexThe desired controller index.
[in]adlGammaThe Gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because the controller index is no longer used with DAL2. Replaced by ADL_Display_LUTColor_Set

◆ ADL_DesktopConfig_Get()

int ADL_DesktopConfig_Get ( int  iAdapterIndex,
int *  lpDesktopConfig 
)

Function to get the Desktop Configuration.

This function retreives current the desktop configuration information.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpDesktopConfigThe pointer to the retrieved desktop configuration information.
Desktop Configuration Flags
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.

◆ ADL_DesktopConfig_Set()

int ADL_DesktopConfig_Set ( int  iAdapterIndex,
int  iDesktopConfig 
)

Function to set the Desktop Configuration.

This function sets the current desktop configuration information.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDesktopConfigThe desired Desktop Configuration information.
Desktop Configuration Flags
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.

◆ ADL_Display_IdentifyDisplay()

int ADL_Display_IdentifyDisplay ( int  iAdapterIndex,
int  iDisplayIndex,
int  iDisplayControllerIndex,
int  iShow,
int  iDisplayNum,
int  iPosX,
int  iPosY 
)

Function to set the desktop configuration.

This function sets the desktop configuration.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index.
[in]iDisplayControllerIndexThe controller index. A field from ADLDisplayInfo structure
[in]iShowThe instruction to show the display number. Enter 0 to show and 1 to hide.
[in]iDisplayNumThe number to display on screen.
[in]iPosXThe X position on screen to display index in % of screen.
[in]iPosYThe Y position on screen to display index in % of screen.
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_LUTColor_Get()

int ADL_Display_LUTColor_Get ( int  iAdapterIndex,
int  iDisplayIndex,
ADLGamma lpGammaCurrent,
ADLGamma lpGammaDefault,
ADLGamma lpGammaMin,
ADLGamma lpGammaMax 
)

Function to get the current value of gamma for a LUT (controller).

This function retrieves the current gamma value of the specified display index. Note: This replaces ADL_Controller_Color_Get

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index.
[out]lpGammaCurrentThe pointer to the retrieved current gamma information structure.
[out]lpGammaDefaultThe pointer to the retrieved default gamma information structure.
[out]lpGammaMinThe pointer to the retrieved minimum gamma information structure.
[out]lpGammaMaxThe pointer to the retrieved maximum gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_LUTColor_Set()

int ADL_Display_LUTColor_Set ( int  iAdapterIndex,
int  iDisplayIndex,
ADLGamma  adlGamma 
)

Function to set the current gamma value for a LUT (controller).

This function sets the gamma value of a specified display index (controller) Note: This replaces ADL_Controller_Color_Set

Supported Platforms:
Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index.
[in]adlGammaThe Gamma information structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_XrandrDisplayName_Get()

int ADL_Display_XrandrDisplayName_Get ( int  iAdapterIndex,
int  iDisplayIndex,
char *  lpXrandrDisplayName,
int  iBuffSize 
)

Function to retrieve the name of the Xrandr display.

This function retrieves the Xrandr display name based on a specified adapter and display.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe ADL index handle of the desired display.
[out]lpXrandrDisplayNameThe pointer to the buffer storing the retrieved Xrandr display name.
[in]iBuffSizeThe size of the lpXrandrDisplayName buffer.
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_DisplayEnable_Set()

int ADL_DisplayEnable_Set ( int  iAdapterIndex,
int *  lpDisplayIndexList,
int  iDisplayListSize,
int  bPersistOnly 
)

Function to dynamically enable displays on a GPU.

This function dynamically enables displays on a GPU. Supported on randr 1.1 distributions. This function is not supported on randr 1.2 and newer distributions.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]lpDisplayIndexListThe pointer to the list of display indexes that will be enabled. All others will be disabled.
[in]iDisplayListSizeThe size of the list.
[in]bPersistOnlyNon-zero value means that settings will not take effect until system restart
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.

◆ ADL_NumberOfDisplayEnable_Get()

int ADL_NumberOfDisplayEnable_Get ( int  iAdapterIndex,
int *  lpNumberOfDisplays 
)

Function to retrieve the number of enabled displays.

This function retrieves the current number of enabled displays.

Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpNumberOfDisplaysThe pointer to the number of enabled displays.
Supported Platforms:
Linux; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it was only used for RandR 1.1 (Red Hat 5.x) distributions which is now not supported.

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