Package org.lwjgl.openxr

Class XrHandTrackingDataSourceStateEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrHandTrackingDataSourceStateEXT>

org.lwjgl.openxr.XrHandTrackingDataSourceStateEXT

All Implemented Interfaces:

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

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

Chains to XrHandJointLocationsEXT to get hand tracking data source state.

Description

XrHandTrackingDataSourceStateEXT is a structure that an application can chain to XrHandJointLocationsEXT::next when calling LocateHandJointsEXT to retrieve the data source of the currently active hand tracking device.

When the returned isActive is XR_FALSE, it indicates the currently active hand tracking device does not support any of the requested data sources. In these cases, the runtime must also return no valid tracking locations for hand joints from this LocateHandJointsEXT function.

If the tracker was not created with XrHandTrackingDataSourceInfoEXT chained to XrHandTrackerCreateInfoEXT::next, then the runtime must return ERROR_VALIDATION_FAILURE, if XrHandTrackingDataSourceStateEXT is passed in the call to LocateHandJointsEXT.

If there is an active hand tracking device that is one of the specified XrHandTrackingDataSourceInfoEXT::requestedDataSources, the runtime must set isActive to TRUE. When the runtime sets isActive to TRUE, the runtime must set dataSource indicate the active data source. The runtime must return a dataSource that is a subset of the XrHandTrackingDataSourceInfoEXT::requestedDataSources when creating the corresponding hand tracker.

Valid Usage (Implicit)

• The XR_EXT_hand_tracking_data_source extension must be enabled prior to using XrHandTrackingDataSourceStateEXT
• type must be TYPE_HAND_TRACKING_DATA_SOURCE_STATE_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• dataSource must be a valid XrHandTrackingDataSourceEXT value

See Also

XrHandJointLocationsEXT, LocateHandJointsEXT

Layout

 struct XrHandTrackingDataSourceStateEXT {
     XrStructureType type();
     void * next();
     XrBool32 isActive();
     XrHandTrackingDataSourceEXT dataSource();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrHandTrackingDataSourceStateEXT	calloc()	Returns a new XrHandTrackingDataSourceStateEXT instance allocated with memCalloc.
static XrHandTrackingDataSourceStateEXT.Buffer	calloc(int capacity)	Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with memCalloc.
static XrHandTrackingDataSourceStateEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHandTrackingDataSourceStateEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceStateEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHandTrackingDataSourceStateEXT	create()	Returns a new XrHandTrackingDataSourceStateEXT instance allocated with BufferUtils.
static XrHandTrackingDataSourceStateEXT.Buffer	create(int capacity)	Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with BufferUtils.
static XrHandTrackingDataSourceStateEXT	create(long address)	Returns a new XrHandTrackingDataSourceStateEXT instance for the specified memory address.
static XrHandTrackingDataSourceStateEXT.Buffer	create(long address, int capacity)	Create a XrHandTrackingDataSourceStateEXT.Buffer instance at the specified memory.
static @Nullable XrHandTrackingDataSourceStateEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrHandTrackingDataSourceStateEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	dataSource()	indicating the data source that was used to generate the hand tracking joints.
XrHandTrackingDataSourceStateEXT	dataSource(int value)	Sets the specified value to the dataSource() field.
boolean	isActive()	indicating there is an active data source
XrHandTrackingDataSourceStateEXT	isActive(boolean value)	Sets the specified value to the isActive() field.
static XrHandTrackingDataSourceStateEXT	malloc()	Returns a new XrHandTrackingDataSourceStateEXT instance allocated with memAlloc.
static XrHandTrackingDataSourceStateEXT.Buffer	malloc(int capacity)	Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with memAlloc.
static XrHandTrackingDataSourceStateEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated on the specified MemoryStack.
static XrHandTrackingDataSourceStateEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHandTrackingDataSourceStateEXT instance allocated on the specified MemoryStack.
static int	ndataSource(long struct)	Unsafe version of dataSource().
static void	ndataSource(long struct, int value)	Unsafe version of dataSource.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrHandTrackingDataSourceStateEXT	next(long value)	Sets the specified value to the next() field.
static int	nisActive(long struct)	Unsafe version of isActive().
static void	nisActive(long struct, int value)	Unsafe version of isActive.
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.
XrHandTrackingDataSourceStateEXT	set(int type, long next, boolean isActive, int dataSource)	Initializes this struct with the specified values.
XrHandTrackingDataSourceStateEXT	set(XrHandTrackingDataSourceStateEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrHandTrackingDataSourceStateEXT	type(int value)	Sets the specified value to the type() field.
XrHandTrackingDataSourceStateEXT	type$Default()	Sets the TYPE_HAND_TRACKING_DATA_SOURCE_STATE_EXT 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.

ISACTIVE

public static final int ISACTIVE

The struct member offsets.

DATASOURCE

public static final int DATASOURCE

The struct member offsets.

Constructor Details

XrHandTrackingDataSourceStateEXT

public XrHandTrackingDataSourceStateEXT(ByteBuffer container)

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

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.

isActive

public boolean isActive()

indicating there is an active data source

dataSource

public int dataSource()

indicating the data source that was used to generate the hand tracking joints.

type

public XrHandTrackingDataSourceStateEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrHandTrackingDataSourceStateEXT type$Default()

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_STATE_EXT value to the type() field.

next

public XrHandTrackingDataSourceStateEXT next(long value)

Sets the specified value to the next() field.

isActive

public XrHandTrackingDataSourceStateEXT isActive(boolean value)

Sets the specified value to the isActive() field.

dataSource

public XrHandTrackingDataSourceStateEXT dataSource(int value)

Sets the specified value to the dataSource() field.

set

public XrHandTrackingDataSourceStateEXT set(int type,
 long next,
 boolean isActive,
 int dataSource)

Initializes this struct with the specified values.

set

public XrHandTrackingDataSourceStateEXT set(XrHandTrackingDataSourceStateEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrHandTrackingDataSourceStateEXT malloc()

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

calloc

public static XrHandTrackingDataSourceStateEXT calloc()

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

create

public static XrHandTrackingDataSourceStateEXT create()

Returns a new XrHandTrackingDataSourceStateEXT instance allocated with BufferUtils.

create

public static XrHandTrackingDataSourceStateEXT create(long address)

Returns a new XrHandTrackingDataSourceStateEXT instance for the specified memory address.

createSafe

public static @Nullable XrHandTrackingDataSourceStateEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrHandTrackingDataSourceStateEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrHandTrackingDataSourceStateEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrHandTrackingDataSourceStateEXT.Buffer create(int capacity)

Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrHandTrackingDataSourceStateEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrHandTrackingDataSourceStateEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nisActive

public static int nisActive(long struct)

Unsafe version of isActive().

ndataSource

public static int ndataSource(long struct)

Unsafe version of dataSource().

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.

nisActive

public static void nisActive(long struct,
 int value)

Unsafe version of isActive.

ndataSource

public static void ndataSource(long struct,
 int value)

Unsafe version of dataSource.