Package org.lwjgl.openxr

Class XrControllerModelKeyStateMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrControllerModelKeyStateMSFT>

org.lwjgl.openxr.XrControllerModelKeyStateMSFT

All Implemented Interfaces:

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

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

The model key state for a controller.

Description

The modelKey value for the session represents a unique controller model that can be retrieved from LoadControllerModelMSFT function. Therefore, the application can use modelKey to cache the returned data from LoadControllerModelMSFT for the session.

A modelKey value of NULL_CONTROLLER_MODEL_KEY_MSFT, represents an invalid model key and indicates there is no controller model yet available. The application should keep calling GetControllerModelKeyMSFT because the model may become available at a later point.

The returned modelKey value depends on an active action binding to the corresponding subpathname:/grip/pose of the controller. Therefore, the application must have provided a valid action set containing an action for subpathname:/grip/pose, and have successfully completed an SyncActions call, in order to obtain a valid modelKey.

Valid Usage (Implicit)

• The XR_MSFT_controller_model extension must be enabled prior to using XrControllerModelKeyStateMSFT
• type must be TYPE_CONTROLLER_MODEL_KEY_STATE_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetControllerModelKeyMSFT

Layout

 struct XrControllerModelKeyStateMSFT {
     XrStructureType type();
     void * next();
     XrControllerModelKeyMSFT modelKey();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrControllerModelKeyStateMSFT.Buffer	An array of XrControllerModelKeyStateMSFT 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	MODELKEY	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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
XrControllerModelKeyStateMSFT(ByteBuffer container)	Creates a XrControllerModelKeyStateMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrControllerModelKeyStateMSFT	calloc()	Returns a new XrControllerModelKeyStateMSFT instance allocated with memCalloc.
static XrControllerModelKeyStateMSFT.Buffer	calloc(int capacity)	Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated with memCalloc.
static XrControllerModelKeyStateMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelKeyStateMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelKeyStateMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelKeyStateMSFT	create()	Returns a new XrControllerModelKeyStateMSFT instance allocated with BufferUtils.
static XrControllerModelKeyStateMSFT.Buffer	create(int capacity)	Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated with BufferUtils.
static XrControllerModelKeyStateMSFT	create(long address)	Returns a new XrControllerModelKeyStateMSFT instance for the specified memory address.
static XrControllerModelKeyStateMSFT.Buffer	create(long address, int capacity)	Create a XrControllerModelKeyStateMSFT.Buffer instance at the specified memory.
static @Nullable XrControllerModelKeyStateMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrControllerModelKeyStateMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrControllerModelKeyStateMSFT	malloc()	Returns a new XrControllerModelKeyStateMSFT instance allocated with memAlloc.
static XrControllerModelKeyStateMSFT.Buffer	malloc(int capacity)	Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated with memAlloc.
static XrControllerModelKeyStateMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated on the specified MemoryStack.
static XrControllerModelKeyStateMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelKeyStateMSFT instance allocated on the specified MemoryStack.
long	modelKey()	the model key corresponding to the controller render model being queried.
XrControllerModelKeyStateMSFT	modelKey(long value)	Sets the specified value to the modelKey() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrControllerModelKeyStateMSFT	next(long value)	Sets the specified value to the next() field.
static long	nmodelKey(long struct)	Unsafe version of modelKey().
static void	nmodelKey(long struct, long value)	Unsafe version of modelKey.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrControllerModelKeyStateMSFT	set(int type, long next, long modelKey)	Initializes this struct with the specified values.
XrControllerModelKeyStateMSFT	set(XrControllerModelKeyStateMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrControllerModelKeyStateMSFT	type(int value)	Sets the specified value to the type() field.
XrControllerModelKeyStateMSFT	type$Default()	Sets the TYPE_CONTROLLER_MODEL_KEY_STATE_MSFT value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

MODELKEY

public static final int MODELKEY

The struct member offsets.

Constructor Details

XrControllerModelKeyStateMSFT

public XrControllerModelKeyStateMSFT(ByteBuffer container)

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

type

public int type()

the XrStructureType of this structure.

next

public long next()

NULL or a pointer to the next structure in a structure chain.

modelKey

public long modelKey()

the model key corresponding to the controller render model being queried.

type

public XrControllerModelKeyStateMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrControllerModelKeyStateMSFT type$Default()

Sets the TYPE_CONTROLLER_MODEL_KEY_STATE_MSFT value to the type() field.

next

public XrControllerModelKeyStateMSFT next(long value)

Sets the specified value to the next() field.

modelKey

public XrControllerModelKeyStateMSFT modelKey(long value)

Sets the specified value to the modelKey() field.

set

public XrControllerModelKeyStateMSFT set(int type,
 long next,
 long modelKey)

Initializes this struct with the specified values.

set

public XrControllerModelKeyStateMSFT set(XrControllerModelKeyStateMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrControllerModelKeyStateMSFT malloc()

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

calloc

public static XrControllerModelKeyStateMSFT calloc()

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

create

public static XrControllerModelKeyStateMSFT create()

Returns a new XrControllerModelKeyStateMSFT instance allocated with BufferUtils.

create

public static XrControllerModelKeyStateMSFT create(long address)

Returns a new XrControllerModelKeyStateMSFT instance for the specified memory address.

createSafe

public static @Nullable XrControllerModelKeyStateMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrControllerModelKeyStateMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrControllerModelKeyStateMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrControllerModelKeyStateMSFT.Buffer create(int capacity)

Returns a new XrControllerModelKeyStateMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrControllerModelKeyStateMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrControllerModelKeyStateMSFT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrControllerModelKeyStateMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrControllerModelKeyStateMSFT.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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nmodelKey

public static long nmodelKey(long struct)

Unsafe version of modelKey().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nmodelKey

public static void nmodelKey(long struct,
 long value)

Unsafe version of modelKey.