Package org.lwjgl.openvr

Class VREventOverlay

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VREventOverlay>

org.lwjgl.openvr.VREventOverlay

All Implemented Interfaces:

Pointer

public class VREventOverlay
extends Struct<VREventOverlay>

Used for a few events about overlays.

Layout

 struct VREvent_Overlay_t {
     uint64_t overlayHandle();
     uint64_t devicePath;
     uint64_t memoryBlockId;
     uint32_t cursorIndex();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CURSORINDEX	The struct member offsets.
static final int	DEVICEPATH	The struct member offsets.
static final int	MEMORYBLOCKID	The struct member offsets.
static final int	OVERLAYHANDLE	The struct member offsets.
static final 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(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.
int	cursorIndex()	if from an event triggered by cursor input on an overlay that supports multiple cursors, this is the index of which tracked cursor the event is for
long	devicePath()
long	memoryBlockId()
static int	ncursorIndex(long struct)	Unsafe version of cursorIndex().
static long	ndevicePath(long struct)	Unsafe version of devicePath().
static long	nmemoryBlockId(long struct)	Unsafe version of memoryBlockId().
static long	noverlayHandle(long struct)	Unsafe version of overlayHandle().
long	overlayHandle()	one of: VR.EVRState_VRState_UndefinedVR.EVRState_VRState_OffVR.EVRState_VRState_SearchingVR.EVRState_VRState_Searching_AlertVR.EVRState_VRState_ReadyVR.EVRState_VRState_Ready_AlertVR.EVRState_VRState_NotReadyVR.EVRState_VRState_StandbyVR.EVRState_VRState_Ready_Alert_Low
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

OVERLAYHANDLE

public static final int OVERLAYHANDLE

The struct member offsets.

DEVICEPATH

public static final int DEVICEPATH

The struct member offsets.

MEMORYBLOCKID

public static final int MEMORYBLOCKID

The struct member offsets.

CURSORINDEX

public static final int CURSORINDEX

The struct member offsets.

Constructor Details

VREventOverlay

public VREventOverlay(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VREventOverlay>

overlayHandle

public long 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

devicePath

public long devicePath()

Returns:

the value of the devicePath field.

memoryBlockId

public long memoryBlockId()

Returns:

the value of the memoryBlockId field.

cursorIndex

public int cursorIndex()

if from an event triggered by cursor input on an overlay that supports multiple cursors, this is the index of which tracked cursor the event is for

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().

nmemoryBlockId

public static long nmemoryBlockId(long struct)

Unsafe version of memoryBlockId().

ncursorIndex

public static int ncursorIndex(long struct)

Unsafe version of cursorIndex().