ADL (AMD Display Library) Public APIs  Version 17.0
Functions
Power Management Related of APIs

This group describes the Power Management Related of APIs. More...

Functions

int ADL2_BOOST_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_BOOST_SETTINGS *settings)
 Function to get the BOOST settings This function retrieves the BOOST settings for a specified display adapter. More...
 
int ADL2_BOOST_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_BOOST_SETTINGS settings, ADL_BOOST_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set BOOST settings This function sets the user input values to BOOST feature. More...
 
int ADL2_Chill_Caps_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iCheckCaps)
 
int ADL2_Chill_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpEnabled)
 
int ADL2_Chill_Settings_Notify (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iChanged)
 
int ADL2_Chill_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iEnabled)
 
int ADL2_CHILL_SettingsX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_CHILL_SETTINGS *settings)
 Function to get the CHILL settings This function retrieves the CHILL settings for a specified display adapter. More...
 
int ADL2_CHILL_SettingsX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_CHILL_SETTINGS settings, ADL_CHILL_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set CHILL settings This function sets the user input values to CHILL feature. More...
 
int ADL2_DELAG_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_DELAG_SETTINGS *settings)
 Function to get the DELAG settings This function retrieves the DELAG settings for a specified display adapter. More...
 
int ADL2_DELAG_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_DELAG_SETTINGS settings, ADL_DELAG_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set DELAG settings This function sets the user input values to DELAG feature. More...
 
int ADL2_ElmCompatibilityMode_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_ElmCompatibilityMode_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValue)
 
int ADL2_ElmCompatibilityMode_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iValue)
 
int ADL2_FPS_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpVersion)
 Function to retrieve FPS Global Setting Capability. More...
 
int ADL2_FPS_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFPSSettingsOutput *lpFPSSettings)
 Function to retrieve FPS Global Settings. More...
 
int ADL2_FPS_Settings_Reset (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to reset FPS Global Settings. More...
 
int ADL2_FPS_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFPSSettingsInput lpFPSSettings)
 Function to update FPS Global Settings. More...
 
int ADL2_PerformanceTuning_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_PerfTuning_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpPTuningValue)
 
int ADL2_PerfTuning_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int lpPTuningValue)
 
int ADL2_PPW_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_PPW_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpFPWValue)
 
int ADL2_PPW_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iFPWValue)
 
int ADL2_PROVSR_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_PROVSR_SETTINGS *settings)
 Function to get the Pro VSR settings This function retrieves the Pro VSR for a specified display adapter. More...
 
int ADL2_PROVSR_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_PROVSR_SETTINGS settings, ADL_PROVSR_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set Pro VSR settings This function sets the user input values to VSR feature. More...
 
int ADL2_RIS_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_RIS_SETTINGS *settings)
 Function to get the RIS settings This function retrieves the RIS settings for a specified display adapter. More...
 
int ADL2_RIS_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_RIS_SETTINGS settings, ADL_RIS_NOTFICATION_REASON changeReason)
 Function to set RIS settings This function sets the user input values to RIS feature. More...
 

Detailed Description

This group describes the Power Management Related of APIs.

Function Documentation

◆ ADL2_BOOST_Settings_Get()

int ADL2_BOOST_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_BOOST_SETTINGS settings 
)

Function to get the BOOST settings This function retrieves the BOOST settings for a specified display 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 index of the desired adapter.
[out]settingsThe pointer to the pointer to the BOOST data structure
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_BOOST_Settings_Set()

int ADL2_BOOST_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_BOOST_SETTINGS  settings,
ADL_BOOST_NOTFICATION_REASON  changeReason,
ADL_ERROR_REASON errorReason 
)

Function to set BOOST settings This function sets the user input values to BOOST feature.

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 index of the desired adapter.
[in]settingsADL_BOOST_SETTINGS : structure with the input values
[in]changeReasonADL_BOOST_NOTFICATION_REASON : structure with the changed feilds in settings parameter
[out]errorReasonADL_ERROR_REASON : structure with the error feilds in settings parameter. client should refer to this feild when set call is filed.
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_Chill_Caps_Get()

int ADL2_Chill_Caps_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  iSupported,
int *  iCheckCaps 
)
Function to get the Global Chill capabilities This function retrieves the Global Chill capabilities for a specified display 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 index of the desired adapter.
[out]iSupportedThe pointer to an int variable which indicates if Global Chill is supported ( ADL_TRUE : enabled, ADL_FALSE : disabled)
[out]iCheckCapsThe pointer to an int variable which indicates if iSupported flag is to be considered from Clients ( ADL_TRUE : iSupported to be considered, ADL_FALSE : ignore iSupported)
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_Chill_Settings_Get()

int ADL2_Chill_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpEnabled 
)
Function to get the Global Chill capabilities This function retrieves the Global Chill capabilities for a specified display 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 index of the desired adapter.
[out]lpEnabledThe pointer to an int variable which indicates if Global Chill is enabled ( ADL_TRUE : enabled, ADL_FALSE : disabled)
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_Chill_Settings_Notify()

int ADL2_Chill_Settings_Notify ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iChanged 
)
Function to notify DX via KMD that Chill settings have changed. This function communicates DX via KMD that user changed chill settings.
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 index of the desired adapter.
[in]iChangedADL_TRUE ADL_FALSE
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_Chill_Settings_Set()

int ADL2_Chill_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iEnabled 
)
Function to enable or disable Global Chill This function enables or disables Global Chill for a specified display 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 index of the desired adapter.
[in]iEnabledADL_TRUE : enables Global Chill, ADL_FALSE : disables Global Chill.
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_CHILL_SettingsX2_Get()

int ADL2_CHILL_SettingsX2_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_CHILL_SETTINGS settings 
)

Function to get the CHILL settings This function retrieves the CHILL settings for a specified display 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 index of the desired adapter.
[out]settingsThe pointer to the pointer to the CHILL data structure
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_CHILL_SettingsX2_Set()

int ADL2_CHILL_SettingsX2_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_CHILL_SETTINGS  settings,
ADL_CHILL_NOTFICATION_REASON  changeReason,
ADL_ERROR_REASON errorReason 
)

Function to set CHILL settings This function sets the user input values to CHILL feature.

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 index of the desired adapter.
[in]settingsADL_CHILL_SETTINGS : structure with the input values
[in]changeReasonADL_CHILL_NOTFICATION_REASON : structure with the changed feilds in settings parameter
[out]errorReasonADL_ERROR_REASON : structure with the error feilds in settings parameter. client should refer to this feild when set call is filed.
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_DELAG_Settings_Get()

int ADL2_DELAG_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_DELAG_SETTINGS settings 
)

Function to get the DELAG settings This function retrieves the DELAG settings for a specified display 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 index of the desired adapter.
[out]settingsThe pointer to the pointer to the DEALG data structure
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_DELAG_Settings_Set()

int ADL2_DELAG_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_DELAG_SETTINGS  settings,
ADL_DELAG_NOTFICATION_REASON  changeReason,
ADL_ERROR_REASON errorReason 
)

Function to set DELAG settings This function sets the user input values to DELAG feature.

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 index of the desired adapter.
[in]settingsADL_DELAG_SETTINGS : structure with the input values
[in]changeReasonADL_DELAG_NOTFICATION_REASON : structure with the changed feilds in settings parameter
[out]errorReasonADL_ERROR_REASON : structure with the error feilds in settings parameter. client should refer to this feild when set call is filed.
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_ElmCompatibilityMode_Caps()

int ADL2_ElmCompatibilityMode_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported,
int *  lpDefault 
)
Function to retrieve Compatibility Mode setting capability.

This function retrieves the Compatibility Mode capability.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpSupported: Integer indicating capability of the CompatibilityMode Feature Support.

◆ ADL2_ElmCompatibilityMode_Status_Get()

int ADL2_ElmCompatibilityMode_Status_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpValue 
)
Function to retrieve Compatibility Mode status whether it is On or Off.

This function retrieves Compatibility Mode status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpCompatibilityModeValue: Pointer to the current CompatibilityMode status obtained

◆ ADL2_ElmCompatibilityMode_Status_Set()

int ADL2_ElmCompatibilityMode_Status_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iValue 
)
Function to update Compatibility Mode status to either On or Off.

This function update Compatibility Mode status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[in]iFPWValue: CompatibilityMode status to update the current compatibility Status

◆ ADL2_FPS_Caps()

int ADL2_FPS_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported,
int *  lpVersion 
)

Function to retrieve FPS Global Setting Capability.

This function retrieves the Global Setting Capability.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpSupported: Integer indicating capability of the FPS Feature Support.
[out]lpVersion: Integer indicating Feature Version.

◆ ADL2_FPS_Settings_Get()

int ADL2_FPS_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLFPSSettingsOutput lpFPSSettings 
)

Function to retrieve FPS Global Settings.

This function retrieves FPS Global Settings.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpFPSSettings: Pointer to ADLFPSSettingsOutput struct which will load the Global FPS Settings

◆ ADL2_FPS_Settings_Reset()

int ADL2_FPS_Settings_Reset ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex 
)

Function to reset FPS Global Settings.

This function reset FPS Global Settings.

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]iAdapterIndex: The ADL index handle of the desired adapter.

◆ ADL2_FPS_Settings_Set()

int ADL2_FPS_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLFPSSettingsInput  lpFPSSettings 
)

Function to update FPS Global Settings.

This function update FPS Global Settings.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[in]lpFPSSettings: ADLFPSSettingsInput struct which will update the Global FPS Settings

◆ ADL2_PerformanceTuning_Caps()

int ADL2_PerformanceTuning_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported,
int *  lpDefault 
)
Function to retrieve Performance Tuning capability.

This function retrieves the Performance Tuning capability.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpSupported: Integer indicating capability of the Performance Tuning Feature Support.
[out]lpDefault: Integer indicating default Performance Tuning value

◆ ADL2_PerfTuning_Status_Get()

int ADL2_PerfTuning_Status_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpPTuningValue 
)
Function to retrieve Performance ui tunning status whether it is On or Off.

This function retrieves Performance ui tunning status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpPTuningValue: Pointer to the current performance tuning status obtained

◆ ADL2_PerfTuning_Status_Set()

int ADL2_PerfTuning_Status_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  lpPTuningValue 
)
Function to update Performance ui tunning status to either On or Off.

This function update FPS Performance ui tunning status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[in]lpPTuningValue: performance tuning status to update the current Performance Per Watt Status

◆ ADL2_PPW_Caps()

int ADL2_PPW_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported,
int *  lpDefault 
)
Function to retrieve Performance Per Watt setting capability.

This function retrieves the Performance Per Watt capability.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpSupported: Integer indicating capability of the PPW Feature Support.

◆ ADL2_PPW_Status_Get()

int ADL2_PPW_Status_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpFPWValue 
)
Function to retrieve Performance Per Watt status whether it is On or Off.

This function retrieves Performance Per Watt status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[out]lpPPWValue: Pointer to the current PPW status obtained

◆ ADL2_PPW_Status_Set()

int ADL2_PPW_Status_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iFPWValue 
)
Function to update Performance Per Watt status to either On or Off.

This function update FPS Performance Per Watt status.

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]iAdapterIndex: The ADL index handle of the desired adapter.
[in]iFPWValue: PPW status to update the current Performance Per Watt Status

◆ ADL2_PROVSR_Settings_Get()

int ADL2_PROVSR_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_PROVSR_SETTINGS settings 
)

Function to get the Pro VSR settings This function retrieves the Pro VSR for a specified display 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 index of the desired adapter.
[out]settingsThe pointer to the pointer to the VSR data structure
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_PROVSR_Settings_Set()

int ADL2_PROVSR_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_PROVSR_SETTINGS  settings,
ADL_PROVSR_NOTFICATION_REASON  changeReason,
ADL_ERROR_REASON errorReason 
)

Function to set Pro VSR settings This function sets the user input values to VSR feature.

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 index of the desired adapter.
[in]settingsADL_PROVSR_SETTINGS : structure with the input values
[in]changeReasonADL_PROVSR_SETTINGS_NOTFICATION_REASON : structure with the changed feilds in settings parameter
[out]errorReasonADL_ERROR_REASON : structure with the error feilds in settings parameter. client should refer to this feild when set call is filed.
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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_RIS_Settings_Get()

int ADL2_RIS_Settings_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_RIS_SETTINGS settings 
)

Function to get the RIS settings This function retrieves the RIS settings for a specified display 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 index of the desired adapter.
[out]settingsThe pointer to the pointer to the RIS data structure
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

◆ ADL2_RIS_Settings_Set()

int ADL2_RIS_Settings_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_RIS_SETTINGS  settings,
ADL_RIS_NOTFICATION_REASON  changeReason 
)

Function to set RIS settings This function sets the user input values to RIS feature.

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 index of the desired adapter.
[in]settingsADL_RIS_SETTINGS : structure with the input values
[in]changeReasonADL_RIS_NOTFICATION_REASON : structure with the changed feilds in settings parameter
Returns
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). 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.

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