Package org.lwjgl.openxr

Class XrBodyJointLocationsFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrBodyJointLocationsFB>
org.lwjgl.openxr.XrBodyJointLocationsFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrBodyJointLocationsFB extends org.lwjgl.system.Struct<XrBodyJointLocationsFB> implements org.lwjgl.system.NativeResource
Returns the body joint locations.
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 jointLocations representing the range of human body motion, without any obstructions. Input systems that either obstruct the movement of the user’s body (for example, a held controller preventing the user from making a fist) or input systems that have only limited ability to track finger positions must use the information available to them to emulate an unobstructed range of motion.

The runtime must update the jointLocations array ordered so that it is indexed using the corresponding body joint enum (e.g. XrBodyJointFB) as described by XrBodyJointSetFB when creating the XrBodyTrackerFB. For example, when the XrBodyTrackerFB is created with BODY_JOINT_SET_DEFAULT_FB, the application must set the jointCount to BODY_JOINT_COUNT_FB, and the runtime must fill the jointLocations array ordered so that it is indexed by the XrBodyJointFB enum.

If the returned isActive is true, the runtime must return all joint locations with both SPACE_LOCATION_POSITION_VALID_BIT and SPACE_LOCATION_ORIENTATION_VALID_BIT set. However, in this case, some joint space locations may be untracked (i.e. SPACE_LOCATION_POSITION_TRACKED_BIT or SPACE_LOCATION_ORIENTATION_TRACKED_BIT is unset).

If the returned isActive is false, it indicates that the body tracker did not detect the body input, the application lost input focus, or the consent for body tracking was denied by the user. In this case, the runtime must return all jointLocations with neither SPACE_LOCATION_POSITION_VALID_BIT nor SPACE_LOCATION_ORIENTATION_VALID_BIT set.

Valid Usage (Implicit)
See Also

XrBodyJointLocationFB, LocateBodyJointsFB

Layout


 struct XrBodyJointLocationsFB {
     XrStructureType type();
     void * next();
     XrBool32 isActive();
     float confidence();
     uint32_t jointCount();
     XrBodyJointLocationFB * jointLocations();
     uint32_t skeletonChangedCount();
     XrTime time();
 }

  • 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.

    • ISACTIVE

      public static final int ISACTIVE
      The struct member offsets.

    • CONFIDENCE

      public static final int CONFIDENCE
      The struct member offsets.

    • JOINTCOUNT

      public static final int JOINTCOUNT
      The struct member offsets.

    • JOINTLOCATIONS

      public static final int JOINTLOCATIONS
      The struct member offsets.

    • SKELETONCHANGEDCOUNT

      public static final int SKELETONCHANGEDCOUNT
      The struct member offsets.

    • TIME

      public static final int TIME
      The struct member offsets.

  • Constructor Details

    • XrBodyJointLocationsFB

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

    • 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.

    • isActive

      public boolean isActive()
      an XrBool32 indicating if the body tracker is actively tracking.

    • confidence

      public float confidence()
      a float between 0 and 1 which represents the confidence for the returned body pose. A value of 0 means there is no confidence in the pose returned, and a value of 1 means maximum confidence in the returned body pose.

    • jointCount

      public int jointCount()
      a uint32_t describing the count of elements in jointLocations array.

    • jointLocations

      public XrBodyJointLocationFB.Buffer jointLocations()
      an application-allocated array of XrBodyJointLocationFB that will be filled with joint locations.

    • skeletonChangedCount

      public int skeletonChangedCount()
      an output uint32_t incremental counter indicating that the skeleton scale proportions have changed. GetBodySkeletonFB can be called when this counter increases to get the latest body proportions/scale.

    • time

      public long time()
      an XrTime time at which the returned joints are tracked. Equals the time at which the joints were requested if the interpolation at the time was successful.

    • type

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

    • type$Default

      public XrBodyJointLocationsFB type$Default()
      Sets the TYPE_BODY_JOINT_LOCATIONS_FB value to the type() field.

    • next

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

    • isActive

      public XrBodyJointLocationsFB isActive(boolean value)
      Sets the specified value to the isActive() field.

    • confidence

      public XrBodyJointLocationsFB confidence(float value)
      Sets the specified value to the confidence() field.

    • jointLocations

      public XrBodyJointLocationsFB jointLocations(XrBodyJointLocationFB.Buffer value)
      Sets the address of the specified XrBodyJointLocationFB.Buffer to the jointLocations() field.

    • skeletonChangedCount

      public XrBodyJointLocationsFB skeletonChangedCount(int value)
      Sets the specified value to the skeletonChangedCount() field.

    • time

      public XrBodyJointLocationsFB time(long value)
      Sets the specified value to the time() field.

    • set

      public XrBodyJointLocationsFB set(int type, long next, boolean isActive, float confidence, XrBodyJointLocationFB.Buffer jointLocations, int skeletonChangedCount, long time)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nisActive

      public static int nisActive(long struct)
      Unsafe version of isActive().

    • nconfidence

      public static float nconfidence(long struct)
      Unsafe version of confidence().

    • njointCount

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

    • njointLocations

      public static XrBodyJointLocationFB.Buffer njointLocations(long struct)
      Unsafe version of jointLocations().

    • nskeletonChangedCount

      public static int nskeletonChangedCount(long struct)
      Unsafe version of skeletonChangedCount().

    • ntime

      public static long ntime(long struct)
      Unsafe version of time().

    • 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.

    • nisActive

      public static void nisActive(long struct, int value)
      Unsafe version of isActive.

    • nconfidence

      public static void nconfidence(long struct, float value)
      Unsafe version of confidence.

    • njointCount

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

    • njointLocations

      public static void njointLocations(long struct, XrBodyJointLocationFB.Buffer value)
      Unsafe version of jointLocations.

    • nskeletonChangedCount

      public static void nskeletonChangedCount(long struct, int value)
      Unsafe version of skeletonChangedCount.

    • ntime

      public static void ntime(long struct, long value)
      Unsafe version of time.

    • validate

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