TryGetFramePresentCount(out int)
Retrieves the number of times the current frame has been drawn to the device as reported by the XR SDK.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEngine.XR
- Assembly: UnityEngine.XRModule
TryGetFramePresentCount(int)
Warning
Deprecated. XRStats.TryGetFramePresentCount is deprecated. Use XRDisplaySubsystem.activeSubsystemOrStub.TryGetFramePresentCount instead.
public static bool TryGetFramePresentCount(out int framePresentCount)
Parameters
Outputs the number of times the current frame has been presented.
Returns
Type | Description |
|---|---|
| bool | True if the frame present count is available, false otherwise. |
Remarks
If performance degrades, some SDKs may choose to draw the current frame multiple times with or without some kind of adaptation to compensate. The frame present count can tell if the SDK has presented the same frame to the viewer multiple times.
Statistics are not always available and can vary based on hardware, SDK, and even frame to frame. As such it is important to check the return value of this method before using the statistic value from the out parameter.