ADL (AMD Display Library) Public APIs  Version 17.0
Functions

This group outlines ViewPort Related APIs. More...

Functions

int ADL2_Display_ViewPort_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)
 Function to check if the selected adapter supports the view port control. More...
 
int ADL2_Display_ViewPort_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLControllerMode *lpControllerMode)
 Function to get the view position, view size or view pan lock of a selected display. More...
 
int ADL2_Display_ViewPort_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLControllerMode *lpControllerMode)
 Function to change the view position, view size or view pan lock of a selected display. More...
 
int ADL_Display_ViewPort_Cap (int iAdapterIndex, int *lpSupported)
 Function to check if the selected adapter supports the view port control. More...
 
int ADL_Display_ViewPort_Get (int iAdapterIndex, int iDisplayIndex, ADLControllerMode *lpControllerMode)
 Function to get the view position, view size or view pan lock of a selected display. More...
 
int ADL_Display_ViewPort_Set (int iAdapterIndex, int iDisplayIndex, ADLControllerMode *lpControllerMode)
 Function to change the view position, view size or view pan lock of a selected display. More...
 

Detailed Description

This group outlines ViewPort Related APIs.

Function Documentation

◆ ADL2_Display_ViewPort_Cap()

int ADL2_Display_ViewPort_Cap ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported 
)

Function to check if the selected adapter supports the view port control.

This function used to check if the selected adapter supports the view port control.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpSupportedis if this adapter supports the view port control. ADL_TRUE: the view port control are supported; otherwise: not supported.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Display_ViewPort_Get()

int ADL2_Display_ViewPort_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
ADLControllerMode lpControllerMode 
)

Function to get the view position, view size or view pan lock of a selected display.

This function used to get the view position, view size or view pan lock of a selected display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpControllerModeThe pointer to the ADLControllerMode structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Display_ViewPort_Set()

int ADL2_Display_ViewPort_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
ADLControllerMode lpControllerMode 
)

Function to change the view position, view size or view pan lock of a selected display.

This function used to change the view position, view size or view pan lock of a selected display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]lpControllerMode.The pointer to the ADLControllerMode structure.
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_Display_ViewPort_Cap()

int ADL_Display_ViewPort_Cap ( int  iAdapterIndex,
int *  lpSupported 
)

Function to check if the selected adapter supports the view port control.

This function used to check if the selected adapter supports the view port control.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpSupportedis if this adapter supports the view port control. ADL_TRUE: the view port control are supported; otherwise: not supported.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_ViewPort_Get()

int ADL_Display_ViewPort_Get ( int  iAdapterIndex,
int  iDisplayIndex,
ADLControllerMode lpControllerMode 
)

Function to get the view position, view size or view pan lock of a selected display.

This function used to get the view position, view size or view pan lock of a selected display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpControllerModeThe pointer to the ADLControllerMode structure.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Display_ViewPort_Set()

int ADL_Display_ViewPort_Set ( int  iAdapterIndex,
int  iDisplayIndex,
ADLControllerMode lpControllerMode 
)

Function to change the view position, view size or view pan lock of a selected display.

This function used to change the view position, view size or view pan lock of a selected display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]lpControllerMode.The pointer to the ADLControllerMode structure.
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.