Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandJointLocationEXT

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

Describes the location and radius of a hand joint.
Description

If the returned locationFlags has SPACE_LOCATION_POSITION_VALID_BIT set, the returned radius must be a positive value.

If the returned locationFlags has SPACE_LOCATION_POSITION_VALID_BIT unset, the returned radius value is undefined and should be avoided.

Valid Usage (Implicit)
See Also

XrHandJointLocationsEXT, XrPosef

Layout


struct XrHandJointLocationEXT {
    XrSpaceLocationFlags locationFlags;
    XrPosef pose;
    float radius;
}

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
LOCATIONFLAGS

The struct member offsets.

public static final int
POSE

The struct member offsets.

public static final int
RADIUS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrHandJointLocationEXT(long address, ByteBuffer container)

public
XrHandJointLocationEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHandJointLocationEXT
calloc()

Returns a new XrHandJointLocationEXT instance allocated with memCalloc.

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

Returns a new XrHandJointLocationEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHandJointLocationEXT instance allocated with BufferUtils.

public static XrHandJointLocationEXT
create(long address)

Returns a new XrHandJointLocationEXT instance for the specified memory address.

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

Returns a new XrHandJointLocationEXT.Buffer instance allocated with BufferUtils.

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

Create a XrHandJointLocationEXT.Buffer instance at the specified memory.

public static XrHandJointLocationEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
locationFlags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.

public XrHandJointLocationEXT
locationFlags(long value)

Sets the specified value to the locationFlags field.

public static XrHandJointLocationEXT
malloc()

Returns a new XrHandJointLocationEXT instance allocated with memAlloc.

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

Returns a new XrHandJointLocationEXT.Buffer instance allocated with memAlloc.

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

Returns a new XrHandJointLocationEXT instance allocated on the specified MemoryStack.

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

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

public static long
nlocationFlags(long struct)

Unsafe version of locationFlags.

public static void
nlocationFlags(long struct, long value)

Unsafe version of locationFlags.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public static float
nradius(long struct)

Unsafe version of radius.

public static void
nradius(long struct, float value)

Unsafe version of radius.

public XrPosef
pose()

an XrPosef defining the position and orientation of the origin of a hand joint within the reference frame of the corresponding XrHandJointsLocateInfoEXT::baseSpace.

public XrHandJointLocationEXT
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrHandJointLocationEXT
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public float
radius()

a float value radius of the corresponding joint in units of meters.

public XrHandJointLocationEXT
radius(float value)

Sets the specified value to the radius field.

public XrHandJointLocationEXT
set(long locationFlags, XrPosef pose, float radius)

Initializes this struct with the specified values.

public XrHandJointLocationEXT

Returns:

this struct
set
(XrHandJointLocationEXT
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).
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.

LOCATIONFLAGSback to summary
public static final int LOCATIONFLAGS

The struct member offsets.

POSEback to summary
public static final int POSE

The struct member offsets.

RADIUSback to summary
public static final int RADIUS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrHandJointLocationEXTback to summary
protected XrHandJointLocationEXT(long address, ByteBuffer container)
XrHandJointLocationEXTback to summary
public XrHandJointLocationEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandJointLocationEXT calloc(MemoryStack stack)

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

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

Returns a new XrHandJointLocationEXT instance allocated with BufferUtils.

createback to summary
public static XrHandJointLocationEXT create(long address)

Returns a new XrHandJointLocationEXT instance for the specified memory address.

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

Returns a new XrHandJointLocationEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandJointLocationEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandJointLocationEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationFlagsback to summary
public long locationFlags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data. If none of the bits are set, no other fields in this structure should be considered to be valid or meaningful.

Annotations
@NativeType:XrSpaceLocationFlags
locationFlagsback to summary
public XrHandJointLocationEXT locationFlags(long value)

Sets the specified value to the locationFlags field.

mallocback to summary
public static XrHandJointLocationEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandJointLocationEXT malloc(MemoryStack stack)

Returns a new XrHandJointLocationEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nlocationFlagsback to summary
public static long nlocationFlags(long struct)

Unsafe version of locationFlags.

nlocationFlagsback to summary
public static void nlocationFlags(long struct, long value)

Unsafe version of locationFlags.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

nradiusback to summary
public static float nradius(long struct)

Unsafe version of radius.

nradiusback to summary
public static void nradius(long struct, float value)

Unsafe version of radius.

poseback to summary
public XrPosef pose()

an XrPosef defining the position and orientation of the origin of a hand joint within the reference frame of the corresponding XrHandJointsLocateInfoEXT::baseSpace.

poseback to summary
public XrHandJointLocationEXT pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrHandJointLocationEXT pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

radiusback to summary
public float radius()

a float value radius of the corresponding joint in units of meters.

radiusback to summary
public XrHandJointLocationEXT radius(float value)

Sets the specified value to the radius field.

setback to summary
public XrHandJointLocationEXT set(long locationFlags, XrPosef pose, float radius)

Initializes this struct with the specified values.

setback to summary
public XrHandJointLocationEXT set(XrHandJointLocationEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrHandJointLocationEXT

the source struct

Returns:XrHandJointLocationEXT

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
org.lwjgl.openxr back to summary

public Class XrHandJointLocationEXT.Buffer

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

An array of XrHandJointLocationEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandJointLocationEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the XrHandJointLocationEXT#locationFlags field.
locationFlags
()

public XrHandJointLocationEXT.Buffer
locationFlags(long value)

Sets the specified value to the XrHandJointLocationEXT#locationFlags field.

public XrPosef

Returns:

a XrPosef view of the XrHandJointLocationEXT#pose field.
pose
()

public XrHandJointLocationEXT.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrHandJointLocationEXT#pose field.

public XrHandJointLocationEXT.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrHandJointLocationEXT#pose field to the specified Consumer.

public float

Returns:

the value of the XrHandJointLocationEXT#radius field.
radius
()

public XrHandJointLocationEXT.Buffer
radius(float value)

Sets the specified value to the XrHandJointLocationEXT#radius field.

protected XrHandJointLocationEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandJointLocationEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
locationFlagsback to summary
public long locationFlags()
Returns:long

the value of the XrHandJointLocationEXT#locationFlags field.

Annotations
@NativeType:XrSpaceLocationFlags
locationFlagsback to summary
public XrHandJointLocationEXT.Buffer locationFlags(long value)

Sets the specified value to the XrHandJointLocationEXT#locationFlags field.

poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrHandJointLocationEXT#pose field.

poseback to summary
public XrHandJointLocationEXT.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrHandJointLocationEXT#pose field.

poseback to summary
public XrHandJointLocationEXT.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrHandJointLocationEXT#pose field to the specified Consumer.

radiusback to summary
public float radius()
Returns:float

the value of the XrHandJointLocationEXT#radius field.

radiusback to summary
public XrHandJointLocationEXT.Buffer radius(float value)

Sets the specified value to the XrHandJointLocationEXT#radius field.

selfback to summary
protected XrHandJointLocationEXT.Buffer self()

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

Annotations
@Override