Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandTrackingDataSourceInfoEXT

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

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)
See Also

XrHandTrackerCreateInfoEXT, CreateHandTrackerEXT

Layout


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

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
NEXT

The struct member offsets.

public static final int
REQUESTEDDATASOURCECOUNT

The struct member offsets.

public static final int
REQUESTEDDATASOURCES

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
XrHandTrackingDataSourceInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHandTrackingDataSourceInfoEXT
calloc()

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with memCalloc.

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

Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrHandTrackingDataSourceInfoEXT
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 XrHandTrackingDataSourceInfoEXT
create()

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with BufferUtils.

public static XrHandTrackingDataSourceInfoEXT
create(long address)

Returns a new XrHandTrackingDataSourceInfoEXT instance for the specified memory address.

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

Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a XrHandTrackingDataSourceInfoEXT.Buffer instance at the specified memory.

public static XrHandTrackingDataSourceInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrHandTrackingDataSourceInfoEXT
malloc()

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with memAlloc.

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

Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrHandTrackingDataSourceInfoEXT
next(long value)

Sets the specified value to the next field.

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
nrequestedDataSourceCount(long struct)

Unsafe version of requestedDataSourceCount.

public static void
nrequestedDataSourceCount(long struct, int value)

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

public static IntBuffer
nrequestedDataSources(long struct)

Unsafe version of requestedDataSources.

public static void
nrequestedDataSources(long struct, IntBuffer value)

Unsafe version of requestedDataSources.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public int
requestedDataSourceCount()

the number of elements in the requestedDataSources array.

public IntBuffer
requestedDataSources()

an array of XrHandTrackingDataSourceEXT that the application accepts.

public XrHandTrackingDataSourceInfoEXT
requestedDataSources(IntBuffer value)

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

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

Initializes this struct with the specified values.

public XrHandTrackingDataSourceInfoEXT

Returns:

this struct
set
(XrHandTrackingDataSourceInfoEXT
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 XrHandTrackingDataSourceInfoEXT
type(int value)

Sets the specified value to the type field.

public XrHandTrackingDataSourceInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

REQUESTEDDATASOURCECOUNTback to summary
public static final int REQUESTEDDATASOURCECOUNT

The struct member offsets.

REQUESTEDDATASOURCESback to summary
public static final int REQUESTEDDATASOURCES

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

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

callocback to summary
public static XrHandTrackingDataSourceInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandTrackingDataSourceInfoEXT calloc(MemoryStack stack)

Returns a new XrHandTrackingDataSourceInfoEXT 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 XrHandTrackingDataSourceInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated with BufferUtils.

createback to summary
public static XrHandTrackingDataSourceInfoEXT create(long address)

Returns a new XrHandTrackingDataSourceInfoEXT instance for the specified memory address.

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

Returns a new XrHandTrackingDataSourceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandTrackingDataSourceInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandTrackingDataSourceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrHandTrackingDataSourceInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandTrackingDataSourceInfoEXT malloc(MemoryStack stack)

Returns a new XrHandTrackingDataSourceInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

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

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

Sets the specified value to the next field.

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.

nrequestedDataSourceCountback to summary
public static int nrequestedDataSourceCount(long struct)

Unsafe version of requestedDataSourceCount.

nrequestedDataSourceCountback to summary
public static void nrequestedDataSourceCount(long struct, int value)

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

nrequestedDataSourcesback to summary
public static IntBuffer nrequestedDataSources(long struct)

Unsafe version of requestedDataSources.

Annotations
@Nullable
nrequestedDataSourcesback to summary
public static void nrequestedDataSources(long struct, IntBuffer value)

Unsafe version of requestedDataSources.

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.

requestedDataSourceCountback to summary
public int requestedDataSourceCount()

the number of elements in the requestedDataSources array.

Annotations
@NativeType:uint32_t
requestedDataSourcesback to summary
public IntBuffer requestedDataSources()

an array of XrHandTrackingDataSourceEXT that the application accepts.

Annotations
@Nullable
@NativeType:XrHandTrackingDataSourceEXT *
requestedDataSourcesback to summary
public XrHandTrackingDataSourceInfoEXT requestedDataSources(IntBuffer value)

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

setback to summary
public XrHandTrackingDataSourceInfoEXT set(int type, long next, IntBuffer requestedDataSources)

Initializes this struct with the specified values.

setback to summary
public XrHandTrackingDataSourceInfoEXT set(XrHandTrackingDataSourceInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrHandTrackingDataSourceInfoEXT

the source struct

Returns:XrHandTrackingDataSourceInfoEXT

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 XrHandTrackingDataSourceInfoEXT type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_INFO_EXT value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrHandTrackingDataSourceInfoEXT.Buffer

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

An array of XrHandTrackingDataSourceInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandTrackingDataSourceInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHandTrackingDataSourceInfoEXT.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
protected XrHandTrackingDataSourceInfoEXT
public long

Returns:

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

public XrHandTrackingDataSourceInfoEXT.Buffer
next(long value)

Sets the specified value to the XrHandTrackingDataSourceInfoEXT#next field.

public int
public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the XrHandTrackingDataSourceInfoEXT#requestedDataSources field.
requestedDataSources
()

public XrHandTrackingDataSourceInfoEXT.Buffer
protected XrHandTrackingDataSourceInfoEXT.Buffer
public int

Returns:

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

public XrHandTrackingDataSourceInfoEXT.Buffer
type(int value)

Sets the specified value to the XrHandTrackingDataSourceInfoEXT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandTrackingDataSourceInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrHandTrackingDataSourceInfoEXT.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 XrHandTrackingDataSourceInfoEXT#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

getElementFactoryback to summary
protected XrHandTrackingDataSourceInfoEXT getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrHandTrackingDataSourceInfoEXT#next field.

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

Sets the specified value to the XrHandTrackingDataSourceInfoEXT#next field.

requestedDataSourceCountback to summary
public int requestedDataSourceCount()
Returns:int

the value of the XrHandTrackingDataSourceInfoEXT#requestedDataSourceCount field.

Annotations
@NativeType:uint32_t
requestedDataSourcesback to summary
public IntBuffer requestedDataSources()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the XrHandTrackingDataSourceInfoEXT#requestedDataSources field.

Annotations
@Nullable
@NativeType:XrHandTrackingDataSourceEXT *
requestedDataSourcesback to summary
public XrHandTrackingDataSourceInfoEXT.Buffer requestedDataSources(IntBuffer value)

Sets the address of the specified IntBuffer to the XrHandTrackingDataSourceInfoEXT#requestedDataSources field.

selfback to summary
protected XrHandTrackingDataSourceInfoEXT.Buffer self()

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

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

the value of the XrHandTrackingDataSourceInfoEXT#type field.

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

Sets the specified value to the XrHandTrackingDataSourceInfoEXT#type field.

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

Sets the TYPE_HAND_TRACKING_DATA_SOURCE_INFO_EXT value to the XrHandTrackingDataSourceInfoEXT#type field.