GetCurrentGPUMetrics

Gets the reference counted IADLXGPUMetrics interface for the current metric set of a GPU.

Syntax

Copied!

ADLX_RESULT     GetCurrentGPUMetrics (IADLXGPU * pGPU, IADLXGPUMetrics ** ppMetrics)

Parameters

  1. [in] pGPU IADLXGPU * The pointer to the GPU interface.

  2. [out] ppMetrics IADLXGPUMetrics ** 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. It takes some time and is suitable for a single acquisition. For continuous collection, it is recommended to use GetGPUMetricsHistory .

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