Package org.lwjgl.openxr

Class XrBodySkeletonFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrBodySkeletonFB>
org.lwjgl.openxr.XrBodySkeletonFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrBodySkeletonFB extends org.lwjgl.system.Struct<XrBodySkeletonFB> implements org.lwjgl.system.NativeResource
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)
See Also

XrBodySkeletonJointFB, GetBodySkeletonFB

Layout


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

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • TYPE

      public static final int TYPE
      The struct member offsets.

    • NEXT

      public static final int NEXT
      The struct member offsets.

    • JOINTCOUNT

      public static final int JOINTCOUNT
      The struct member offsets.

    • JOINTS

      public static final int JOINTS
      The struct member offsets.

  • Constructor Details

    • XrBodySkeletonFB

      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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<XrBodySkeletonFB>

    • type

      public int type()
      the XrStructureType of this structure.

    • next

      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.

    • jointCount

      public int jointCount()
      an uint32_t describing the count of elements in joints array.

    • joints

      public XrBodySkeletonJointFB.Buffer joints()
      an application-allocated array of XrBodySkeletonJointFB that will be filled with skeleton joint elements.

    • type

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

    • type$Default

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

    • next

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

    • joints

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

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

      public static XrBodySkeletonFB create()
      Returns a new XrBodySkeletonFB instance allocated with BufferUtils.

    • create

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

    • createSafe

      public static @Nullable XrBodySkeletonFB createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

      public static XrBodySkeletonFB malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrBodySkeletonFB instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

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

    • malloc

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

    • calloc

      public static XrBodySkeletonFB.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrBodySkeletonFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • ntype

      public static int ntype(long struct)
      Unsafe version of type().

    • nnext

      public static long nnext(long struct)
      Unsafe version of next().

    • njointCount

      public static int njointCount(long struct)
      Unsafe version of jointCount().

    • njoints

      public static XrBodySkeletonJointFB.Buffer njoints(long struct)
      Unsafe version of joints().

    • ntype

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

    • nnext

      public static void nnext(long struct, long value)
      Unsafe version of next.

    • njointCount

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

    • njoints

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

    • validate

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