Skip to content

IADLXPerformanceMonitoringServices

Navigation: ADLX SDK ReferencesADLX InterfacesPerformance Monitoring

The IADLXPerformanceMonitoringServices interface provides methods to configure the performance monitoring functionality and to obtain the performance data.

InterfaceId:IADLXPerformanceMonitoringServices
Smart Pointer Interface Name:IADLXPerformanceMonitoringServicesPtr
Inherits:IADLXInterface
Inherited By:N/A

The IADLXPerformanceMonitoringServices interface provides:

  • The configuration for the performance metric sampling.
  • The methods to start and stop the performance metric sampling.
  • Access to the data from the performance metric buffer.

Methods

MethodDescription
ClearPerformanceMetricsHistoryClears the buffer for performance monitoring.
GetAllMetricsHistoryGets the reference counted list of all the metrics in a time interval.
GetCurrentAllMetricsGets the reference counted IADLXAllMetrics interface for the current metric set.
GetCurrentFPSGets the reference counted IADLXFPS interface for the current FPS metric.
GetCurrentGPUMetricsGets the reference counted IADLXGPUMetrics interface for the current metric set of a GPU.
GetCurrentPerformanceMetricsHistorySizeGets the duration of the metrics history from the performance monitoring buffer.
GetCurrentSystemMetricsGets the reference counted IADLXSystemMetrics interface for the current metric set.
GetFPSHistoryGets the reference counted list of FPS metrics in a time interval.
GetGPUMetricsHistoryGets the reference counted list of GPU metrics in a time interval of a GPU.
GetMaxPerformanceMetricsHistorySizeGets the duration of the performance monitoring buffer.
GetMaxPerformanceMetricsHistorySizeRangeGets the maximum size, minimum size, and step size for the performance monitoring buffer.
GetSamplingIntervalGets the sampling interval for performance monitoring.
GetSamplingIntervalRangeGets the maximum sampling interval, minimum sampling interval, and step sampling interval for the performance monitoring.
GetSupportedGPUMetricsGets the reference counted interface for discovering what performance metrics are supported on a GPU.
GetSupportedSystemMetricsGets the reference counted interface for discovering what performance metrics are supported on the system.
GetSystemMetricsHistoryGets the reference counted list of system metrics in a time interval.
SetMaxPerformanceMetricsHistorySizeSets the duration of the performance monitoring buffer.
SetSamplingIntervalSets the sampling interval for the performance monitoring.
StartPerformanceMetricsTrackingIncreases the count for the performance metrics tracking.
StopPerformanceMetricsTrackingDecreases the count for the performance metrics tracking.

Requirements

Headerinclude “IPerformanceMonitoring.h”
Minimum version1.0

Example

To see how to use this interface in a C++ application, refer to the PerfSystemMetrics C++ sample.

For a C application, refer to the PerfSystemMetrics C sample.

Subpages

API Reference

This page references: