Package org.lwjgl.openvr

Class VREventOverlay

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.openvr.VREventOverlay

All Implemented Interfaces:

org.lwjgl.system.Pointer

public class VREventOverlay
extends org.lwjgl.system.Struct

Used for a few events about overlays.

Member documentation

• overlayHandle – one of:
  

  VR.EVRState_VRState_Undefined	VR.EVRState_VRState_Off	VR.EVRState_VRState_Searching
  VR.EVRState_VRState_Searching_Alert	VR.EVRState_VRState_Ready	VR.EVRState_VRState_Ready_Alert
  VR.EVRState_VRState_NotReady	VR.EVRState_VRState_Standby	VR.EVRState_VRState_Ready_Alert_Low

Layout

 struct VREvent_Overlay_t {
     uint64_t overlayHandle;
     uint64_t devicePath;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VREventOverlay.Buffer	An array of VREventOverlay structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	DEVICEPATH OVERLAYHANDLE	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
VREventOverlay(java.nio.ByteBuffer container)	Creates a VREventOverlay instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VREventOverlay	create(long address)	Returns a new VREventOverlay instance for the specified memory address.
static VREventOverlay.Buffer	create(long address, int capacity)	Create a VREventOverlay.Buffer instance at the specified memory.
static VREventOverlay	createSafe(long address)	Like create, but returns null if address is NULL.
static VREventOverlay.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	devicePath()	Returns the value of the devicePath field.
static long	ndevicePath(long struct)	Unsafe version of devicePath().
static long	noverlayHandle(long struct)	Unsafe version of overlayHandle().
long	overlayHandle()	Returns the value of the overlayHandle field.
int	sizeof()

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

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

OVERLAYHANDLE, DEVICEPATH

The struct member offsets.

Constructor Detail

VREventOverlay

public VREventOverlay(java.nio.ByteBuffer container)

Creates a VREventOverlay 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

overlayHandle

public long overlayHandle()

Returns the value of the overlayHandle field.

devicePath

public long devicePath()

Returns the value of the devicePath field.

create

public static VREventOverlay create(long address)

Returns a new VREventOverlay instance for the specified memory address.

createSafe

@Nullable
public static VREventOverlay createSafe(long address)

Like create, but returns null if address is NULL.

create

public static VREventOverlay.Buffer create(long address,
                                           int capacity)

Create a VREventOverlay.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VREventOverlay.Buffer createSafe(long address,
                                               int capacity)

Like create, but returns null if address is NULL.

noverlayHandle

public static long noverlayHandle(long struct)

Unsafe version of overlayHandle().

ndevicePath

public static long ndevicePath(long struct)

Unsafe version of devicePath().