A 3D capsule defined by two points and a radius.

Member Descriptions

points are the two points defining the capsule length.
radius is the radius of the capsule.
joint is the hand joint that drives this capsule’s transform. Multiple capsules can be attached to the same joint.

Valid Usage (Implicit)

The XR_FB_hand_tracking_capsules extension must be enabled prior to using XrHandCapsuleFB

Layout


struct XrHandCapsuleFB {
    XrVector3f points[XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB];
    float radius;
    XrHandJointEXT joint;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrHandCapsuleFB.Buffer An array of `XrHandCapsuleFB` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	JOINT The struct member offsets.
public static final int	POINTS 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrHandCapsuleFB(long address, ByteBuffer container)
public	XrHandCapsuleFB(ByteBuffer container) Creates a `XrHandCapsuleFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
protected XrHandCapsuleFB	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 XrHandCapsuleFB	create(long address) Returns a new `XrHandCapsuleFB` instance for the specified memory address.
public static XrHandCapsuleFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrHandCapsuleFB.Buffer` instance at the specified memory.
public static XrHandCapsuleFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrHandCapsuleFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	Returns: the value of the `joint` field. joint()
public static int	njoint(long struct) Unsafe version of `joint`.
public static XrVector3f.Buffer	npoints(long struct) Unsafe version of `points`.
public static XrVector3f	npoints(long struct, int index) Unsafe version of `points`.
public static float	nradius(long struct) Unsafe version of `radius`.
public XrVector3f.Buffer	Returns: a `XrVector3f`.Buffer view of the `points` field. points()
public XrVector3f	Returns: a `XrVector3f` view of the struct at the specified index of the `points` field. points(int index)
public float	Returns: the value of the `radius` field. radius()
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

JOINT	back to summary
public static final int JOINT The struct member offsets.

POINTS	back to summary
public static final int POINTS The struct member offsets.

RADIUS	back to summary
public static final int RADIUS The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

XrHandCapsuleFB	back to summary
protected XrHandCapsuleFB(long address, ByteBuffer container)

XrHandCapsuleFB back to summary

XrHandCapsuleFB	back to summary
public XrHandCapsuleFB(ByteBuffer container) Creates a `XrHandCapsuleFB` 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.

public XrHandCapsuleFB(ByteBuffer container)

Creates a XrHandCapsuleFB 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

create back to summary

create	back to summary
protected XrHandCapsuleFB 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

protected XrHandCapsuleFB 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

create	back to summary
public static XrHandCapsuleFB create(long address) Returns a new `XrHandCapsuleFB` instance for the specified memory address.

create back to summary

create	back to summary
public static XrHandCapsuleFB.Buffer create(long address, int capacity) Create a `XrHandCapsuleFB.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static XrHandCapsuleFB.Buffer create(long address, int capacity)

Create a XrHandCapsuleFB.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrHandCapsuleFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrHandCapsuleFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrHandCapsuleFB.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

joint	back to summary
public int joint() Returns:int the value of the `joint` field. Annotations @NativeType:XrHandJointEXT

njoint	back to summary
public static int njoint(long struct) Unsafe version of `joint`.

npoints	back to summary
public static XrVector3f.Buffer npoints(long struct) Unsafe version of `points`.

npoints	back to summary
public static XrVector3f npoints(long struct, int index) Unsafe version of `points`.

nradius	back to summary
public static float nradius(long struct) Unsafe version of `radius`.

points	back to summary
public XrVector3f.Buffer points() Returns:XrVector3f.Buffer a `XrVector3f`.Buffer view of the `points` field. Annotations @NativeType:XrVector3f[XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB]

points	back to summary
public XrVector3f points(int index) Returns:XrVector3f a `XrVector3f` view of the struct at the specified index of the `points` field.

radius	back to summary
public float radius() Returns:float the value of the `radius` field.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

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 XrHandCapsuleFB.Buffer

Class Inheritance

extends StructBuffer<XrHandCapsuleFB, XrHandCapsuleFB.Buffer>

An array of XrHandCapsuleFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrHandCapsuleFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrHandCapsuleFB.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 Type	Method and Description
protected XrHandCapsuleFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `joint` field. joint()
public XrVector3f.Buffer	Returns: a `XrVector3f`.Buffer view of the `points` field. points()
public XrVector3f	Returns: a `XrVector3f` view of the struct at the specified index of the `points` field. points(int index)
public float	Returns: the value of the `radius` field. radius()
protected XrHandCapsuleFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrHandCapsuleFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrHandCapsuleFB.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 `XrHandCapsuleFB#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrHandCapsuleFB.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 XrHandCapsuleFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected XrHandCapsuleFB getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrHandCapsuleFB getElementFactory()

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

Annotations

@Override

joint	back to summary
public int joint() Returns:int the value of the `joint` field. Annotations @NativeType:XrHandJointEXT

points	back to summary
public XrVector3f.Buffer points() Returns:XrVector3f.Buffer a `XrVector3f`.Buffer view of the `points` field. Annotations @NativeType:XrVector3f[XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB]

points	back to summary
public XrVector3f points(int index) Returns:XrVector3f a `XrVector3f` view of the struct at the specified index of the `points` field.

radius	back to summary
public float radius() Returns:float the value of the `radius` field.

self	back to summary
protected XrHandCapsuleFB.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected XrHandCapsuleFB.Buffer self()

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

Annotations

@Override

public Class XrHandCapsuleFB

Member Descriptions

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrHandCapsuleFB.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail