Record Class XrHandCapsuleFB

java.lang.Object
java.lang.Record
club.doki7.openxr.datatype.XrHandCapsuleFB
All Implemented Interfaces:
IPointer, IXrHandCapsuleFB
@ValueBasedCandidate @UnsafeConstructor public record XrHandCapsuleFB(@NotNull MemorySegment segment) extends Record implements IXrHandCapsuleFB

Represents a pointer to a XrHandCapsuleFB structure in native memory.

Structure

typedef struct XrHandCapsuleFB {
    XrVector3f[XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB] points;
    float radius;
    XrHandJointEXT joint;
} XrHandCapsuleFB;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$points

      public static final MemoryLayout.PathElement PATH$points

    • PATH$radius

      public static final MemoryLayout.PathElement PATH$radius

    • PATH$joint

      public static final MemoryLayout.PathElement PATH$joint

    • LAYOUT$points

      public static final SequenceLayout LAYOUT$points

    • LAYOUT$radius

      public static final ValueLayout.OfFloat LAYOUT$radius

    • LAYOUT$joint

      public static final ValueLayout.OfInt LAYOUT$joint

    • SIZE$points

      public static final long SIZE$points

    • SIZE$radius

      public static final long SIZE$radius

    • SIZE$joint

      public static final long SIZE$joint

    • OFFSET$points

      public static final long OFFSET$points

    • OFFSET$radius

      public static final long OFFSET$radius

    • OFFSET$joint

      public static final long OFFSET$joint

  • Constructor Details

    • XrHandCapsuleFB

      public XrHandCapsuleFB(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a XrHandCapsuleFB record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static XrHandCapsuleFB allocate(Arena arena)

    • allocate

      public static XrHandCapsuleFB.Ptr allocate(Arena arena, long count)

    • clone

      public static XrHandCapsuleFB clone(Arena arena, XrHandCapsuleFB src)

    • points

      public XrVector3f.Ptr points()

    • points

      public XrHandCapsuleFB points(@NotNull @NotNull Consumer<XrVector3f.Ptr> consumer)

    • points

      public XrHandCapsuleFB points(XrVector3f.Ptr value)

    • pointsAt

      public XrVector3f pointsAt(int index)

    • pointsAt

      public void pointsAt(int index, XrVector3f value)

    • pointsRaw

      @NotNull public @NotNull MemorySegment pointsRaw()

    • radius

      public float radius()

    • radius

      public XrHandCapsuleFB radius(float value)

    • joint

      @EnumType(XrHandJointEXT.class) public int joint()

    • joint

      public XrHandCapsuleFB joint(@EnumType(XrHandJointEXT.class) int value)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • segment

      @NotNull public @NotNull MemorySegment segment()
      Returns the value of the segment record component.
      Specified by:
      segment in interface IPointer
      Returns:
      the value of the segment record component