Returns the body skeleton hierarchy.

Description

The runtime must return ERROR_VALIDATION_FAILURE if jointCount does not equal to the number of joints defined by the XrBodyJointSetFB used to create the XrBodyTrackerFB.

The runtime must return joints representing the default pose of the current estimation regarding the user’s skeleton.

Valid Usage (Implicit)

The XR_FB_body_tracking extension must be enabled prior to using XrBodySkeletonFB
type must be TYPE_BODY_SKELETON_FB
next must be NULL or a valid pointer to the next structure in a structure chain
joints must be a pointer to an array of jointCount XrBodySkeletonJointFB structures
The jointCount parameter must be greater than 0

Layout


struct XrBodySkeletonFB {
    XrStructureType type;
    void * next;
    uint32_t jointCount;
    XrBodySkeletonJointFB * joints;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field 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	JOINTS 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static XrBodySkeletonFB	calloc() Returns a new `XrBodySkeletonFB` instance allocated with `memCalloc`.
public static XrBodySkeletonFB.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `memCalloc`.
public static XrBodySkeletonFB	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrBodySkeletonFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrBodySkeletonFB.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrBodySkeletonFB.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrBodySkeletonFB	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 XrBodySkeletonFB	create() Returns a new `XrBodySkeletonFB` instance allocated with `BufferUtils`.
public static XrBodySkeletonFB	create(long address) Returns a new `XrBodySkeletonFB` instance for the specified memory address.
public static XrBodySkeletonFB.Buffer	create(int the buffer capacity capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `BufferUtils`.
public static XrBodySkeletonFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrBodySkeletonFB.Buffer` instance at the specified memory.
public static XrBodySkeletonFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrBodySkeletonFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	jointCount() an `uint32_t` describing the count of elements in `joints` array.
public XrBodySkeletonJointFB.Buffer	joints() an application-allocated array of `XrBodySkeletonJointFB` that will be filled with skeleton joint elements.
public XrBodySkeletonFB	joints(XrBodySkeletonJointFB.Buffer value) Sets the address of the specified `XrBodySkeletonJointFB.Buffer` to the `joints` field.
public static XrBodySkeletonFB	malloc() Returns a new `XrBodySkeletonFB` instance allocated with `memAlloc`.
public static XrBodySkeletonFB.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `memAlloc`.
public static XrBodySkeletonFB	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrBodySkeletonFB` instance allocated on the specified `MemoryStack`.
public static XrBodySkeletonFB.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrBodySkeletonFB.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrBodySkeletonFB	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 XrBodySkeletonJointFB.Buffer	njoints(long struct) Unsafe version of `joints`.
public static void	njoints(long struct, XrBodySkeletonJointFB.Buffer value) Unsafe version of `joints`.
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 XrBodySkeletonFB	set(int type, long next, XrBodySkeletonJointFB.Buffer joints) Initializes this struct with the specified values.
public XrBodySkeletonFB	Returns: this struct set(XrBodySkeletonFB 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 XrBodySkeletonFB	type(int value) Sets the specified value to the `type` field.
public XrBodySkeletonFB	type$Default() Sets the `TYPE_BODY_SKELETON_FB` value to the `type` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

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

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

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

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

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

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

Constructor Detail

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

XrBodySkeletonFB back to summary

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

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

calloc	back to summary
public static XrBodySkeletonFB calloc() Returns a new `XrBodySkeletonFB` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrBodySkeletonFB.Buffer calloc(int capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrBodySkeletonFB.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrBodySkeletonFB calloc(MemoryStack stack) Returns a new `XrBodySkeletonFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrBodySkeletonFB calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrBodySkeletonFB.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrBodySkeletonFB.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

public static XrBodySkeletonFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrBodySkeletonFB.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

create back to summary

create	back to summary
protected XrBodySkeletonFB 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 XrBodySkeletonFB 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 XrBodySkeletonFB create() Returns a new `XrBodySkeletonFB` instance allocated with `BufferUtils`.

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

create back to summary

create	back to summary
public static XrBodySkeletonFB.Buffer create(int capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrBodySkeletonFB.Buffer create(int capacity)

Returns a new XrBodySkeletonFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a XrBodySkeletonFB.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 XrBodySkeletonFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrBodySkeletonFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

jointCount back to summary

jointCount	back to summary
public int jointCount() an `uint32_t` describing the count of elements in `joints` array. Annotations @NativeType:uint32_t

public int jointCount()

an uint32_t describing the count of elements in joints array.

Annotations

@NativeType:uint32_t

joints back to summary

joints	back to summary
public XrBodySkeletonJointFB.Buffer joints() an application-allocated array of `XrBodySkeletonJointFB` that will be filled with skeleton joint elements. Annotations @NativeType:XrBodySkeletonJointFB *

public XrBodySkeletonJointFB.Buffer joints()

an application-allocated array of XrBodySkeletonJointFB that will be filled with skeleton joint elements.

Annotations

@NativeType:XrBodySkeletonJointFB *

joints	back to summary
public XrBodySkeletonFB joints(XrBodySkeletonJointFB.Buffer value) Sets the address of the specified `XrBodySkeletonJointFB.Buffer` to the `joints` field.

malloc	back to summary
public static XrBodySkeletonFB malloc() Returns a new `XrBodySkeletonFB` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrBodySkeletonFB.Buffer malloc(int capacity) Returns a new `XrBodySkeletonFB.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrBodySkeletonFB.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrBodySkeletonFB malloc(MemoryStack stack) Returns a new `XrBodySkeletonFB` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrBodySkeletonFB malloc(MemoryStack stack)

Returns a new XrBodySkeletonFB instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrBodySkeletonFB.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrBodySkeletonFB.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrBodySkeletonFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back 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 *

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 *

next	back to summary
public XrBodySkeletonFB next(long value) Sets the specified value to the `next` field.

njointCount	back to summary
public static int njointCount(long struct) Unsafe version of `jointCount`.

njointCount	back to summary
public static void njointCount(long struct, int value) Sets the specified value to the `jointCount` field of the specified `struct`.

njoints	back to summary
public static XrBodySkeletonJointFB.Buffer njoints(long struct) Unsafe version of `joints`.

njoints	back to summary
public static void njoints(long struct, XrBodySkeletonJointFB.Buffer value) Unsafe version of `joints`.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

set	back to summary
public XrBodySkeletonFB set(int type, long next, XrBodySkeletonJointFB.Buffer joints) Initializes this struct with the specified values.

set	back to summary
public XrBodySkeletonFB set(XrBodySkeletonFB src) Copies the specified struct data to this struct. Parameters src:XrBodySkeletonFB the source struct Returns:XrBodySkeletonFB this struct

set

back to summary

public XrBodySkeletonFB set(XrBodySkeletonFB src)

Copies the specified struct data to this struct.

Parameters

src:XrBodySkeletonFB: the source struct

Returns:XrBodySkeletonFB

this struct

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

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrBodySkeletonFB type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrBodySkeletonFB type$Default() Sets the `TYPE_BODY_SKELETON_FB` value to the `type` field.

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

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

Class Inheritance

extends StructBuffer<XrBodySkeletonFB, XrBodySkeletonFB.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrBodySkeletonFB.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrBodySkeletonFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrBodySkeletonFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrBodySkeletonFB.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 XrBodySkeletonFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `XrBodySkeletonFB#jointCount` field. jointCount()
public XrBodySkeletonJointFB.Buffer	Returns: a `XrBodySkeletonJointFB.Buffer` view of the struct array pointed to by the `XrBodySkeletonFB#joints` field. joints()
public XrBodySkeletonFB.Buffer	joints(XrBodySkeletonJointFB.Buffer value) Sets the address of the specified `XrBodySkeletonJointFB.Buffer` to the `XrBodySkeletonFB#joints` field.
public long	Returns: the value of the `XrBodySkeletonFB#next` field. next()
public XrBodySkeletonFB.Buffer	next(long value) Sets the specified value to the `XrBodySkeletonFB#next` field.
protected XrBodySkeletonFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrBodySkeletonFB#type` field. type()
public XrBodySkeletonFB.Buffer	type(int value) Sets the specified value to the `XrBodySkeletonFB#type` field.
public XrBodySkeletonFB.Buffer	type$Default() Sets the `TYPE_BODY_SKELETON_FB` value to the `XrBodySkeletonFB#type` field.

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 XrBodySkeletonFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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

Annotations

@Override

jointCount	back to summary
public int jointCount() Returns:int the value of the `XrBodySkeletonFB#jointCount` field. Annotations @NativeType:uint32_t

joints	back to summary
public XrBodySkeletonJointFB.Buffer joints() Returns:XrBodySkeletonJointFB.Buffer a `XrBodySkeletonJointFB.Buffer` view of the struct array pointed to by the `XrBodySkeletonFB#joints` field. Annotations @NativeType:XrBodySkeletonJointFB *

joints	back to summary
public XrBodySkeletonFB.Buffer joints(XrBodySkeletonJointFB.Buffer value) Sets the address of the specified `XrBodySkeletonJointFB.Buffer` to the `XrBodySkeletonFB#joints` field.

next	back to summary
public long next() Returns:long the value of the `XrBodySkeletonFB#next` field. Annotations @NativeType:void *

next	back to summary
public XrBodySkeletonFB.Buffer next(long value) Sets the specified value to the `XrBodySkeletonFB#next` field.

self

back to summary

protected XrBodySkeletonFB.Buffer self()

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

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrBodySkeletonFB#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrBodySkeletonFB.Buffer type(int value) Sets the specified value to the `XrBodySkeletonFB#type` field.

type$Default	back to summary
public XrBodySkeletonFB.Buffer type$Default() Sets the `TYPE_BODY_SKELETON_FB` value to the `XrBodySkeletonFB#type` field.

public Class XrBodySkeletonFB

Description

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail