ADL (AMD Display Library) Public APIs  Version 17.1
Functions | Variables
General Adapter APIs

This group describes General adapter APIs. More...

Functions

int ADL2_Adapter_Radeon_Usb_Led_Flash_Save (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to save programmed LED configuration onto LED flash to persist on reboot and power down. More...
 
int ADL2_Adapter_Radeon_USB_LED_Pattern_Supported_Controls_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_RADEON_USB_LED_BAR_CONTROLS control, RadeonLEDBARSupportedConfig *ConfigSupport) int ADL2_Adapter_Radeon_LED_Patten_Control_Set(ADL_CONTEXT_HANDLE context
 Function to query list of supported LED pattern control. More...
 
int ADL2_Adapter_Radeon_USB_LED_Support_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, bool *bLEDSupported)
 
int ADL2_Adapter_Radeon_USB_LED_Supported_Controls_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, RadeonLEDBARSupportedControl *ControlSupport)
 Function to query supported LED controls. More...
 

Variables

int int ADL_RADEON_LED_PATTERN_CONFIG config
 
int int iAdapterIndex
 

Detailed Description

This group describes General adapter APIs.

Function to get LED devices presence for GPU index.

This interface allows ADL user to query the number of LED devices present.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter
[out]bLEDSupportedreturns true if Radeon USB LED is supported
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks

Function Documentation

◆ ADL2_Adapter_Radeon_Usb_Led_Flash_Save()

int ADL2_Adapter_Radeon_Usb_Led_Flash_Save ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex 
)

Function to save programmed LED configuration onto LED flash to persist on reboot and power down.

This interface allows ADL user to query the number of LED devices present.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks

◆ ADL2_Adapter_Radeon_USB_LED_Pattern_Supported_Controls_Get()

int ADL2_Adapter_Radeon_USB_LED_Pattern_Supported_Controls_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_RADEON_USB_LED_BAR_CONTROLS  control,
RadeonLEDBARSupportedConfig ConfigSupport 
)

Function to query list of supported LED pattern control.

This interface allows ADL user to query list of LED patterns on the LED controller. Output can be used for set functionality

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter
[in]

◆ ADL2_Adapter_Radeon_USB_LED_Support_Get()

int ADL2_Adapter_Radeon_USB_LED_Support_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
bool *  bLEDSupported 
)

◆ ADL2_Adapter_Radeon_USB_LED_Supported_Controls_Get()

int ADL2_Adapter_Radeon_USB_LED_Supported_Controls_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
RadeonLEDBARSupportedControl ControlSupport 
)

Function to query supported LED controls.

This interface allows ADL user to a bitmask of supported LED patterns on the LED controllers, including OFF and custom pattern, Rainbow, etc...

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter
[out]ControlSupportreturns a bitmask of all supported LED patterns.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks

Variable Documentation

◆ config

◆ iAdapterIndex

int int iAdapterIndex

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