Package org.lwjgl.openxr

Class XrBodySkeletonHTC

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrBodySkeletonHTC>
org.lwjgl.openxr.XrBodySkeletonHTC
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrBodySkeletonHTC extends org.lwjgl.system.Struct<XrBodySkeletonHTC> implements org.lwjgl.system.NativeResource
Returns the body skeleton.
Description

The XrBodySkeletonHTC structure is a container to represent the body skeleton in T-pose including each joint pose. The runtime must return ERROR_VALIDATION_FAILURE if jointCount does not equal the number of joints associated with the XrBodyJointSetHTC value used to create the XrBodyTrackerHTC.

The application must allocate an array of at least jointCount elements for joints, to be populated by the runtime. If joints is NULL, the runtime must return ERROR_VALIDATION_FAILURE.

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

The runtime must update the joints array ordered so that it is indexed using the corresponding body joint enumeration (e.g. XrBodyJointHTC for the joint set BODY_JOINT_SET_FULL_HTC) as associated with the XrBodyJointSetHTC value used when creating the XrBodyTrackerHTC. For example, when the XrBodyTrackerHTC is created with BODY_JOINT_SET_FULL_HTC, the runtime must fill the joints array indexed by the XrBodyJointHTC enumeration.

Valid Usage (Implicit)
See Also

XrBodySkeletonJointHTC, GetBodySkeletonHTC

Layout


 struct XrBodySkeletonHTC {
     XrStructureType type();
     void * next();
     uint32_t jointCount();
     XrBodySkeletonJointHTC * 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

    • XrBodySkeletonHTC

      public XrBodySkeletonHTC(ByteBuffer container)
      Creates a XrBodySkeletonHTC 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<XrBodySkeletonHTC>

    • 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 XrBodySkeletonJointHTC.Buffer joints()
      an application-allocated array of XrBodySkeletonJointHTC that will be filled with skeleton joint elements.

    • type

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

    • type$Default

      public XrBodySkeletonHTC type$Default()
      Sets the TYPE_BODY_SKELETON_HTC value to the type() field.

    • next

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

    • joints

      public XrBodySkeletonHTC joints(XrBodySkeletonJointHTC.Buffer value)
      Sets the address of the specified XrBodySkeletonJointHTC.Buffer to the joints() field.

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static XrBodySkeletonHTC.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrBodySkeletonHTC.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 XrBodySkeletonJointHTC.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, XrBodySkeletonJointHTC.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