Record Class SDL_JoyDeviceEvent

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

Joystick device event structure (event.jdevice.*)

SDL will send JOYSTICK_ADDED events for devices that are already plugged in during SDL_Init.

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_GamepadDeviceEvent

Structure

typedef struct SDL_JoyDeviceEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_JoystickID which;
} SDL_JoyDeviceEvent;

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

    • PATH$type

      public static final MemoryLayout.PathElement PATH$type

    • PATH$timestamp

      public static final MemoryLayout.PathElement PATH$timestamp

    • PATH$which

      public static final MemoryLayout.PathElement PATH$which

    • LAYOUT$type

      public static final ValueLayout.OfInt LAYOUT$type

    • LAYOUT$timestamp

      public static final ValueLayout.OfLong LAYOUT$timestamp

    • LAYOUT$which

      public static final ValueLayout.OfInt LAYOUT$which

    • SIZE$type

      public static final long SIZE$type

    • SIZE$timestamp

      public static final long SIZE$timestamp

    • SIZE$which

      public static final long SIZE$which

    • OFFSET$type

      public static final long OFFSET$type

    • OFFSET$timestamp

      public static final long OFFSET$timestamp

    • OFFSET$which

      public static final long OFFSET$which

  • Constructor Details

    • SDL_JoyDeviceEvent

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

  • Method Details

    • allocate

      public static SDL_JoyDeviceEvent allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_JoyDeviceEvent clone(Arena arena, SDL_JoyDeviceEvent src)

    • type

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

    • type

      public SDL_JoyDeviceEvent type(@EnumType(SDL_EventType.class) int value)

    • timestamp

      @NativeType("Uint64") @Unsigned public long timestamp()

    • timestamp

      public SDL_JoyDeviceEvent timestamp(@NativeType("Uint64") @Unsigned long value)

    • which

      @NativeType("SDL_JoystickID") @Unsigned public int which()

    • which

      public SDL_JoyDeviceEvent which(@NativeType("SDL_JoystickID") @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