Package org.lwjgl.ovr
Class OVRSessionStatus
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.ovr.OVRSessionStatus
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class OVRSessionStatus extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specifies status information for the current session.Member documentation
IsVisible
– True if the process has VR focus and thus is visible in the HMD.HmdPresent
– True if an HMD is present.HmdMounted
– True if the HMD is on the user's head.DisplayLost
– True if the session is in a display-lost state. SeeSubmitFrame
.ShouldQuit
– True if the application should initiate shutdown.ShouldRecenter
– True if UX has requested re-centering. Must callClearShouldRecenterFlag
,RecenterTrackingOrigin
orSpecifyTrackingOrigin
.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
– 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
– True if runtime is requesting that the application provide depth buffers with projection layers.
Layout
struct ovrSessionStatus { ovrBool IsVisible; ovrBool HmdPresent; ovrBool HmdMounted; ovrBool DisplayLost; ovrBool ShouldQuit; ovrBool ShouldRecenter; ovrBool HasInputFocus; ovrBool OverlayPresent; ovrBool DepthRequested; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OVRSessionStatus.Buffer
An array ofOVRSessionStatus
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DEPTHREQUESTED
DISPLAYLOST
HASINPUTFOCUS
HMDMOUNTED
HMDPRESENT
ISVISIBLE
OVERLAYPRESENT
SHOULDQUIT
SHOULDRECENTERThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description OVRSessionStatus(java.nio.ByteBuffer container)
Creates aOVRSessionStatus
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OVRSessionStatus
calloc()
Returns a newOVRSessionStatus
instance allocated withmemCalloc
.static OVRSessionStatus.Buffer
calloc(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withmemCalloc
.static OVRSessionStatus
callocStack()
Returns a newOVRSessionStatus
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static OVRSessionStatus.Buffer
callocStack(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static OVRSessionStatus.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static OVRSessionStatus
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static OVRSessionStatus
create()
Returns a newOVRSessionStatus
instance allocated withBufferUtils
.static OVRSessionStatus.Buffer
create(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withBufferUtils
.static OVRSessionStatus
create(long address)
Returns a newOVRSessionStatus
instance for the specified memory address.static OVRSessionStatus.Buffer
create(long address, int capacity)
Create aOVRSessionStatus.Buffer
instance at the specified memory.static OVRSessionStatus
createSafe(long address)
static OVRSessionStatus.Buffer
createSafe(long address, int capacity)
boolean
DepthRequested()
Returns the value of theDepthRequested
field.boolean
DisplayLost()
Returns the value of theDisplayLost
field.boolean
HasInputFocus()
Returns the value of theHasInputFocus
field.boolean
HmdMounted()
Returns the value of theHmdMounted
field.boolean
HmdPresent()
Returns the value of theHmdPresent
field.boolean
IsVisible()
Returns the value of theIsVisible
field.static OVRSessionStatus
malloc()
Returns a newOVRSessionStatus
instance allocated withmemAlloc
.static OVRSessionStatus.Buffer
malloc(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withmemAlloc
.static OVRSessionStatus
mallocStack()
Returns a newOVRSessionStatus
instance allocated on the thread-localMemoryStack
.static OVRSessionStatus.Buffer
mallocStack(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated on the thread-localMemoryStack
.static OVRSessionStatus.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus.Buffer
instance allocated on the specifiedMemoryStack
.static OVRSessionStatus
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus
instance allocated on the specifiedMemoryStack
.static boolean
nDepthRequested(long struct)
Unsafe version ofDepthRequested()
.static boolean
nDisplayLost(long struct)
Unsafe version ofDisplayLost()
.static boolean
nHasInputFocus(long struct)
Unsafe version ofHasInputFocus()
.static boolean
nHmdMounted(long struct)
Unsafe version ofHmdMounted()
.static boolean
nHmdPresent(long struct)
Unsafe version ofHmdPresent()
.static boolean
nIsVisible(long struct)
Unsafe version ofIsVisible()
.static boolean
nOverlayPresent(long struct)
Unsafe version ofOverlayPresent()
.static boolean
nShouldQuit(long struct)
Unsafe version ofShouldQuit()
.static boolean
nShouldRecenter(long struct)
Unsafe version ofShouldRecenter()
.boolean
OverlayPresent()
Returns the value of theOverlayPresent
field.boolean
ShouldQuit()
Returns the value of theShouldQuit
field.boolean
ShouldRecenter()
Returns the value of theShouldRecenter
field.int
sizeof()
-
-
-
Constructor Detail
-
OVRSessionStatus
public OVRSessionStatus(java.nio.ByteBuffer container)
Creates aOVRSessionStatus
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
IsVisible
public boolean IsVisible()
Returns the value of theIsVisible
field.
-
HmdPresent
public boolean HmdPresent()
Returns the value of theHmdPresent
field.
-
HmdMounted
public boolean HmdMounted()
Returns the value of theHmdMounted
field.
-
DisplayLost
public boolean DisplayLost()
Returns the value of theDisplayLost
field.
-
ShouldQuit
public boolean ShouldQuit()
Returns the value of theShouldQuit
field.
-
ShouldRecenter
public boolean ShouldRecenter()
Returns the value of theShouldRecenter
field.
-
HasInputFocus
public boolean HasInputFocus()
Returns the value of theHasInputFocus
field.
-
OverlayPresent
public boolean OverlayPresent()
Returns the value of theOverlayPresent
field.
-
DepthRequested
public boolean DepthRequested()
Returns the value of theDepthRequested
field.
-
malloc
public static OVRSessionStatus malloc()
Returns a newOVRSessionStatus
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static OVRSessionStatus calloc()
Returns a newOVRSessionStatus
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static OVRSessionStatus create()
Returns a newOVRSessionStatus
instance allocated withBufferUtils
.
-
create
public static OVRSessionStatus create(long address)
Returns a newOVRSessionStatus
instance for the specified memory address.
-
createSafe
@Nullable public static OVRSessionStatus createSafe(long address)
-
malloc
public static OVRSessionStatus.Buffer malloc(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static OVRSessionStatus.Buffer calloc(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static OVRSessionStatus.Buffer create(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static OVRSessionStatus.Buffer create(long address, int capacity)
Create aOVRSessionStatus.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static OVRSessionStatus.Buffer createSafe(long address, int capacity)
-
mallocStack
public static OVRSessionStatus mallocStack()
Returns a newOVRSessionStatus
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static OVRSessionStatus callocStack()
Returns a newOVRSessionStatus
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static OVRSessionStatus mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static OVRSessionStatus callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static OVRSessionStatus.Buffer mallocStack(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static OVRSessionStatus.Buffer callocStack(int capacity)
Returns a newOVRSessionStatus.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static OVRSessionStatus.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static OVRSessionStatus.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newOVRSessionStatus.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nIsVisible
public static boolean nIsVisible(long struct)
Unsafe version ofIsVisible()
.
-
nHmdPresent
public static boolean nHmdPresent(long struct)
Unsafe version ofHmdPresent()
.
-
nHmdMounted
public static boolean nHmdMounted(long struct)
Unsafe version ofHmdMounted()
.
-
nDisplayLost
public static boolean nDisplayLost(long struct)
Unsafe version ofDisplayLost()
.
-
nShouldQuit
public static boolean nShouldQuit(long struct)
Unsafe version ofShouldQuit()
.
-
nShouldRecenter
public static boolean nShouldRecenter(long struct)
Unsafe version ofShouldRecenter()
.
-
nHasInputFocus
public static boolean nHasInputFocus(long struct)
Unsafe version ofHasInputFocus()
.
-
nOverlayPresent
public static boolean nOverlayPresent(long struct)
Unsafe version ofOverlayPresent()
.
-
nDepthRequested
public static boolean nDepthRequested(long struct)
Unsafe version ofDepthRequested()
.
-
-