GetFPSHistory

Gets the reference counted list of FPS metrics in a time interval.

Syntax

Copied!

ADLX_RESULT     GetFPSHistory (adlx_int startMs, adlx_int stopMs, IADLXFPSList ** ppMetricsList)

Parameters

  1. [in] startMs adlx_int The start time of the time interval (in millisecond).

  2. [in] stopMs adlx_int The stop time of the time interval (in millisecond).

  3. [out] ppMetricsList IADLXFPSList** The address of a pointer to the returned interface. If the interface is not successfully returned, the method sets the dereferenced address *ppMetricsList to nullptr.

Return Value

If the interface is successfully returned, ADLX_OK is returned.

If the interface is not successfully returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Remarks

Use the startMs and stopMs to specify the time intervals for fetching the history.

The returned interface must be discarded with Release when it is no longer needed.

Additional Info

In C++, when using ADLX interfaces as smart pointers, there is no need to call Release because smart pointers call it in their internal implementation.

Note: The FPS metric is only available while a 3D graphics application or game runs in exclusive full screen mode.

Requirements

Header

include “IPerformanceMonitoring.h”

Minimum version

1.0

Additional Info

In C++, when using ADLX interfaces as smart pointers, there is no need to call Release because smart pointers call it in their internal implementation.

Requirements

Header

include “IPerformanceMonitoring.h”

Minimum version

1.0