Top Description Inners Fields Constructors Methods
org.lwjgl.openvr

public Class VREventOverlay

extends Struct<VREventOverlay>
Class Inheritance
Annotations
@NativeType:struct VREvent_Overlay_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Used for a few events about overlays.

Layout


struct VREvent_Overlay_t {
    uint64_t overlayHandle;
    uint64_t devicePath;
    uint64_t memoryBlockId;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEVICEPATH

The struct member offsets.

public static final int
MEMORYBLOCKID

The struct member offsets.

public static final int
OVERLAYHANDLE

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
VREventOverlay(long address, ByteBuffer container)

public
VREventOverlay(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected VREventOverlay
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 VREventOverlay
create(long address)

Returns a new VREventOverlay instance for the specified memory address.

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

Create a VREventOverlay.Buffer instance at the specified memory.

public static VREventOverlay
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the devicePath field.
devicePath
()

public long

Returns:

the value of the memoryBlockId field.
memoryBlockId
()

public static long
ndevicePath(long struct)

Unsafe version of devicePath.

public static long
nmemoryBlockId(long struct)

Unsafe version of memoryBlockId.

public static long
noverlayHandle(long struct)

Unsafe version of overlayHandle.

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

DEVICEPATHback to summary
public static final int DEVICEPATH

The struct member offsets.

MEMORYBLOCKIDback to summary
public static final int MEMORYBLOCKID

The struct member offsets.

OVERLAYHANDLEback to summary
public static final int OVERLAYHANDLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

createback to summary
protected VREventOverlay 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 VREventOverlay create(long address)

Returns a new VREventOverlay instance for the specified memory address.

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

Create a VREventOverlay.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VREventOverlay createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
devicePathback to summary
public long devicePath()
Returns:long

the value of the devicePath field.

Annotations
@NativeType:uint64_t
memoryBlockIdback to summary
public long memoryBlockId()
Returns:long

the value of the memoryBlockId field.

Annotations
@NativeType:uint64_t
ndevicePathback to summary
public static long ndevicePath(long struct)

Unsafe version of devicePath.

nmemoryBlockIdback to summary
public static long nmemoryBlockId(long struct)

Unsafe version of memoryBlockId.

noverlayHandleback to summary
public static long noverlayHandle(long struct)

Unsafe version of overlayHandle.

overlayHandleback to summary
public long overlayHandle()

one of:

VR#EVRState_VRState_UndefinedVR#EVRState_VRState_OffVR#EVRState_VRState_Searching
VR#EVRState_VRState_Searching_AlertVR#EVRState_VRState_ReadyVR#EVRState_VRState_Ready_Alert
VR#EVRState_VRState_NotReadyVR#EVRState_VRState_StandbyVR#EVRState_VRState_Ready_Alert_Low
Annotations
@NativeType:uint64_t
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.openvr back to summary

public Class VREventOverlay.Buffer

extends StructBuffer<VREventOverlay, VREventOverlay.Buffer>
Class Inheritance

An array of VREventOverlay structs.

Field Summary

Modifier and TypeField and Description
private static final VREventOverlay

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VREventOverlay.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 long

Returns:

the value of the devicePath field.
devicePath
()

protected VREventOverlay
public long

Returns:

the value of the memoryBlockId field.
memoryBlockId
()

public long

Returns:

the value of the VREventOverlay#overlayHandle field.
overlayHandle
()

protected VREventOverlay.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VREventOverlay ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VREventOverlay.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 VREventOverlay#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

devicePathback to summary
public long devicePath()
Returns:long

the value of the devicePath field.

Annotations
@NativeType:uint64_t
getElementFactoryback to summary
protected VREventOverlay getElementFactory()

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

Annotations
@Override
memoryBlockIdback to summary
public long memoryBlockId()
Returns:long

the value of the memoryBlockId field.

Annotations
@NativeType:uint64_t
overlayHandleback to summary
public long overlayHandle()
Returns:long

the value of the VREventOverlay#overlayHandle field.

Annotations
@NativeType:uint64_t
selfback to summary
protected VREventOverlay.Buffer self()

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

Annotations
@Override