ADL (AMD Display Library) Public APIs  Version 17.0
Functions
Overscan/Underscan APIs

This group outlines Overscan and Underscan related APIs. More...

Functions

int ADL2_Display_Overscan_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefualt, int *lpMin, int *lpMax, int *lpStep)
 Function to retrieve the current value of gamma for each controller. More...
 
int ADL2_Display_Overscan_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the current value of gamma for each controller. More...
 
int ADL2_Display_Underscan_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefault, int *lpMin, int *lpMax, int *lpStep)
 Function to retrieve the detailed information for underscan. More...
 
int ADL2_Display_Underscan_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the current value of underscan.
More...
 
int ADL2_Display_UnderscanState_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefault)
 Function to get the value of under scan enabled.
More...
 
int ADL2_Display_UnderscanState_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iUnderscanEnabled)
 Function to set the value of under scan enabled.
More...
 
int ADL2_Display_UnderscanSupport_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpSupport)
 Function to get the value of under scan support.
More...
 
int ADL_Display_Overscan_Get (int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefualt, int *lpMin, int *lpMax, int *lpStep)
 Function to retrieve the current value of gamma for each controller. More...
 
int ADL_Display_Overscan_Set (int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the current value of gamma for each controller. More...
 
int ADL_Display_Underscan_Get (int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefault, int *lpMin, int *lpMax, int *lpStep)
 Function to retrieve the detailed information for underscan. More...
 
int ADL_Display_Underscan_Set (int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the current value of underscan.
More...
 

Detailed Description

This group outlines Overscan and Underscan related APIs.

Function Documentation

◆ ADL2_Display_Overscan_Get()

int ADL2_Display_Overscan_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefualt,
int *  lpMin,
int *  lpMax,
int *  lpStep 
)

Function to retrieve the current value of gamma for each controller.

This function retrieves the Overscan value for a specified display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current Overscan value.
[out]lpDefualtThe pointer to the default Overscan value.
[out]lpMinThe pointer to the minimum Overscan value.
[out]lpMaxThe pointer to the maximum Overscan value.
[out]lpStepThe pointer to the increment of the Overscan value.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code.
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_Overscan_Set()

int ADL2_Display_Overscan_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the current value of gamma for each controller.

This function sets the Overscan value for a specified display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired Overscan value.
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_Underscan_Get()

int ADL2_Display_Underscan_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefault,
int *  lpMin,
int *  lpMax,
int *  lpStep 
)

Function to retrieve the detailed information for underscan.

This function retrieves the detailed information for underscan.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current underscan value.
[out]lpDefaultThe pointer to the default underscan value.
[out]lpMinThe pointer to the minimum underscan value.
[out]lpMaxThe pointer to the maximum underscan value.
[out]lpStepThe pointer to the increment of the underscan setting.
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_Underscan_Set()

int ADL2_Display_Underscan_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the current value of underscan.

This function sets the display underscan for a specified adapter, display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired underscan value.
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_UnderscanState_Get()

int ADL2_Display_UnderscanState_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefault 
)

Function to get the value of under scan enabled.

This function gets the display under scan enabled flag for a specified adapter, display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]*lpCurrentpointer to the the under scan enabled current value. Enabled :1 ; disabled:0
[in]*lpDefaultpointer to the the under scan enabled default value. Enabled :1 ; disabled:0
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_UnderscanState_Set()

int ADL2_Display_UnderscanState_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iUnderscanEnabled 
)

Function to set the value of under scan enabled.

This function sets the display under scan enabled flag for a specified adapter, display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]iUnderscanEnabledthe the under scan enabled value. Enabled :1 ; disabled:0
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_UnderscanSupport_Get()

int ADL2_Display_UnderscanSupport_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpSupport 
)

Function to get the value of under scan support.

This function gets the display under scan support flag for a specified adapter, display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]*lpSupportpointer to the the under scan support value.
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.

◆ ADL_Display_Overscan_Get()

int ADL_Display_Overscan_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefualt,
int *  lpMin,
int *  lpMax,
int *  lpStep 
)

Function to retrieve the current value of gamma for each controller.

This function retrieves the Overscan value for a specified display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current Overscan value.
[out]lpDefualtThe pointer to the default Overscan value.
[out]lpMinThe pointer to the minimum Overscan value.
[out]lpMaxThe pointer to the maximum Overscan value.
[out]lpStepThe pointer to the increment of the Overscan value.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code.

◆ ADL_Display_Overscan_Set()

int ADL_Display_Overscan_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the current value of gamma for each controller.

This function sets the Overscan value for a specified display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired Overscan value.
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_Underscan_Get()

int ADL_Display_Underscan_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefault,
int *  lpMin,
int *  lpMax,
int *  lpStep 
)

Function to retrieve the detailed information for underscan.

This function retrieves the detailed information for underscan.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current underscan value.
[out]lpDefaultThe pointer to the default underscan value.
[out]lpMinThe pointer to the minimum underscan value.
[out]lpMaxThe pointer to the maximum underscan value.
[out]lpStepThe pointer to the increment of the underscan setting.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_Underscan_Set()

int ADL_Display_Underscan_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the current value of underscan.

This function sets the display underscan for a specified adapter, display.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired underscan value.
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.