Record Class XrApplicationInfo

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

Represents a pointer to a XrApplicationInfo structure in native memory.

Structure

typedef struct XrApplicationInfo {
    char[XR_MAX_APPLICATION_NAME_SIZE] applicationName;
    uint32_t applicationVersion;
    char[XR_MAX_ENGINE_NAME_SIZE] engineName;
    uint32_t engineVersion;
    XrVersion apiVersion;
} XrApplicationInfo;

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

      public static final MemoryLayout.PathElement PATH$applicationName

    • PATH$applicationVersion

      public static final MemoryLayout.PathElement PATH$applicationVersion

    • PATH$engineName

      public static final MemoryLayout.PathElement PATH$engineName

    • PATH$engineVersion

      public static final MemoryLayout.PathElement PATH$engineVersion

    • PATH$apiVersion

      public static final MemoryLayout.PathElement PATH$apiVersion

    • LAYOUT$applicationName

      public static final SequenceLayout LAYOUT$applicationName

    • LAYOUT$applicationVersion

      public static final ValueLayout.OfInt LAYOUT$applicationVersion

    • LAYOUT$engineName

      public static final SequenceLayout LAYOUT$engineName

    • LAYOUT$engineVersion

      public static final ValueLayout.OfInt LAYOUT$engineVersion

    • LAYOUT$apiVersion

      public static final ValueLayout.OfLong LAYOUT$apiVersion

    • SIZE$applicationName

      public static final long SIZE$applicationName

    • SIZE$applicationVersion

      public static final long SIZE$applicationVersion

    • SIZE$engineName

      public static final long SIZE$engineName

    • SIZE$engineVersion

      public static final long SIZE$engineVersion

    • SIZE$apiVersion

      public static final long SIZE$apiVersion

    • OFFSET$applicationName

      public static final long OFFSET$applicationName

    • OFFSET$applicationVersion

      public static final long OFFSET$applicationVersion

    • OFFSET$engineName

      public static final long OFFSET$engineName

    • OFFSET$engineVersion

      public static final long OFFSET$engineVersion

    • OFFSET$apiVersion

      public static final long OFFSET$apiVersion

  • Constructor Details

    • XrApplicationInfo

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

  • Method Details

    • allocate

      public static XrApplicationInfo allocate(Arena arena)

    • allocate

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

    • clone

      public static XrApplicationInfo clone(Arena arena, XrApplicationInfo src)

    • applicationName

      public BytePtr applicationName()

    • applicationName

      public XrApplicationInfo applicationName(@NotNull @NotNull Consumer<BytePtr> consumer)

    • applicationName

      public XrApplicationInfo applicationName(BytePtr value)

    • applicationNameRaw

      @NotNull public @NotNull MemorySegment applicationNameRaw()

    • applicationVersion

      @Unsigned public int applicationVersion()

    • applicationVersion

      public XrApplicationInfo applicationVersion(@Unsigned int value)

    • engineName

      public BytePtr engineName()

    • engineName

      public XrApplicationInfo engineName(@NotNull @NotNull Consumer<BytePtr> consumer)

    • engineName

      public XrApplicationInfo engineName(BytePtr value)

    • engineNameRaw

      @NotNull public @NotNull MemorySegment engineNameRaw()

    • engineVersion

      @Unsigned public int engineVersion()

    • engineVersion

      public XrApplicationInfo engineVersion(@Unsigned int value)

    • apiVersion

      @NativeType("XrVersion") @Unsigned public long apiVersion()

    • apiVersion

      public XrApplicationInfo apiVersion(@NativeType("XrVersion") @Unsigned long 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