This group describes the Performance Related of APIs. More...

Functions
int	ADL2_Adapter_FrameMetrics_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iIsFrameMonitorSupported)

int	ADL2_Adapter_FrameMetrics_FrameDuration_Disable (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRAME_DURATION_HANDLE *frameDurationHandle)

int	ADL2_Adapter_FrameMetrics_FrameDuration_Enable (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRAME_DURATION_HANDLE *frameDurationHandle)

int	ADL2_Adapter_FrameMetrics_FrameDuration_Get (ADL_CONTEXT_HANDLE context, ADL_FRAME_DURATION_HANDLE frameDurationHandle, unsigned long long pFrameDurationsArr, unsigned int frameDurationsArrSize, unsigned int elementsCopied)

int	ADL2_Adapter_FrameMetrics_FrameDuration_Start (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)

int	ADL2_Adapter_FrameMetrics_FrameDuration_Stop (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)

int	ADL2_Adapter_FrameMetrics_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId, float *iFramesPerSecond)

int	ADL2_Adapter_FrameMetrics_Start (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)

int	ADL2_Adapter_FrameMetrics_Stop (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)

Detailed Description

This group describes the Performance Related of APIs.

Function to Checks if given GPU (identified by adapter id) supports Frame Monitoring Metrics or not.

Checks if given GPU (identified by adapter id) supports Frame Monitoring Metrics or not.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	iIsFrameMonitorSupported	The pointer to the structure storing the retrieved adapter capability information.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

Function Documentation

◆ ADL2_Adapter_FrameMetrics_Caps()

int ADL2_Adapter_FrameMetrics_Caps	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	iIsFrameMonitorSupported
	)

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Disable()

int ADL2_Adapter_FrameMetrics_FrameDuration_Disable	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADL_FRAME_DURATION_HANDLE *	frameDurationHandle
	)

Function to Disable frame metrics time stamp recording on any GPU.

Will try to deallocate memory that was previously allocated for Frame Metrics Duration recording inside supplied Handle. This handle is required to start, Get and stop Frame Metrics Duration recording and must be supplied in all future calls.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	frameDurationHandle	Handle containing information used inside Get calls to know how many Time stamp elements to read. Will be allocated by the enable call within ADL and then released after Disable call.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Enable()

int ADL2_Adapter_FrameMetrics_FrameDuration_Enable	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADL_FRAME_DURATION_HANDLE *	frameDurationHandle
	)

Function to Enable frame metrics time stamp recording on any GPU.

Will try to allocate memory required for Frame Metrics Duration recording inside supplied Handle. This handle is required to start, Get and stop Frame Metrics Duration recording and must be supplied in all future calls.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	frameDurationHandle	Handle containing information used inside Get calls to know how many Time stamp elements to read. Will be allocated by the enable call within ADL and then released after Disable call. Value must be set to null before being passed in.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Get()

int ADL2_Adapter_FrameMetrics_FrameDuration_Get	(	ADL_CONTEXT_HANDLE	context,
		ADL_FRAME_DURATION_HANDLE	frameDurationHandle,
		unsigned long long *	pFrameDurationsArr,
		unsigned int	frameDurationsArrSize,
		unsigned int *	elementsCopied
	)

Function to retrieve frame metrics frame duration information on GPU (identified by adapter id).

Get frame metrics frame duration Data on GPU (identified by adapter id). ADL2_Adapter_FrameMetrics_FrameDuration_Enable (at least once) & then ADL2_Adapter_FrameMetrics_FrameDuration_Start must be called and succeed before Get will function. This function does not take adapterindex/vidPnSourceId so it will return the information on the adapter previously Started on. Will detect if in crossfire and Get data from all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	frameDurationHandle	Handle containing information used inside Get calls to know how many Time stamp elements to read. Will be allocated by the enable call within ADL and then released after Disable call.
[out]	pFrameDurationsArr	Array that will be filled with the new frame durations since the last call. Durations in Microseconds
[in]	frameDurationsArrSize	size of pFrameTimeStampsArr array to avoid overflow.
[out]	elementsCopied	Number of elements copied from shared memory address to be passed into pFrameDurationsArr

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Start()

int ADL2_Adapter_FrameMetrics_FrameDuration_Start	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	VidPnSourceId
	)

Function to start frame metrics time stamp recording on GPU (identified by adapter id).

Start frame metrics time stamp/frame duration recording on GPU (identified by adapter id). Will try to enable TimeStamp/FrameDuration recording (ADL2_Adapter_FrameMetrics_Start will be called inside and must succeed). Will detect if in crossfire and start all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	VidPnSourceId	The Source ID of the Display FPS metrics will be started from.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Stop()

int ADL2_Adapter_FrameMetrics_FrameDuration_Stop	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	VidPnSourceId
	)

Function to stop frame metrics time stamp recording on GPU (identified by adapter id).

Stop frame metrics time stamp recording on GPU (identified by adapter id). Will try to stop time stamp/Frame duration recording. (ADL2_Adapter_FrameMetrics_Stop will be called inside upon successful stop) Will detect if in crossfire and stop all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	VidPnSourceId	The Source ID of the Display FPS metrics will be stopped from.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_Get()

int ADL2_Adapter_FrameMetrics_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	VidPnSourceId,
		float *	iFramesPerSecond
	)

Function to retrieve frame metrics information on GPU (identified by adapter id).

Get frame metrics monitoring Data on GPU (identified by adapter id). Will detect if in crossfire and Get data from all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	VidPnSourceId	The Source ID of the Display FPS metrics will be gathered from.
[out]	iFramesPerSecond	The FPS presented by the GPU. This is the average of all FPS presented since the last time the function was called.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_Start()

int ADL2_Adapter_FrameMetrics_Start	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	VidPnSourceId
	)

Function to start frame metrics monitoring on GPU (identified by adapter id).

Start frame metrics monitoring on GPU (identified by adapter id). Will detect if in crossfire and start all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	VidPnSourceId	The Source ID of the Display FPS metrics will be started from.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_FrameMetrics_Stop()

int ADL2_Adapter_FrameMetrics_Stop	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	VidPnSourceId
	)

Function to stop frame metrics monitoring on GPU (identified by adapter id).

Stop frame metrics monitoring on GPU (identified by adapter id). Will detect if in crossfire and stop all slaves as well.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[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]	VidPnSourceId	The Source ID of the Display FPS metrics will be stopped from.

Returns: If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

Functions

Detailed Description

Function Documentation

◆ ADL2_Adapter_FrameMetrics_Caps()

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Disable()

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Enable()

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Get()

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Start()

◆ ADL2_Adapter_FrameMetrics_FrameDuration_Stop()

◆ ADL2_Adapter_FrameMetrics_Get()

◆ ADL2_Adapter_FrameMetrics_Start()

◆ ADL2_Adapter_FrameMetrics_Stop()