Record Class SDL_GUID

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

An SDL_GUID is a 128-bit identifier for an input device that identifies that device across runs of SDL programs on the same platform.

If the device is detached and then re-attached to a different port, or if the base system is rebooted, the device should still report the same GUID.

GUIDs are as precise as possible but are not guaranteed to distinguish physically distinct but equivalent devices. For example, two game controllers from the same vendor with the same product ID and revision may have the same GUID.

GUIDs may be platform-dependent (i.e., the same device may report different GUIDs on different operating systems).

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_GUID {
} SDL_GUID;

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.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

  • Constructor Details

    • SDL_GUID

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

  • Method Details

    • allocate

      public static SDL_GUID allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_GUID clone(Arena arena, SDL_GUID src)

    • 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