Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandJointVelocitiesEXT

extends Struct<XrHandJointVelocitiesEXT>
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 velocities.
Description

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

The application must input jointCount as described by the XrHandJointSetEXT when creating the XrHandTrackerEXT. Otherwise, the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must update the jointVelocities array in the order so that the application can index elements using the corresponding hand joint enum (e.g. XrHandJointEXT) as described by the 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 returned jointVelocities array must be ordered to be indexed by enum XrHandJointEXT enum.

If the returned XrHandJointLocationsEXT::isActive is false, it indicates the hand tracker did not detect a hand input or the application lost input focus. In this case, the runtime must return all jointVelocities with neither SPACE_VELOCITY_LINEAR_VALID_BIT nor SPACE_VELOCITY_ANGULAR_VALID_BIT set.

If an XrHandJointVelocitiesEXT structure is chained to XrHandJointLocationsEXT::next, the returned XrHandJointLocationsEXT::isActive is true, and the velocity is observed or can be calculated by the runtime, the runtime must fill in the linear velocity of each hand joint within the reference frame of baseSpace and set the SPACE_VELOCITY_LINEAR_VALID_BIT. Similarly, if an XrHandJointVelocitiesEXT structure is chained to XrHandJointLocationsEXT::next, the returned XrHandJointLocationsEXT::isActive is true, and the angular velocity is observed or can be calculated by the runtime, the runtime must fill in the angular velocity of each joint within the reference frame of baseSpace and set the SPACE_VELOCITY_ANGULAR_VALID_BIT.

Valid Usage (Implicit)
See Also

XrHandJointLocationsEXT, XrHandJointVelocityEXT

Layout


struct XrHandJointVelocitiesEXT {
    XrStructureType type;
    void * next;
    uint32_t jointCount;
    XrHandJointVelocityEXT * jointVelocities;
}

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
JOINTCOUNT

The struct member offsets.

public static final int
JOINTVELOCITIES

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

public
XrHandJointVelocitiesEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHandJointVelocitiesEXT
calloc()

Returns a new XrHandJointVelocitiesEXT instance allocated with memCalloc.

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

Returns a new XrHandJointVelocitiesEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHandJointVelocitiesEXT instance allocated with BufferUtils.

public static XrHandJointVelocitiesEXT
create(long address)

Returns a new XrHandJointVelocitiesEXT instance for the specified memory address.

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

Returns a new XrHandJointVelocitiesEXT.Buffer instance allocated with BufferUtils.

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

Create a XrHandJointVelocitiesEXT.Buffer instance at the specified memory.

public static XrHandJointVelocitiesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
jointCount()

a uint32_t describing the number of elements in jointVelocities array.

public XrHandJointVelocityEXT.Buffer
jointVelocities()

an array of XrHandJointVelocityEXT receiving the returned hand joint velocities.

public XrHandJointVelocitiesEXT
jointVelocities(XrHandJointVelocityEXT.Buffer value)

Sets the address of the specified XrHandJointVelocityEXT.Buffer to the jointVelocities field.

public static XrHandJointVelocitiesEXT
malloc()

Returns a new XrHandJointVelocitiesEXT instance allocated with memAlloc.

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

Returns a new XrHandJointVelocitiesEXT.Buffer instance allocated with memAlloc.

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

Returns a new XrHandJointVelocitiesEXT instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrHandJointVelocitiesEXT
next(long value)

Sets the specified value to the next field.

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 XrHandJointVelocityEXT.Buffer
njointVelocities(long struct)

Unsafe version of jointVelocities.

public static void
njointVelocities(long struct, XrHandJointVelocityEXT.Buffer value)

Unsafe version of jointVelocities.

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 XrHandJointVelocitiesEXT
set(int type, long next, XrHandJointVelocityEXT.Buffer jointVelocities)

Initializes this struct with the specified values.

public XrHandJointVelocitiesEXT

Returns:

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

Sets the specified value to the type field.

public XrHandJointVelocitiesEXT
type$Default()

Sets the TYPE_HAND_JOINT_VELOCITIES_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.

JOINTCOUNTback to summary
public static final int JOINTCOUNT

The struct member offsets.

JOINTVELOCITIESback to summary
public static final int JOINTVELOCITIES

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

XrHandJointVelocitiesEXTback to summary
protected XrHandJointVelocitiesEXT(long address, ByteBuffer container)
XrHandJointVelocitiesEXTback to summary
public XrHandJointVelocitiesEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandJointVelocitiesEXT calloc(MemoryStack stack)

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

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

Returns a new XrHandJointVelocitiesEXT instance allocated with BufferUtils.

createback to summary
public static XrHandJointVelocitiesEXT create(long address)

Returns a new XrHandJointVelocitiesEXT instance for the specified memory address.

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

Returns a new XrHandJointVelocitiesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandJointVelocitiesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandJointVelocitiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
jointCountback to summary
public int jointCount()

a uint32_t describing the number of elements in jointVelocities array.

Annotations
@NativeType:uint32_t
jointVelocitiesback to summary
public XrHandJointVelocityEXT.Buffer jointVelocities()

an array of XrHandJointVelocityEXT receiving the returned hand joint velocities.

Annotations
@NativeType:XrHandJointVelocityEXT *
jointVelocitiesback to summary
public XrHandJointVelocitiesEXT jointVelocities(XrHandJointVelocityEXT.Buffer value)

Sets the address of the specified XrHandJointVelocityEXT.Buffer to the jointVelocities field.

mallocback to summary
public static XrHandJointVelocitiesEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandJointVelocitiesEXT malloc(MemoryStack stack)

Returns a new XrHandJointVelocitiesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrHandJointVelocitiesEXT.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. No such structures are defined in core OpenXR or this extension.

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

Sets the specified value to the next field.

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.

njointVelocitiesback to summary
public static XrHandJointVelocityEXT.Buffer njointVelocities(long struct)

Unsafe version of jointVelocities.

njointVelocitiesback to summary
public static void njointVelocities(long struct, XrHandJointVelocityEXT.Buffer value)

Unsafe version of jointVelocities.

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 XrHandJointVelocitiesEXT set(int type, long next, XrHandJointVelocityEXT.Buffer jointVelocities)

Initializes this struct with the specified values.

setback to summary
public XrHandJointVelocitiesEXT set(XrHandJointVelocitiesEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrHandJointVelocitiesEXT

the source struct

Returns:XrHandJointVelocitiesEXT

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

Sets the specified value to the type field.

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

Sets the TYPE_HAND_JOINT_VELOCITIES_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 XrHandJointVelocitiesEXT.Buffer

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

An array of XrHandJointVelocitiesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandJointVelocitiesEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHandJointVelocitiesEXT.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 XrHandJointVelocitiesEXT
public int

Returns:

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

public XrHandJointVelocityEXT.Buffer

Returns:

a XrHandJointVelocityEXT.Buffer view of the struct array pointed to by the XrHandJointVelocitiesEXT#jointVelocities field.
jointVelocities
()

public XrHandJointVelocitiesEXT.Buffer
public long

Returns:

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

public XrHandJointVelocitiesEXT.Buffer
next(long value)

Sets the specified value to the XrHandJointVelocitiesEXT#next field.

protected XrHandJointVelocitiesEXT.Buffer
public int

Returns:

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

public XrHandJointVelocitiesEXT.Buffer
type(int value)

Sets the specified value to the XrHandJointVelocitiesEXT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandJointVelocitiesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
jointCountback to summary
public int jointCount()
Returns:int

the value of the XrHandJointVelocitiesEXT#jointCount field.

Annotations
@NativeType:uint32_t
jointVelocitiesback to summary
public XrHandJointVelocityEXT.Buffer jointVelocities()
Returns:XrHandJointVelocityEXT.Buffer

a XrHandJointVelocityEXT.Buffer view of the struct array pointed to by the XrHandJointVelocitiesEXT#jointVelocities field.

Annotations
@NativeType:XrHandJointVelocityEXT *
jointVelocitiesback to summary
public XrHandJointVelocitiesEXT.Buffer jointVelocities(XrHandJointVelocityEXT.Buffer value)

Sets the address of the specified XrHandJointVelocityEXT.Buffer to the XrHandJointVelocitiesEXT#jointVelocities field.

nextback to summary
public long next()
Returns:long

the value of the XrHandJointVelocitiesEXT#next field.

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

Sets the specified value to the XrHandJointVelocitiesEXT#next field.

selfback to summary
protected XrHandJointVelocitiesEXT.Buffer self()

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

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

the value of the XrHandJointVelocitiesEXT#type field.

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

Sets the specified value to the XrHandJointVelocitiesEXT#type field.

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

Sets the TYPE_HAND_JOINT_VELOCITIES_EXT value to the XrHandJointVelocitiesEXT#type field.