Package org.lwjgl.openxr

Class XrControllerModelPropertiesMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrControllerModelPropertiesMSFT>

org.lwjgl.openxr.XrControllerModelPropertiesMSFT

All Implemented Interfaces:

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

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

Describes the properties of a controller model.

Valid Usage (Implicit)

• The XR_MSFT_controller_model extension must be enabled prior to using XrControllerModelPropertiesMSFT
• type must be TYPE_CONTROLLER_MODEL_PROPERTIES_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If nodeCapacityInput is not 0, nodeProperties must be a pointer to an array of nodeCapacityInput XrControllerModelNodePropertiesMSFT structures

See Also

XrControllerModelNodePropertiesMSFT, GetControllerModelPropertiesMSFT, LoadControllerModelMSFT

Layout

 struct XrControllerModelPropertiesMSFT {
     XrStructureType type();
     void * next();
     uint32_t nodeCapacityInput();
     uint32_t nodeCountOutput();
     XrControllerModelNodePropertiesMSFT * nodeProperties();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrControllerModelPropertiesMSFT.Buffer	An array of XrControllerModelPropertiesMSFT 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	NEXT	The struct member offsets.
static final int	NODECAPACITYINPUT	The struct member offsets.
static final int	NODECOUNTOUTPUT	The struct member offsets.
static final int	NODEPROPERTIES	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
XrControllerModelPropertiesMSFT(ByteBuffer container)	Creates a XrControllerModelPropertiesMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrControllerModelPropertiesMSFT	calloc()	Returns a new XrControllerModelPropertiesMSFT instance allocated with memCalloc.
static XrControllerModelPropertiesMSFT.Buffer	calloc(int capacity)	Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated with memCalloc.
static XrControllerModelPropertiesMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelPropertiesMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelPropertiesMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelPropertiesMSFT	create()	Returns a new XrControllerModelPropertiesMSFT instance allocated with BufferUtils.
static XrControllerModelPropertiesMSFT.Buffer	create(int capacity)	Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated with BufferUtils.
static XrControllerModelPropertiesMSFT	create(long address)	Returns a new XrControllerModelPropertiesMSFT instance for the specified memory address.
static XrControllerModelPropertiesMSFT.Buffer	create(long address, int capacity)	Create a XrControllerModelPropertiesMSFT.Buffer instance at the specified memory.
static @Nullable XrControllerModelPropertiesMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrControllerModelPropertiesMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrControllerModelPropertiesMSFT	malloc()	Returns a new XrControllerModelPropertiesMSFT instance allocated with memAlloc.
static XrControllerModelPropertiesMSFT.Buffer	malloc(int capacity)	Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated with memAlloc.
static XrControllerModelPropertiesMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated on the specified MemoryStack.
static XrControllerModelPropertiesMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelPropertiesMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrControllerModelPropertiesMSFT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nnodeCapacityInput(long struct)	Unsafe version of nodeCapacityInput().
static void	nnodeCapacityInput(long struct, int value)	Sets the specified value to the nodeCapacityInput field of the specified struct.
static int	nnodeCountOutput(long struct)	Unsafe version of nodeCountOutput().
static void	nnodeCountOutput(long struct, int value)	Unsafe version of nodeCountOutput.
static @Nullable XrControllerModelNodePropertiesMSFT.Buffer	nnodeProperties(long struct)	Unsafe version of nodeProperties().
static void	nnodeProperties(long struct, @Nullable XrControllerModelNodePropertiesMSFT.Buffer value)	Unsafe version of nodeProperties.
int	nodeCapacityInput()	the capacity of the nodeProperties array, or 0 to indicate a request to retrieve the required capacity.
XrControllerModelPropertiesMSFT	nodeCapacityInput(int value)	Sets the specified value to the nodeCapacityInput() field.
int	nodeCountOutput()	filled in by the runtime with the count of elements in nodeProperties array, or returns the required capacity in the case that nodeCapacityInput is insufficient.
XrControllerModelPropertiesMSFT	nodeCountOutput(int value)	Sets the specified value to the nodeCountOutput() field.
@Nullable XrControllerModelNodePropertiesMSFT.Buffer	nodeProperties()	a pointer to an application-allocated array that will be filled with the XrControllerModelNodePropertiesMSFT values.
XrControllerModelPropertiesMSFT	nodeProperties(@Nullable XrControllerModelNodePropertiesMSFT.Buffer value)	Sets the address of the specified XrControllerModelNodePropertiesMSFT.Buffer to the nodeProperties() field.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrControllerModelPropertiesMSFT	set(int type, long next, int nodeCapacityInput, int nodeCountOutput, @Nullable XrControllerModelNodePropertiesMSFT.Buffer nodeProperties)	Initializes this struct with the specified values.
XrControllerModelPropertiesMSFT	set(XrControllerModelPropertiesMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrControllerModelPropertiesMSFT	type(int value)	Sets the specified value to the type() field.
XrControllerModelPropertiesMSFT	type$Default()	Sets the TYPE_CONTROLLER_MODEL_PROPERTIES_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.

NODECAPACITYINPUT

public static final int NODECAPACITYINPUT

The struct member offsets.

NODECOUNTOUTPUT

public static final int NODECOUNTOUTPUT

The struct member offsets.

NODEPROPERTIES

public static final int NODEPROPERTIES

The struct member offsets.

Constructor Details

XrControllerModelPropertiesMSFT

public XrControllerModelPropertiesMSFT(ByteBuffer container)

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

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.

nodeCapacityInput

public int nodeCapacityInput()

the capacity of the nodeProperties array, or 0 to indicate a request to retrieve the required capacity.

nodeCountOutput

public int nodeCountOutput()

filled in by the runtime with the count of elements in nodeProperties array, or returns the required capacity in the case that nodeCapacityInput is insufficient.

nodeProperties

public @Nullable XrControllerModelNodePropertiesMSFT.Buffer nodeProperties()

a pointer to an application-allocated array that will be filled with the XrControllerModelNodePropertiesMSFT values. It can be NULL if nodeCapacityInput is 0.

type

public XrControllerModelPropertiesMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrControllerModelPropertiesMSFT type$Default()

Sets the TYPE_CONTROLLER_MODEL_PROPERTIES_MSFT value to the type() field.

next

public XrControllerModelPropertiesMSFT next(long value)

Sets the specified value to the next() field.

nodeCapacityInput

public XrControllerModelPropertiesMSFT nodeCapacityInput(int value)

Sets the specified value to the nodeCapacityInput() field.

nodeCountOutput

public XrControllerModelPropertiesMSFT nodeCountOutput(int value)

Sets the specified value to the nodeCountOutput() field.

nodeProperties

public XrControllerModelPropertiesMSFT nodeProperties(@Nullable XrControllerModelNodePropertiesMSFT.Buffer value)

Sets the address of the specified XrControllerModelNodePropertiesMSFT.Buffer to the nodeProperties() field.

set

public XrControllerModelPropertiesMSFT set(int type,
 long next,
 int nodeCapacityInput,
 int nodeCountOutput,
 @Nullable XrControllerModelNodePropertiesMSFT.Buffer nodeProperties)

Initializes this struct with the specified values.

set

public XrControllerModelPropertiesMSFT set(XrControllerModelPropertiesMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrControllerModelPropertiesMSFT malloc()

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

calloc

public static XrControllerModelPropertiesMSFT calloc()

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

create

public static XrControllerModelPropertiesMSFT create()

Returns a new XrControllerModelPropertiesMSFT instance allocated with BufferUtils.

create

public static XrControllerModelPropertiesMSFT create(long address)

Returns a new XrControllerModelPropertiesMSFT instance for the specified memory address.

createSafe

public static @Nullable XrControllerModelPropertiesMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrControllerModelPropertiesMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrControllerModelPropertiesMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrControllerModelPropertiesMSFT.Buffer create(int capacity)

Returns a new XrControllerModelPropertiesMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrControllerModelPropertiesMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrControllerModelPropertiesMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrControllerModelPropertiesMSFT.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().

nnodeCapacityInput

public static int nnodeCapacityInput(long struct)

Unsafe version of nodeCapacityInput().

nnodeCountOutput

public static int nnodeCountOutput(long struct)

Unsafe version of nodeCountOutput().

nnodeProperties

public static @Nullable XrControllerModelNodePropertiesMSFT.Buffer nnodeProperties(long struct)

Unsafe version of nodeProperties().

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.

nnodeCapacityInput

public static void nnodeCapacityInput(long struct,
 int value)

Sets the specified value to the nodeCapacityInput field of the specified struct.

nnodeCountOutput

public static void nnodeCountOutput(long struct,
 int value)

Unsafe version of nodeCountOutput.

nnodeProperties

public static void nnodeProperties(long struct,
 @Nullable XrControllerModelNodePropertiesMSFT.Buffer value)

Unsafe version of nodeProperties.