Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandJointLocationsEXT

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

Returns the hand joint locations.
Description

The application must allocate the memory for the output array jointLocations that can contain at least jointCount of XrHandJointLocationEXT.

The application must set jointCount as described by the XrHandJointSetEXT when creating the XrHandTrackerEXT otherwise the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must return jointLocations representing the range of motion of a human hand, without any obstructions. Input systems that obstruct the movement of the user’s hand (e.g.: a held controller preventing the user from making a fist) or that have only limited ability to track finger positions must use the information available to them to emulate an unobstructed range of motion.

The runtime must update the jointLocations array ordered so that the application can index elements using the corresponding hand joint enum (e.g. XrHandJointEXT) as described by XrHandJointSetEXT when creating the XrHandTrackerEXT. For example, when the XrHandTrackerEXT is created with HAND_JOINT_SET_DEFAULT_EXT, the application must set the jointCount to HAND_JOINT_COUNT_EXT, and the runtime must fill the jointLocations array ordered so that it may be indexed by the XrHandJointEXT enum.

If the returned isActive is true, the runtime must return all joint locations with both SPACE_LOCATION_POSITION_VALID_BIT and SPACE_LOCATION_ORIENTATION_VALID_BIT set. Although, in this case, some joint space locations may be untracked (i.e. SPACE_LOCATION_POSITION_TRACKED_BIT or SPACE_LOCATION_ORIENTATION_TRACKED_BIT is unset).

If the returned isActive is false, it indicates the hand tracker did not detect the hand input or the application lost input focus. In this case, the runtime must return all jointLocations with neither SPACE_LOCATION_POSITION_VALID_BIT nor SPACE_LOCATION_ORIENTATION_VALID_BIT set.

Valid Usage (Implicit)
See Also

XrHandJointLocationEXT, LocateHandJointsEXT

Layout


struct XrHandJointLocationsEXT {
    XrStructureType type;
    void * next;
    XrBool32 isActive;
    uint32_t jointCount;
    XrHandJointLocationEXT * jointLocations;
}

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
ISACTIVE

The struct member offsets.

public static final int
JOINTCOUNT

The struct member offsets.

public static final int
JOINTLOCATIONS

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
XrHandJointLocationsEXT(long address, ByteBuffer container)

public
XrHandJointLocationsEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHandJointLocationsEXT
calloc()

Returns a new XrHandJointLocationsEXT instance allocated with memCalloc.

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

Returns a new XrHandJointLocationsEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHandJointLocationsEXT instance allocated with BufferUtils.

public static XrHandJointLocationsEXT
create(long address)

Returns a new XrHandJointLocationsEXT instance for the specified memory address.

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

Returns a new XrHandJointLocationsEXT.Buffer instance allocated with BufferUtils.

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

Create a XrHandJointLocationsEXT.Buffer instance at the specified memory.

public static XrHandJointLocationsEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
isActive()

an XrBool32 indicating if the hand tracker is actively tracking.

public XrHandJointLocationsEXT
isActive(boolean value)

Sets the specified value to the isActive field.

public int
jointCount()

a uint32_t describing the count of elements in jointLocations array.

public XrHandJointLocationEXT.Buffer
jointLocations()

an array of XrHandJointLocationEXT receiving the returned hand joint locations.

public XrHandJointLocationsEXT
jointLocations(XrHandJointLocationEXT.Buffer value)

Sets the address of the specified XrHandJointLocationEXT.Buffer to the jointLocations field.

public static XrHandJointLocationsEXT
malloc()

Returns a new XrHandJointLocationsEXT instance allocated with memAlloc.

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

Returns a new XrHandJointLocationsEXT.Buffer instance allocated with memAlloc.

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

Returns a new XrHandJointLocationsEXT instance allocated on the specified MemoryStack.

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

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

public long
next()

NULL or a pointer to the next structure in a structure chain, such as XrHandJointVelocitiesEXT.

public XrHandJointLocationsEXT
next(long value)

Sets the specified value to the next field.

public XrHandJointLocationsEXT
next(XrHandJointVelocitiesEXT value)

Prepends the specified XrHandJointVelocitiesEXT value to the next chain.

public XrHandJointLocationsEXT
next(XrHandTrackingAimStateFB value)

Prepends the specified XrHandTrackingAimStateFB value to the next chain.

public XrHandJointLocationsEXT
next(XrHandTrackingCapsulesStateFB value)

Prepends the specified XrHandTrackingCapsulesStateFB value to the next chain.

public XrHandJointLocationsEXT
next(XrHandTrackingDataSourceStateEXT value)

Prepends the specified XrHandTrackingDataSourceStateEXT value to the next chain.

public XrHandJointLocationsEXT
next(XrHandTrackingScaleFB value)

Prepends the specified XrHandTrackingScaleFB value to the next chain.

public static int
nisActive(long struct)

Unsafe version of isActive.

public static void
nisActive(long struct, int value)

Unsafe version of isActive.

public static int
njointCount(long struct)

Unsafe version of jointCount.

public static void
njointCount(long struct, int value)

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

public static XrHandJointLocationEXT.Buffer
njointLocations(long struct)

Unsafe version of jointLocations.

public static void
njointLocations(long struct, XrHandJointLocationEXT.Buffer value)

Unsafe version of jointLocations.

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 XrHandJointLocationsEXT
set(int type, long next, boolean isActive, XrHandJointLocationEXT.Buffer jointLocations)

Initializes this struct with the specified values.

public XrHandJointLocationsEXT

Returns:

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

Sets the specified value to the type field.

public XrHandJointLocationsEXT
type$Default()

Sets the TYPE_HAND_JOINT_LOCATIONS_EXT value to the type field.

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.

ISACTIVEback to summary
public static final int ISACTIVE

The struct member offsets.

JOINTCOUNTback to summary
public static final int JOINTCOUNT

The struct member offsets.

JOINTLOCATIONSback to summary
public static final int JOINTLOCATIONS

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

XrHandJointLocationsEXTback to summary
protected XrHandJointLocationsEXT(long address, ByteBuffer container)
XrHandJointLocationsEXTback to summary
public XrHandJointLocationsEXT(ByteBuffer container)

Creates a XrHandJointLocationsEXT 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 XrHandJointLocationsEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandJointLocationsEXT calloc(MemoryStack stack)

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

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

Returns a new XrHandJointLocationsEXT instance allocated with BufferUtils.

createback to summary
public static XrHandJointLocationsEXT create(long address)

Returns a new XrHandJointLocationsEXT instance for the specified memory address.

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

Returns a new XrHandJointLocationsEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandJointLocationsEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandJointLocationsEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
isActiveback to summary
public boolean isActive()

an XrBool32 indicating if the hand tracker is actively tracking.

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

Sets the specified value to the isActive field.

jointCountback to summary
public int jointCount()

a uint32_t describing the count of elements in jointLocations array.

Annotations
@NativeType:uint32_t
jointLocationsback to summary
public XrHandJointLocationEXT.Buffer jointLocations()

an array of XrHandJointLocationEXT receiving the returned hand joint locations.

Annotations
@NativeType:XrHandJointLocationEXT *
jointLocationsback to summary
public XrHandJointLocationsEXT jointLocations(XrHandJointLocationEXT.Buffer value)

Sets the address of the specified XrHandJointLocationEXT.Buffer to the jointLocations field.

mallocback to summary
public static XrHandJointLocationsEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandJointLocationsEXT malloc(MemoryStack stack)

Returns a new XrHandJointLocationsEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrHandJointLocationsEXT.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, such as XrHandJointVelocitiesEXT.

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

Sets the specified value to the next field.

nextback to summary
public XrHandJointLocationsEXT next(XrHandJointVelocitiesEXT value)

Prepends the specified XrHandJointVelocitiesEXT value to the next chain.

nextback to summary
public XrHandJointLocationsEXT next(XrHandTrackingAimStateFB value)

Prepends the specified XrHandTrackingAimStateFB value to the next chain.

nextback to summary
public XrHandJointLocationsEXT next(XrHandTrackingCapsulesStateFB value)

Prepends the specified XrHandTrackingCapsulesStateFB value to the next chain.

nextback to summary
public XrHandJointLocationsEXT next(XrHandTrackingDataSourceStateEXT value)

Prepends the specified XrHandTrackingDataSourceStateEXT value to the next chain.

nextback to summary
public XrHandJointLocationsEXT next(XrHandTrackingScaleFB value)

Prepends the specified XrHandTrackingScaleFB value to the next chain.

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.

njointCountback to summary
public static int njointCount(long struct)

Unsafe version of jointCount.

njointCountback to summary
public static void njointCount(long struct, int value)

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

njointLocationsback to summary
public static XrHandJointLocationEXT.Buffer njointLocations(long struct)

Unsafe version of jointLocations.

njointLocationsback to summary
public static void njointLocations(long struct, XrHandJointLocationEXT.Buffer value)

Unsafe version of jointLocations.

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 XrHandJointLocationsEXT set(int type, long next, boolean isActive, XrHandJointLocationEXT.Buffer jointLocations)

Initializes this struct with the specified values.

setback to summary
public XrHandJointLocationsEXT set(XrHandJointLocationsEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrHandJointLocationsEXT

the source struct

Returns:XrHandJointLocationsEXT

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

Sets the specified value to the type field.

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

Sets the TYPE_HAND_JOINT_LOCATIONS_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 XrHandJointLocationsEXT.Buffer

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

An array of XrHandJointLocationsEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandJointLocationsEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHandJointLocationsEXT.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 XrHandJointLocationsEXT
public boolean

Returns:

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

public XrHandJointLocationsEXT.Buffer
isActive(boolean value)

Sets the specified value to the XrHandJointLocationsEXT#isActive field.

public int

Returns:

the value of the XrHandJointLocationsEXT#jointCount field.
jointCount
()

public XrHandJointLocationEXT.Buffer

Returns:

a XrHandJointLocationEXT.Buffer view of the struct array pointed to by the XrHandJointLocationsEXT#jointLocations field.
jointLocations
()

public XrHandJointLocationsEXT.Buffer
public long

Returns:

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

public XrHandJointLocationsEXT.Buffer
next(long value)

Sets the specified value to the XrHandJointLocationsEXT#next field.

public XrHandJointLocationsEXT.Buffer
next(XrHandJointVelocitiesEXT value)

Prepends the specified XrHandJointVelocitiesEXT value to the next chain.

public XrHandJointLocationsEXT.Buffer
next(XrHandTrackingAimStateFB value)

Prepends the specified XrHandTrackingAimStateFB value to the next chain.

public XrHandJointLocationsEXT.Buffer
next(XrHandTrackingCapsulesStateFB value)

Prepends the specified XrHandTrackingCapsulesStateFB value to the next chain.

public XrHandJointLocationsEXT.Buffer
next(XrHandTrackingDataSourceStateEXT value)

Prepends the specified XrHandTrackingDataSourceStateEXT value to the next chain.

public XrHandJointLocationsEXT.Buffer
next(XrHandTrackingScaleFB value)

Prepends the specified XrHandTrackingScaleFB value to the next chain.

protected XrHandJointLocationsEXT.Buffer
public int

Returns:

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

public XrHandJointLocationsEXT.Buffer
type(int value)

Sets the specified value to the XrHandJointLocationsEXT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandJointLocationsEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrHandJointLocationsEXT.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 XrHandJointLocationsEXT#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 XrHandJointLocationsEXT getElementFactory()

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

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

the value of the XrHandJointLocationsEXT#isActive field.

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

Sets the specified value to the XrHandJointLocationsEXT#isActive field.

jointCountback to summary
public int jointCount()
Returns:int

the value of the XrHandJointLocationsEXT#jointCount field.

Annotations
@NativeType:uint32_t
jointLocationsback to summary
public XrHandJointLocationEXT.Buffer jointLocations()
Returns:XrHandJointLocationEXT.Buffer

a XrHandJointLocationEXT.Buffer view of the struct array pointed to by the XrHandJointLocationsEXT#jointLocations field.

Annotations
@NativeType:XrHandJointLocationEXT *
jointLocationsback to summary
public XrHandJointLocationsEXT.Buffer jointLocations(XrHandJointLocationEXT.Buffer value)

Sets the address of the specified XrHandJointLocationEXT.Buffer to the XrHandJointLocationsEXT#jointLocations field.

nextback to summary
public long next()
Returns:long

the value of the XrHandJointLocationsEXT#next field.

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

Sets the specified value to the XrHandJointLocationsEXT#next field.

nextback to summary
public XrHandJointLocationsEXT.Buffer next(XrHandJointVelocitiesEXT value)

Prepends the specified XrHandJointVelocitiesEXT value to the next chain.

nextback to summary
public XrHandJointLocationsEXT.Buffer next(XrHandTrackingAimStateFB value)

Prepends the specified XrHandTrackingAimStateFB value to the next chain.

nextback to summary
public XrHandJointLocationsEXT.Buffer next(XrHandTrackingCapsulesStateFB value)

Prepends the specified XrHandTrackingCapsulesStateFB value to the next chain.

nextback to summary
public XrHandJointLocationsEXT.Buffer next(XrHandTrackingDataSourceStateEXT value)

Prepends the specified XrHandTrackingDataSourceStateEXT value to the next chain.

nextback to summary
public XrHandJointLocationsEXT.Buffer next(XrHandTrackingScaleFB value)

Prepends the specified XrHandTrackingScaleFB value to the next chain.

selfback to summary
protected XrHandJointLocationsEXT.Buffer self()

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

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

the value of the XrHandJointLocationsEXT#type field.

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

Sets the specified value to the XrHandJointLocationsEXT#type field.

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

Sets the TYPE_HAND_JOINT_LOCATIONS_EXT value to the XrHandJointLocationsEXT#type field.