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.

Inheritance

object

Stats.PerfMetrics

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.XR.Oculus

Assembly: Unity.XR.Oculus.dll

Syntax

public static class Stats.PerfMetrics

Remarks

The PerfMetrics stats do not work under the OpenXR runtime. All values return 0. Instead, you can use the profiling tools available from the Oculus Developer Hub. Refer to Performance Analyzer and Metrics for more information.

Properties

AppCPUTime

Reports the time the application spent on the CPU last frame in seconds.

Declaration

public static float AppCPUTime { get; }

Property Value

Type	Description
float	time in seconds

AppGPUTime

Reports the time the application spen on the GPU last frame in seconds.

Declaration

public static float AppGPUTime { get; }

Property Value

Type	Description
float	time in seconds

CPUClockFrequency

Reports the CPU clock frequency

Declaration

public static float CPUClockFrequency { get; }

Property Value

Type	Description
float	the CPU clock frequency

CPUUtilizationAverage

Reports the average CPU utilization as a value from 0.0 - 1.0.

Declaration

public static float CPUUtilizationAverage { get; }

Property Value

Type	Description
float	clamped value between 0.0 and 1.0

CPUUtilizationWorst

Reports the worst CPU utilization as a value from 0.0 - 1.0.

Declaration

public static float CPUUtilizationWorst { get; }

Property Value

Type	Description
float	clamped value between 0.0 and 1.0

CompositorCPUTime

Reports the time the compositor spent on the CPU last frame in seconds.

Declaration

public static float CompositorCPUTime { get; }

Property Value

Type	Description
float	time in seconds

CompositorGPUTime

Reports the time the compositor spent on the GPU last frame in seconds.

Declaration

public static float CompositorGPUTime { get; }

Property Value

Type	Description
float	time in seconds

GPUClockFrequency

Reports the GPU clock frequency

Declaration

public static float GPUClockFrequency { get; }

Property Value

Type	Description
float	the GPU clock frequency

GPUUtilization

Reports the GPU utilization as a value from 0.0 - 1.0.

Declaration

public static float GPUUtilization { get; }

Property Value

Type	Description
float	clamped value between 0.0 and 1.0

Methods

EnablePerfMetrics(bool)

Enable or disable provider tracking perf metrics. Perf metrics are disabled by default.

Declaration

public static void EnablePerfMetrics(bool enable)

Parameters

Type	Name	Description
bool	enable	true to enable perf metrics