Trees       Indices       Help   
VRED Python API v1
Module vrOpenVR :: Class vrOpenVRFrameTimings
[frames] | no frames]

Class vrOpenVRFrameTimings

 object --+    
          |    
??.instance --+
              |
             vrOpenVRFrameTimings

The vrOpenVRFrameTimings class stores timing information from the OpenVR library that can be queried by calling getOpenVRFrameTimings(). The timing information always refers to the last rendered frame.

Instance Methods
 
__init__(source)
The constructor of the vrOpenVRFrameTimings class.
 
__reduce__()
Real32
getClientFrameInterval()
Returns the time between calls to WaitGetPoses
Real32
getCompositorIdleCpu()
Returns the time spent waiting for running start (application could have used this much more time)
Real32
getCompositorRenderCpu()
Returns the time spent on cpu submitting the above work for this frame
Real32
getCompositorRenderGpu()
Returns the time spend performing distortion correction, rendering chaperone, overlays, etc
Real32
getCompositorRenderStart()
Returns the timestamp when the compositor started rendering relative to the global system time
Real32
getCompositorUpdateEnd()
Returns the timestamp when the compositor update was finished relative to the global system time
Real32
getCompositorUpdateStart()
Returns the timestamp when a the compositor update was started relative to the global system times
UInt32
getFrameId()
Returns index of the current frame.
UInt32
getFrameIndex()
Returns the current frame index.
Real32
getMulticastCopyTimeCpu()
Returns the cpu time required to copy buffers from one GPU to the other if multicast SLI is enabled.
Real32
getNewFrameReady()
Returns the timestamp when a new frame was ready relative to the global system time
Real32
getNewPosesReady()
Returns the timestamp when a new pose was ready relative to the global system time
UInt32
getNumDroppedFrames()
Returns the number of additional times previous frame was scanned out.
UInt32
getNumFramePresents()
Returns the number of times this frame was presented.
UInt32
getNumMisPresented()
Returns the number of times this frame was presented on a vsync other than it was originally predicted to.
Real32
getPostSubmitCpu()
Returns the cpu time from completing the submit calls
Real32
getPostSubmitGpu()
Returns the additional time spent rendering by application (e.g.
Real32
getPreSubmitGpu()
Returns the time spent rendering the scene
Real32
getPresentCallCpu()
Returns the time blocked on call to present (usually 0.0, but can go long)
Real32
getRenderTimeCpu()
Returns the complete cpu rendertime measured from binding the first eye buffer to completing the second eye and creating the mirror texture.
UInt32
getReprojectionFlag()
Returns whether the frame was reprojected or not.
Real32
getSubmitCpu()
Returns the cpu time for doing the submit calls for both eyes
Real32
getSubmitFrameTime()
Returns the time spent in IVRCompositor::Submit (not near-zero indicates driver issue)
Real64
getSystemTimeInSeconds()
Returns the absolute time reference for comparing frames.
Real32
getTimeBetweenRenderCpu()
Returns the cpu time passed between the rendering of two frames.
Real32
getTimeBetweenSubmitCpu()
Returns the cpu time passed between two calls to submit.
Real32
getTimeBetweenWaitGetPosesCpu()
Returns the cpu time passed between two calls to WaitGetPoses.
Real32
getTotalRenderGpu()
Returns the time between work submitted immediately after present (ideally vsync) until the end of compositor submitted work
Real32
getWaitForPresentCpu()
Returns the time spent spin-waiting for frame index to change (not near-zero indicates wait object failure)
Real32
getWaitGetPosesCalled()
Returns the timestamp when WaitGetPoses was called relative to the global system time
Real32
getWaitGetPosesCpu()
Returns the cpu time for WaitGetPoses.

Inherited from unreachable.instance: __new__

Class Variables
  __instance_size__ = 304
Method Details

__init__(source)
(Constructor)

 

The constructor of the vrOpenVRFrameTimings class.

Parameters:
  • source (vrOpenVRFrameTimings) - The source.
Overrides: object.__init__

__reduce__()

 
Overrides: object.__reduce__
(inherited documentation)

getClientFrameInterval()

 

Returns the time between calls to WaitGetPoses

Returns: Real32
The time between calls to WaitGetPoses in milliseconds.

getCompositorIdleCpu()

 

Returns the time spent waiting for running start (application could have used this much more time)

Returns: Real32
The time spent waiting for running start in milliseconds.

getCompositorRenderCpu()

 

Returns the time spent on cpu submitting the above work for this frame

Returns: Real32
The time spent on cpu submitting the above work for this frame in milliseconds.

getCompositorRenderGpu()

 

Returns the time spend performing distortion correction, rendering chaperone, overlays, etc

Returns: Real32
The compositor rendering time in milliseconds.

getCompositorRenderStart()

 

Returns the timestamp when the compositor started rendering relative to the global system time

Returns: Real32
The timestamp in milliseconds.

getCompositorUpdateEnd()

 

Returns the timestamp when the compositor update was finished relative to the global system time

Returns: Real32
The timestamp in milliseconds.

getCompositorUpdateStart()

 

Returns the timestamp when a the compositor update was started relative to the global system times

Returns: Real32
The timestamp in milliseconds.

getFrameId()

 

Returns index of the current frame.

Returns: UInt32
The current frame id.

getFrameIndex()

 

Returns the current frame index.

Returns: UInt32
The current frame index.

getMulticastCopyTimeCpu()

 

Returns the cpu time required to copy buffers from one GPU to the other if multicast SLI is enabled. The time is undefined otherwise.

Returns: Real32
The time in milliseconds.

getNewFrameReady()

 

Returns the timestamp when a new frame was ready relative to the global system time

Returns: Real32
The timestamp in milliseconds.

getNewPosesReady()

 

Returns the timestamp when a new pose was ready relative to the global system time

Returns: Real32
The timestamp in milliseconds.

getNumDroppedFrames()

 

Returns the number of additional times previous frame was scanned out.

Returns: UInt32
The number of additional times previous frame was scanned out.

getNumFramePresents()

 

Returns the number of times this frame was presented.

Returns: UInt32
The number of times this frame was presented.

getNumMisPresented()

 

Returns the number of times this frame was presented on a vsync other than it was originally predicted to.

Returns: UInt32
The number of times this frame was presented on a vsync other than it was originally predicted to.

getPostSubmitCpu()

 

Returns the cpu time from completing the submit calls

Returns: Real32
The time in milliseconds.

getPostSubmitGpu()

 

Returns the additional time spent rendering by application (e.g. companion window)

Returns: Real32
The additional rendering time in milliseconds.

getPreSubmitGpu()

 

Returns the time spent rendering the scene

Returns: Real32
The the time spent rendering the scene in milliseconds.

getPresentCallCpu()

 

Returns the time blocked on call to present (usually 0.0, but can go long)

Returns: Real32
The present call time in milliseconds.

getRenderTimeCpu()

 

Returns the complete cpu rendertime measured from binding the first eye buffer to completing the second eye and creating the mirror texture.

Returns: Real32
The time in milliseconds.

getReprojectionFlag()

 

Returns whether the frame was reprojected or not.

Returns: UInt32
The reprojection state.

getSubmitCpu()

 

Returns the cpu time for doing the submit calls for both eyes

Returns: Real32
The time in milliseconds.

getSubmitFrameTime()

 

Returns the time spent in IVRCompositor::Submit (not near-zero indicates driver issue)

Returns: Real32
The time spent in submitting the current frame in milliseconds.

getSystemTimeInSeconds()

 

Returns the absolute time reference for comparing frames. This aligns with the vsync that running start is relative to

Returns: Real64
The absolute system time reference in seconds.

getTimeBetweenRenderCpu()

 

Returns the cpu time passed between the rendering of two frames.

Returns: Real32
The time in milliseconds.

getTimeBetweenSubmitCpu()

 

Returns the cpu time passed between two calls to submit.

Returns: Real32
The time in milliseconds.

getTimeBetweenWaitGetPosesCpu()

 

Returns the cpu time passed between two calls to WaitGetPoses.

Returns: Real32
The time in milliseconds.

getTotalRenderGpu()

 

Returns the time between work submitted immediately after present (ideally vsync) until the end of compositor submitted work

Returns: Real32
The total gpu render time in milliseconds.

getWaitForPresentCpu()

 

Returns the time spent spin-waiting for frame index to change (not near-zero indicates wait object failure)

Returns: Real32
The time waiting for next frame in milliseconds.

getWaitGetPosesCalled()

 

Returns the timestamp when WaitGetPoses was called relative to the global system time

Returns: Real32
The timestamp in milliseconds.

getWaitGetPosesCpu()

 

Returns the cpu time for WaitGetPoses.

Returns: Real32
The time in milliseconds.

   Trees       Indices       Help   
VRED Python API v1
Generated by Epydoc 3.0.1 on Fri Nov 29 09:33:22 2024 http://epydoc.sourceforge.net