Package org.lwjgl.openvr

Class VRControllerState

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VRControllerState>

org.lwjgl.openvr.VRControllerState

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VRControllerState
extends org.lwjgl.system.Struct<VRControllerState>
implements org.lwjgl.system.NativeResource

Holds all the state of a controller at one moment in time.

Layout

 struct VRControllerState_t {
     uint32_t unPacketNum();
     uint64_t ulButtonPressed();
     uint64_t ulButtonTouched;
     VRControllerAxis_t rAxis()[5];
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	RAXIS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	ULBUTTONPRESSED	The struct member offsets.
static final int	ULBUTTONTOUCHED	The struct member offsets.
static final int	UNPACKETNUM	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VRControllerState(ByteBuffer container)	Creates a VRControllerState instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VRControllerState	calloc()	Returns a new VRControllerState instance allocated with memCalloc.
static VRControllerState.Buffer	calloc(int capacity)	Returns a new VRControllerState.Buffer instance allocated with memCalloc.
static VRControllerState.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VRControllerState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VRControllerState	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VRControllerState instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VRControllerState	callocStack()	Deprecated.
static VRControllerState.Buffer	callocStack(int capacity)	Deprecated.
static VRControllerState.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VRControllerState	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VRControllerState	create()	Returns a new VRControllerState instance allocated with BufferUtils.
static VRControllerState.Buffer	create(int capacity)	Returns a new VRControllerState.Buffer instance allocated with BufferUtils.
static VRControllerState	create(long address)	Returns a new VRControllerState instance for the specified memory address.
static VRControllerState.Buffer	create(long address, int capacity)	Create a VRControllerState.Buffer instance at the specified memory.
static @Nullable VRControllerState	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VRControllerState.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VRControllerState	malloc()	Returns a new VRControllerState instance allocated with memAlloc.
static VRControllerState.Buffer	malloc(int capacity)	Returns a new VRControllerState.Buffer instance allocated with memAlloc.
static VRControllerState.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VRControllerState.Buffer instance allocated on the specified MemoryStack.
static VRControllerState	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VRControllerState instance allocated on the specified MemoryStack.
static VRControllerState	mallocStack()	Deprecated.
static VRControllerState.Buffer	mallocStack(int capacity)	Deprecated.
static VRControllerState.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VRControllerState	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VRControllerAxis.Buffer	nrAxis(long struct)	Unsafe version of rAxis().
static VRControllerAxis	nrAxis(long struct, int index)	Unsafe version of rAxis.
static void	nrAxis(long struct, int index, VRControllerAxis value)	Unsafe version of rAxis.
static void	nrAxis(long struct, VRControllerAxis.Buffer value)	Unsafe version of rAxis.
static long	nulButtonPressed(long struct)	Unsafe version of ulButtonPressed().
static void	nulButtonPressed(long struct, long value)	Unsafe version of ulButtonPressed.
static long	nulButtonTouched(long struct)	Unsafe version of ulButtonTouched().
static void	nulButtonTouched(long struct, long value)	Unsafe version of ulButtonTouched.
static int	nunPacketNum(long struct)	Unsafe version of unPacketNum().
static void	nunPacketNum(long struct, int value)	Unsafe version of unPacketNum.
VRControllerAxis.Buffer	rAxis()	axis data for the controller's analog inputs
VRControllerAxis	rAxis(int index)	axis data for the controller's analog inputs
VRControllerState	rAxis(int index, Consumer<VRControllerAxis> consumer)	Passes the element at index of the rAxis() field to the specified Consumer.
VRControllerState	rAxis(int index, VRControllerAxis value)	Copies the specified VRControllerAxis at the specified index of the rAxis() field.
VRControllerState	rAxis(Consumer<VRControllerAxis.Buffer> consumer)	Passes the rAxis() field to the specified Consumer.
VRControllerState	rAxis(VRControllerAxis.Buffer value)	Copies the specified VRControllerAxis.Buffer to the rAxis() field.
VRControllerState	set(int unPacketNum, long ulButtonPressed, long ulButtonTouched, VRControllerAxis.Buffer rAxis)	Initializes this struct with the specified values.
VRControllerState	set(VRControllerState src)	Copies the specified struct data to this struct.
int	sizeof()
long	ulButtonPressed()	bit flags for each of the buttons.
VRControllerState	ulButtonPressed(long value)	Sets the specified value to the ulButtonPressed() field.
long	ulButtonTouched()
VRControllerState	ulButtonTouched(long value)	Sets the specified value to the ulButtonTouched field.
int	unPacketNum()	If packet num matches that on your prior call, then the controller state hasn't been changed since your last call and there is no need to process it.
VRControllerState	unPacketNum(int value)	Sets the specified value to the unPacketNum() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

UNPACKETNUM

public static final int UNPACKETNUM

The struct member offsets.

ULBUTTONPRESSED

public static final int ULBUTTONPRESSED

The struct member offsets.

ULBUTTONTOUCHED

public static final int ULBUTTONTOUCHED

The struct member offsets.

RAXIS

public static final int RAXIS

The struct member offsets.

Constructor Details

VRControllerState

public VRControllerState(ByteBuffer container)

Creates a VRControllerState 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VRControllerState>

unPacketNum

public int unPacketNum()

If packet num matches that on your prior call, then the controller state hasn't been changed since your last call and there is no need to process it.

ulButtonPressed

public long ulButtonPressed()

bit flags for each of the buttons. Use ButtonMaskFromId to turn an ID into a mask

ulButtonTouched

public long ulButtonTouched()

Returns:

the value of the ulButtonTouched field.

rAxis

public VRControllerAxis.Buffer rAxis()

axis data for the controller's analog inputs

rAxis

public VRControllerAxis rAxis(int index)

axis data for the controller's analog inputs

unPacketNum

public VRControllerState unPacketNum(int value)

Sets the specified value to the unPacketNum() field.

ulButtonPressed

public VRControllerState ulButtonPressed(long value)

Sets the specified value to the ulButtonPressed() field.

ulButtonTouched

public VRControllerState ulButtonTouched(long value)

Sets the specified value to the ulButtonTouched field.

rAxis

public VRControllerState rAxis(VRControllerAxis.Buffer value)

Copies the specified VRControllerAxis.Buffer to the rAxis() field.

rAxis

public VRControllerState rAxis(int index,
 VRControllerAxis value)

Copies the specified VRControllerAxis at the specified index of the rAxis() field.

rAxis

public VRControllerState rAxis(Consumer<VRControllerAxis.Buffer> consumer)

Passes the rAxis() field to the specified Consumer.

rAxis

public VRControllerState rAxis(int index,
 Consumer<VRControllerAxis> consumer)

Passes the element at index of the rAxis() field to the specified Consumer.

set

public VRControllerState set(int unPacketNum,
 long ulButtonPressed,
 long ulButtonTouched,
 VRControllerAxis.Buffer rAxis)

Initializes this struct with the specified values.

set

public VRControllerState set(VRControllerState src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VRControllerState malloc()

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

calloc

public static VRControllerState calloc()

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

create

public static VRControllerState create()

Returns a new VRControllerState instance allocated with BufferUtils.

create

public static VRControllerState create(long address)

Returns a new VRControllerState instance for the specified memory address.

createSafe

public static @Nullable VRControllerState createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VRControllerState.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VRControllerState.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VRControllerState.Buffer create(int capacity)

Returns a new VRControllerState.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VRControllerState.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VRControllerState mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VRControllerState callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VRControllerState mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VRControllerState callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VRControllerState.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VRControllerState.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VRControllerState.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 VRControllerState.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 VRControllerState malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VRControllerState instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VRControllerState calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VRControllerState.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VRControllerState.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nunPacketNum

public static int nunPacketNum(long struct)

Unsafe version of unPacketNum().

nulButtonPressed

public static long nulButtonPressed(long struct)

Unsafe version of ulButtonPressed().

nulButtonTouched

public static long nulButtonTouched(long struct)

Unsafe version of ulButtonTouched().

nrAxis

public static VRControllerAxis.Buffer nrAxis(long struct)

Unsafe version of rAxis().

nrAxis

public static VRControllerAxis nrAxis(long struct,
 int index)

Unsafe version of rAxis.

nunPacketNum

public static void nunPacketNum(long struct,
 int value)

Unsafe version of unPacketNum.

nulButtonPressed

public static void nulButtonPressed(long struct,
 long value)

Unsafe version of ulButtonPressed.

nulButtonTouched

public static void nulButtonTouched(long struct,
 long value)

Unsafe version of ulButtonTouched.

nrAxis

public static void nrAxis(long struct,
 VRControllerAxis.Buffer value)

Unsafe version of rAxis.

nrAxis

public static void nrAxis(long struct,
 int index,
 VRControllerAxis value)

Unsafe version of rAxis.