Package org.lwjgl.openxr

Class XrSystemHandTrackingMeshPropertiesMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemHandTrackingMeshPropertiesMSFT>

org.lwjgl.openxr.XrSystemHandTrackingMeshPropertiesMSFT

All Implemented Interfaces:

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

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

System property for hand tracking mesh.

Description

If a runtime returns FALSE for supportsHandTrackingMesh, the system does not support hand tracking mesh input, and therefore must return ERROR_FEATURE_UNSUPPORTED from CreateHandMeshSpaceMSFT and UpdateHandMeshMSFT. The application should avoid using hand mesh functionality when supportsHandTrackingMesh is FALSE.

If a runtime returns TRUE for supportsHandTrackingMesh, the system supports hand tracking mesh input. In this case, the runtime must return a positive number for maxHandMeshIndexCount and maxHandMeshVertexCount. An application should use maxHandMeshIndexCount and maxHandMeshVertexCount to preallocate hand mesh buffers and reuse them in their render loop when calling UpdateHandMeshMSFT every frame.

Valid Usage (Implicit)

• The XR_MSFT_hand_tracking_mesh extension must be enabled prior to using XrSystemHandTrackingMeshPropertiesMSFT
• type must be TYPE_SYSTEM_HAND_TRACKING_MESH_PROPERTIES_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrSystemProperties, GetSystemProperties

Layout

 struct XrSystemHandTrackingMeshPropertiesMSFT {
     XrStructureType type();
     void * next();
     XrBool32 supportsHandTrackingMesh();
     uint32_t maxHandMeshIndexCount();
     uint32_t maxHandMeshVertexCount();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSystemHandTrackingMeshPropertiesMSFT	calloc()	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated with memCalloc.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	calloc(int capacity)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated with memCalloc.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemHandTrackingMeshPropertiesMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemHandTrackingMeshPropertiesMSFT	create()	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated with BufferUtils.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	create(int capacity)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated with BufferUtils.
static XrSystemHandTrackingMeshPropertiesMSFT	create(long address)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance for the specified memory address.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	create(long address, int capacity)	Create a XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance at the specified memory.
static @Nullable XrSystemHandTrackingMeshPropertiesMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSystemHandTrackingMeshPropertiesMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSystemHandTrackingMeshPropertiesMSFT	malloc()	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated with memAlloc.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	malloc(int capacity)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated with memAlloc.
static XrSystemHandTrackingMeshPropertiesMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSystemHandTrackingMeshPropertiesMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated on the specified MemoryStack.
int	maxHandMeshIndexCount()	a uint32_t returns the maximum count of indices that will be returned from the hand tracker.
int	maxHandMeshVertexCount()	a uint32_t returns the maximum count of vertices that will be returned from the hand tracker.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSystemHandTrackingMeshPropertiesMSFT	next(long value)	Sets the specified value to the next() field.
static int	nmaxHandMeshIndexCount(long struct)	Unsafe version of maxHandMeshIndexCount().
static int	nmaxHandMeshVertexCount(long struct)	Unsafe version of maxHandMeshVertexCount().
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nsupportsHandTrackingMesh(long struct)	Unsafe version of supportsHandTrackingMesh().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSystemHandTrackingMeshPropertiesMSFT	set(int type, long next)	Initializes this struct with the specified values.
XrSystemHandTrackingMeshPropertiesMSFT	set(XrSystemHandTrackingMeshPropertiesMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
boolean	supportsHandTrackingMesh()	an XrBool32, indicating if current system is capable of hand tracking mesh input.
int	type()	the XrStructureType of this structure.
XrSystemHandTrackingMeshPropertiesMSFT	type(int value)	Sets the specified value to the type() field.
XrSystemHandTrackingMeshPropertiesMSFT	type$Default()	Sets the TYPE_SYSTEM_HAND_TRACKING_MESH_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.

SUPPORTSHANDTRACKINGMESH

public static final int SUPPORTSHANDTRACKINGMESH

The struct member offsets.

MAXHANDMESHINDEXCOUNT

public static final int MAXHANDMESHINDEXCOUNT

The struct member offsets.

MAXHANDMESHVERTEXCOUNT

public static final int MAXHANDMESHVERTEXCOUNT

The struct member offsets.

Constructor Details

XrSystemHandTrackingMeshPropertiesMSFT

public XrSystemHandTrackingMeshPropertiesMSFT(ByteBuffer container)

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

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. No such structures are defined in core OpenXR or this extension.

supportsHandTrackingMesh

public boolean supportsHandTrackingMesh()

an XrBool32, indicating if current system is capable of hand tracking mesh input.

maxHandMeshIndexCount

public int maxHandMeshIndexCount()

a uint32_t returns the maximum count of indices that will be returned from the hand tracker.

maxHandMeshVertexCount

public int maxHandMeshVertexCount()

a uint32_t returns the maximum count of vertices that will be returned from the hand tracker.

type

public XrSystemHandTrackingMeshPropertiesMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemHandTrackingMeshPropertiesMSFT type$Default()

Sets the TYPE_SYSTEM_HAND_TRACKING_MESH_PROPERTIES_MSFT value to the type() field.

next

public XrSystemHandTrackingMeshPropertiesMSFT next(long value)

Sets the specified value to the next() field.

set

public XrSystemHandTrackingMeshPropertiesMSFT set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemHandTrackingMeshPropertiesMSFT set(XrSystemHandTrackingMeshPropertiesMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemHandTrackingMeshPropertiesMSFT malloc()

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

calloc

public static XrSystemHandTrackingMeshPropertiesMSFT calloc()

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

create

public static XrSystemHandTrackingMeshPropertiesMSFT create()

Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated with BufferUtils.

create

public static XrSystemHandTrackingMeshPropertiesMSFT create(long address)

Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSystemHandTrackingMeshPropertiesMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemHandTrackingMeshPropertiesMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemHandTrackingMeshPropertiesMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemHandTrackingMeshPropertiesMSFT.Buffer create(int capacity)

Returns a new XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemHandTrackingMeshPropertiesMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemHandTrackingMeshPropertiesMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsHandTrackingMesh

public static int nsupportsHandTrackingMesh(long struct)

Unsafe version of supportsHandTrackingMesh().

nmaxHandMeshIndexCount

public static int nmaxHandMeshIndexCount(long struct)

Unsafe version of maxHandMeshIndexCount().

nmaxHandMeshVertexCount

public static int nmaxHandMeshVertexCount(long struct)

Unsafe version of maxHandMeshVertexCount().

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.