Class Stats.PerfMetrics
Provides additional perf metrics. These stats will not be tracked unless the user makes a PerfMetrics.EnablePerfMetrics(true) method call. Not every stat is supported on every Oculus platform and will always return a value of 0 if unsupported.
Note: PerfMetrics stats will return 0 when using the OpenXR runtime. The suggested replacement is to use the profiling tools available via the Oculus Developer Hub: https://developer.oculus.com/documentation/unity/ts-odh-logs-metrics/
Namespace: Unity.XR.Oculus
Syntax
public static class PerfMetricsProperties
AppCPUTime
Reports the time the application spent on the CPU last frame in seconds.
Declaration
public static float AppCPUTime { get; }Property Value
| Type | Description |
|---|---|
| Single |
AppGPUTime
Reports the time the application spen on the GPU last frame in seconds.
Declaration
public static float AppGPUTime { get; }Property Value
| Type | Description |
|---|---|
| Single |
CompositorCPUTime
Reports the time the compositor spent on the CPU last frame in seconds.
Declaration
public static float CompositorCPUTime { get; }Property Value
| Type | Description |
|---|---|
| Single |
CompositorGPUTime
Reports the time the compositor spent on the GPU last frame in seconds.
Declaration
public static float CompositorGPUTime { get; }Property Value
| Type | Description |
|---|---|
| Single |
CPUClockFrequency
Reports the CPU clock frequency
Declaration
public static float CPUClockFrequency { get; }Property Value
| Type | Description |
|---|---|
| Single |
CPUUtilizationAverage
Reports the average CPU utilization as a value from 0.0 - 1.0.
Declaration
public static float CPUUtilizationAverage { get; }Property Value
| Type | Description |
|---|---|
| Single |
CPUUtilizationWorst
Reports the worst CPU utilization as a value from 0.0 - 1.0.
Declaration
public static float CPUUtilizationWorst { get; }Property Value
| Type | Description |
|---|---|
| Single |
GPUClockFrequency
Reports the GPU clock frequency
Declaration
public static float GPUClockFrequency { get; }Property Value
| Type | Description |
|---|---|
| Single |
GPUUtilization
Reports the GPU utilization as a value from 0.0 - 1.0.
Declaration
public static float GPUUtilization { get; }Property Value
| Type | Description |
|---|---|
| Single |
Methods
EnablePerfMetrics(Boolean)
Enable or disable provider tracking perf metrics. Perf metrics are disabled by default.
Declaration
public static void EnablePerfMetrics(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | enable |