ADL (AMD Display Library) Public APIs
Version 17.1
|
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... | |
This group outlines PowerXpress Related APIs.
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.
[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] | lpAutoSwitchOnACDCEvent | The pointer to the switch configuration for ACDC. The returned value could be 0 or 1 |
[out] | lpAutoSwitchOnDCACEvent | The pointer to the switch configuration for DCAC. The returned value could be 0 or 1 |
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.
[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] | iAutoSwitchOnACDCEvent | The pointer to the value used to set the switch configuration for ACDC. Set value 0 or 1 |
[in] | iAutoSwitchOnDCACEvent | The pointer to the value used to set the switch configuration for DCAC. Set value 0 or 1 |
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.
[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] | lpActiveGPU | The pointer to the value storing the active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE |
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.
[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] | iActiveGPU | The value of the desired active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE |
[out] | lpOperationResult | The pointer to the retrieved result of the operation. |
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.
[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] | lpVersion | The pointer to the value storing the retrieved version. |
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
[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] | lpNumberOfAncillaryDevices | Pointer to a variable that indicates the number of ancillary devices. |
[out] | lppRemovableDevices | Pointer of a pointer to a variable with type ADLBdf, which contains a list of ancillary devices . |
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.
[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] | lpPXConfigCaps | The pointer to the PowerXpress config Caps returned: ADLPXConfigCaps |
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
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lpPxType | Pointer to a variable that indicates the PX type ADLPxType |
[out] | lpIGPUBdf | Pointer to a variable that indicates the IGPU BDF ADLBdf |
[out] | lpNumberOfDGPUs | Pointer to a variable that indicates the number of DGPUs. |
[out] | lppDGPUBDFs | Pointer of a pointer to a variable with type ADLBdf, which contains a list of DGPUs . |
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.
[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] | lpPXSchemeRange | The pointer to the scheme range to be returned: ADLPXScheme |
[out] | lpPXSchemeCurrentState | The pointer to the current scheme to be returned: ADLPXScheme |
[out] | lpPXSchemeDefaultState | The pointer to the default scheme to be returned: ADLPXScheme |
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.
[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] | scheme | The PX scheme to set: ADLPXScheme |
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
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iListType | The type of applications to be retrieved. It can be either 1(currently running applications) or 2(recently ran applications) |
[out] | lpNumApps | The pointer to the number of applications currently retrieved based on the iListType passed |
[out] | lppAppList | pointer 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. |
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
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
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.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpAutoSwitchOnACDCEvent | The pointer to the switch configuration for ACDC. The returned value could be 0 or 1 |
[out] | lpAutoSwitchOnDCACEvent | The pointer to the switch configuration for DCAC. The returned value could be 0 or 1 |
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.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iAutoSwitchOnACDCEvent | The pointer to the value used to set the switch configuration for ACDC. Set value 0 or 1 |
[in] | iAutoSwitchOnDCACEvent | The pointer to the value used to set the switch configuration for DCAC. Set value 0 or 1 |
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.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpActiveGPU | The pointer to the value storing the active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE |
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.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iActiveGPU | The value of the desired active GPU in PowerXpress: ADL_DL_POWERXPRESS_GPU_INTEGRATED or ADL_DL_POWERXPRESS_GPU_DISCRETE |
[out] | lpOperationResult | The pointer to the retrieved result of the operation. |
int ADL_Display_PowerXpressVersion_Get | ( | int | iAdapterIndex, |
int * | lpVersion | ||
) |
Function to retrieve the PowerXpress version.
This function retrieves the PowerXpress version.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpVersion | The pointer to the value storing the retrieved version. |
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
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpNumberOfAncillaryDevices | Pointer to a variable that indicates the number of ancillary devices. |
[out] | lppRemovableDevices | Pointer of a pointer to a variable with type ADLBdf, which contains a list of ancillary devices . |
int ADL_PowerXpress_Config_Caps | ( | int | iAdapterIndex, |
ADLPXConfigCaps * | lpPXConfigCaps | ||
) |
This function gets the PowerXpress configuration Caps.
This function gets the PowerXpress configuration Caps.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpPXConfigCaps | The pointer to the PowerXpress config Caps returned: ADLPXConfigCaps |
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.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpPXSchemeRange | The pointer to the scheme range to be returned: ADLPXScheme |
[out] | lpPXSchemeCurrentState | The pointer to the current scheme to be returned: ADLPXScheme |
[out] | lpPXSchemeDefaultState | The pointer to the default scheme to be returned: ADLPXScheme |
int ADL_PowerXpress_Scheme_Set | ( | int | iAdapterIndex, |
ADLPXScheme | scheme | ||
) |
This function sets the PowerXpress scheme.
This function sets the PowerXpress scheme.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | scheme | The PX scheme to set: ADLPXScheme |