Package org.lwjgl.ovr

Class OVRSessionStatus

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<OVRSessionStatus>
org.lwjgl.ovr.OVRSessionStatus
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class OVRSessionStatus extends org.lwjgl.system.Struct<OVRSessionStatus> implements org.lwjgl.system.NativeResource
Specifies status information for the current session.

Layout


 struct ovrSessionStatus {
     ovrBool IsVisible();
     ovrBool HmdPresent();
     ovrBool HmdMounted();
     ovrBool DisplayLost();
     ovrBool ShouldQuit();
     ovrBool ShouldRecenter();
     ovrBool HasInputFocus();
     ovrBool OverlayPresent();
     ovrBool DepthRequested();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • ISVISIBLE

      public static final int ISVISIBLE
      The struct member offsets.

    • HMDPRESENT

      public static final int HMDPRESENT
      The struct member offsets.

    • HMDMOUNTED

      public static final int HMDMOUNTED
      The struct member offsets.

    • DISPLAYLOST

      public static final int DISPLAYLOST
      The struct member offsets.

    • SHOULDQUIT

      public static final int SHOULDQUIT
      The struct member offsets.

    • SHOULDRECENTER

      public static final int SHOULDRECENTER
      The struct member offsets.

    • HASINPUTFOCUS

      public static final int HASINPUTFOCUS
      The struct member offsets.

    • OVERLAYPRESENT

      public static final int OVERLAYPRESENT
      The struct member offsets.

    • DEPTHREQUESTED

      public static final int DEPTHREQUESTED
      The struct member offsets.

  • Constructor Details

    • OVRSessionStatus

      public OVRSessionStatus(ByteBuffer container)
      Creates a OVRSessionStatus 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<OVRSessionStatus>

    • IsVisible

      public boolean IsVisible()
      True if the process has VR focus and thus is visible in the HMD.

    • HmdPresent

      public boolean HmdPresent()
      True if an HMD is present.

    • HmdMounted

      public boolean HmdMounted()
      True if the HMD is on the user's head.

    • DisplayLost

      public boolean DisplayLost()
      True if the session is in a display-lost state. See SubmitFrame.

    • ShouldQuit

      public boolean ShouldQuit()
      True if the application should initiate shutdown.

    • ShouldRecenter

      public boolean ShouldRecenter()
      True if UX has requested re-centering. Must call ClearShouldRecenterFlag, RecenterTrackingOrigin or SpecifyTrackingOrigin.

    • HasInputFocus

      public boolean HasInputFocus()
      True if the application is the foreground application and receives input (e.g. Touch controller state). If this is false then the application is in the background (but possibly still visible) should hide any input representations such as hands.

    • OverlayPresent

      public boolean OverlayPresent()
      True if a system overlay is present, such as a dashboard. In this case the application (if visible) should pause while still drawing, avoid drawing near-field graphics so they don't visually fight with the system overlay, and consume fewer CPU and GPU resources.

      Deprecated, do not use.

    • DepthRequested

      public boolean DepthRequested()
      True if runtime is requesting that the application provide depth buffers with projection layers.

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

      @Deprecated public static OVRSessionStatus mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static OVRSessionStatus callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

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

    • callocStack

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

    • mallocStack

      @Deprecated public static OVRSessionStatus.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static OVRSessionStatus.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static OVRSessionStatus malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new OVRSessionStatus instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

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

    • malloc

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

    • calloc

      public static OVRSessionStatus.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new OVRSessionStatus.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

    • nIsVisible

      public static boolean nIsVisible(long struct)
      Unsafe version of IsVisible().

    • nHmdPresent

      public static boolean nHmdPresent(long struct)
      Unsafe version of HmdPresent().

    • nHmdMounted

      public static boolean nHmdMounted(long struct)
      Unsafe version of HmdMounted().

    • nDisplayLost

      public static boolean nDisplayLost(long struct)
      Unsafe version of DisplayLost().

    • nShouldQuit

      public static boolean nShouldQuit(long struct)
      Unsafe version of ShouldQuit().

    • nShouldRecenter

      public static boolean nShouldRecenter(long struct)
      Unsafe version of ShouldRecenter().

    • nHasInputFocus

      public static boolean nHasInputFocus(long struct)
      Unsafe version of HasInputFocus().

    • nOverlayPresent

      public static boolean nOverlayPresent(long struct)
      Unsafe version of OverlayPresent().

    • nDepthRequested

      public static boolean nDepthRequested(long struct)
      Unsafe version of DepthRequested().