Package org.lwjgl.openxr

Class XrHandTrackingDataSourceInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrHandTrackingDataSourceInfoEXT>

org.lwjgl.openxr.XrHandTrackingDataSourceInfoEXT

All Implemented Interfaces:

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

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

Specify the data source to create the hand tracker.

Description

The XrHandTrackingDataSourceInfoEXT is a structure that an application can chain to XrHandTrackerCreateInfoEXT::next to specify the hand tracking data sources that the application accepts.

Because the hand tracking device may change during a running session, the runtime may return a valid XrHandTrackerEXT handle even if there is no currently active hand tracking device or the active device does not safisty any or all data sources requested by the applications’s call to CreateHandTrackerEXT. The runtime may instead return ERROR_FEATURE_UNSUPPORTED from CreateHandTrackerEXT, if for example the runtime believes it will never be able to satisfy the request.

If any value in requestedDataSources is duplicated, the runtime must return ERROR_VALIDATION_FAILURE from the call to CreateHandTrackerEXT. If requestedDataSourceCount is 0, the runtime must return ERROR_VALIDATION_FAILURE from the call to CreateHandTrackerEXT.

Valid Usage (Implicit)

• The XR_EXT_hand_tracking_data_source extension must be enabled prior to using XrHandTrackingDataSourceInfoEXT
• type must be TYPE_HAND_TRACKING_DATA_SOURCE_INFO_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If requestedDataSourceCount is not 0, requestedDataSources must be a pointer to an array of requestedDataSourceCount XrHandTrackingDataSourceEXT values

See Also

XrHandTrackerCreateInfoEXT, CreateHandTrackerEXT

Layout

 struct XrHandTrackingDataSourceInfoEXT {
     XrStructureType type();
     void const * next();
     uint32_t requestedDataSourceCount();
     XrHandTrackingDataSourceEXT * requestedDataSources();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrHandTrackingDataSourceInfoEXT	calloc()	Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with memCalloc.
static XrHandTrackingDataSourceInfoEXT.Buffer	calloc(int capacity)	Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with memCalloc.
static XrHandTrackingDataSourceInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHandTrackingDataSourceInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHandTrackingDataSourceInfoEXT	create()	Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with BufferUtils.
static XrHandTrackingDataSourceInfoEXT.Buffer	create(int capacity)	Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with BufferUtils.
static XrHandTrackingDataSourceInfoEXT	create(long address)	Returns a new XrHandTrackingDataSourceInfoEXT instance for the specified memory address.
static XrHandTrackingDataSourceInfoEXT.Buffer	create(long address, int capacity)	Create a XrHandTrackingDataSourceInfoEXT.Buffer instance at the specified memory.
static @Nullable XrHandTrackingDataSourceInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrHandTrackingDataSourceInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrHandTrackingDataSourceInfoEXT	malloc()	Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with memAlloc.
static XrHandTrackingDataSourceInfoEXT.Buffer	malloc(int capacity)	Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with memAlloc.
static XrHandTrackingDataSourceInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated on the specified MemoryStack.
static XrHandTrackingDataSourceInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceInfoEXT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrHandTrackingDataSourceInfoEXT	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	nrequestedDataSourceCount(long struct)	Unsafe version of requestedDataSourceCount().
static void	nrequestedDataSourceCount(long struct, int value)	Sets the specified value to the requestedDataSourceCount field of the specified struct.
static @Nullable IntBuffer	nrequestedDataSources(long struct)	Unsafe version of requestedDataSources.
static void	nrequestedDataSources(long struct, @Nullable IntBuffer value)	Unsafe version of requestedDataSources.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	requestedDataSourceCount()	the number of elements in the requestedDataSources array.
@Nullable IntBuffer	requestedDataSources()	an array of XrHandTrackingDataSourceEXT that the application accepts.
XrHandTrackingDataSourceInfoEXT	requestedDataSources(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the requestedDataSources() field.
XrHandTrackingDataSourceInfoEXT	set(int type, long next, @Nullable IntBuffer requestedDataSources)	Initializes this struct with the specified values.
XrHandTrackingDataSourceInfoEXT	set(XrHandTrackingDataSourceInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrHandTrackingDataSourceInfoEXT	type(int value)	Sets the specified value to the type() field.
XrHandTrackingDataSourceInfoEXT	type$Default()	Sets the TYPE_HAND_TRACKING_DATA_SOURCE_INFO_EXT value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

REQUESTEDDATASOURCECOUNT

public static final int REQUESTEDDATASOURCECOUNT

The struct member offsets.

REQUESTEDDATASOURCES

public static final int REQUESTEDDATASOURCES

The struct member offsets.

Constructor Details

XrHandTrackingDataSourceInfoEXT

public XrHandTrackingDataSourceInfoEXT(ByteBuffer container)

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

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.

requestedDataSourceCount

public int requestedDataSourceCount()

the number of elements in the requestedDataSources array.

requestedDataSources

public @Nullable IntBuffer requestedDataSources()

an array of XrHandTrackingDataSourceEXT that the application accepts.

type

public XrHandTrackingDataSourceInfoEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrHandTrackingDataSourceInfoEXT type$Default()

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_INFO_EXT value to the type() field.

next

public XrHandTrackingDataSourceInfoEXT next(long value)

Sets the specified value to the next() field.

requestedDataSources

public XrHandTrackingDataSourceInfoEXT requestedDataSources(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the requestedDataSources() field.

set

public XrHandTrackingDataSourceInfoEXT set(int type,
 long next,
 @Nullable IntBuffer requestedDataSources)

Initializes this struct with the specified values.

set

public XrHandTrackingDataSourceInfoEXT set(XrHandTrackingDataSourceInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrHandTrackingDataSourceInfoEXT malloc()

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

calloc

public static XrHandTrackingDataSourceInfoEXT calloc()

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

create

public static XrHandTrackingDataSourceInfoEXT create()

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with BufferUtils.

create

public static XrHandTrackingDataSourceInfoEXT create(long address)

Returns a new XrHandTrackingDataSourceInfoEXT instance for the specified memory address.

createSafe

public static @Nullable XrHandTrackingDataSourceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrHandTrackingDataSourceInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrHandTrackingDataSourceInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrHandTrackingDataSourceInfoEXT.Buffer create(int capacity)

Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrHandTrackingDataSourceInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrequestedDataSourceCount

public static int nrequestedDataSourceCount(long struct)

Unsafe version of requestedDataSourceCount().

nrequestedDataSources

public static @Nullable IntBuffer nrequestedDataSources(long struct)

Unsafe version of requestedDataSources.

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.

nrequestedDataSourceCount

public static void nrequestedDataSourceCount(long struct,
 int value)

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

nrequestedDataSources

public static void nrequestedDataSources(long struct,
 @Nullable IntBuffer value)

Unsafe version of requestedDataSources.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate