IADLXPerformanceMonitoringServices
Navigation: ADLX SDK References → ADLX Interfaces → Performance 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
| Method | Description |
|---|---|
| ClearPerformanceMetricsHistory | Clears the buffer for performance monitoring. |
| GetAllMetricsHistory | Gets the reference counted list of all the metrics in a time interval. |
| GetCurrentAllMetrics | Gets the reference counted IADLXAllMetrics interface for the current metric set. |
| GetCurrentFPS | Gets the reference counted IADLXFPS interface for the current FPS metric. |
| GetCurrentGPUMetrics | Gets the reference counted IADLXGPUMetrics interface for the current metric set of a GPU. |
| GetCurrentPerformanceMetricsHistorySize | Gets the duration of the metrics history from the performance monitoring buffer. |
| GetCurrentSystemMetrics | Gets the reference counted IADLXSystemMetrics interface for the current metric set. |
| GetFPSHistory | Gets the reference counted list of FPS metrics in a time interval. |
| GetGPUMetricsHistory | Gets the reference counted list of GPU metrics in a time interval of a GPU. |
| GetMaxPerformanceMetricsHistorySize | Gets the duration of the performance monitoring buffer. |
| GetMaxPerformanceMetricsHistorySizeRange | Gets the maximum size, minimum size, and step size for the performance monitoring buffer. |
| GetSamplingInterval | Gets the sampling interval for performance monitoring. |
| GetSamplingIntervalRange | Gets the maximum sampling interval, minimum sampling interval, and step sampling interval for the performance monitoring. |
| GetSupportedGPUMetrics | Gets the reference counted interface for discovering what performance metrics are supported on a GPU. |
| GetSupportedSystemMetrics | Gets the reference counted interface for discovering what performance metrics are supported on the system. |
| GetSystemMetricsHistory | Gets the reference counted list of system metrics in a time interval. |
| SetMaxPerformanceMetricsHistorySize | Sets the duration of the performance monitoring buffer. |
| SetSamplingInterval | Sets the sampling interval for the performance monitoring. |
| StartPerformanceMetricsTracking | Increases the count for the performance metrics tracking. |
| StopPerformanceMetricsTracking | Decreases the count for the performance metrics tracking. |
Requirements
| Header | include “IPerformanceMonitoring.h” |
|---|---|
| Minimum version | 1.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.
- ClearPerformanceMetricsHistory
- GetAllMetricsHistory
- GetCurrentAllMetrics
- GetCurrentFPS
- GetCurrentGPUMetrics
- GetCurrentPerformanceMetricsHistorySize
- GetCurrentSystemMetrics
- GetFPSHistory
- GetGPUMetricsHistory
- GetMaxPerformanceMetricsHistorySize
- GetMaxPerformanceMetricsHistorySizeRange
- GetSamplingInterval
- GetSamplingIntervalRange
- GetSupportedGPUMetrics
- GetSupportedSystemMetrics
- GetSystemMetricsHistory
- SetMaxPerformanceMetricsHistorySize
- SetSamplingInterval
- StartPerformanceMetricsTracking
- StopPerformanceMetricsTracking
Subpages
- ClearPerformanceMetricsHistory - Clears the buffer for performance monitoring.
- GetAllMetricsHistory - Gets the reference counted list of all the metrics in a time interval.
- GetCurrentAllMetrics - Gets the reference counted IADLXAllMetrics interface for the current metric set.
- GetCurrentFPS - Gets the reference counted IADLXFPS interface for the current FPS metric.
- GetCurrentGPUMetrics - Gets the reference counted IADLXGPUMetrics interface for the current metric set of a GPU.
- GetCurrentPerformanceMetricsHistorySize - Gets the duration of the metrics history from the performance monitoring buffer.
- GetCurrentSystemMetrics - Gets the reference counted IADLXSystemMetrics interface for the current metric set.
- GetFPSHistory - Gets the reference counted list of FPS metrics in a time interval.
- GetGPUMetricsHistory - Gets the reference counted list of GPU metrics in a time interval of a GPU.
- GetMaxPerformanceMetricsHistorySize - Gets the duration of the performance monitoring buffer.
- GetMaxPerformanceMetricsHistorySizeRange - Gets the maximum size, minimum size, and step size for the performance monitoring buffer.
- GetSamplingInterval - Gets the sampling interval for performance monitoring.
- GetSamplingIntervalRange - Gets the maximum sampling interval, minimum sampling interval, and step sampling interval for the performance monitoring.
- GetSupportedGPUMetrics - Gets the reference counted interface for discovering what performance metrics are supported on a GPU.
- GetSupportedSystemMetrics - Gets the reference counted interface for discovering what performance metrics are supported on the system.
- GetSystemMetricsHistory - Gets the reference counted list of system metrics in a time interval.
- SetMaxPerformanceMetricsHistorySize - Sets the duration of the performance monitoring buffer.
- SetSamplingInterval - Sets the sampling interval for the performance monitoring.
- StartPerformanceMetricsTracking - Increases the count for the performance metrics tracking.
- StopPerformanceMetricsTracking - Decreases the count for the performance metrics tracking.
API Reference
This page references:
- IADLXAllMetrics
- IADLXFPS
- IADLXGPUMetrics
- IADLXInterface
- ClearPerformanceMetricsHistory
- GetAllMetricsHistory
- GetCurrentAllMetrics
- GetCurrentFPS
- GetCurrentGPUMetrics
- GetCurrentPerformanceMetricsHistorySize
- GetCurrentSystemMetrics
- GetFPSHistory
- GetGPUMetricsHistory
- GetMaxPerformanceMetricsHistorySize
- GetMaxPerformanceMetricsHistorySizeRange
- GetSamplingInterval
- GetSamplingIntervalRange
- GetSupportedGPUMetrics
- GetSupportedSystemMetrics
- GetSystemMetricsHistory
- SetMaxPerformanceMetricsHistorySize
- SetSamplingInterval
- StartPerformanceMetricsTracking
- StopPerformanceMetricsTracking
- IADLXSystemMetrics
- PerfSystemMetrics
- PerfSystemMetrics