ADL (AMD Display Library) Public APIs
Version 17.1
|
This group outlines Graphics version and architechture specific APIs. More...
Functions | |
int | ADL2_Adapter_Accessibility_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAccessibility) |
Function to check if the GPU is accessible or not at the time of this call. More... | |
int | ADL2_Adapter_AceDefaults_Restore (ADL_CONTEXT_HANDLE context, int iAdapterIndex) |
int | ADL2_Adapter_Active_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpStatus) |
Function to determine if the adapter is active or not. More... | |
int | ADL2_Adapter_Active_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iStatus, int *lpNewlyActivate) |
Function to set the current extended desktop mode status for a display. More... | |
int | ADL2_Adapter_Active_SetPrefer (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iStatus, int iNumPreferTarget, ADLDisplayTarget *lpPreferTarget, int *lpNewlyActivate) |
Function to set the current extended desktop mode status for the display. More... | |
int | ADL2_Adapter_AdapterInfo_Get (ADL_CONTEXT_HANDLE context, LPAdapterInfo lpInfo, int iInputSize) |
Retrieves all OS-known adapter information. More... | |
int | ADL2_Adapter_AdapterInfoX2_Get (ADL_CONTEXT_HANDLE context, AdapterInfo **lppAdapterInfo) |
Retrieves all OS-known adapter information. More... | |
int | ADL2_Adapter_AdapterInfoX3_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *numAdapters, AdapterInfo **lppAdapterInfo) |
int | ADL2_Adapter_AdapterInfoX4_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *numAdapters, AdapterInfoX2 **lppAdapterInfoX2) |
int | ADL2_Adapter_AdapterList_Disable (ADL_CONTEXT_HANDLE context, int iNumAdapters, int *lpAdapterIndexList, bool isSkipSaveDB=false) |
int | ADL2_Adapter_ASICFamilyType_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAsicTypes, int *lpValids) |
Function to get the ASICFamilyType from the adapter. More... | |
int | ADL2_Adapter_Aspects_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, char *lpAspects, int iSize) |
ADL local interface. Function to retrieve the supported aspects list. More... | |
int | ADL2_Adapter_BigSw_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpBigSwSupportMajor, int *lpBigSwSupportMinor, int *lpRedStoneSupport) |
int | ADL2_Adapter_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCaps *adapterCaps) |
int | ADL2_Adapter_ChipSetInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLChipSetInfo *lpChipSetInfo) |
int | ADL2_Adapter_DedicatedVRAMUsage_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVRAMUsageInMB) |
int | ADL2_Adapter_Feature_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int *iIsFeatureSupported) |
int | ADL2_Adapter_HBC_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpHbcCapable) |
int | ADL2_Adapter_Headless_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpHeadless) |
int | ADL2_Adapter_ID_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterID) |
Function to get the unique identifier of an adapter. More... | |
int | ADL2_Adapter_IsGamingDriver_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCwgSupport, int *lpIsGamingMode) |
int | ADL2_Adapter_LED_Support_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion) |
int | ADL2_Adapter_MemoryInfo2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfo2 *lpMemoryInfo2) |
int | ADL2_Adapter_MemoryInfoX4_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfoX4 *lpMemoryInfoX4) |
int | ADL2_Adapter_Modes_ReEnumerate (ADL_CONTEXT_HANDLE context) |
int | ADL2_Adapter_ModeSwitch (ADL_CONTEXT_HANDLE context, int iAdapterIndex) |
Function to perform a mode switch for an adapter. More... | |
int | ADL2_Adapter_NumberOfAdapters_Get (ADL_CONTEXT_HANDLE context, int *lpNumAdapters) |
Function to retrieve the number of OS-known adapters. More... | |
int | ADL2_Adapter_ObservedClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCoreClock, int *lpMemoryClock) |
Function to get the core and memory clock info of an adapter. This is the clock displayed on CCC information center. Specific logic is used to select appropriate clock for display in current configuration. More... | |
int | ADL2_Adapter_Primary_Get (ADL_CONTEXT_HANDLE context, int *lpPrimaryAdapterIndex) |
Function to retrieve the primary display adapter index. More... | |
int | ADL2_Adapter_Primary_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex) |
Function to set the primary display adapter index. More... | |
int | ADL2_Adapter_RegValueInt_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int *lpKeyValue) |
ADL local interface. Function to query a integer registry value set by driver. More... | |
int | ADL2_Adapter_RegValueInt_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iKeyValue) |
ADL local interface. Function to set a driver registry integer value. More... | |
int | ADL2_Adapter_RegValueString_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue) |
ADL local interface. Function to query a string registry value set by driver. More... | |
int | ADL2_Adapter_RegValueString_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue) |
ADL local interface. Function to set a driver registry string value. More... | |
int | ADL2_Adapter_Speed_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCaps, int *lpValid) |
Function to get the current Force3DClock setting from the adapter. More... | |
int | ADL2_Adapter_Speed_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCurrent, int *lpDefault) |
Function to get the current Speed setting from the adapter. More... | |
int | ADL2_Adapter_Speed_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSpeed) |
Function to set the current Speed setting from the adapter. More... | |
int | ADL2_Adapter_TRNG_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iTRNGSize, int iTRNGBufferSize, char *lpTRNGBuffer) |
int | ADL2_Adapter_VerndorID_Int_get (ADL_CONTEXT_HANDLE context, int iAdapterIndex) |
Retrieves adapter vendor id. More... | |
int | ADL2_Adapter_VideoBiosInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLBiosInfo *lpBiosInfo) |
ADL local interface. Function to retrieve BIOS information. More... | |
int | ADL2_Adapter_VRAMUsage_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVRAMUsageInMB) |
int | ADL2_AdapterX2_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps) |
Function to retrieve adapter caps information. More... | |
int | ADL2_Feature_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int *iCurrent) |
int | ADL2_Feature_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int iCurrent) |
int | ADL2_Flush_Driver_Data (ADL_CONTEXT_HANDLE context, int iAdapterIndex) |
Function to save driver data. More... | |
int | ADL2_GcnAsicInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLGcnInfo *gcnInfo) |
int | ADL2_GPUVMPageSize_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVMPageSizeSupport, int *iVMPageSizeType) |
int | ADL2_GPUVMPageSize_Info_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iVMPageSizeType) |
int | ADL2_SmartShift_DeltaGain_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iMode, int iValue) |
int | ADL2_SmartShift_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLSmartShiftSettings *lpCurrent) |
int | ADL2_SmartShift_Support (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpVersion) |
int | ADL2_Stress_Test_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion) |
int | ADL2_Throttle_Notification_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion) |
int | ADL_Adapter_Accessibility_Get (int iAdapterIndex, int *lpAccessibility) |
Function to check if the GPU is accessible or not at the time of this call. More... | |
int | ADL_Adapter_Active_Get (int iAdapterIndex, int *lpStatus) |
Function to determine if the adapter is active or not. More... | |
int | ADL_Adapter_Active_Set (int iAdapterIndex, int iStatus, int *lpNewlyActivate) |
Function to set the current extended desktop mode status for a display. More... | |
int | ADL_Adapter_Active_SetPrefer (int iAdapterIndex, int iStatus, int iNumPreferTarget, ADLDisplayTarget *lpPreferTarget, int *lpNewlyActivate) |
Function to set the current extended desktop mode status for the display. More... | |
int | ADL_Adapter_AdapterInfo_Get (LPAdapterInfo lpInfo, int iInputSize) |
Retrieves all OS-known adapter information. More... | |
int | ADL_Adapter_AdapterInfoX2_Get (AdapterInfo **lppAdapterInfo) |
Retrieves all OS-known adapter information. More... | |
int | ADL_Adapter_AdapterList_Disable (int iNumAdapters, int *lpAdapterIndexList) |
int | ADL_Adapter_ASICFamilyType_Get (int iAdapterIndex, int *lpAsicTypes, int *lpValids) |
Function to get the ASICFamilyType from the adapter. More... | |
int | ADL_Adapter_Aspects_Get (int iAdapterIndex, char *lpAspects, int iSize) |
ADL local interface. Function to retrieve the supported aspects list. More... | |
int | ADL_Adapter_BigSw_Info_Get (int iAdapterIndex, int *lpBigSwSupportMajor, int *lpBigSwSupportMinor, int *lpRedStoneSupport) |
int | ADL_Adapter_Caps (int iAdapterIndex, ADLAdapterCaps *adapterCaps) |
int | ADL_Adapter_ChipSetInfo_Get (int iAdapterIndex, ADLChipSetInfo *lpChipSetInfo) |
int | ADL_Adapter_ID_Get (int iAdapterIndex, int *lpAdapterID) |
Function to get the unique identifier of an adapter. More... | |
int | ADL_Adapter_MemoryInfo2_Get (int iAdapterIndex, ADLMemoryInfo2 *lpMemoryInfo2) |
int | ADL_Adapter_Modes_ReEnumerate () |
int | ADL_Adapter_ModeSwitch (int iAdapterIndex) |
Function to perform a mode switch for an adapter. More... | |
int | ADL_Adapter_NumberOfAdapters_Get (int *lpNumAdapters) |
Function to retrieve the number of OS-known adapters. More... | |
int | ADL_Adapter_ObservedClockInfo_Get (int iAdapterIndex, int *lpCoreClock, int *lpMemoryClock) |
Function to get the core and memory clock info of an adapter. This is the clock displayed on CCC information center. Specific logic is used to select appropriate clock for display in current configuration. More... | |
int | ADL_Adapter_ObservedGameClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpBaseClock, int *lpGameClock, int *lpBoostClock, int *lpMemoryClock) |
Function to get the base, game, boost and memory clock info of an adapter. Specific logic is used to select appropriate clock for display in current configuration. More... | |
int | ADL_Adapter_Primary_Get (int *lpPrimaryAdapterIndex) |
Function to retrieve the primary display adapter index. More... | |
int | ADL_Adapter_Primary_Set (int iAdapterIndex) |
Function to set the primary display adapter index. More... | |
int | ADL_Adapter_RegValueInt_Get (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int *lpKeyValue) |
ADL local interface. Function to query a integer registry value set by driver. More... | |
int | ADL_Adapter_RegValueInt_Set (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iKeyValue) |
ADL local interface. Function to set a driver registry integer value. More... | |
int | ADL_Adapter_RegValueString_Get (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue) |
ADL local interface. Function to query a string registry value set by driver. More... | |
int | ADL_Adapter_RegValueString_Set (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue) |
ADL local interface. Function to set a driver registry string value. More... | |
int | ADL_Adapter_Speed_Caps (int iAdapterIndex, int *lpCaps, int *lpValid) |
Function to get the current Force3DClock setting from the adapter. More... | |
int | ADL_Adapter_Speed_Get (int iAdapterIndex, int *lpCurrent, int *lpDefault) |
Function to get the current Speed setting from the adapter. More... | |
int | ADL_Adapter_Speed_Set (int iAdapterIndex, int iSpeed) |
Function to set the current Speed setting from the adapter. More... | |
int | ADL_Adapter_VideoBiosInfo_Get (int iAdapterIndex, ADLBiosInfo *lpBiosInfo) |
ADL local interface. Function to retrieve BIOS information. More... | |
int | ADL_AdapterX2_Caps (int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps) |
Function to retrieve adapter caps information. More... | |
int | ADL_Flush_Driver_Data (int iAdapterIndex) |
Function to save driver data. More... | |
This group outlines Graphics version and architechture specific APIs.
int ADL2_Adapter_Accessibility_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpAccessibility | ||
) |
Function to check if the GPU is accessible or not at the time of this call.
Some GPUs enter into various power savings mode when not in use, and during this time, direct access to the GPU can result in failures. Access through proper channels (such as via ADL) always works because the software accounts for the GPU's accessibility. However, direct access outside of authorised mechanisms may fail. Use this API to find out if the GPU is currently accessible or not. If API returns GPU accessible, this status will be maintained for 2 seconds.
[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] | lpAccessibility | The pointer to an int value which indicates if the adapter is accessible or not (ADL_TRUE : Accessible, ADL_FALSE : Not accessible) |
int ADL2_Adapter_AceDefaults_Restore | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex | ||
) |
This function restores the ACE INF registry defaults.
[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. |
int ADL2_Adapter_Active_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpStatus | ||
) |
Function to determine if the adapter is active or not.
The function is used to check if the adapter associated with iAdapterIndex is active which has enabled desktop mapped on it.
[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] | lpStatus | The pointer to the retrieved status. ADL_TRUE : Active; ADL_FALSE : Disabled. |
int ADL2_Adapter_Active_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iStatus, | ||
int * | lpNewlyActivate | ||
) |
Function to set the current extended desktop mode status for a display.
This function enables or disables extended desktop mode for a specified display.
[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] | iStatus | The desired display extended desktop mode status. ADL_TRUE : extended desktop mode; ADL_FALSE : otherwise. |
[out] | lpNewlyActivate | The pointer to the retrieved adapter activation information. ADL_TRUE : the adapter is activated for the first time; ADL_FALSE : otherwise. |
int ADL2_Adapter_Active_SetPrefer | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iStatus, | ||
int | iNumPreferTarget, | ||
ADLDisplayTarget * | lpPreferTarget, | ||
int * | lpNewlyActivate | ||
) |
Function to set the current extended desktop mode status for the display.
This function enables or disables the input adapter for a specified display. In addition, this function allows the user to enable the input adapter and pass in the preferred targets.
[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] | iStatus | The desired display extended desktop mode status. ADL_TRUE : extended desktop mode; ADL_FALSE : otherwise. |
[in] | iNumPreferTarget | If iStatus is TRUE, the user can pass the size of preferred Display Targets array. |
[in] | lpPreferTarget | If iStatus is TRUE, the user can pass the preferred Display Targets array to be enabled (with targets cloned). |
[out] | lpNewlyActivate | The pointer to the retrieved adapter activation information. ADL_TRUE : the adapter is activated for the first time; ADL_FALSE : otherwise. |
int ADL2_Adapter_AdapterInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
LPAdapterInfo | lpInfo, | ||
int | iInputSize | ||
) |
Retrieves all OS-known adapter information.
This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iInputSize | The size of the lpInfo buffer. |
[out] | lpInfo | The pointer to the buffer containing the retrieved adapter information. |
int ADL2_Adapter_AdapterInfoX2_Get | ( | ADL_CONTEXT_HANDLE | context, |
AdapterInfo ** | lppAdapterInfo | ||
) |
Retrieves all OS-known adapter information.
This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lppAdapterInfo | is pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function. |
int ADL2_Adapter_AdapterInfoX3_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | numAdapters, | ||
AdapterInfo ** | lppAdapterInfo | ||
) |
This function retrieves information for passed adapter or if pass -1, information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[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 or -1 if all adapters are desired |
[out] | number | of items in the lppAdapterInfo array. Can pass NULL pointer if passign an adapter index (in which case only one AdapterInfo is returned) |
[out] | lppAdapterInfo | pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function. |
int ADL2_Adapter_AdapterInfoX4_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | numAdapters, | ||
AdapterInfoX2 ** | lppAdapterInfoX2 | ||
) |
This function retrieves information for passed adapter or if pass -1, information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[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 or -1 if all adapters are desired |
[out] | number | of items in the lppAdapterInfo array. Can pass NULL pointer if passing an adapter index (in which case only one AdapterInfo is returned) |
[out] | lppAdapterInfoX2 | pointer to the pointer of AdapterInfoX2 array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function. |
int ADL2_Adapter_AdapterList_Disable | ( | ADL_CONTEXT_HANDLE | context, |
int | iNumAdapters, | ||
int * | lpAdapterIndexList, | ||
bool | isSkipSaveDB = false |
||
) |
This function disable multiple adapters in one CCD call for Win7 and later in order to improve the performace. the fucntion will fail if the current primary adapter is in the disabled adapter list
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iNumAdapters | An integer indicates the number of desktops to be disabled. |
[in] | lpAdapterIndexList | The pointer to the integer array that contains the list of logicl adapter indexes to be disabled |
[in] | isSkipSaveDB | A bool flag to indicate a temporary Display config setting (no SDC_SAVE_TO_DATABASE) |
int ADL2_Adapter_ASICFamilyType_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpAsicTypes, | ||
int * | lpValids | ||
) |
Function to get the ASICFamilyType from the adapter.
This function retrieves the ASIC family types for a specified adapter.
[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] | lpAsicTypes | The pointer to the Detailed asic types information retrieved from the driver. |
[out] | lpValids | The pointer to the bit vector indicating which bit is valid on the lpAsicTypes returned. |
int ADL2_Adapter_Aspects_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
char * | lpAspects, | ||
int | iSize | ||
) |
ADL local interface. Function to retrieve the supported aspects list.
This function retrieves the list of supported aspects for a specified adapter.
[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] | lpAspects | The pointer to the buffer storing the list of aspects supported for the specified adapter. |
[in] | iSize | The size of the lpAspects buffer. |
int ADL2_Adapter_BigSw_Info_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpBigSwSupportMajor, | ||
int * | lpBigSwSupportMinor, | ||
int * | lpRedStoneSupport | ||
) |
This function retrieves the Big Software & Red Stone support information for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lpBigSwSupportMajor | The pointer to the Big Software major version information retrieved from the driver. Detailed asic types |
[out] | lpBigSwSupportMinor | The pointer to the Big Software minor version information retrieved from the driver. Detailed asic types |
[out] | lpRedStoneSupport | The pointer to the Red Stone support information retrieved from the driver. |
int ADL2_Adapter_Caps | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLAdapterCaps * | adapterCaps | ||
) |
This function implements a DI call to retrieve adapter capability information .
[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] | adapterCaps | The pointer to the structure storing the retrieved adapter capability information. |
int ADL2_Adapter_ChipSetInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLChipSetInfo * | lpChipSetInfo | ||
) |
This function retrieves the chipset information for a specified adapter.
[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] | lpChipSetInfo | The pointer to the structure storing the retrieved chipset information. |
int ADL2_Adapter_DedicatedVRAMUsage_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iVRAMUsageInMB | ||
) |
This function retrieves the Dedicated VRAM usage of given adapter
The function is used to get Dedicated VRAM usge by calling MS Counter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iAdapterIndex | The index of the desired adapter. |
[in] | iVRAMUsageInMB | The pointer to an int variable retrives the current usage of VRAM. |
int ADL2_Adapter_Feature_Caps | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADL_UIFEATURES_GROUP | iFeatureID, | ||
int * | iIsFeatureSupported | ||
) |
Checks if given GPU (identified by adapter id) supports feature (iFeatureID) or not.
[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] | iFeatureID | The Feature index of the desired feature. ADL_UIFEATURES_GROUP |
[out] | iIsFeatureSupported | The pointer to the structure storing the retrieved adapter capability information. |
int ADL2_Adapter_HBC_Caps | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpHbcCapable | ||
) |
This function retrieves the HBC Capability for a specified graphics adapter.
[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] | lpHbcCapable | : Will be set to 1 to indicate that given GPU supports HBC. |
int ADL2_Adapter_Headless_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpHeadless | ||
) |
This function implements private adapter info to retrieve the configuration state of a specified adapter.
[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] | lpHeadless | Integer indicating the state of the adapter. |
int ADL2_Adapter_ID_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpAdapterID | ||
) |
Function to get the unique identifier of an adapter.
This function retrieves the unique identifier of a specified adapter.
The adapter ID is a unique value and will be used to determine what other controllers share the same adapter.
The desktop will use this to find which HDCs are associated with an adapter.
[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] | lpAdapterID | The pointer to the adapter identifier. Zero means: The adapter is not AMD. |
int ADL2_Adapter_IsGamingDriver_Info_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpCwgSupport, | ||
int * | lpIsGamingMode | ||
) |
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lpCwgSupport | Will be set to 1 to indicate that given GPU supports CWG. Detailed asic types |
[out] | lpIsGamingMode | Will be set to 1 to indicate that given GPU supports Gaming Mode. Detailed asic types |
int ADL2_Adapter_LED_Support_Cap | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iSupported, | ||
int * | iEnabled, | ||
int * | iVersion | ||
) |
This function retrieves current status of LED supported for a specified adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iSupported | The pointer to an int variable which indicates if LED is supported ( ADL_TRUE : supported, ADL_FALSE : not supported) |
[in] | iEnabled | The pointer to an int variable which indicates if LED is enabled ( ADL_TRUE : enabled, ADL_FALSE : disabled) |
[in] | iVersion | The pointer to an int variable receiving the LED feature version. |
int ADL2_Adapter_MemoryInfo2_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLMemoryInfo2 * | lpMemoryInfo2 | ||
) |
This function retrieves the memory information for a specified graphics adapter.
[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] | lpMemoryInfo2 | The pointer to the structure storing the retrieved memory information. |
int ADL2_Adapter_MemoryInfoX4_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLMemoryInfoX4 * | lpMemoryInfoX4 | ||
) |
This function retrieves the memory information for a specified graphics adapter.
[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] | lpMemoryInfoX4 | The pointer to the structure storing the retrieved memory information. |
int ADL2_Adapter_Modes_ReEnumerate | ( | ADL_CONTEXT_HANDLE | context | ) |
This function re-enumerates adapter modes
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
int ADL2_Adapter_ModeSwitch | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex | ||
) |
Function to perform a mode switch for an adapter.
This function performs a mode switch for a specified adapter.
[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. |
int ADL2_Adapter_NumberOfAdapters_Get | ( | ADL_CONTEXT_HANDLE | context, |
int * | lpNumAdapters | ||
) |
Function to retrieve the number of OS-known adapters.
This function retrieves the number of graphics adapters recognized by the OS (OS-known adapters). OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that no longer present in the system but are still recognized by the OS.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lpNumAdapters | The pointer to the number of OS-known adapters. |
int ADL2_Adapter_ObservedClockInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpCoreClock, | ||
int * | lpMemoryClock | ||
) |
Function to get the core and memory clock info of an adapter. This is the clock displayed on CCC information center. Specific logic is used to select appropriate clock for display in current configuration.
This function retrieves the core and memory clock of an adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] |
int ADL2_Adapter_Primary_Get | ( | ADL_CONTEXT_HANDLE | context, |
int * | lpPrimaryAdapterIndex | ||
) |
Function to retrieve the primary display adapter index.
This function retrieves the adapter index for the primary display adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[out] | lpPrimaryAdapterIndex | The pointer to the ADL index handle of the primary adapter. |
int ADL2_Adapter_Primary_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex | ||
) |
Function to set the primary display adapter index.
This function sets the adapter index for a specified primary display adapter.
[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. |
int ADL2_Adapter_RegValueInt_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int * | lpKeyValue | ||
) |
ADL local interface. Function to query a integer registry value set by driver.
This function queries a driver registry integer value for a specified adapter by specifying the subkey path and key name.
[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] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry subkey to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be got. This is a null terminated string. |
[out] | lpKeyValue | The pointer to registry value to be got. |
int ADL2_Adapter_RegValueInt_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iKeyValue | ||
) |
ADL local interface. Function to set a driver registry integer value.
This function sets a driver registry integer value for a specified adapter by specifying the subkey path and key name.
[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] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry subkey to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be set. This is a null terminated string. |
[in] | iKeyValue | The integer registry value to be set. |
int ADL2_Adapter_RegValueString_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iSize, | ||
char * | lpKeyValue | ||
) |
ADL local interface. Function to query a string registry value set by driver.
This function queries a driver registry string value for a specified adapter by specifying the subkey path and key name.
[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] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be got. This is a null terminated string. |
[in] | iSize | The size of registry value to be got. |
[out] | lpKeyValue | The pointer to registry value to be got. |
int ADL2_Adapter_RegValueString_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iSize, | ||
char * | lpKeyValue | ||
) |
ADL local interface. Function to set a driver registry string value.
This function sets a driver registry string value for a specified adapter by specifying the subkey path and key name.
[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] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be set. This is a null terminated string. |
[in] | iSize | The size of registry value to be set. |
[in] | lpKeyValue | The pointer to registry value to be set. |
int ADL2_Adapter_Speed_Caps | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpCaps, | ||
int * | lpValid | ||
) |
Function to get the current Force3DClock setting from the adapter.
This function retrieves the adapter speed information for a specified adapter. Return valud can be ADL_ADAPTER_SPEEDCAPS_SUPPORTED or “0”
[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] | lpCaps | The caps of adapter speed settings |
[out] | lpValid | The valid bits of adapter speed settings |
int ADL2_Adapter_Speed_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpCurrent, | ||
int * | lpDefault | ||
) |
Function to get the current Speed setting from the adapter.
This function retrieves the adapter speed information for a specified adapter. Return value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH
[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] | lpCurrent | The current speed setting |
[out] | lpDefault | The default speed setting |
int ADL2_Adapter_Speed_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iSpeed | ||
) |
Function to set the current Speed setting from the adapter.
This function set the adapter speed information for a specified adapter. Input value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH
[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] | iSpeed | The speed to set on specified adapter |
int ADL2_Adapter_TRNG_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iTRNGSize, | ||
int | iTRNGBufferSize, | ||
char * | lpTRNGBuffer | ||
) |
This function implements a lhEscape call to retrieve TRGN from hardware .
[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] | iTRNGSize | size of the requested TRNG |
[in] | iTRNGBufferSize | size of the trngBuffer |
[out] | trngBuffer | The pointer where TRNG value is stored, buffer should be allocated at client side |
int ADL2_Adapter_VerndorID_Int_get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex | ||
) |
Retrieves adapter vendor id.
This function retrieves the parsed hex vendor id
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
int ADL2_Adapter_VideoBiosInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLBiosInfo * | lpBiosInfo | ||
) |
ADL local interface. Function to retrieve BIOS information.
This function retrieves the BIOS information for a specified adapter.
[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] | lpBiosInfo | The pointer to the structure storing the retrieved BIOs information. |
int ADL2_Adapter_VRAMUsage_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iVRAMUsageInMB | ||
) |
This function retrieves the VRAM usage of given adapter
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iAdapterIndex | The index of the desired adapter. |
[in] | iVRAMUsageInMB | The pointer to an int variable retrives the current usage of VRAM. |
int ADL2_AdapterX2_Caps | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLAdapterCapsX2 * | adapterCaps | ||
) |
Function to retrieve adapter caps information.
This function implements a DI call to retrieve adapter capability information .
[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] | adapterCaps | The pointer to the structure storing the retrieved adapter capability information. |
int ADL2_Feature_Settings_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADL_UIFEATURES_GROUP | iFeatureID, | ||
int * | iCurrent | ||
) |
provides the current value of the given feature
[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] | iFeatureID | The Feature index of the desired feature. ADL_UIFEATURES_GROUP |
[out] | iCurrent | The pointer to the structure storing the retrieved feature current value. |
int ADL2_Feature_Settings_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADL_UIFEATURES_GROUP | iFeatureID, | ||
int | iCurrent | ||
) |
sets the current value to the given adapter
[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] | iFeatureID | The Feature index of the desired feature. ADL_UIFEATURES_GROUP |
[in] | iCurrent | The pointer to the feature current value |
int ADL2_Flush_Driver_Data | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex | ||
) |
Function to save driver data.
This function saves all required data from driver to persist updated settings
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iAdapterIndex | The adapter index to be flushed. |
int ADL2_GcnAsicInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLGcnInfo * | gcnInfo | ||
) |
[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. The adapter identifies the ASIC that the information will be returned for. |
[out] | gcnInfo | The ADL structure that contains information about components of ASIC GCN architecture. |
int ADL2_GPUVMPageSize_Info_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iVMPageSizeSupport, | ||
int * | iVMPageSizeType | ||
) |
This function retrieves the GPU VM PageSize info for a specified adapter.
[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] | iVMPageSizeSupport | 1 for supported and 0 for unsupported |
[out] | iVMPageSizeType | Type will be available only if iVMPageSizeSupport is 1. 0: Invalid; 1: Gaming; 2: Mining |
int ADL2_GPUVMPageSize_Info_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iVMPageSizeType | ||
) |
This function sets the GPU VM PageSize type for a specified adapter.
[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] | iVMPageSizeType | Type will be available only if iVMPageSizeSupport = 1. |
int ADL2_SmartShift_DeltaGain_Set | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int | iMode, | ||
int | iValue | ||
) |
This function set the smart shift Delta gain settings for a specified adapter.
[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] | iMode | Smart shift Mode |
[in] | iValue | Smart shift value |
int ADL2_SmartShift_Settings_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
ADLSmartShiftSettings * | lpCurrent | ||
) |
This function retrieves the smart shift settings for a specified adapter.
[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] | lpCurrent | Smart shift settings |
int ADL2_SmartShift_Support | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpSupported, | ||
int * | lpVersion | ||
) |
This function retrieves the smart shift support for a specified adapter.
[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 | Smart shift supported state |
[out] | lpVersion | Smart shift supported version |
int ADL2_Stress_Test_Cap | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iSupported, | ||
int * | iEnabled, | ||
int * | iVersion | ||
) |
This function retrieves current Stress Test overdrivecapabilities for a specified adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iSupported | The pointer to an int variable which indicates if Overdrive feature is supported ( ADL_TRUE : supported, ADL_FALSE : not supported) |
[in] | iEnabled | The pointer to an int variable which indicates if Overdrive feature is enabled ( ADL_TRUE : enabled, ADL_FALSE : disabled) |
[in] | iVersion | The pointer to an int variable receiving the Overdrive feature version. |
int ADL2_Throttle_Notification_Cap | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | iSupported, | ||
int * | iEnabled, | ||
int * | iVersion | ||
) |
This function retrieves current Throttle Notification overdrivecapabilities for a specified adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] | iSupported | The pointer to an int variable which indicates if Overdrive feature is supported ( ADL_TRUE : supported, ADL_FALSE : not supported) |
[in] | iEnabled | The pointer to an int variable which indicates if Overdrive feature is enabled ( ADL_TRUE : enabled, ADL_FALSE : disabled) |
[in] | iVersion | The pointer to an int variable receiving the Overdrive feature version. |
int ADL_Adapter_Accessibility_Get | ( | int | iAdapterIndex, |
int * | lpAccessibility | ||
) |
Function to check if the GPU is accessible or not at the time of this call.
Some GPUs enter into various power savings mode when not in use, and during this time, direct access to the GPU can result in failures. Access through proper channels (such as via ADL) always works because the software accounts for the GPU's accessibility. However, direct access outside of authorised mechanisms may fail. Use this API to find out if the GPU is currently accessible or not. If API returns GPU accessible, this status will be maintained for 2 seconds.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpAccessibility | The pointer to an int value which indicates if the adapter is accessible or not (ADL_TRUE : Accessible, ADL_FALSE : Not accessible) |
int ADL_Adapter_Active_Get | ( | int | iAdapterIndex, |
int * | lpStatus | ||
) |
Function to determine if the adapter is active or not.
The function is used to check if the adapter associated with iAdapterIndex is active which has enabled desktop mapped on it.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpStatus | The pointer to the retrieved status. ADL_TRUE : Active; ADL_FALSE : Disabled. |
int ADL_Adapter_Active_Set | ( | int | iAdapterIndex, |
int | iStatus, | ||
int * | lpNewlyActivate | ||
) |
Function to set the current extended desktop mode status for a display.
This function enables or disables extended desktop mode for a specified display.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iStatus | The desired display extended desktop mode status. ADL_TRUE : extended desktop mode; ADL_FALSE : otherwise. |
[out] | lpNewlyActivate | The pointer to the retrieved adapter activation information. ADL_TRUE : the adapter is activated for the first time; ADL_FALSE : otherwise. |
int ADL_Adapter_Active_SetPrefer | ( | int | iAdapterIndex, |
int | iStatus, | ||
int | iNumPreferTarget, | ||
ADLDisplayTarget * | lpPreferTarget, | ||
int * | lpNewlyActivate | ||
) |
Function to set the current extended desktop mode status for the display.
This function enables or disables the input adapter for a specified display. In addition, this function allows the user to enable the input adapter and pass in the preferred targets.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iStatus | The desired display extended desktop mode status. ADL_TRUE : extended desktop mode; ADL_FALSE : otherwise. |
[in] | iNumPreferTarget | If iStatus is TRUE, the user can pass the size of preferred Display Targets array. |
[in] | lpPreferTarget | If iStatus is TRUE, the user can pass the preferred Display Targets array to be enabled (with targets cloned). |
[out] | lpNewlyActivate | The pointer to the retrieved adapter activation information. ADL_TRUE : the adapter is activated for the first time; ADL_FALSE : otherwise. |
int ADL_Adapter_AdapterInfo_Get | ( | LPAdapterInfo | lpInfo, |
int | iInputSize | ||
) |
Retrieves all OS-known adapter information.
This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[in] | iInputSize | The size of the lpInfo buffer. |
[out] | lpInfo | The pointer to the buffer containing the retrieved adapter information. |
int ADL_Adapter_AdapterInfoX2_Get | ( | AdapterInfo ** | lppAdapterInfo | ) |
Retrieves all OS-known adapter information.
This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that are no longer present in the system but are still recognized by the OS.
[out] | lppAdapterInfo | is pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function. |
int ADL_Adapter_AdapterList_Disable | ( | int | iNumAdapters, |
int * | lpAdapterIndexList | ||
) |
This function disable multiple adapters in one CCD call for Win7 and later in order to improve the performace. the fucntion will fail if the current primary adapter is in the disabled adapter list
[in] | iNumAdapters | An integer indicates the number of desktops to be disabled. |
[in] | lpAdapterIndexList | The pointer to the integer array that contains the list of logicl adapter indexes to be disabled |
int ADL_Adapter_ASICFamilyType_Get | ( | int | iAdapterIndex, |
int * | lpAsicTypes, | ||
int * | lpValids | ||
) |
Function to get the ASICFamilyType from the adapter.
This function retrieves the ASIC family types for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpAsicTypes | The pointer to the Detailed asic types information retrieved from the driver. |
[out] | lpValids | The pointer to the bit vector indicating which bit is valid on the lpAsicTypes returned. |
int ADL_Adapter_Aspects_Get | ( | int | iAdapterIndex, |
char * | lpAspects, | ||
int | iSize | ||
) |
ADL local interface. Function to retrieve the supported aspects list.
This function retrieves the list of supported aspects for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpAspects | The pointer to the buffer storing the list of aspects supported for the specified adapter. |
[in] | iSize | The size of the lpAspects buffer. |
int ADL_Adapter_BigSw_Info_Get | ( | int | iAdapterIndex, |
int * | lpBigSwSupportMajor, | ||
int * | lpBigSwSupportMinor, | ||
int * | lpRedStoneSupport | ||
) |
This function retrieves the Big Software & Red Stone support information for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpBigSwSupportMajor | The pointer to the Big Software major version information retrieved from the driver. Detailed asic types |
[out] | lpBigSwSupportMinor | The pointer to the Big Software minor version information retrieved from the driver. Detailed asic types |
[out] | lpRedStoneSupport | The pointer to the Red Stone support information retrieved from the driver. |
int ADL_Adapter_Caps | ( | int | iAdapterIndex, |
ADLAdapterCaps * | adapterCaps | ||
) |
This function implements a DI call to retrieve adapter capability information .
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | adapterCaps | The pointer to the structure storing the retrieved adapter capability information. |
int ADL_Adapter_ChipSetInfo_Get | ( | int | iAdapterIndex, |
ADLChipSetInfo * | lpChipSetInfo | ||
) |
This function retrieves the chipset information for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpChipSetInfo | The pointer to the structure storing the retrieved chipset information. |
int ADL_Adapter_ID_Get | ( | int | iAdapterIndex, |
int * | lpAdapterID | ||
) |
Function to get the unique identifier of an adapter.
This function retrieves the unique identifier of a specified adapter.
The adapter ID is a unique value and will be used to determine what other controllers share the same adapter.
The desktop will use this to find which HDCs are associated with an adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpAdapterID | The pointer to the adapter identifier. Zero means: The adapter is not AMD. |
int ADL_Adapter_MemoryInfo2_Get | ( | int | iAdapterIndex, |
ADLMemoryInfo2 * | lpMemoryInfo2 | ||
) |
This function retrieves the memory information for a specified graphics adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpMemoryInfo2 | The pointer to the structure storing the retrieved memory information. |
int ADL_Adapter_Modes_ReEnumerate | ( | ) |
This function re-enumerates adapter modes
int ADL_Adapter_ModeSwitch | ( | int | iAdapterIndex | ) |
Function to perform a mode switch for an adapter.
This function performs a mode switch for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
int ADL_Adapter_NumberOfAdapters_Get | ( | int * | lpNumAdapters | ) |
Function to retrieve the number of OS-known adapters.
This function retrieves the number of graphics adapters recognized by the OS (OS-known adapters). OS-known adapters can include adapters that are physically present in the system (logical adapters)
as well as ones that no longer present in the system but are still recognized by the OS.
[out] | lpNumAdapters | The pointer to the number of OS-known adapters. |
int ADL_Adapter_ObservedClockInfo_Get | ( | int | iAdapterIndex, |
int * | lpCoreClock, | ||
int * | lpMemoryClock | ||
) |
Function to get the core and memory clock info of an adapter. This is the clock displayed on CCC information center. Specific logic is used to select appropriate clock for display in current configuration.
This function retrieves the core and memory clock of an adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpCoreClock | The pointer to the core clock retrieved from the driver in Mhz. |
[out] | lpMemoryClock | The pointer to the memory clock retrieved from the driver in Mhz. |
int ADL_Adapter_ObservedGameClockInfo_Get | ( | ADL_CONTEXT_HANDLE | context, |
int | iAdapterIndex, | ||
int * | lpBaseClock, | ||
int * | lpGameClock, | ||
int * | lpBoostClock, | ||
int * | lpMemoryClock | ||
) |
Function to get the base, game, boost and memory clock info of an adapter. Specific logic is used to select appropriate clock for display in current configuration.
This function retrieves the game, base, boost and memory clock of an adapter.
[in] | context | Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create. |
[in] |
int ADL_Adapter_Primary_Get | ( | int * | lpPrimaryAdapterIndex | ) |
Function to retrieve the primary display adapter index.
This function retrieves the adapter index for the primary display adapter.
[out] | lpPrimaryAdapterIndex | The pointer to the ADL index handle of the primary adapter. |
int ADL_Adapter_Primary_Set | ( | int | iAdapterIndex | ) |
Function to set the primary display adapter index.
This function sets the adapter index for a specified primary display adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
int ADL_Adapter_RegValueInt_Get | ( | int | iAdapterIndex, |
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int * | lpKeyValue | ||
) |
ADL local interface. Function to query a integer registry value set by driver.
This function queries a driver registry integer value for a specified adapter by specifying the subkey path and key name.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry subkey to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be got. This is a null terminated string. |
[out] | lpKeyValue | The pointer to registry value to be got. |
int ADL_Adapter_RegValueInt_Set | ( | int | iAdapterIndex, |
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iKeyValue | ||
) |
ADL local interface. Function to set a driver registry integer value.
This function sets a driver registry integer value for a specified adapter by specifying the subkey path and key name.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry subkey to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be set. This is a null terminated string. |
[in] | iKeyValue | The integer registry value to be set. |
int ADL_Adapter_RegValueString_Get | ( | int | iAdapterIndex, |
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iSize, | ||
char * | lpKeyValue | ||
) |
ADL local interface. Function to query a string registry value set by driver.
This function queries a driver registry string value for a specified adapter by specifying the subkey path and key name.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be got. This is a null terminated string. |
[in] | iSize | The size of registry value to be got. |
[out] | lpKeyValue | The pointer to registry value to be got. |
int ADL_Adapter_RegValueString_Set | ( | int | iAdapterIndex, |
int | iDriverPathOption, | ||
char * | szSubKey, | ||
char * | szKeyName, | ||
int | iSize, | ||
char * | lpKeyValue | ||
) |
ADL local interface. Function to set a driver registry string value.
This function sets a driver registry string value for a specified adapter by specifying the subkey path and key name.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iDriverPathOption | The option of the driver path. 0: Current; 1: function1; 2: function2; 0xFFFF for all device. |
[in] | szSubKey | The path of registry sub key to be accessed. This is a null terminated string and the parameter can be NULL. |
[in] | szKeyName | The name of registry value to be set. This is a null terminated string. |
[in] | iSize | The size of registry value to be set. |
[in] | lpKeyValue | The pointer to registry value to be set. |
int ADL_Adapter_Speed_Caps | ( | int | iAdapterIndex, |
int * | lpCaps, | ||
int * | lpValid | ||
) |
Function to get the current Force3DClock setting from the adapter.
This function retrieves the adapter speed information for a specified adapter. Return valud can be ADL_ADAPTER_SPEEDCAPS_SUPPORTED or “0”
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpCaps | The caps of adapter speed settings |
[out] | lpValid | The valid bits of adapter speed settings |
int ADL_Adapter_Speed_Get | ( | int | iAdapterIndex, |
int * | lpCurrent, | ||
int * | lpDefault | ||
) |
Function to get the current Speed setting from the adapter.
This function retrieves the adapter speed information for a specified adapter. Return value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpCurrent | The current speed setting |
[out] | lpDefault | The default speed setting |
int ADL_Adapter_Speed_Set | ( | int | iAdapterIndex, |
int | iSpeed | ||
) |
Function to set the current Speed setting from the adapter.
This function set the adapter speed information for a specified adapter. Input value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[in] | iSpeed | The speed to set on specified adapter |
int ADL_Adapter_VideoBiosInfo_Get | ( | int | iAdapterIndex, |
ADLBiosInfo * | lpBiosInfo | ||
) |
ADL local interface. Function to retrieve BIOS information.
This function retrieves the BIOS information for a specified adapter.
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | lpBiosInfo | The pointer to the structure storing the retrieved BIOs information. |
int ADL_AdapterX2_Caps | ( | int | iAdapterIndex, |
ADLAdapterCapsX2 * | adapterCaps | ||
) |
Function to retrieve adapter caps information.
This function implements a DI call to retrieve adapter capability information .
[in] | iAdapterIndex | The ADL index handle of the desired adapter. |
[out] | adapterCaps | The pointer to the structure storing the retrieved adapter capability information. |
int ADL_Flush_Driver_Data | ( | int | iAdapterIndex | ) |
Function to save driver data.
This function saves all required data from driver to persist updated settings
[in] | iAdapterIndex | The adapter index to be flushed. |