Package org.lwjgl.openxr

Class XrControllerModelNodePropertiesMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrControllerModelNodePropertiesMSFT>

org.lwjgl.openxr.XrControllerModelNodePropertiesMSFT

All Implemented Interfaces:

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

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

Describes the controller model node properties.

Description

The node can be located in the glTF node hierarchy by finding the node(s) with the matching node name and parent node name. If the parentNodeName is empty, the matching will be solely based on the nodeName.

If there are multiple nodes in the glTF file matches the condition above, the first matching node using depth-first traversal in the glTF scene should be animated and the rest should be ignored.

The runtime must not return any nodeName or parentNodeName that does not match any glTF nodes in the corresponding controller model.

Valid Usage (Implicit)

• The XR_MSFT_controller_model extension must be enabled prior to using XrControllerModelNodePropertiesMSFT
• type must be TYPE_CONTROLLER_MODEL_NODE_PROPERTIES_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• parentNodeName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_CONTROLLER_MODEL_NODE_NAME_SIZE_MSFT
• nodeName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_CONTROLLER_MODEL_NODE_NAME_SIZE_MSFT

See Also

XrControllerModelPropertiesMSFT, GetControllerModelPropertiesMSFT, LoadControllerModelMSFT

Layout

 struct XrControllerModelNodePropertiesMSFT {
     XrStructureType type();
     void * next();
     char parentNodeName()[XR_MAX_CONTROLLER_MODEL_NODE_NAME_SIZE_MSFT];
     char nodeName()[XR_MAX_CONTROLLER_MODEL_NODE_NAME_SIZE_MSFT];
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrControllerModelNodePropertiesMSFT	calloc()	Returns a new XrControllerModelNodePropertiesMSFT instance allocated with memCalloc.
static XrControllerModelNodePropertiesMSFT.Buffer	calloc(int capacity)	Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated with memCalloc.
static XrControllerModelNodePropertiesMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelNodePropertiesMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelNodePropertiesMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrControllerModelNodePropertiesMSFT	create()	Returns a new XrControllerModelNodePropertiesMSFT instance allocated with BufferUtils.
static XrControllerModelNodePropertiesMSFT.Buffer	create(int capacity)	Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated with BufferUtils.
static XrControllerModelNodePropertiesMSFT	create(long address)	Returns a new XrControllerModelNodePropertiesMSFT instance for the specified memory address.
static XrControllerModelNodePropertiesMSFT.Buffer	create(long address, int capacity)	Create a XrControllerModelNodePropertiesMSFT.Buffer instance at the specified memory.
static @Nullable XrControllerModelNodePropertiesMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrControllerModelNodePropertiesMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrControllerModelNodePropertiesMSFT	malloc()	Returns a new XrControllerModelNodePropertiesMSFT instance allocated with memAlloc.
static XrControllerModelNodePropertiesMSFT.Buffer	malloc(int capacity)	Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated with memAlloc.
static XrControllerModelNodePropertiesMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated on the specified MemoryStack.
static XrControllerModelNodePropertiesMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrControllerModelNodePropertiesMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrControllerModelNodePropertiesMSFT	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 ByteBuffer	nnodeName(long struct)	Unsafe version of nodeName().
static void	nnodeName(long struct, ByteBuffer value)	Unsafe version of nodeName.
static String	nnodeNameString(long struct)	Unsafe version of nodeNameString().
ByteBuffer	nodeName()	the name of this node in the provided glTF file.
XrControllerModelNodePropertiesMSFT	nodeName(ByteBuffer value)	Copies the specified encoded string to the nodeName() field.
String	nodeNameString()	the name of this node in the provided glTF file.
static ByteBuffer	nparentNodeName(long struct)	Unsafe version of parentNodeName().
static void	nparentNodeName(long struct, ByteBuffer value)	Unsafe version of parentNodeName.
static String	nparentNodeNameString(long struct)	Unsafe version of parentNodeNameString().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
ByteBuffer	parentNodeName()	the name of the parent node in the provided glTF file.
XrControllerModelNodePropertiesMSFT	parentNodeName(ByteBuffer value)	Copies the specified encoded string to the parentNodeName() field.
String	parentNodeNameString()	the name of the parent node in the provided glTF file.
XrControllerModelNodePropertiesMSFT	set(int type, long next, ByteBuffer parentNodeName, ByteBuffer nodeName)	Initializes this struct with the specified values.
XrControllerModelNodePropertiesMSFT	set(XrControllerModelNodePropertiesMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrControllerModelNodePropertiesMSFT	type(int value)	Sets the specified value to the type() field.
XrControllerModelNodePropertiesMSFT	type$Default()	Sets the TYPE_CONTROLLER_MODEL_NODE_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.

PARENTNODENAME

public static final int PARENTNODENAME

The struct member offsets.

NODENAME

public static final int NODENAME

The struct member offsets.

Constructor Details

XrControllerModelNodePropertiesMSFT

public XrControllerModelNodePropertiesMSFT(ByteBuffer container)

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

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.

parentNodeName

public ByteBuffer parentNodeName()

the name of the parent node in the provided glTF file. The parent name may be empty if it should not be used to locate this node.

parentNodeNameString

public String parentNodeNameString()

the name of the parent node in the provided glTF file. The parent name may be empty if it should not be used to locate this node.

nodeName

public ByteBuffer nodeName()

the name of this node in the provided glTF file.

nodeNameString

public String nodeNameString()

the name of this node in the provided glTF file.

type

public XrControllerModelNodePropertiesMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrControllerModelNodePropertiesMSFT type$Default()

Sets the TYPE_CONTROLLER_MODEL_NODE_PROPERTIES_MSFT value to the type() field.

next

public XrControllerModelNodePropertiesMSFT next(long value)

Sets the specified value to the next() field.

parentNodeName

public XrControllerModelNodePropertiesMSFT parentNodeName(ByteBuffer value)

Copies the specified encoded string to the parentNodeName() field.

nodeName

public XrControllerModelNodePropertiesMSFT nodeName(ByteBuffer value)

Copies the specified encoded string to the nodeName() field.

set

public XrControllerModelNodePropertiesMSFT set(int type,
 long next,
 ByteBuffer parentNodeName,
 ByteBuffer nodeName)

Initializes this struct with the specified values.

set

public XrControllerModelNodePropertiesMSFT set(XrControllerModelNodePropertiesMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrControllerModelNodePropertiesMSFT malloc()

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

calloc

public static XrControllerModelNodePropertiesMSFT calloc()

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

create

public static XrControllerModelNodePropertiesMSFT create()

Returns a new XrControllerModelNodePropertiesMSFT instance allocated with BufferUtils.

create

public static XrControllerModelNodePropertiesMSFT create(long address)

Returns a new XrControllerModelNodePropertiesMSFT instance for the specified memory address.

createSafe

public static @Nullable XrControllerModelNodePropertiesMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrControllerModelNodePropertiesMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrControllerModelNodePropertiesMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrControllerModelNodePropertiesMSFT.Buffer create(int capacity)

Returns a new XrControllerModelNodePropertiesMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrControllerModelNodePropertiesMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrControllerModelNodePropertiesMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nparentNodeName

public static ByteBuffer nparentNodeName(long struct)

Unsafe version of parentNodeName().

nparentNodeNameString

public static String nparentNodeNameString(long struct)

Unsafe version of parentNodeNameString().

nnodeName

public static ByteBuffer nnodeName(long struct)

Unsafe version of nodeName().

nnodeNameString

public static String nnodeNameString(long struct)

Unsafe version of nodeNameString().

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.

nparentNodeName

public static void nparentNodeName(long struct,
 ByteBuffer value)

Unsafe version of parentNodeName.

nnodeName

public static void nnodeName(long struct,
 ByteBuffer value)

Unsafe version of nodeName.