API reference
OVRMetricsTicks Class
Extends
OVRMetricsGroup
Modifiers:
final Metrics group for tick rate performance monitoring.
Tick data is calculated in OVRMetricsTickTrackingSystem.execute() which runs every tick. The OVRMetricsTickTrackingSystem is lazily registered only when OVRMetricsTicks.ticksPerSecond or OVRMetricsTicks.maxTickTimeMs is called, avoiding unnecessary overhead if tick metrics aren't used.
Signature
class OVRMetricsTicks(systemManager: SystemManager, init: OVRMetricsTicks.() -> Unit = {}) : OVRMetricsGroupConstructors
OVRMetricsTicks
(
systemManager
, init
)
|
Signature
constructor(systemManager: SystemManager, init: OVRMetricsTicks.() -> Unit = {})Parameters systemManager: SystemManager
The SystemManager used to register the OVRMetricsTickTrackingSystem when needed.
init: Function1Returns OVRMetricsTicks |
Properties
groupName
: String
[Get] |
Signature
val groupName: String |
metrics
: mutableListOf<OVRMetric>()
[Get] |
Signature
val metrics: mutableListOf<OVRMetric>() |
overlayMessages
: mutableListOf<() -> String>()
[Get] |
Signature
val overlayMessages: mutableListOf<() -> String>() |
Methods
maxTickTimeMs
(
durationSeconds
)
|
Adds a max tick time metric showing the worst tick duration in milliseconds over the specified duration.
Signature
fun maxTickTimeMs(durationSeconds: Int = 1): OVRMetricsTicks Parameters durationSeconds: Int
The number of seconds to track max tick time over (default: 1, minimum: 1)
Returns OVRMetricsTicks |
ticksPerSecond
(
sampleCount
)
|
Adds a ticks-per-second metric with a graph ranging from 0-90 TPS.
Signature
fun ticksPerSecond(sampleCount: Int = 5): OVRMetricsTicks Parameters sampleCount: Int
The number of samples to use for the rolling average (default: 5, minimum: 1). Higher values provide smoother readings but slower response to changes.
Returns OVRMetricsTicks |
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta