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

This group outlines PowerXpress Related APIs. More...

Functions

int ADL2_Display_PowerXpress_AutoSwitchConfig_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAutoSwitchOnACDCEvent, int *lpAutoSwitchOnDCACEvent)
 Function to retrieve the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured. More...
 
int ADL2_Display_PowerXpress_AutoSwitchConfig_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iAutoSwitchOnACDCEvent, int iAutoSwitchOnDCACEvent)
 Function to set the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured. More...
 
int ADL2_Display_PowerXpressActiveGPU_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpActiveGPU)
 Function to get the active GPU in PowerXpress. More...
 
int ADL2_Display_PowerXpressActiveGPU_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iActiveGPU, int *lpOperationResult)
 Function to set the active GPU in PowerXpress. More...
 
int ADL2_Display_PowerXpressVersion_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpVersion)
 Function to retrieve the PowerXpress version. More...
 
int ADL2_PowerXpress_AncillaryDevices_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumberOfAncillaryDevices, ADLBdf **lppAncillaryDevices)
 This function gets ancillary GPUs. More...
 
int ADL2_PowerXpress_Config_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLPXConfigCaps *lpPXConfigCaps)
 This function gets the PowerXpress configuration Caps. More...
 
int ADL2_PowerXpress_Configuration_Get (ADL_CONTEXT_HANDLE context, ADLPxType *lpPxType, ADLBdf *lpIGPUBdf, int *lpNumberOfDGPUs, ADLBdf **lppDGPUBDFs)
 This function gets PX configuration. More...
 
int ADL2_PowerXpress_Scheme_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLPXScheme *lpPXSchemeRange, ADLPXScheme *lpPXSchemeCurrentState, ADLPXScheme *lpPXSchemeDefaultState)
 This function gets the PowerXpress scheme. More...
 
int ADL2_PowerXpress_Scheme_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLPXScheme scheme)
 This function sets the PowerXpress scheme. More...
 
int ADL2_SwitchableGraphics_Applications_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLSGApplicationInfo **lppAppList)
 ADL local interface. Function to get all the recently ran and currently running applications. More...
 
int ADL2_Win_IsHybridAI (ADL_CONTEXT_HANDLE context)
 ADL local interface. Function to get Hybrid Discrete graphics support. More...
 
int ADL_Display_PowerXpress_AutoSwitchConfig_Get (int iAdapterIndex, int *lpAutoSwitchOnACDCEvent, int *lpAutoSwitchOnDCACEvent)
 Function to retrieve the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured. More...
 
int ADL_Display_PowerXpress_AutoSwitchConfig_Set (int iAdapterIndex, int iAutoSwitchOnACDCEvent, int iAutoSwitchOnDCACEvent)
 Function to set the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured. More...
 
int ADL_Display_PowerXpressActiveGPU_Get (int iAdapterIndex, int *lpActiveGPU)
 Function to get the active GPU in PowerXpress. More...
 
int ADL_Display_PowerXpressActiveGPU_Set (int iAdapterIndex, int iActiveGPU, int *lpOperationResult)
 Function to set the active GPU in PowerXpress. More...
 
int ADL_Display_PowerXpressVersion_Get (int iAdapterIndex, int *lpVersion)
 Function to retrieve the PowerXpress version. More...
 
int ADL_PowerXpress_AncillaryDevices_Get (int iAdapterIndex, int *lpNumberOfAncillaryDevices, ADLBdf **lppAncillaryDevices)
 This function gets ancillary GPUs. More...
 
int ADL_PowerXpress_Config_Caps (int iAdapterIndex, ADLPXConfigCaps *lpPXConfigCaps)
 This function gets the PowerXpress configuration Caps. More...
 
int ADL_PowerXpress_Scheme_Get (int iAdapterIndex, ADLPXScheme *lpPXSchemeRange, ADLPXScheme *lpPXSchemeCurrentState, ADLPXScheme *lpPXSchemeDefaultState)
 This function gets the PowerXpress scheme. More...
 
int ADL_PowerXpress_Scheme_Set (int iAdapterIndex, ADLPXScheme scheme)
 This function sets the PowerXpress scheme. More...
 

Detailed Description

This group outlines PowerXpress Related APIs.

Function Documentation

◆ ADL2_Display_PowerXpress_AutoSwitchConfig_Get()

int ADL2_Display_PowerXpress_AutoSwitchConfig_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpAutoSwitchOnACDCEvent,
int *  lpAutoSwitchOnDCACEvent 
)

Function to retrieve the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

This function retrieves the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

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]lpAutoSwitchOnACDCEventThe pointer to the switch configuration for ACDC. The returned value could be 0 or 1
[out]lpAutoSwitchOnDCACEventThe pointer to the switch configuration for DCAC. The returned value could be 0 or 1
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_PowerXpress_AutoSwitchConfig_Set()

int ADL2_Display_PowerXpress_AutoSwitchConfig_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iAutoSwitchOnACDCEvent,
int  iAutoSwitchOnDCACEvent 
)

Function to set the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

This function sets the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

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]iAutoSwitchOnACDCEventThe pointer to the value used to set the switch configuration for ACDC. Set value 0 or 1
[in]iAutoSwitchOnDCACEventThe pointer to the value used to set the switch configuration for DCAC. Set value 0 or 1
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_PowerXpressActiveGPU_Get()

int ADL2_Display_PowerXpressActiveGPU_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpActiveGPU 
)

Function to get the active GPU in PowerXpress.

This function retrieves the active GPU in PowerXpress.

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]lpActiveGPUThe pointer to the value storing the active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE
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_PowerXpressActiveGPU_Set()

int ADL2_Display_PowerXpressActiveGPU_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iActiveGPU,
int *  lpOperationResult 
)

Function to set the active GPU in PowerXpress.

This function sets the active GPU in PowerXpress.

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]iActiveGPUThe value of the desired active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE
[out]lpOperationResultThe pointer to the retrieved result of the operation.
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_PowerXpressVersion_Get()

int ADL2_Display_PowerXpressVersion_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpVersion 
)

Function to retrieve the PowerXpress version.

This function retrieves the PowerXpress version.

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]lpVersionThe pointer to the value storing the retrieved version.
Returns
If the system is PowerXpress capable, the function returns ADL_OK and lpVersion is always set to ADL_DL_POWERXPRESS_VERSION
If the system is not PowerXpress capable, the function returns a value different from ADL_OK
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_PowerXpress_AncillaryDevices_Get()

int ADL2_PowerXpress_AncillaryDevices_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumberOfAncillaryDevices,
ADLBdf **  lppAncillaryDevices 
)

This function gets ancillary GPUs.

In Power Express configuration system, the master GPU(Integrated GPU) can have several linked GPU which can be removed by the driver. These removable GPU are called ancillary devices. They are usually discrete GPUs in Power Express system

Supported Platforms:
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]lpNumberOfAncillaryDevicesPointer to a variable that indicates the number of ancillary devices.
[out]lppRemovableDevicesPointer of a pointer to a variable with type ADLBdf, which contains a list of ancillary devices .
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_PowerXpress_Config_Caps()

int ADL2_PowerXpress_Config_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLPXConfigCaps lpPXConfigCaps 
)

This function gets the PowerXpress configuration Caps.

This function gets the PowerXpress configuration Caps.

Supported Platforms:
Windows 7; 32bit and 64bit 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]lpPXConfigCapsThe pointer to the PowerXpress config Caps returned: ADLPXConfigCaps
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_PowerXpress_Configuration_Get()

int ADL2_PowerXpress_Configuration_Get ( ADL_CONTEXT_HANDLE  context,
ADLPxType lpPxType,
ADLBdf lpIGPUBdf,
int *  lpNumberOfDGPUs,
ADLBdf **  lppDGPUBDFs 
)

This function gets PX configuration.

In Power Express configuration system, the master GPU(Integrated GPU) can have several linked GPUs

Supported Platforms:
Windows 7; 32bit and 64bitWindows 10; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]lpPxTypePointer to a variable that indicates the PX type ADLPxType
[out]lpIGPUBdfPointer to a variable that indicates the IGPU BDF ADLBdf
[out]lpNumberOfDGPUsPointer to a variable that indicates the number of DGPUs.
[out]lppDGPUBDFsPointer of a pointer to a variable with type ADLBdf, which contains a list of DGPUs .
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_PowerXpress_Scheme_Get()

int ADL2_PowerXpress_Scheme_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLPXScheme lpPXSchemeRange,
ADLPXScheme lpPXSchemeCurrentState,
ADLPXScheme lpPXSchemeDefaultState 
)

This function gets the PowerXpress scheme.

This function gets the PowerXpress scheme.

Supported Platforms:
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]lpPXSchemeRangeThe pointer to the scheme range to be returned: ADLPXScheme
[out]lpPXSchemeCurrentStateThe pointer to the current scheme to be returned: ADLPXScheme
[out]lpPXSchemeDefaultStateThe pointer to the default scheme to be returned: ADLPXScheme
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_PowerXpress_Scheme_Set()

int ADL2_PowerXpress_Scheme_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLPXScheme  scheme 
)

This function sets the PowerXpress scheme.

This function sets the PowerXpress scheme.

Supported Platforms:
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.
[in]schemeThe PX scheme to set: ADLPXScheme
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_SwitchableGraphics_Applications_Get()

int ADL2_SwitchableGraphics_Applications_Get ( ADL_CONTEXT_HANDLE  context,
int  iListType,
int *  lpNumApps,
ADLSGApplicationInfo **  lppAppList 
)

ADL local interface. Function to get all the recently ran and currently running applications.

The function is used to get all the recently ran and currently running applications in any PX/HG/DG platform

Supported Platforms:
\WINBlue
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iListTypeThe type of applications to be retrieved. It can be either 1(currently running applications) or 2(recently ran applications)
[out]lpNumAppsThe pointer to the number of applications currently retrieved based on the iListType passed
[out]lppAppListpointer to the pointer of ADLSGApplicationInfo array containing details of each application retrieved. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function.
Supported Platforms:
Linux and Windows(XP, Vista and above); 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

◆ ADL2_Win_IsHybridAI()

int ADL2_Win_IsHybridAI ( ADL_CONTEXT_HANDLE  context)

ADL local interface. Function to get Hybrid Discrete graphics support.

The function is used to get if the windows has inbuilt support for Hybrid Discrete graphics, which implies A+I

Supported Platforms:
\WINBlue
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
Returns
TRUE: HybridDiscrete; FALSE: otherwise.
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_PowerXpress_AutoSwitchConfig_Get()

int ADL_Display_PowerXpress_AutoSwitchConfig_Get ( int  iAdapterIndex,
int *  lpAutoSwitchOnACDCEvent,
int *  lpAutoSwitchOnDCACEvent 
)

Function to retrieve the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

This function retrieves the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpAutoSwitchOnACDCEventThe pointer to the switch configuration for ACDC. The returned value could be 0 or 1
[out]lpAutoSwitchOnDCACEventThe pointer to the switch configuration for DCAC. The returned value could be 0 or 1
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_PowerXpress_AutoSwitchConfig_Set()

int ADL_Display_PowerXpress_AutoSwitchConfig_Set ( int  iAdapterIndex,
int  iAutoSwitchOnACDCEvent,
int  iAutoSwitchOnDCACEvent 
)

Function to set the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

This function sets the auto switch configuration setting for PowerXpress. This is not supported when DPPE state switching is configured.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iAutoSwitchOnACDCEventThe pointer to the value used to set the switch configuration for ACDC. Set value 0 or 1
[in]iAutoSwitchOnDCACEventThe pointer to the value used to set the switch configuration for DCAC. Set value 0 or 1
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_PowerXpressActiveGPU_Get()

int ADL_Display_PowerXpressActiveGPU_Get ( int  iAdapterIndex,
int *  lpActiveGPU 
)

Function to get the active GPU in PowerXpress.

This function retrieves the active GPU in PowerXpress.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpActiveGPUThe pointer to the value storing the active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_PowerXpressActiveGPU_Set()

int ADL_Display_PowerXpressActiveGPU_Set ( int  iAdapterIndex,
int  iActiveGPU,
int *  lpOperationResult 
)

Function to set the active GPU in PowerXpress.

This function sets the active GPU in PowerXpress.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iActiveGPUThe value of the desired active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE
[out]lpOperationResultThe pointer to the retrieved result of the operation.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_PowerXpressVersion_Get()

int ADL_Display_PowerXpressVersion_Get ( int  iAdapterIndex,
int *  lpVersion 
)

Function to retrieve the PowerXpress version.

This function retrieves the PowerXpress version.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpVersionThe pointer to the value storing the retrieved version.
Returns
If the system is PowerXpress capable, the function returns ADL_OK and lpVersion is always set to ADL_DL_POWERXPRESS_VERSION
If the system is not PowerXpress capable, the function returns a value different from ADL_OK

◆ ADL_PowerXpress_AncillaryDevices_Get()

int ADL_PowerXpress_AncillaryDevices_Get ( int  iAdapterIndex,
int *  lpNumberOfAncillaryDevices,
ADLBdf **  lppAncillaryDevices 
)

This function gets ancillary GPUs.

In Power Express configuration system, the master GPU(Integrated GPU) can have several linked GPU which can be removed by the driver. These removable GPU are called ancillary devices. They are usually discrete GPUs in Power Express system

Supported Platforms:
Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpNumberOfAncillaryDevicesPointer to a variable that indicates the number of ancillary devices.
[out]lppRemovableDevicesPointer of a pointer to a variable with type ADLBdf, which contains a list of ancillary devices .
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_PowerXpress_Config_Caps()

int ADL_PowerXpress_Config_Caps ( int  iAdapterIndex,
ADLPXConfigCaps lpPXConfigCaps 
)

This function gets the PowerXpress configuration Caps.

This function gets the PowerXpress configuration Caps.

Supported Platforms:
Windows 7; 32bit and 64bit Linux; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpPXConfigCapsThe pointer to the PowerXpress config Caps returned: ADLPXConfigCaps
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_PowerXpress_Scheme_Get()

int ADL_PowerXpress_Scheme_Get ( int  iAdapterIndex,
ADLPXScheme lpPXSchemeRange,
ADLPXScheme lpPXSchemeCurrentState,
ADLPXScheme lpPXSchemeDefaultState 
)

This function gets the PowerXpress scheme.

This function gets the PowerXpress scheme.

Supported Platforms:
Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpPXSchemeRangeThe pointer to the scheme range to be returned: ADLPXScheme
[out]lpPXSchemeCurrentStateThe pointer to the current scheme to be returned: ADLPXScheme
[out]lpPXSchemeDefaultStateThe pointer to the default scheme to be returned: ADLPXScheme
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_PowerXpress_Scheme_Set()

int ADL_PowerXpress_Scheme_Set ( int  iAdapterIndex,
ADLPXScheme  scheme 
)

This function sets the PowerXpress scheme.

This function sets the PowerXpress scheme.

Supported Platforms:
Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]schemeThe PX scheme to set: ADLPXScheme
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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