Record Class XrHapticVibration

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

Represents a pointer to a XrHapticVibration structure in native memory.

Structure

typedef struct XrHapticVibration {
    XrStructureType type;
    void const* next;
    XrDuration duration;
    float frequency; // optional
    float amplitude;
} XrHapticVibration;

Auto initialization

This structure has the following members that can be automatically initialized:

  • type = XR_TYPE_HAPTIC_VIBRATION

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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$type

      public static final MemoryLayout.PathElement PATH$type

    • PATH$next

      public static final MemoryLayout.PathElement PATH$next

    • PATH$duration

      public static final MemoryLayout.PathElement PATH$duration

    • PATH$frequency

      public static final MemoryLayout.PathElement PATH$frequency

    • PATH$amplitude

      public static final MemoryLayout.PathElement PATH$amplitude

    • LAYOUT$type

      public static final ValueLayout.OfInt LAYOUT$type

    • LAYOUT$next

      public static final AddressLayout LAYOUT$next

    • LAYOUT$duration

      public static final ValueLayout.OfLong LAYOUT$duration

    • LAYOUT$frequency

      public static final ValueLayout.OfFloat LAYOUT$frequency

    • LAYOUT$amplitude

      public static final ValueLayout.OfFloat LAYOUT$amplitude

    • SIZE$type

      public static final long SIZE$type

    • SIZE$next

      public static final long SIZE$next

    • SIZE$duration

      public static final long SIZE$duration

    • SIZE$frequency

      public static final long SIZE$frequency

    • SIZE$amplitude

      public static final long SIZE$amplitude

    • OFFSET$type

      public static final long OFFSET$type

    • OFFSET$next

      public static final long OFFSET$next

    • OFFSET$duration

      public static final long OFFSET$duration

    • OFFSET$frequency

      public static final long OFFSET$frequency

    • OFFSET$amplitude

      public static final long OFFSET$amplitude

  • Constructor Details

    • XrHapticVibration

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

  • Method Details

    • allocate

      public static XrHapticVibration allocate(Arena arena)

    • allocate

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

    • clone

      public static XrHapticVibration clone(Arena arena, XrHapticVibration src)

    • autoInit

      public void autoInit()

    • type

      @EnumType(XrStructureType.class) public int type()

    • type

      public XrHapticVibration type(@EnumType(XrStructureType.class) int value)

    • next

      @Pointer(comment="void*") @NotNull public @NotNull MemorySegment next()

    • next

      public XrHapticVibration next(@Pointer(comment="void*") @NotNull @NotNull MemorySegment value)

    • next

      public XrHapticVibration next(@Nullable @Nullable IPointer pointer)

    • duration

      @NativeType("XrDuration") public long duration()

    • duration

      public XrHapticVibration duration(@NativeType("XrDuration") long value)

    • frequency

      public float frequency()

    • frequency

      public XrHapticVibration frequency(float value)

    • amplitude

      public float amplitude()

    • amplitude

      public XrHapticVibration amplitude(float 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