Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


TryGetFramePresentCount(out int)

Retrieves the number of times the current frame has been drawn to the device as reported by the XR Plugin.
Read time 1 minuteLast updated 13 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine.XR
  • Assembly: UnityEngine.XRModule

TryGetFramePresentCount(int)

public bool TryGetFramePresentCount(out int framePresentCount)

Parameters

framePresentCount

Outputs the number of times the current frame has been presented.

Returns

Type

Description

boolReturns true if the current frame count is available. Returns false otherwise.

Remarks

If performance degrades, some SDKs draw the current frame multiple times. You can use the frame present count to see if the SDK has presented the same frame to the viewer multiple times.
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.