Package org.lwjgl.openxr

Class XrHandJointLocationEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrHandJointLocationEXT>
org.lwjgl.openxr.XrHandJointLocationEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrHandJointLocationEXT extends org.lwjgl.system.Struct<XrHandJointLocationEXT> implements org.lwjgl.system.NativeResource
Describes the location and radius of a hand joint.
Description

If the returned locationFlags has SPACE_LOCATION_POSITION_VALID_BIT set, the returned radius must be a positive value.

If the returned locationFlags has SPACE_LOCATION_POSITION_VALID_BIT unset, the returned radius value is undefined and should be avoided.

Valid Usage (Implicit)
See Also

XrHandJointLocationsEXT, XrPosef

Layout


 struct XrHandJointLocationEXT {
     XrSpaceLocationFlags locationFlags();
     XrPosef pose();
     float radius();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • LOCATIONFLAGS

      public static final int LOCATIONFLAGS
      The struct member offsets.

    • POSE

      public static final int POSE
      The struct member offsets.

    • RADIUS

      public static final int RADIUS
      The struct member offsets.

  • Constructor Details

    • XrHandJointLocationEXT

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

    • locationFlags

      public long locationFlags()
      a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data. If none of the bits are set, no other fields in this structure should be considered to be valid or meaningful.

    • pose

      public XrPosef pose()
      an XrPosef defining the position and orientation of the origin of a hand joint within the reference frame of the corresponding XrHandJointsLocateInfoEXT::baseSpace.

    • radius

      public float radius()
      a float value radius of the corresponding joint in units of meters.

    • locationFlags

      public XrHandJointLocationEXT locationFlags(long value)
      Sets the specified value to the locationFlags() field.

    • pose

      public XrHandJointLocationEXT pose(XrPosef value)
      Copies the specified XrPosef to the pose() field.

    • pose

      public XrHandJointLocationEXT pose(Consumer<XrPosef> consumer)
      Passes the pose() field to the specified Consumer.

    • radius

      public XrHandJointLocationEXT radius(float value)
      Sets the specified value to the radius() field.

    • set

      public XrHandJointLocationEXT set(long locationFlags, XrPosef pose, float radius)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nlocationFlags

      public static long nlocationFlags(long struct)
      Unsafe version of locationFlags().

    • npose

      public static XrPosef npose(long struct)
      Unsafe version of pose().

    • nradius

      public static float nradius(long struct)
      Unsafe version of radius().

    • nlocationFlags

      public static void nlocationFlags(long struct, long value)
      Unsafe version of locationFlags.

    • npose

      public static void npose(long struct, XrPosef value)
      Unsafe version of pose.

    • nradius

      public static void nradius(long struct, float value)
      Unsafe version of radius.