ADL (AMD Display Library) Public APIs  Version 17.0
Functions
Video Related APIs

This group outlines all Video related APIs. More...

Functions

int ADL2_Adapter_VideoTheaterModeInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpOverlayDisplayMode, int *lpSavedSettings)
 Function to get MM video theater mode info. More...
 
int ADL2_Adapter_VideoTheaterModeInfo_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iOverlayDisplayMode, int iSavedSettings)
 Function to set MM video theater mode info. More...
 
int ADL2_MMD_Features_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureCaps **lppFeatureCaps, int *lpFeatureCount)
 
int ADL2_MMD_FeatureValues_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureValues **lppFeatureValues, int *lpFeatureCount)
 
int ADL2_MMD_FeatureValues_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureValues *lpFeatureValues, int iFeatureCount, int ClientID)
 
int ADL_Adapter_VideoTheaterModeInfo_Get (int iAdapterIndex, int *lpOverlayDisplayMode, int *lpSavedSettings)
 Function to get MM video theater mode info. More...
 
int ADL_Adapter_VideoTheaterModeInfo_Set (int iAdapterIndex, int iOverlayDisplayMode, int iSavedSettings)
 Function to set MM video theater mode info. More...
 
int ADL_MMD_Features_Caps (int iAdapterIndex, ADLFeatureCaps **lppFeatureCaps, int *lpFeatureCount)
 
int ADL_MMD_FeatureValues_Get (int iAdapterIndex, ADLFeatureValues **lppFeatureValues, int *lpFeatureCount)
 
int ADL_MMD_FeatureValues_Set (int iAdapterIndex, ADLFeatureValues *lpFeatureValues, int iFeatureCount, int ClientID)
 

Detailed Description

This group outlines all Video related APIs.

Function Documentation

◆ ADL2_Adapter_VideoTheaterModeInfo_Get()

int ADL2_Adapter_VideoTheaterModeInfo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpOverlayDisplayMode,
int *  lpSavedSettings 
)

Function to get MM video theater mode info.

The function is used to get multi-media video theater mode information.

Supported Platforms:
Windows Vista and 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]lpOverlayDisplayModeThe pointer to the overlay display mode.
[out]lpSavedSettingsThe pointer to the saved settings of the related mode.
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_Adapter_VideoTheaterModeInfo_Set()

int ADL2_Adapter_VideoTheaterModeInfo_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iOverlayDisplayMode,
int  iSavedSettings 
)

Function to set MM video theater mode info.

The function is used to set multi-media video theater mode information.

Supported Platforms:
Windows Vista and 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]iOverlayDisplayModeThe overlay display mode to be set.
[in]iSavedSettingsThe saved settings of the related mode to be set.
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_MMD_Features_Caps()

int ADL2_MMD_Features_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLFeatureCaps **  lppFeatureCaps,
int *  lpFeatureCount 
)
Function to obtain capabilities of Multi-Media features

The function is used to obtain the capabilities for a set of specific Multi-Media features for a specific display adapter.

Supported Platforms:
Windows Vista and 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]lppFeatureCapsThe pointer to the pointer to the retrieved Feature Caps array. Initialize to NULL before calling this API.
[out]lpFeatureCountThe pointer to the number of ADLFeatureCaps elements in the retrieved list.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
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_MMD_FeatureValues_Get()

int ADL2_MMD_FeatureValues_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLFeatureValues **  lppFeatureValues,
int *  lpFeatureCount 
)
Function to obtain the values and state of a Multi-Media feature

The function is used to obtain the values and state of a single Multi-Media feature for a specific display adapter.

Supported Platforms:
Windows Vista and 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]lppFeatureValuesThe pointer to the pointer to the retrieved ADLFeatureValues array. Initialize to NULL before calling this API.
[out]lpFeatureCountThe pointer to the number of ADLFeatureValues elements in the retrieved list.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
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_MMD_FeatureValues_Set()

int ADL2_MMD_FeatureValues_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLFeatureValues lpFeatureValues,
int  iFeatureCount,
int  ClientID 
)
Function to set the current value of a Multi-Media feature

The function is used to set the current value of a single Multi-Media feature and optionally provide the handle of SetEvent object.

Supported Platforms:
Windows Vista and 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]lpFeatureValuesA pointer to the ADLFeatureValues array. Refer to ADLFeatureValues structure for more information.
[in]iFeatureCountThe number of ADLFeatureValues elements in the array.
[in]ClientIDThe Client ID of the caller. It is recommended to provide a valid Client ID to avoid raising caller?s event object, immediately after the current value is set.
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.

◆ ADL_Adapter_VideoTheaterModeInfo_Get()

int ADL_Adapter_VideoTheaterModeInfo_Get ( int  iAdapterIndex,
int *  lpOverlayDisplayMode,
int *  lpSavedSettings 
)

Function to get MM video theater mode info.

The function is used to get multi-media video theater mode information.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpOverlayDisplayModeThe pointer to the overlay display mode.
[out]lpSavedSettingsThe pointer to the saved settings of the related mode.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_VideoTheaterModeInfo_Set()

int ADL_Adapter_VideoTheaterModeInfo_Set ( int  iAdapterIndex,
int  iOverlayDisplayMode,
int  iSavedSettings 
)

Function to set MM video theater mode info.

The function is used to set multi-media video theater mode information.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iOverlayDisplayModeThe overlay display mode to be set.
[in]iSavedSettingsThe saved settings of the related mode to be set.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_MMD_Features_Caps()

int ADL_MMD_Features_Caps ( int  iAdapterIndex,
ADLFeatureCaps **  lppFeatureCaps,
int *  lpFeatureCount 
)
Function to obtain capabilities of Multi-Media features

The function is used to obtain the capabilities for a set of specific Multi-Media features for a specific display adapter.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]lppFeatureCapsThe pointer to the pointer to the retrieved Feature Caps array. Initialize to NULL before calling this API.
[out]lpFeatureCountThe pointer to the number of ADLFeatureCaps elements in the retrieved list.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.

◆ ADL_MMD_FeatureValues_Get()

int ADL_MMD_FeatureValues_Get ( int  iAdapterIndex,
ADLFeatureValues **  lppFeatureValues,
int *  lpFeatureCount 
)
Function to obtain the values and state of a Multi-Media feature

The function is used to obtain the values and state of a single Multi-Media feature for a specific display adapter.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lppFeatureValuesThe pointer to the pointer to the retrieved ADLFeatureValues array. Initialize to NULL before calling this API.
[out]lpFeatureCountThe pointer to the number of ADLFeatureValues elements in the retrieved list.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.

◆ ADL_MMD_FeatureValues_Set()

int ADL_MMD_FeatureValues_Set ( int  iAdapterIndex,
ADLFeatureValues lpFeatureValues,
int  iFeatureCount,
int  ClientID 
)
Function to set the current value of a Multi-Media feature

The function is used to set the current value of a single Multi-Media feature and optionally provide the handle of SetEvent object.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]lpFeatureValuesA pointer to the ADLFeatureValues array. Refer to ADLFeatureValues structure for more information.
[in]iFeatureCountThe number of ADLFeatureValues elements in the array.
[in]ClientIDThe Client ID of the caller. It is recommended to provide a valid Client ID to avoid raising caller?s event object, immediately after the current value is set.
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.