TryGetDroppedFrameCount(out int)
Retrieves the number of dropped frames reported by the XR SDK.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEngine.XR
- Assembly: UnityEngine.XRModule
TryGetDroppedFrameCount(int)
Warning
Deprecated. XRStats.TryGetDroppedFrameCount is deprecated. Use XRDisplaySubsystem.activeSubsystemOrStub.TryGetDroppedFrameCount instead.
public static bool TryGetDroppedFrameCount(out int droppedFrameCount)
Parameters
Outputs the number of frames dropped since the last update.
Returns
Type | Description |
|---|---|
| bool | True if the dropped frame count is available, false otherwise. |
Remarks
The number of dropped frames can be useful to games or applications that wish to dynamically scale content or settings in order to maximize frame rate. It is important for XR applications to run at a consistent, high frame rate. If an application is drawing too much or making too many calculations, it may be unable to maintain a high frame rate and "drop" frames. When the SDK reports that frames are being dropped, the game or application can adjust settings, disable objects, or perform other actions to reduce overhead.
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.