ADL (AMD Display Library) Public APIs  Version 17.0
Functions

This group outlines all Overlay related APIs. More...

Functions

int ADL2_Display_ControllerOverlayAdjustmentCaps_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLControllerOverlayInput *lpOverlayInput, ADLControllerOverlayInfo *lpCapsInfo)
 Function to get the minimum, maximum, and default values of an overlay adjustment. More...
 
int ADL2_Display_ControllerOverlayAdjustmentData_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLControllerOverlayInput *lpOverlay)
 Function to retrieve the current setting of an overlay adjustment. More...
 
int ADL2_Display_ControllerOverlayAdjustmentData_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLControllerOverlayInput *lpOverlay)
 Function to set the current setting of an overlay adjustment. More...
 
int ADL_Display_ControllerOverlayAdjustmentCaps_Get (int iAdapterIndex, ADLControllerOverlayInput *lpOverlayInput, ADLControllerOverlayInfo *lpCapsInfo)
 Function to get the minimum, maximum, and default values of an overlay adjustment. More...
 
int ADL_Display_ControllerOverlayAdjustmentData_Get (int iAdapterIndex, ADLControllerOverlayInput *lpOverlay)
 Function to retrieve the current setting of an overlay adjustment. More...
 
int ADL_Display_ControllerOverlayAdjustmentData_Set (int iAdapterIndex, ADLControllerOverlayInput *lpOverlay)
 Function to set the current setting of an overlay adjustment. More...
 

Detailed Description

This group outlines all Overlay related APIs.

Function Documentation

◆ ADL2_Display_ControllerOverlayAdjustmentCaps_Get()

int ADL2_Display_ControllerOverlayAdjustmentCaps_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLControllerOverlayInput lpOverlayInput,
ADLControllerOverlayInfo lpCapsInfo 
)

Function to get the minimum, maximum, and default values of an overlay adjustment.

This function retrieves the minimum, maximum, and default values of an overlay adjustment for a specified adapter.

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]lpOverlayInputThe pointer to the ADLControllerOverlayInput structure.
[in,out]lpCapsInfoThe pointer to the ADLControllerOverlayInfo structure storing the retrieved overlay adjustment 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_Display_ControllerOverlayAdjustmentData_Get()

int ADL2_Display_ControllerOverlayAdjustmentData_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLControllerOverlayInput lpOverlay 
)

Function to retrieve the current setting of an overlay adjustment.

This function retrieves the current setting of an overlay adjustment.

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]lpOverlayThe pointer to the retrieved overlay adjustment ADLControllerOverlayInput 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_ControllerOverlayAdjustmentData_Set()

int ADL2_Display_ControllerOverlayAdjustmentData_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLControllerOverlayInput lpOverlay 
)

Function to set the current setting of an overlay adjustment.

This function sets the current setting of an overlay adjustment.

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,out]lpOverlayThe pointer to the overlay adjustment ADLControllerOverlayInput structure.
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.

◆ ADL_Display_ControllerOverlayAdjustmentCaps_Get()

int ADL_Display_ControllerOverlayAdjustmentCaps_Get ( int  iAdapterIndex,
ADLControllerOverlayInput lpOverlayInput,
ADLControllerOverlayInfo lpCapsInfo 
)

Function to get the minimum, maximum, and default values of an overlay adjustment.

This function retrieves the minimum, maximum, and default values of an overlay adjustment for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]lpOverlayInputThe pointer to the ADLControllerOverlayInput structure.
[in,out]lpCapsInfoThe pointer to the ADLControllerOverlayInfo structure storing the retrieved overlay adjustment information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_ControllerOverlayAdjustmentData_Get()

int ADL_Display_ControllerOverlayAdjustmentData_Get ( int  iAdapterIndex,
ADLControllerOverlayInput lpOverlay 
)

Function to retrieve the current setting of an overlay adjustment.

This function retrieves the current setting of an overlay adjustment.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpOverlayThe pointer to the retrieved overlay adjustment ADLControllerOverlayInput 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_ControllerOverlayAdjustmentData_Set()

int ADL_Display_ControllerOverlayAdjustmentData_Set ( int  iAdapterIndex,
ADLControllerOverlayInput lpOverlay 
)

Function to set the current setting of an overlay adjustment.

This function sets the current setting of an overlay adjustment.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in,out]lpOverlayThe pointer to the overlay adjustment ADLControllerOverlayInput structure.
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.

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