GetCurrentFPS 

Gets the reference counted IADLXFPS interface for the current FPS metric.

Syntax 

ADLX_RESULT     GetCurrentFPS (IADLXFPS ** ppMetrics)

Parameters 

  1. [out] ppMetrics IADLXFPS** The address of a pointer to the returned interface. If the interface is not successfully returned, the method sets the dereferenced address *ppMetrics 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 

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