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.

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 of OVRSessionStatus 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`	`DEPTHREQUESTED DISPLAYLOST HASINPUTFOCUS HMDMOUNTED HMDPRESENT ISVISIBLE OVERLAYPRESENT SHOULDQUIT SHOULDRECENTER`	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

OVRSessionStatus(java.nio.ByteBuffer container)
Creates a OVRSessionStatus instance at the current position of the specified ByteBuffer container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static OVRSessionStatus`	`calloc()`	Returns a new `OVRSessionStatus` instance allocated with `memCalloc`.
`static OVRSessionStatus.Buffer`	`calloc(int capacity)`	Returns a new `OVRSessionStatus.Buffer` instance allocated with `memCalloc`.
`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.
`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.
`static OVRSessionStatus`	`callocStack()`	Deprecated.
`static OVRSessionStatus.Buffer`	`callocStack(int capacity)`	Deprecated.
`static OVRSessionStatus.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static OVRSessionStatus`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static OVRSessionStatus`	`create()`	Returns a new `OVRSessionStatus` instance allocated with `BufferUtils`.
`static OVRSessionStatus.Buffer`	`create(int capacity)`	Returns a new `OVRSessionStatus.Buffer` instance allocated with `BufferUtils`.
`static OVRSessionStatus`	`create(long address)`	Returns a new `OVRSessionStatus` instance for the specified memory address.
`static OVRSessionStatus.Buffer`	`create(long address, int capacity)`	Create a `OVRSessionStatus.Buffer` instance at the specified memory.
`static OVRSessionStatus`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static OVRSessionStatus.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`boolean`	`DepthRequested()`	True if runtime is requesting that the application provide depth buffers with projection layers.
`boolean`	`DisplayLost()`	True if the session is in a display-lost state.
`boolean`	`HasInputFocus()`	True if the application is the foreground application and receives input (e.g.
`boolean`	`HmdMounted()`	True if the HMD is on the user's head.
`boolean`	`HmdPresent()`	True if an HMD is present.
`boolean`	`IsVisible()`	True if the process has VR focus and thus is visible in the HMD.
`static OVRSessionStatus`	`malloc()`	Returns a new `OVRSessionStatus` instance allocated with `memAlloc`.
`static OVRSessionStatus.Buffer`	`malloc(int capacity)`	Returns a new `OVRSessionStatus.Buffer` instance allocated with `memAlloc`.
`static OVRSessionStatus.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRSessionStatus.Buffer` instance allocated on the specified `MemoryStack`.
`static OVRSessionStatus`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRSessionStatus` instance allocated on the specified `MemoryStack`.
`static OVRSessionStatus`	`mallocStack()`	Deprecated.
`static OVRSessionStatus.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static OVRSessionStatus.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static OVRSessionStatus`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static boolean`	`nDepthRequested(long struct)`	Unsafe version of `DepthRequested()`.
`static boolean`	`nDisplayLost(long struct)`	Unsafe version of `DisplayLost()`.
`static boolean`	`nHasInputFocus(long struct)`	Unsafe version of `HasInputFocus()`.
`static boolean`	`nHmdMounted(long struct)`	Unsafe version of `HmdMounted()`.
`static boolean`	`nHmdPresent(long struct)`	Unsafe version of `HmdPresent()`.
`static boolean`	`nIsVisible(long struct)`	Unsafe version of `IsVisible()`.
`static boolean`	`nOverlayPresent(long struct)`	Unsafe version of `OverlayPresent()`.
`static boolean`	`nShouldQuit(long struct)`	Unsafe version of `ShouldQuit()`.
`static boolean`	`nShouldRecenter(long struct)`	Unsafe version of `ShouldRecenter()`.
`boolean`	`OverlayPresent()`	True if a system overlay is present, such as a dashboard.
`boolean`	`ShouldQuit()`	True if the application should initiate shutdown.
`boolean`	`ShouldRecenter()`	True if UX has requested re-centering.
`int`	`sizeof()`

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

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.
  - ISVISIBLE, HMDPRESENT, HMDMOUNTED, DISPLAYLOST, SHOULDQUIT, SHOULDRECENTER, HASINPUTFOCUS, OVERLAYPRESENT, DEPTHREQUESTED
    
    The struct member offsets.
- Constructor Detail
  - OVRSessionStatus
```
public OVRSessionStatus(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - 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
```
@Nullable
public static 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
```
@Nullable
public static 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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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().

Class OVRSessionStatus

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 interface org.lwjgl.system.NativeResource

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

ISVISIBLE, HMDPRESENT, HMDMOUNTED, DISPLAYLOST, SHOULDQUIT, SHOULDRECENTER, HASINPUTFOCUS, OVERLAYPRESENT, DEPTHREQUESTED

Constructor Detail

OVRSessionStatus

Method Detail

sizeof

IsVisible

HmdPresent

HmdMounted

DisplayLost

ShouldQuit

ShouldRecenter

HasInputFocus

OverlayPresent

DepthRequested

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nIsVisible

nHmdPresent

nHmdMounted

nDisplayLost

nShouldQuit

nShouldRecenter

nHasInputFocus

nOverlayPresent

nDepthRequested