Record Class XrSpaceQueryResultFB

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

Represents a pointer to a XrSpaceQueryResultFB structure in native memory.

Structure

typedef struct XrSpaceQueryResultFB {
    XrSpace space;
    XrUuidEXT uuid;
} XrSpaceQueryResultFB;

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

      public static final MemoryLayout.PathElement PATH$space

    • PATH$uuid

      public static final MemoryLayout.PathElement PATH$uuid

    • LAYOUT$space

      public static final AddressLayout LAYOUT$space

    • LAYOUT$uuid

      public static final StructLayout LAYOUT$uuid

    • SIZE$space

      public static final long SIZE$space

    • SIZE$uuid

      public static final long SIZE$uuid

    • OFFSET$space

      public static final long OFFSET$space

    • OFFSET$uuid

      public static final long OFFSET$uuid

  • Constructor Details

    • XrSpaceQueryResultFB

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

  • Method Details

    • allocate

      public static XrSpaceQueryResultFB allocate(Arena arena)

    • allocate

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

    • clone

      public static XrSpaceQueryResultFB clone(Arena arena, XrSpaceQueryResultFB src)

    • space

      @Nullable public @Nullable XrSpace space()

    • space

      public XrSpaceQueryResultFB space(@Nullable @Nullable XrSpace value)

    • uuid

      @NotNull public @NotNull XrUuidEXT uuid()

    • uuid

      public XrSpaceQueryResultFB uuid(@NotNull @NotNull XrUuidEXT value)

    • uuid

      public XrSpaceQueryResultFB uuid(Consumer<@NotNull XrUuidEXT> consumer)

    • 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