Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRSessionStatus

extends Struct<OVRSessionStatus>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ovrSessionStatus
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OVRSessionStatus.Buffer

An array of OVRSessionStatus structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEPTHREQUESTED

The struct member offsets.

public static final int
DISPLAYLOST

The struct member offsets.

public static final int
HASINPUTFOCUS

The struct member offsets.

public static final int
HMDMOUNTED

The struct member offsets.

public static final int
HMDPRESENT

The struct member offsets.

public static final int
ISVISIBLE

The struct member offsets.

public static final int
OVERLAYPRESENT

The struct member offsets.

public static final int
SHOULDQUIT

The struct member offsets.

public static final int
SHOULDRECENTER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
OVRSessionStatus(long address, ByteBuffer container)

public
OVRSessionStatus(ByteBuffer container)

Creates a OVRSessionStatus instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static OVRSessionStatus
calloc()

Returns a new OVRSessionStatus instance allocated with memCalloc.

public static OVRSessionStatus.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with memCalloc.

public static OVRSessionStatus
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new OVRSessionStatus instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static OVRSessionStatus.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new OVRSessionStatus.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static OVRSessionStatus
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected OVRSessionStatus
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static OVRSessionStatus
create()

Returns a new OVRSessionStatus instance allocated with BufferUtils.

public static OVRSessionStatus
create(long address)

Returns a new OVRSessionStatus instance for the specified memory address.

public static OVRSessionStatus.Buffer
create(int
the buffer capacity
capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with BufferUtils.

public static OVRSessionStatus.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a OVRSessionStatus.Buffer instance at the specified memory.

public static OVRSessionStatus
createSafe(long address)

Like create, but returns null if address is NULL.

public static OVRSessionStatus.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public boolean
DepthRequested()

True if runtime is requesting that the application provide depth buffers with projection layers.

public boolean
DisplayLost()

True if the session is in a display-lost state.

public boolean
HasInputFocus()

True if the application is the foreground application and receives input (e.g. Touch controller state).

public boolean
HmdMounted()

True if the HMD is on the user's head.

public boolean
HmdPresent()

True if an HMD is present.

public boolean
IsVisible()

True if the process has VR focus and thus is visible in the HMD.

public static OVRSessionStatus
malloc()

Returns a new OVRSessionStatus instance allocated with memAlloc.

public static OVRSessionStatus.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with memAlloc.

public static OVRSessionStatus
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new OVRSessionStatus instance allocated on the specified MemoryStack.

public static OVRSessionStatus.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new OVRSessionStatus.Buffer instance allocated on the specified MemoryStack.

public static OVRSessionStatus
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRSessionStatus.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static boolean
nDepthRequested(long struct)

Unsafe version of DepthRequested.

public static boolean
nDisplayLost(long struct)

Unsafe version of DisplayLost.

public static boolean
nHasInputFocus(long struct)

Unsafe version of HasInputFocus.

public static boolean
nHmdMounted(long struct)

Unsafe version of HmdMounted.

public static boolean
nHmdPresent(long struct)

Unsafe version of HmdPresent.

public static boolean
nIsVisible(long struct)

Unsafe version of IsVisible.

public static boolean
nOverlayPresent(long struct)

Unsafe version of OverlayPresent.

public static boolean
nShouldQuit(long struct)

Unsafe version of ShouldQuit.

public static boolean
nShouldRecenter(long struct)

Unsafe version of ShouldRecenter.

public boolean
OverlayPresent()

True if a system overlay is present, such as a dashboard.

public boolean
ShouldQuit()

True if the application should initiate shutdown.

public boolean
ShouldRecenter()

True if UX has requested re-centering.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEPTHREQUESTEDback to summary
public static final int DEPTHREQUESTED

The struct member offsets.

DISPLAYLOSTback to summary
public static final int DISPLAYLOST

The struct member offsets.

HASINPUTFOCUSback to summary
public static final int HASINPUTFOCUS

The struct member offsets.

HMDMOUNTEDback to summary
public static final int HMDMOUNTED

The struct member offsets.

HMDPRESENTback to summary
public static final int HMDPRESENT

The struct member offsets.

ISVISIBLEback to summary
public static final int ISVISIBLE

The struct member offsets.

OVERLAYPRESENTback to summary
public static final int OVERLAYPRESENT

The struct member offsets.

SHOULDQUITback to summary
public static final int SHOULDQUIT

The struct member offsets.

SHOULDRECENTERback to summary
public static final int SHOULDRECENTER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVRSessionStatusback to summary
protected OVRSessionStatus(long address, ByteBuffer container)
OVRSessionStatusback to summary
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 Detail

callocback to summary
public static OVRSessionStatus calloc()

Returns a new OVRSessionStatus instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static OVRSessionStatus.Buffer calloc(int capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRSessionStatus calloc(MemoryStack stack)

Returns a new OVRSessionStatus instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static OVRSessionStatus.Buffer calloc(int capacity, MemoryStack stack)

Returns a new OVRSessionStatus.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static OVRSessionStatus callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVRSessionStatus callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVRSessionStatus.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVRSessionStatus.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected OVRSessionStatus create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static OVRSessionStatus create()

Returns a new OVRSessionStatus instance allocated with BufferUtils.

createback to summary
public static OVRSessionStatus create(long address)

Returns a new OVRSessionStatus instance for the specified memory address.

createback to summary
public static OVRSessionStatus.Buffer create(int capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static OVRSessionStatus.Buffer create(long address, int capacity)

Create a OVRSessionStatus.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRSessionStatus createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static OVRSessionStatus.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
DepthRequestedback to summary
public boolean DepthRequested()

True if runtime is requesting that the application provide depth buffers with projection layers.

Annotations
@NativeType:ovrBool
DisplayLostback to summary
public boolean DisplayLost()

True if the session is in a display-lost state. See SubmitFrame.

Annotations
@NativeType:ovrBool
HasInputFocusback to summary
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.

Annotations
@NativeType:ovrBool
HmdMountedback to summary
public boolean HmdMounted()

True if the HMD is on the user's head.

Annotations
@NativeType:ovrBool
HmdPresentback to summary
public boolean HmdPresent()

True if an HMD is present.

Annotations
@NativeType:ovrBool
IsVisibleback to summary
public boolean IsVisible()

True if the process has VR focus and thus is visible in the HMD.

Annotations
@NativeType:ovrBool
mallocback to summary
public static OVRSessionStatus malloc()

Returns a new OVRSessionStatus instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static OVRSessionStatus.Buffer malloc(int capacity)

Returns a new OVRSessionStatus.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRSessionStatus malloc(MemoryStack stack)

Returns a new OVRSessionStatus instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static OVRSessionStatus.Buffer malloc(int capacity, MemoryStack stack)

Returns a new OVRSessionStatus.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static OVRSessionStatus mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVRSessionStatus mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVRSessionStatus.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVRSessionStatus.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nDepthRequestedback to summary
public static boolean nDepthRequested(long struct)

Unsafe version of DepthRequested.

nDisplayLostback to summary
public static boolean nDisplayLost(long struct)

Unsafe version of DisplayLost.

nHasInputFocusback to summary
public static boolean nHasInputFocus(long struct)

Unsafe version of HasInputFocus.

nHmdMountedback to summary
public static boolean nHmdMounted(long struct)

Unsafe version of HmdMounted.

nHmdPresentback to summary
public static boolean nHmdPresent(long struct)

Unsafe version of HmdPresent.

nIsVisibleback to summary
public static boolean nIsVisible(long struct)

Unsafe version of IsVisible.

nOverlayPresentback to summary
public static boolean nOverlayPresent(long struct)

Unsafe version of OverlayPresent.

nShouldQuitback to summary
public static boolean nShouldQuit(long struct)

Unsafe version of ShouldQuit.

nShouldRecenterback to summary
public static boolean nShouldRecenter(long struct)

Unsafe version of ShouldRecenter.

OverlayPresentback to summary
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.

Annotations
@NativeType:ovrBool
ShouldQuitback to summary
public boolean ShouldQuit()

True if the application should initiate shutdown.

Annotations
@NativeType:ovrBool
ShouldRecenterback to summary
public boolean ShouldRecenter()

True if UX has requested re-centering. Must call ClearShouldRecenterFlag, RecenterTrackingOrigin or SpecifyTrackingOrigin.

Annotations
@NativeType:ovrBool
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.ovr back to summary

public Class OVRSessionStatus.Buffer

extends StructBuffer<OVRSessionStatus, OVRSessionStatus.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of OVRSessionStatus structs.

Field Summary

Modifier and TypeField and Description
private static final OVRSessionStatus
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRSessionStatus.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the value of the OVRSessionStatus#DepthRequested field.
DepthRequested()

public boolean

Returns:

the value of the OVRSessionStatus#DisplayLost field.
DisplayLost()

protected OVRSessionStatus
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public boolean

Returns:

the value of the OVRSessionStatus#HasInputFocus field.
HasInputFocus()

public boolean

Returns:

the value of the OVRSessionStatus#HmdMounted field.
HmdMounted()

public boolean

Returns:

the value of the OVRSessionStatus#HmdPresent field.
HmdPresent()

public boolean

Returns:

the value of the OVRSessionStatus#IsVisible field.
IsVisible()

public boolean

Returns:

the value of the OVRSessionStatus#OverlayPresent field.
OverlayPresent()

protected OVRSessionStatus.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public boolean

Returns:

the value of the OVRSessionStatus#ShouldQuit field.
ShouldQuit()

public boolean

Returns:

the value of the OVRSessionStatus#ShouldRecenter field.
ShouldRecenter()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRSessionStatus ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OVRSessionStatus.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by OVRSessionStatus#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

DepthRequestedback to summary
public boolean DepthRequested()
Returns:boolean

the value of the OVRSessionStatus#DepthRequested field.

Annotations
@NativeType:ovrBool
DisplayLostback to summary
public boolean DisplayLost()
Returns:boolean

the value of the OVRSessionStatus#DisplayLost field.

Annotations
@NativeType:ovrBool
getElementFactoryback to summary
protected OVRSessionStatus getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
HasInputFocusback to summary
public boolean HasInputFocus()
Returns:boolean

the value of the OVRSessionStatus#HasInputFocus field.

Annotations
@NativeType:ovrBool
HmdMountedback to summary
public boolean HmdMounted()
Returns:boolean

the value of the OVRSessionStatus#HmdMounted field.

Annotations
@NativeType:ovrBool
HmdPresentback to summary
public boolean HmdPresent()
Returns:boolean

the value of the OVRSessionStatus#HmdPresent field.

Annotations
@NativeType:ovrBool
IsVisibleback to summary
public boolean IsVisible()
Returns:boolean

the value of the OVRSessionStatus#IsVisible field.

Annotations
@NativeType:ovrBool
OverlayPresentback to summary
public boolean OverlayPresent()
Returns:boolean

the value of the OVRSessionStatus#OverlayPresent field.

Annotations
@NativeType:ovrBool
selfback to summary
protected OVRSessionStatus.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
ShouldQuitback to summary
public boolean ShouldQuit()
Returns:boolean

the value of the OVRSessionStatus#ShouldQuit field.

Annotations
@NativeType:ovrBool
ShouldRecenterback to summary
public boolean ShouldRecenter()
Returns:boolean

the value of the OVRSessionStatus#ShouldRecenter field.

Annotations
@NativeType:ovrBool