Class XrHandJointLocationsEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrHandJointLocationsEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrHandJointLocationsEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceReturns the hand joint locations.Description
The application must allocate the memory for the output array
jointLocationsthat can contain at leastjointCountofXrHandJointLocationEXT.The application must set
jointCountas described by theXrHandJointSetEXTwhen creating theXrHandTrackerEXTotherwise the runtime must returnERROR_VALIDATION_FAILURE.The runtime must return
jointLocationsrepresenting 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
jointLocationsarray ordered so that the application can index elements using the corresponding hand joint enum (e.g.XrHandJointEXT) as described byXrHandJointSetEXTwhen creating theXrHandTrackerEXT. For example, when theXrHandTrackerEXTis created withHAND_JOINT_SET_DEFAULT_EXT, the application must set thejointCounttoHAND_JOINT_COUNT_EXT, and the runtime must fill thejointLocationsarray ordered so that it may be indexed by theXrHandJointEXTenum.If the returned
isActiveis true, the runtime must return all joint locations with bothSPACE_LOCATION_POSITION_VALID_BITandSPACE_LOCATION_ORIENTATION_VALID_BITset. Although, in this case, some joint space locations may be untracked (i.e.SPACE_LOCATION_POSITION_TRACKED_BITorSPACE_LOCATION_ORIENTATION_TRACKED_BITis unset).If the returned
isActiveis 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 alljointLocationswith neitherSPACE_LOCATION_POSITION_VALID_BITnorSPACE_LOCATION_ORIENTATION_VALID_BITset.Valid Usage (Implicit)
- The
XR_EXT_hand_trackingextension must be enabled prior to usingXrHandJointLocationsEXT typemust beTYPE_HAND_JOINT_LOCATIONS_EXTnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrHandJointVelocitiesEXTjointLocationsmust be a pointer to an array ofjointCountXrHandJointLocationEXTstructures- The
jointCountparameter must be greater than 0
See Also
XrHandJointLocationEXT,LocateHandJointsEXTLayout
struct XrHandJointLocationsEXT { XrStructureTypetype(); void *next(); XrBool32isActive(); uint32_tjointCount();XrHandJointLocationEXT*jointLocations(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrHandJointLocationsEXT.BufferAn array ofXrHandJointLocationsEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intISACTIVE
JOINTCOUNT
JOINTLOCATIONS
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrHandJointLocationsEXT(java.nio.ByteBuffer container)Creates aXrHandJointLocationsEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrHandJointLocationsEXTcalloc()Returns a newXrHandJointLocationsEXTinstance allocated withmemCalloc.static XrHandJointLocationsEXT.Buffercalloc(int capacity)Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withmemCalloc.static XrHandJointLocationsEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHandJointLocationsEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHandJointLocationsEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHandJointLocationsEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHandJointLocationsEXTcreate()Returns a newXrHandJointLocationsEXTinstance allocated withBufferUtils.static XrHandJointLocationsEXT.Buffercreate(int capacity)Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withBufferUtils.static XrHandJointLocationsEXTcreate(long address)Returns a newXrHandJointLocationsEXTinstance for the specified memory address.static XrHandJointLocationsEXT.Buffercreate(long address, int capacity)Create aXrHandJointLocationsEXT.Bufferinstance at the specified memory.static XrHandJointLocationsEXTcreateSafe(long address)static XrHandJointLocationsEXT.BuffercreateSafe(long address, int capacity)booleanisActive()anXrBool32indicating if the hand tracker is actively tracking.XrHandJointLocationsEXTisActive(boolean value)Sets the specified value to theisActive()field.intjointCount()auint32_tdescribing the count of elements injointLocationsarray.XrHandJointLocationEXT.BufferjointLocations()an array ofXrHandJointLocationEXTreceiving the returned hand joint locations.XrHandJointLocationsEXTjointLocations(XrHandJointLocationEXT.Buffer value)Sets the address of the specifiedXrHandJointLocationEXT.Bufferto thejointLocations()field.static XrHandJointLocationsEXTmalloc()Returns a newXrHandJointLocationsEXTinstance allocated withmemAlloc.static XrHandJointLocationsEXT.Buffermalloc(int capacity)Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withmemAlloc.static XrHandJointLocationsEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHandJointLocationsEXT.Bufferinstance allocated on the specifiedMemoryStack.static XrHandJointLocationsEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHandJointLocationsEXTinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain, such asXrHandJointVelocitiesEXT.XrHandJointLocationsEXTnext(long value)Sets the specified value to thenext()field.XrHandJointLocationsEXTnext(XrHandJointVelocitiesEXT value)Prepends the specifiedXrHandJointVelocitiesEXTvalue to thenextchain.static intnisActive(long struct)Unsafe version ofisActive().static voidnisActive(long struct, int value)Unsafe version ofisActive.static intnjointCount(long struct)Unsafe version ofjointCount().static voidnjointCount(long struct, int value)Sets the specified value to thejointCountfield of the specifiedstruct.static XrHandJointLocationEXT.BuffernjointLocations(long struct)Unsafe version ofjointLocations().static voidnjointLocations(long struct, XrHandJointLocationEXT.Buffer value)Unsafe version ofjointLocations.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrHandJointLocationsEXTset(int type, long next, boolean isActive, XrHandJointLocationEXT.Buffer jointLocations)Initializes this struct with the specified values.XrHandJointLocationsEXTset(XrHandJointLocationsEXT src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrHandJointLocationsEXTtype(int value)Sets the specified value to thetype()field.XrHandJointLocationsEXTtype$Default()Sets theTYPE_HAND_JOINT_LOCATIONS_EXTvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrHandJointLocationsEXT
public XrHandJointLocationsEXT(java.nio.ByteBuffer container)
Creates aXrHandJointLocationsEXTinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain, such asXrHandJointVelocitiesEXT.
-
isActive
public boolean isActive()
anXrBool32indicating if the hand tracker is actively tracking.
-
jointCount
public int jointCount()
auint32_tdescribing the count of elements injointLocationsarray.
-
jointLocations
public XrHandJointLocationEXT.Buffer jointLocations()
an array ofXrHandJointLocationEXTreceiving the returned hand joint locations.
-
type
public XrHandJointLocationsEXT type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrHandJointLocationsEXT type$Default()
Sets theTYPE_HAND_JOINT_LOCATIONS_EXTvalue to thetype()field.
-
next
public XrHandJointLocationsEXT next(long value)
Sets the specified value to thenext()field.
-
next
public XrHandJointLocationsEXT next(XrHandJointVelocitiesEXT value)
Prepends the specifiedXrHandJointVelocitiesEXTvalue to thenextchain.
-
isActive
public XrHandJointLocationsEXT isActive(boolean value)
Sets the specified value to theisActive()field.
-
jointLocations
public XrHandJointLocationsEXT jointLocations(XrHandJointLocationEXT.Buffer value)
Sets the address of the specifiedXrHandJointLocationEXT.Bufferto thejointLocations()field.
-
set
public XrHandJointLocationsEXT set(int type, long next, boolean isActive, XrHandJointLocationEXT.Buffer jointLocations)
Initializes this struct with the specified values.
-
set
public XrHandJointLocationsEXT set(XrHandJointLocationsEXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrHandJointLocationsEXT malloc()
Returns a newXrHandJointLocationsEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrHandJointLocationsEXT calloc()
Returns a newXrHandJointLocationsEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrHandJointLocationsEXT create()
Returns a newXrHandJointLocationsEXTinstance allocated withBufferUtils.
-
create
public static XrHandJointLocationsEXT create(long address)
Returns a newXrHandJointLocationsEXTinstance for the specified memory address.
-
createSafe
@Nullable public static XrHandJointLocationsEXT createSafe(long address)
-
malloc
public static XrHandJointLocationsEXT.Buffer malloc(int capacity)
Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrHandJointLocationsEXT.Buffer calloc(int capacity)
Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrHandJointLocationsEXT.Buffer create(int capacity)
Returns a newXrHandJointLocationsEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrHandJointLocationsEXT.Buffer create(long address, int capacity)
Create aXrHandJointLocationsEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrHandJointLocationsEXT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrHandJointLocationsEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHandJointLocationsEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrHandJointLocationsEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHandJointLocationsEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrHandJointLocationsEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHandJointLocationsEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrHandJointLocationsEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHandJointLocationsEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nisActive
public static int nisActive(long struct)
Unsafe version ofisActive().
-
njointCount
public static int njointCount(long struct)
Unsafe version ofjointCount().
-
njointLocations
public static XrHandJointLocationEXT.Buffer njointLocations(long struct)
Unsafe version ofjointLocations().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nisActive
public static void nisActive(long struct, int value)Unsafe version ofisActive.
-
njointCount
public static void njointCount(long struct, int value)Sets the specified value to thejointCountfield of the specifiedstruct.
-
njointLocations
public static void njointLocations(long struct, XrHandJointLocationEXT.Buffer value)Unsafe version ofjointLocations.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-