Record Class XrFrameState

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

Represents a pointer to a XrFrameState structure in native memory.

Structure

typedef struct XrFrameState {
    XrStructureType type;
    void* next;
    XrTime predictedDisplayTime;
    XrDuration predictedDisplayPeriod;
    XrBool32 shouldRender;
} XrFrameState;

Auto initialization

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

  • type = XR_TYPE_FRAME_STATE

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

      public static final MemoryLayout.PathElement PATH$predictedDisplayTime

    • PATH$predictedDisplayPeriod

      public static final MemoryLayout.PathElement PATH$predictedDisplayPeriod

    • PATH$shouldRender

      public static final MemoryLayout.PathElement PATH$shouldRender

    • LAYOUT$type

      public static final ValueLayout.OfInt LAYOUT$type

    • LAYOUT$next

      public static final AddressLayout LAYOUT$next

    • LAYOUT$predictedDisplayTime

      public static final ValueLayout.OfLong LAYOUT$predictedDisplayTime

    • LAYOUT$predictedDisplayPeriod

      public static final ValueLayout.OfLong LAYOUT$predictedDisplayPeriod

    • LAYOUT$shouldRender

      public static final ValueLayout.OfInt LAYOUT$shouldRender

    • SIZE$type

      public static final long SIZE$type

    • SIZE$next

      public static final long SIZE$next

    • SIZE$predictedDisplayTime

      public static final long SIZE$predictedDisplayTime

    • SIZE$predictedDisplayPeriod

      public static final long SIZE$predictedDisplayPeriod

    • SIZE$shouldRender

      public static final long SIZE$shouldRender

    • OFFSET$type

      public static final long OFFSET$type

    • OFFSET$next

      public static final long OFFSET$next

    • OFFSET$predictedDisplayTime

      public static final long OFFSET$predictedDisplayTime

    • OFFSET$predictedDisplayPeriod

      public static final long OFFSET$predictedDisplayPeriod

    • OFFSET$shouldRender

      public static final long OFFSET$shouldRender

  • Constructor Details

    • XrFrameState

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

  • Method Details

    • allocate

      public static XrFrameState allocate(Arena arena)

    • allocate

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

    • clone

      public static XrFrameState clone(Arena arena, XrFrameState src)

    • autoInit

      public void autoInit()

    • type

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

    • type

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

    • next

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

    • next

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

    • next

      public XrFrameState next(@Nullable @Nullable IPointer pointer)

    • predictedDisplayTime

      @NativeType("XrTime") public long predictedDisplayTime()

    • predictedDisplayTime

      public XrFrameState predictedDisplayTime(@NativeType("XrTime") long value)

    • predictedDisplayPeriod

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

    • predictedDisplayPeriod

      public XrFrameState predictedDisplayPeriod(@NativeType("XrDuration") long value)

    • shouldRender

      @NativeType("XrBool32") @Unsigned public int shouldRender()

    • shouldRender

      public XrFrameState shouldRender(@NativeType("XrBool32") @Unsigned 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