java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.ovr.OVRPerfStatsPerCompositorFrame

All Implemented Interfaces:: org.lwjgl.system.Pointer

public class OVRPerfStatsPerCompositorFrame
extends org.lwjgl.system.Struct

Contains the performance stats for a given SDK compositor frame.

All of the int fields can be reset via the ResetPerfStats call.

Layout


 struct ovrPerfStatsPerCompositorFrame {
     int HmdVsyncIndex();
     int AppFrameIndex();
     int AppDroppedFrameCount();
     float AppMotionToPhotonLatency();
     float AppQueueAheadTime();
     float AppCpuElapsedTime();
     float AppGpuElapsedTime();
     int CompositorFrameIndex();
     int CompositorDroppedFrameCount();
     float CompositorLatency();
     float CompositorCpuElapsedTime();
     float CompositorGpuElapsedTime();
     float CompositorCpuStartToGpuEndElapsedTime();
     float CompositorGpuEndToVsyncElapsedTime();
     ovrBool AswIsActive();
     int AswActivatedToggleCount();
     int AswPresentedFrameCount();
     int AswFailedFrameCount();
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OVRPerfStatsPerCompositorFrame.Buffer
An array of OVRPerfStatsPerCompositorFrame structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`APPCPUELAPSEDTIME APPDROPPEDFRAMECOUNT APPFRAMEINDEX APPGPUELAPSEDTIME APPMOTIONTOPHOTONLATENCY APPQUEUEAHEADTIME ASWACTIVATEDTOGGLECOUNT ASWFAILEDFRAMECOUNT ASWISACTIVE ASWPRESENTEDFRAMECOUNT COMPOSITORCPUELAPSEDTIME COMPOSITORCPUSTARTTOGPUENDELAPSEDTIME COMPOSITORDROPPEDFRAMECOUNT COMPOSITORFRAMEINDEX COMPOSITORGPUELAPSEDTIME COMPOSITORGPUENDTOVSYNCELAPSEDTIME COMPOSITORLATENCY HMDVSYNCINDEX`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`OVRPerfStatsPerCompositorFrame(java.nio.ByteBuffer container)`	Creates a `OVRPerfStatsPerCompositorFrame` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`float`	`AppCpuElapsedTime()`	amount of time in seconds spent on the CPU by the app's render-thread that calls `SubmitFrame`.
`int`	`AppDroppedFrameCount()`	if the app fails to call `SubmitFrame` on time, then expect this value to increment with each missed frame
`int`	`AppFrameIndex()`	index that increments with each successive `SubmitFrame` call
`float`	`AppGpuElapsedTime()`	amount of time in seconds spent on the GPU by the app.
`float`	`AppMotionToPhotonLatency()`	motion-to-photon latency for the application
`float`	`AppQueueAheadTime()`	amount of queue-ahead in seconds provided to the app based on performance and overlap of CPU and GPU utilization.
`int`	`AswActivatedToggleCount()`	Increments each time ASW it activated where the app was forced in and out of half-rate rendering.
`int`	`AswFailedFrameCount()`	Accumulates the number of frames that the compositor tried to present when ASW is active but failed
`boolean`	`AswIsActive()`	Will be true if ASW is active for the given frame such that the application is being forced into half the frame-rate while the compositor continues to run at full frame-rate.
`int`	`AswPresentedFrameCount()`	Accumulates the number of frames presented by the compositor which had extrapolated ASW frames presented
`float`	`CompositorCpuElapsedTime()`	the amount of time in seconds spent on the CPU by the SDK compositor.
`float`	`CompositorCpuStartToGpuEndElapsedTime()`	the amount of time in seconds spent from the point the CPU kicks off the compositor to the point in time the compositor completes the distortion & timewarp on the GPU.
`int`	`CompositorDroppedFrameCount()`	increments each time the SDK compositor fails to complete in time.
`int`	`CompositorFrameIndex()`	index that increments each time the SDK compositor completes a distortion and timewarp pass.
`float`	`CompositorGpuElapsedTime()`	the amount of time in seconds spent on the GPU by the SDK compositor.
`float`	`CompositorGpuEndToVsyncElapsedTime()`	the amount of time in seconds left after the compositor is done on the GPU to the associated V-Sync time.
`float`	`CompositorLatency()`	motion-to-photon latency of the SDK compositor in seconds.
`static OVRPerfStatsPerCompositorFrame`	`create(long address)`	Returns a new `OVRPerfStatsPerCompositorFrame` instance for the specified memory address.
`static OVRPerfStatsPerCompositorFrame.Buffer`	`create(long address, int capacity)`	Create a `OVRPerfStatsPerCompositorFrame.Buffer` instance at the specified memory.
`static OVRPerfStatsPerCompositorFrame`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static OVRPerfStatsPerCompositorFrame.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`HmdVsyncIndex()`	Vsync Frame Index - increments with each HMD vertical synchronization signal (i.e.
`static float`	`nAppCpuElapsedTime(long struct)`	Unsafe version of `AppCpuElapsedTime()`.
`static int`	`nAppDroppedFrameCount(long struct)`	Unsafe version of `AppDroppedFrameCount()`.
`static int`	`nAppFrameIndex(long struct)`	Unsafe version of `AppFrameIndex()`.
`static float`	`nAppGpuElapsedTime(long struct)`	Unsafe version of `AppGpuElapsedTime()`.
`static float`	`nAppMotionToPhotonLatency(long struct)`	Unsafe version of `AppMotionToPhotonLatency()`.
`static float`	`nAppQueueAheadTime(long struct)`	Unsafe version of `AppQueueAheadTime()`.
`static int`	`nAswActivatedToggleCount(long struct)`	Unsafe version of `AswActivatedToggleCount()`.
`static int`	`nAswFailedFrameCount(long struct)`	Unsafe version of `AswFailedFrameCount()`.
`static boolean`	`nAswIsActive(long struct)`	Unsafe version of `AswIsActive()`.
`static int`	`nAswPresentedFrameCount(long struct)`	Unsafe version of `AswPresentedFrameCount()`.
`static float`	`nCompositorCpuElapsedTime(long struct)`	Unsafe version of `CompositorCpuElapsedTime()`.
`static float`	`nCompositorCpuStartToGpuEndElapsedTime(long struct)`	Unsafe version of `CompositorCpuStartToGpuEndElapsedTime()`.
`static int`	`nCompositorDroppedFrameCount(long struct)`	Unsafe version of `CompositorDroppedFrameCount()`.
`static int`	`nCompositorFrameIndex(long struct)`	Unsafe version of `CompositorFrameIndex()`.
`static float`	`nCompositorGpuElapsedTime(long struct)`	Unsafe version of `CompositorGpuElapsedTime()`.
`static float`	`nCompositorGpuEndToVsyncElapsedTime(long struct)`	Unsafe version of `CompositorGpuEndToVsyncElapsedTime()`.
`static float`	`nCompositorLatency(long struct)`	Unsafe version of `CompositorLatency()`.
`static int`	`nHmdVsyncIndex(long struct)`	Unsafe version of `HmdVsyncIndex()`.
`int`	`sizeof()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - HMDVSYNCINDEX, APPFRAMEINDEX, APPDROPPEDFRAMECOUNT, APPMOTIONTOPHOTONLATENCY, APPQUEUEAHEADTIME, APPCPUELAPSEDTIME, APPGPUELAPSEDTIME, COMPOSITORFRAMEINDEX, COMPOSITORDROPPEDFRAMECOUNT, COMPOSITORLATENCY, COMPOSITORCPUELAPSEDTIME, COMPOSITORGPUELAPSEDTIME, COMPOSITORCPUSTARTTOGPUENDELAPSEDTIME, COMPOSITORGPUENDTOVSYNCELAPSEDTIME, ASWISACTIVE, ASWACTIVATEDTOGGLECOUNT, ASWPRESENTEDFRAMECOUNT, ASWFAILEDFRAMECOUNT
    
    The struct member offsets.
- Constructor Detail
  - OVRPerfStatsPerCompositorFrame
```
public OVRPerfStatsPerCompositorFrame(java.nio.ByteBuffer container)
```
    Creates a OVRPerfStatsPerCompositorFrame instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - HmdVsyncIndex
```
public int HmdVsyncIndex()
```
    Vsync Frame Index - increments with each HMD vertical synchronization signal (i.e. vsync or refresh rate).
    If the compositor drops a frame, expect this value to increment more than 1 at a time.
  - AppFrameIndex
```
public int AppFrameIndex()
```
    index that increments with each successive SubmitFrame call
  - AppDroppedFrameCount
```
public int AppDroppedFrameCount()
```
    if the app fails to call SubmitFrame on time, then expect this value to increment with each missed frame
  - AppMotionToPhotonLatency
```
public float AppMotionToPhotonLatency()
```
    motion-to-photon latency for the application
    This value is calculated by either using the SensorSampleTime provided for the OVRLayerEyeFov or if that is not available, then the call to GetTrackingState which has latencyMarker set to True.
  - AppQueueAheadTime
```
public float AppQueueAheadTime()
```
    amount of queue-ahead in seconds provided to the app based on performance and overlap of CPU and GPU utilization.
    A value of 0.0 would mean the CPU & GPU workload is being completed in 1 frame's worth of time, while 11 ms (on the CV1) of queue ahead would indicate that the app's CPU workload for the next frame is overlapping the app's GPU workload for the current frame.
  - AppCpuElapsedTime
```
public float AppCpuElapsedTime()
```
    amount of time in seconds spent on the CPU by the app's render-thread that calls SubmitFrame.
    Measured as elapsed time between from when app regains control from SubmitFrame to the next time the app calls SubmitFrame.
  - AppGpuElapsedTime
```
public float AppGpuElapsedTime()
```
    amount of time in seconds spent on the GPU by the app.
    Measured as elapsed time between each SubmitFrame call using GPU timing queries.
  - CompositorFrameIndex
```
public int CompositorFrameIndex()
```
    index that increments each time the SDK compositor completes a distortion and timewarp pass.
    Since the compositor operates asynchronously, even if the app calls SubmitFrame too late, the compositor will kick off for each vsync.
  - CompositorDroppedFrameCount
```
public int CompositorDroppedFrameCount()
```
    increments each time the SDK compositor fails to complete in time.
    This is not tied to the app's performance, but failure to complete can be related to other factors such as OS capabilities, overall available hardware cycles to execute the compositor in time and other factors outside of the app's control.
  - CompositorLatency
```
public float CompositorLatency()
```
    motion-to-photon latency of the SDK compositor in seconds.
    This is the latency of timewarp which corrects the higher app latency as well as dropped app frames.
  - CompositorCpuElapsedTime
```
public float CompositorCpuElapsedTime()
```
    the amount of time in seconds spent on the CPU by the SDK compositor.
    Unless the VR app is utilizing all of the CPU cores at their peak performance, there is a good chance the compositor CPU times will not affect the app's CPU performance in a major way.
  - CompositorGpuElapsedTime
```
public float CompositorGpuElapsedTime()
```
    the amount of time in seconds spent on the GPU by the SDK compositor. Any time spent on the compositor will eat away from the available GPU time for the app.
  - CompositorCpuStartToGpuEndElapsedTime
```
public float CompositorCpuStartToGpuEndElapsedTime()
```
    the amount of time in seconds spent from the point the CPU kicks off the compositor to the point in time the compositor completes the distortion & timewarp on the GPU.
    In the event the GPU time is not available, expect this value to be -1.0f.
  - CompositorGpuEndToVsyncElapsedTime
```
public float CompositorGpuEndToVsyncElapsedTime()
```
    the amount of time in seconds left after the compositor is done on the GPU to the associated V-Sync time.
    In the event the GPU time is not available, expect this value to be -1.0f.
  - AswIsActive
```
public boolean AswIsActive()
```
    Will be true if ASW is active for the given frame such that the application is being forced into half the frame-rate while the compositor continues to run at full frame-rate.
  - AswActivatedToggleCount
```
public int AswActivatedToggleCount()
```
    Increments each time ASW it activated where the app was forced in and out of half-rate rendering.
  - AswPresentedFrameCount
```
public int AswPresentedFrameCount()
```
    Accumulates the number of frames presented by the compositor which had extrapolated ASW frames presented
  - AswFailedFrameCount
```
public int AswFailedFrameCount()
```
    Accumulates the number of frames that the compositor tried to present when ASW is active but failed
  - create
```
public static OVRPerfStatsPerCompositorFrame create(long address)
```
    Returns a new OVRPerfStatsPerCompositorFrame instance for the specified memory address.
  - createSafe
```
@Nullable
public static OVRPerfStatsPerCompositorFrame createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - create
```
public static OVRPerfStatsPerCompositorFrame.Buffer create(long address,
                                                           int capacity)
```
    Create a OVRPerfStatsPerCompositorFrame.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static OVRPerfStatsPerCompositorFrame.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - nHmdVsyncIndex
```
public static int nHmdVsyncIndex(long struct)
```
    Unsafe version of HmdVsyncIndex().
  - nAppFrameIndex
```
public static int nAppFrameIndex(long struct)
```
    Unsafe version of AppFrameIndex().
  - nAppDroppedFrameCount
```
public static int nAppDroppedFrameCount(long struct)
```
    Unsafe version of AppDroppedFrameCount().
  - nAppMotionToPhotonLatency
```
public static float nAppMotionToPhotonLatency(long struct)
```
    Unsafe version of AppMotionToPhotonLatency().
  - nAppQueueAheadTime
```
public static float nAppQueueAheadTime(long struct)
```
    Unsafe version of AppQueueAheadTime().
  - nAppCpuElapsedTime
```
public static float nAppCpuElapsedTime(long struct)
```
    Unsafe version of AppCpuElapsedTime().
  - nAppGpuElapsedTime
```
public static float nAppGpuElapsedTime(long struct)
```
    Unsafe version of AppGpuElapsedTime().
  - nCompositorFrameIndex
```
public static int nCompositorFrameIndex(long struct)
```
    Unsafe version of CompositorFrameIndex().
  - nCompositorDroppedFrameCount
```
public static int nCompositorDroppedFrameCount(long struct)
```
    Unsafe version of CompositorDroppedFrameCount().
  - nCompositorLatency
```
public static float nCompositorLatency(long struct)
```
    Unsafe version of CompositorLatency().
  - nCompositorCpuElapsedTime
```
public static float nCompositorCpuElapsedTime(long struct)
```
    Unsafe version of CompositorCpuElapsedTime().
  - nCompositorGpuElapsedTime
```
public static float nCompositorGpuElapsedTime(long struct)
```
    Unsafe version of CompositorGpuElapsedTime().
  - nCompositorCpuStartToGpuEndElapsedTime
```
public static float nCompositorCpuStartToGpuEndElapsedTime(long struct)
```
    Unsafe version of CompositorCpuStartToGpuEndElapsedTime().
  - nCompositorGpuEndToVsyncElapsedTime
```
public static float nCompositorGpuEndToVsyncElapsedTime(long struct)
```
    Unsafe version of CompositorGpuEndToVsyncElapsedTime().
  - nAswIsActive
```
public static boolean nAswIsActive(long struct)
```
    Unsafe version of AswIsActive().
  - nAswActivatedToggleCount
```
public static int nAswActivatedToggleCount(long struct)
```
    Unsafe version of AswActivatedToggleCount().
  - nAswPresentedFrameCount
```
public static int nAswPresentedFrameCount(long struct)
```
    Unsafe version of AswPresentedFrameCount().
  - nAswFailedFrameCount
```
public static int nAswFailedFrameCount(long struct)
```
    Unsafe version of AswFailedFrameCount().

Class OVRPerfStatsPerCompositorFrame

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

Constructor Detail

OVRPerfStatsPerCompositorFrame

Method Detail

sizeof

HmdVsyncIndex

AppFrameIndex

AppDroppedFrameCount

AppMotionToPhotonLatency

AppQueueAheadTime

AppCpuElapsedTime

AppGpuElapsedTime

CompositorFrameIndex

CompositorDroppedFrameCount

CompositorLatency

CompositorCpuElapsedTime

CompositorGpuElapsedTime

CompositorCpuStartToGpuEndElapsedTime

CompositorGpuEndToVsyncElapsedTime

AswIsActive

AswActivatedToggleCount

AswPresentedFrameCount

AswFailedFrameCount

create

createSafe

create

createSafe

nHmdVsyncIndex

nAppFrameIndex

nAppDroppedFrameCount

nAppMotionToPhotonLatency

nAppQueueAheadTime

nAppCpuElapsedTime

nAppGpuElapsedTime

nCompositorFrameIndex

nCompositorDroppedFrameCount

nCompositorLatency

nCompositorCpuElapsedTime

nCompositorGpuElapsedTime

nCompositorCpuStartToGpuEndElapsedTime

nCompositorGpuEndToVsyncElapsedTime

nAswIsActive

nAswActivatedToggleCount

nAswPresentedFrameCount

nAswFailedFrameCount