Class CompositorCumulativeStats

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CompositorCumulativeStats extends Struct<CompositorCumulativeStats> implements NativeResource
Cumulative stats for current application. These are not cleared until a new app connects, but they do stop accumulating once the associated app disconnects.

Layout


 struct Compositor_CumulativeStats {
     uint32_t m_nPid();
     uint32_t m_nNumFramePresents();
     uint32_t m_nNumDroppedFrames();
     uint32_t m_nNumReprojectedFrames();
     uint32_t m_nNumFramePresentsOnStartup;
     uint32_t m_nNumDroppedFramesOnStartup;
     uint32_t m_nNumReprojectedFramesOnStartup;
     uint32_t m_nNumLoading;
     uint32_t m_nNumFramePresentsLoading;
     uint32_t m_nNumDroppedFramesLoading;
     uint32_t m_nNumReprojectedFramesLoading;
     uint32_t m_nNumTimedOut;
     uint32_t m_nNumFramePresentsTimedOut;
     uint32_t m_nNumDroppedFramesTimedOut;
     uint32_t m_nNumReprojectedFramesTimedOut;
     uint32_t m_nNumFrameSubmits;
     vrshared_double m_flSumCompositorCPUTimeMS();
     vrshared_double m_flSumCompositorGPUTimeMS();
     vrshared_double m_flSumTargetFrameTimes();
     vrshared_double m_flSumApplicationCPUTimeMS();
     vrshared_double m_flSumApplicationGPUTimeMS();
     uint32_t m_nNumFramesWithDepth();
 }
  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • M_NPID

      public static final int M_NPID
      The struct member offsets.
    • M_NNUMFRAMEPRESENTS

      public static final int M_NNUMFRAMEPRESENTS
      The struct member offsets.
    • M_NNUMDROPPEDFRAMES

      public static final int M_NNUMDROPPEDFRAMES
      The struct member offsets.
    • M_NNUMREPROJECTEDFRAMES

      public static final int M_NNUMREPROJECTEDFRAMES
      The struct member offsets.
    • M_NNUMFRAMEPRESENTSONSTARTUP

      public static final int M_NNUMFRAMEPRESENTSONSTARTUP
      The struct member offsets.
    • M_NNUMDROPPEDFRAMESONSTARTUP

      public static final int M_NNUMDROPPEDFRAMESONSTARTUP
      The struct member offsets.
    • M_NNUMREPROJECTEDFRAMESONSTARTUP

      public static final int M_NNUMREPROJECTEDFRAMESONSTARTUP
      The struct member offsets.
    • M_NNUMLOADING

      public static final int M_NNUMLOADING
      The struct member offsets.
    • M_NNUMFRAMEPRESENTSLOADING

      public static final int M_NNUMFRAMEPRESENTSLOADING
      The struct member offsets.
    • M_NNUMDROPPEDFRAMESLOADING

      public static final int M_NNUMDROPPEDFRAMESLOADING
      The struct member offsets.
    • M_NNUMREPROJECTEDFRAMESLOADING

      public static final int M_NNUMREPROJECTEDFRAMESLOADING
      The struct member offsets.
    • M_NNUMTIMEDOUT

      public static final int M_NNUMTIMEDOUT
      The struct member offsets.
    • M_NNUMFRAMEPRESENTSTIMEDOUT

      public static final int M_NNUMFRAMEPRESENTSTIMEDOUT
      The struct member offsets.
    • M_NNUMDROPPEDFRAMESTIMEDOUT

      public static final int M_NNUMDROPPEDFRAMESTIMEDOUT
      The struct member offsets.
    • M_NNUMREPROJECTEDFRAMESTIMEDOUT

      public static final int M_NNUMREPROJECTEDFRAMESTIMEDOUT
      The struct member offsets.
    • M_NNUMFRAMESUBMITS

      public static final int M_NNUMFRAMESUBMITS
      The struct member offsets.
    • M_FLSUMCOMPOSITORCPUTIMEMS

      public static final int M_FLSUMCOMPOSITORCPUTIMEMS
      The struct member offsets.
    • M_FLSUMCOMPOSITORGPUTIMEMS

      public static final int M_FLSUMCOMPOSITORGPUTIMEMS
      The struct member offsets.
    • M_FLSUMTARGETFRAMETIMES

      public static final int M_FLSUMTARGETFRAMETIMES
      The struct member offsets.
    • M_FLSUMAPPLICATIONCPUTIMEMS

      public static final int M_FLSUMAPPLICATIONCPUTIMEMS
      The struct member offsets.
    • M_FLSUMAPPLICATIONGPUTIMEMS

      public static final int M_FLSUMAPPLICATIONGPUTIMEMS
      The struct member offsets.
    • M_NNUMFRAMESWITHDEPTH

      public static final int M_NNUMFRAMESWITHDEPTH
      The struct member offsets.
  • Constructor Details

    • CompositorCumulativeStats

      public CompositorCumulativeStats(ByteBuffer container)
      Creates a CompositorCumulativeStats 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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<CompositorCumulativeStats>
    • m_nPid

      public int m_nPid()
      Process id associated with these stats (may no longer be running).
    • m_nNumFramePresents

      public int m_nNumFramePresents()
      total number of times we called present (includes reprojected frames)
    • m_nNumDroppedFrames

      public int m_nNumDroppedFrames()
      total number of times an old frame was re-scanned out (without reprojection)
    • m_nNumReprojectedFrames

      public int m_nNumReprojectedFrames()
      total number of times a frame was scanned out a second time (with reprojection)
    • m_nNumFramePresentsOnStartup

      public int m_nNumFramePresentsOnStartup()
      Returns:
      the value of the m_nNumFramePresentsOnStartup field.
    • m_nNumDroppedFramesOnStartup

      public int m_nNumDroppedFramesOnStartup()
      Returns:
      the value of the m_nNumDroppedFramesOnStartup field.
    • m_nNumReprojectedFramesOnStartup

      public int m_nNumReprojectedFramesOnStartup()
      Returns:
      the value of the m_nNumReprojectedFramesOnStartup field.
    • m_nNumLoading

      public int m_nNumLoading()
      Returns:
      the value of the m_nNumLoading field.
    • m_nNumFramePresentsLoading

      public int m_nNumFramePresentsLoading()
      Returns:
      the value of the m_nNumFramePresentsLoading field.
    • m_nNumDroppedFramesLoading

      public int m_nNumDroppedFramesLoading()
      Returns:
      the value of the m_nNumDroppedFramesLoading field.
    • m_nNumReprojectedFramesLoading

      public int m_nNumReprojectedFramesLoading()
      Returns:
      the value of the m_nNumReprojectedFramesLoading field.
    • m_nNumTimedOut

      public int m_nNumTimedOut()
      Returns:
      the value of the m_nNumTimedOut field.
    • m_nNumFramePresentsTimedOut

      public int m_nNumFramePresentsTimedOut()
      Returns:
      the value of the m_nNumFramePresentsTimedOut field.
    • m_nNumDroppedFramesTimedOut

      public int m_nNumDroppedFramesTimedOut()
      Returns:
      the value of the m_nNumDroppedFramesTimedOut field.
    • m_nNumReprojectedFramesTimedOut

      public int m_nNumReprojectedFramesTimedOut()
      Returns:
      the value of the m_nNumReprojectedFramesTimedOut field.
    • m_nNumFrameSubmits

      public int m_nNumFrameSubmits()
      Returns:
      the value of the m_nNumFrameSubmits field.
    • m_flSumCompositorCPUTimeMS

      public double m_flSumCompositorCPUTimeMS()
      divide by m_nNumFrameSubmits
    • m_flSumCompositorGPUTimeMS

      public double m_flSumCompositorGPUTimeMS()
      divide by m_nNumFrameSubmits
    • m_flSumTargetFrameTimes

      public double m_flSumTargetFrameTimes()
      divide by m_nNumFrameSubmits
    • m_flSumApplicationCPUTimeMS

      public double m_flSumApplicationCPUTimeMS()
      divide by m_nNumFrameSubmits
    • m_flSumApplicationGPUTimeMS

      public double m_flSumApplicationGPUTimeMS()
      divide by m_nNumFrameSubmits
    • m_nNumFramesWithDepth

      public int m_nNumFramesWithDepth()
      total frames submitted with depth by the current application
    • malloc

      public static CompositorCumulativeStats malloc()
      Returns a new CompositorCumulativeStats instance allocated with memAlloc. The instance must be explicitly freed.
    • calloc

      public static CompositorCumulativeStats calloc()
      Returns a new CompositorCumulativeStats instance allocated with memCalloc. The instance must be explicitly freed.
    • create

      public static CompositorCumulativeStats create()
      Returns a new CompositorCumulativeStats instance allocated with BufferUtils.
    • create

      public static CompositorCumulativeStats create(long address)
      Returns a new CompositorCumulativeStats instance for the specified memory address.
    • createSafe

      @Nullable public static CompositorCumulativeStats createSafe(long address)
      Like create, but returns null if address is NULL.
    • malloc

      public static CompositorCumulativeStats.Buffer malloc(int capacity)
      Returns a new CompositorCumulativeStats.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • calloc

      public static CompositorCumulativeStats.Buffer calloc(int capacity)
      Returns a new CompositorCumulativeStats.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity
    • create

      public static CompositorCumulativeStats.Buffer create(int capacity)
      Returns a new CompositorCumulativeStats.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity
    • create

      public static CompositorCumulativeStats.Buffer create(long address, int capacity)
      Create a CompositorCumulativeStats.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity
    • createSafe

      @Nullable public static CompositorCumulativeStats.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.
    • mallocStack

      @Deprecated public static CompositorCumulativeStats mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

      @Deprecated public static CompositorCumulativeStats callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
    • mallocStack

      @Deprecated public static CompositorCumulativeStats mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

      @Deprecated public static CompositorCumulativeStats callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
    • mallocStack

      @Deprecated public static CompositorCumulativeStats.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
    • callocStack

      @Deprecated public static CompositorCumulativeStats.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
    • mallocStack

      @Deprecated public static CompositorCumulativeStats.Buffer mallocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
    • callocStack

      @Deprecated public static CompositorCumulativeStats.Buffer callocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
    • malloc

      public static CompositorCumulativeStats malloc(MemoryStack stack)
      Returns a new CompositorCumulativeStats instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate
    • calloc

      public static CompositorCumulativeStats calloc(MemoryStack stack)
      Returns a new CompositorCumulativeStats instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate
    • malloc

      public static CompositorCumulativeStats.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new CompositorCumulativeStats.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • calloc

      public static CompositorCumulativeStats.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new CompositorCumulativeStats.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • nm_nPid

      public static int nm_nPid(long struct)
      Unsafe version of m_nPid().
    • nm_nNumFramePresents

      public static int nm_nNumFramePresents(long struct)
      Unsafe version of m_nNumFramePresents().
    • nm_nNumDroppedFrames

      public static int nm_nNumDroppedFrames(long struct)
      Unsafe version of m_nNumDroppedFrames().
    • nm_nNumReprojectedFrames

      public static int nm_nNumReprojectedFrames(long struct)
      Unsafe version of m_nNumReprojectedFrames().
    • nm_nNumFramePresentsOnStartup

      public static int nm_nNumFramePresentsOnStartup(long struct)
    • nm_nNumDroppedFramesOnStartup

      public static int nm_nNumDroppedFramesOnStartup(long struct)
    • nm_nNumReprojectedFramesOnStartup

      public static int nm_nNumReprojectedFramesOnStartup(long struct)
    • nm_nNumLoading

      public static int nm_nNumLoading(long struct)
      Unsafe version of m_nNumLoading().
    • nm_nNumFramePresentsLoading

      public static int nm_nNumFramePresentsLoading(long struct)
      Unsafe version of m_nNumFramePresentsLoading().
    • nm_nNumDroppedFramesLoading

      public static int nm_nNumDroppedFramesLoading(long struct)
      Unsafe version of m_nNumDroppedFramesLoading().
    • nm_nNumReprojectedFramesLoading

      public static int nm_nNumReprojectedFramesLoading(long struct)
    • nm_nNumTimedOut

      public static int nm_nNumTimedOut(long struct)
      Unsafe version of m_nNumTimedOut().
    • nm_nNumFramePresentsTimedOut

      public static int nm_nNumFramePresentsTimedOut(long struct)
    • nm_nNumDroppedFramesTimedOut

      public static int nm_nNumDroppedFramesTimedOut(long struct)
    • nm_nNumReprojectedFramesTimedOut

      public static int nm_nNumReprojectedFramesTimedOut(long struct)
    • nm_nNumFrameSubmits

      public static int nm_nNumFrameSubmits(long struct)
      Unsafe version of m_nNumFrameSubmits().
    • nm_flSumCompositorCPUTimeMS

      public static double nm_flSumCompositorCPUTimeMS(long struct)
      Unsafe version of m_flSumCompositorCPUTimeMS().
    • nm_flSumCompositorGPUTimeMS

      public static double nm_flSumCompositorGPUTimeMS(long struct)
      Unsafe version of m_flSumCompositorGPUTimeMS().
    • nm_flSumTargetFrameTimes

      public static double nm_flSumTargetFrameTimes(long struct)
      Unsafe version of m_flSumTargetFrameTimes().
    • nm_flSumApplicationCPUTimeMS

      public static double nm_flSumApplicationCPUTimeMS(long struct)
    • nm_flSumApplicationGPUTimeMS

      public static double nm_flSumApplicationGPUTimeMS(long struct)
    • nm_nNumFramesWithDepth

      public static int nm_nNumFramesWithDepth(long struct)
      Unsafe version of m_nNumFramesWithDepth().