Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandTrackingDataSourceStateEXT

extends Struct<XrHandTrackingDataSourceStateEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 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 requestedDataSources when creating the corresponding hand tracker.

Valid Usage (Implicit)
See Also

XrHandJointLocationsEXT, LocateHandJointsEXT

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATASOURCE

The struct member offsets.

public static final int
ISACTIVE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrHandTrackingDataSourceStateEXT(ByteBuffer container)

Creates a XrHandTrackingDataSourceStateEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrHandTrackingDataSourceStateEXT
calloc()

Returns a new XrHandTrackingDataSourceStateEXT instance allocated with memCalloc.

public static XrHandTrackingDataSourceStateEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with memCalloc.

public static XrHandTrackingDataSourceStateEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrHandTrackingDataSourceStateEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrHandTrackingDataSourceStateEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrHandTrackingDataSourceStateEXT
create()

Returns a new XrHandTrackingDataSourceStateEXT instance allocated with BufferUtils.

public static XrHandTrackingDataSourceStateEXT
create(long address)

Returns a new XrHandTrackingDataSourceStateEXT instance for the specified memory address.

public static XrHandTrackingDataSourceStateEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with BufferUtils.

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

Create a XrHandTrackingDataSourceStateEXT.Buffer instance at the specified memory.

public static XrHandTrackingDataSourceStateEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
dataSource()

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

public XrHandTrackingDataSourceStateEXT
dataSource(int value)

Sets the specified value to the dataSource field.

public boolean
isActive()

indicating there is an active data source

public XrHandTrackingDataSourceStateEXT
isActive(boolean value)

Sets the specified value to the isActive field.

public static XrHandTrackingDataSourceStateEXT
malloc()

Returns a new XrHandTrackingDataSourceStateEXT instance allocated with memAlloc.

public static XrHandTrackingDataSourceStateEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with memAlloc.

public static XrHandTrackingDataSourceStateEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrHandTrackingDataSourceStateEXT instance allocated on the specified MemoryStack.

public static XrHandTrackingDataSourceStateEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
ndataSource(long struct)

Unsafe version of dataSource.

public static void
ndataSource(long struct, int value)

Unsafe version of dataSource.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrHandTrackingDataSourceStateEXT
next(long value)

Sets the specified value to the next field.

public static int
nisActive(long struct)

Unsafe version of isActive.

public static void
nisActive(long struct, int value)

Unsafe version of isActive.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrHandTrackingDataSourceStateEXT

Returns:

this struct
set
(XrHandTrackingDataSourceStateEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrHandTrackingDataSourceStateEXT
type(int value)

Sets the specified value to the type field.

public XrHandTrackingDataSourceStateEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DATASOURCEback to summary
public static final int DATASOURCE

The struct member offsets.

ISACTIVEback to summary
public static final int ISACTIVE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrHandTrackingDataSourceStateEXTback to summary
protected XrHandTrackingDataSourceStateEXT(long address, ByteBuffer container)
XrHandTrackingDataSourceStateEXTback to summary
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 Detail

callocback to summary
public static XrHandTrackingDataSourceStateEXT calloc()

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

callocback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandTrackingDataSourceStateEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrHandTrackingDataSourceStateEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrHandTrackingDataSourceStateEXT create()

Returns a new XrHandTrackingDataSourceStateEXT instance allocated with BufferUtils.

createback to summary
public static XrHandTrackingDataSourceStateEXT create(long address)

Returns a new XrHandTrackingDataSourceStateEXT instance for the specified memory address.

createback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer create(int capacity)

Returns a new XrHandTrackingDataSourceStateEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandTrackingDataSourceStateEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandTrackingDataSourceStateEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dataSourceback to summary
public int dataSource()

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

Annotations
@NativeType:XrHandTrackingDataSourceEXT
dataSourceback to summary
public XrHandTrackingDataSourceStateEXT dataSource(int value)

Sets the specified value to the dataSource field.

isActiveback to summary
public boolean isActive()

indicating there is an active data source

Annotations
@NativeType:XrBool32
isActiveback to summary
public XrHandTrackingDataSourceStateEXT isActive(boolean value)

Sets the specified value to the isActive field.

mallocback to summary
public static XrHandTrackingDataSourceStateEXT malloc()

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

mallocback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandTrackingDataSourceStateEXT malloc(MemoryStack stack)

Returns a new XrHandTrackingDataSourceStateEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrHandTrackingDataSourceStateEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndataSourceback to summary
public static int ndataSource(long struct)

Unsafe version of dataSource.

ndataSourceback to summary
public static void ndataSource(long struct, int value)

Unsafe version of dataSource.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain.

Annotations
@NativeType:void *
nextback to summary
public XrHandTrackingDataSourceStateEXT next(long value)

Sets the specified value to the next field.

nisActiveback to summary
public static int nisActive(long struct)

Unsafe version of isActive.

nisActiveback to summary
public static void nisActive(long struct, int value)

Unsafe version of isActive.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

setback to summary
public XrHandTrackingDataSourceStateEXT set(XrHandTrackingDataSourceStateEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrHandTrackingDataSourceStateEXT

the source struct

Returns:XrHandTrackingDataSourceStateEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrHandTrackingDataSourceStateEXT type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrHandTrackingDataSourceStateEXT type$Default()

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_STATE_EXT value to the type field.

org.lwjgl.openxr back to summary

public Class XrHandTrackingDataSourceStateEXT.Buffer

extends StructBuffer<XrHandTrackingDataSourceStateEXT, XrHandTrackingDataSourceStateEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrHandTrackingDataSourceStateEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandTrackingDataSourceStateEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHandTrackingDataSourceStateEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the XrHandTrackingDataSourceStateEXT#dataSource field.
dataSource
()

public XrHandTrackingDataSourceStateEXT.Buffer
dataSource(int value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#dataSource field.

protected XrHandTrackingDataSourceStateEXT
public boolean

Returns:

the value of the XrHandTrackingDataSourceStateEXT#isActive field.
isActive
()

public XrHandTrackingDataSourceStateEXT.Buffer
isActive(boolean value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#isActive field.

public long

Returns:

the value of the XrHandTrackingDataSourceStateEXT#next field.
next
()

public XrHandTrackingDataSourceStateEXT.Buffer
next(long value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#next field.

protected XrHandTrackingDataSourceStateEXT.Buffer
public int

Returns:

the value of the XrHandTrackingDataSourceStateEXT#type field.
type
()

public XrHandTrackingDataSourceStateEXT.Buffer
type(int value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#type field.

public XrHandTrackingDataSourceStateEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandTrackingDataSourceStateEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrHandTrackingDataSourceStateEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrHandTrackingDataSourceStateEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dataSourceback to summary
public int dataSource()
Returns:int

the value of the XrHandTrackingDataSourceStateEXT#dataSource field.

Annotations
@NativeType:XrHandTrackingDataSourceEXT
dataSourceback to summary
public XrHandTrackingDataSourceStateEXT.Buffer dataSource(int value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#dataSource field.

getElementFactoryback to summary
protected XrHandTrackingDataSourceStateEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
isActiveback to summary
public boolean isActive()
Returns:boolean

the value of the XrHandTrackingDataSourceStateEXT#isActive field.

Annotations
@NativeType:XrBool32
isActiveback to summary
public XrHandTrackingDataSourceStateEXT.Buffer isActive(boolean value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#isActive field.

nextback to summary
public long next()
Returns:long

the value of the XrHandTrackingDataSourceStateEXT#next field.

Annotations
@NativeType:void *
nextback to summary
public XrHandTrackingDataSourceStateEXT.Buffer next(long value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#next field.

selfback to summary
protected XrHandTrackingDataSourceStateEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrHandTrackingDataSourceStateEXT#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrHandTrackingDataSourceStateEXT.Buffer type(int value)

Sets the specified value to the XrHandTrackingDataSourceStateEXT#type field.

type$Defaultback to summary
public XrHandTrackingDataSourceStateEXT.Buffer type$Default()

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_STATE_EXT value to the XrHandTrackingDataSourceStateEXT#type field.