TryGetDroppedFrameCount(out int)
Retrieves the number of dropped frames reported by the XR Plugin.
Read time 1 minuteLast updated 12 days ago
Definition
- Type: Method
- Namespace: UnityEngine.XR
- Assembly: UnityEngine.XRModule
TryGetDroppedFrameCount(int)
public virtual bool TryGetDroppedFrameCount(out int droppedFrameCount)
Parameters
Outputs the number of frames dropped since the last update.
Returns
Type | Description |
|---|---|
| bool | Returns true if the dropped frame count is available. Returns false otherwise. |
Remarks
Use this method for games and applications that you want to scale content or settings dynamically in order to maximise frame rates. XR applications and games must run at a consistent, high frame rate. If an application has too many draw calls or calculations, it may have to "drop" frames in order to keep a high frame rate. When the SDK reports that the application is dropping frames, the application can adjust settings, disable objects, or perform other actions to reduce overhead.
Statistics are only available for SDKs that support this method, and they can vary based on hardware, the SDK, and the frame. You should always check the return value of this method before you use the statistic value from the out parameter.