club.doki7.sdl3.datatype.SDL_JoyHatEvent

All Implemented Interfaces:: IPointer, ISDL_JoyHatEvent

@ValueBasedCandidate @UnsafeConstructor public record SDL_JoyHatEvent(@NotNull MemorySegment segment) extends Record implements ISDL_JoyHatEvent

Joystick hat position change event structure (event.jhat.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_JoyHatEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_JoystickID which;
    Uint8 hat;
    Uint8 value;
    Uint8 padding1;
    Uint8 padding2;
} SDL_JoyHatEvent;

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.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final record

SDL_JoyHatEvent.Ptr

Represents a pointer to / an array of null structure(s) in native memory.
Field Summary

Fields

Modifier and Type

Field

Description

static final long

BYTES

static final StructLayout

LAYOUT

static final ValueLayout.OfByte

LAYOUT$hat

static final ValueLayout.OfByte

LAYOUT$padding1

static final ValueLayout.OfByte

LAYOUT$padding2

static final ValueLayout.OfLong

LAYOUT$timestamp

static final ValueLayout.OfInt

LAYOUT$type

static final ValueLayout.OfByte

LAYOUT$value

static final ValueLayout.OfInt

LAYOUT$which

static final long

OFFSET$hat

static final long

OFFSET$padding1

static final long

OFFSET$padding2

static final long

OFFSET$timestamp

static final long

OFFSET$type

static final long

OFFSET$value

static final long

OFFSET$which

static final MemoryLayout.PathElement

PATH$hat

static final MemoryLayout.PathElement

PATH$padding1

static final MemoryLayout.PathElement

PATH$padding2

static final MemoryLayout.PathElement

PATH$timestamp

static final MemoryLayout.PathElement

PATH$type

static final MemoryLayout.PathElement

PATH$value

static final MemoryLayout.PathElement

PATH$which

static final long

SIZE$hat

static final long

SIZE$padding1

static final long

SIZE$padding2

static final long

SIZE$timestamp

static final long

SIZE$type

static final long

SIZE$value

static final long

SIZE$which
Constructor Summary

Constructors

Constructor

Description

SDL_JoyHatEvent(@NotNull MemorySegment segment)

Creates an instance of a SDL_JoyHatEvent record class.
Method Summary

Modifier and Type

Method

Description

static SDL_JoyHatEvent

allocate(Arena arena)

static SDL_JoyHatEvent.Ptr

allocate(Arena arena, long count)

static SDL_JoyHatEvent

clone(Arena arena, SDL_JoyHatEvent src)

final boolean

equals(Object o)

Indicates whether some other object is "equal to" this one.

final int

hashCode()

Returns a hash code value for this object.

byte

hat()

SDL_JoyHatEvent

hat(byte value)

byte

padding1()

SDL_JoyHatEvent

padding1(byte value)

byte

padding2()

SDL_JoyHatEvent

padding2(byte value)

@NotNull MemorySegment

segment()

Returns the value of the segment record component.

long

timestamp()

SDL_JoyHatEvent

timestamp(long value)

final String

toString()

Returns a string representation of this record class.

int

type()

SDL_JoyHatEvent

type(int value)

byte

value()

SDL_JoyHatEvent

value(byte value)

int

which()

SDL_JoyHatEvent

which(int value)

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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
- PATH$hat
  
  public static final MemoryLayout.PathElement PATH$hat
- PATH$value
  
  public static final MemoryLayout.PathElement PATH$value
- PATH$padding1
  
  public static final MemoryLayout.PathElement PATH$padding1
- PATH$padding2
  
  public static final MemoryLayout.PathElement PATH$padding2
- 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
- LAYOUT$hat
  
  public static final ValueLayout.OfByte LAYOUT$hat
- LAYOUT$value
  
  public static final ValueLayout.OfByte LAYOUT$value
- LAYOUT$padding1
  
  public static final ValueLayout.OfByte LAYOUT$padding1
- LAYOUT$padding2
  
  public static final ValueLayout.OfByte LAYOUT$padding2
- SIZE$type
  
  public static final long SIZE$type
- SIZE$timestamp
  
  public static final long SIZE$timestamp
- SIZE$which
  
  public static final long SIZE$which
- SIZE$hat
  
  public static final long SIZE$hat
- SIZE$value
  
  public static final long SIZE$value
- SIZE$padding1
  
  public static final long SIZE$padding1
- SIZE$padding2
  
  public static final long SIZE$padding2
- OFFSET$type
  
  public static final long OFFSET$type
- OFFSET$timestamp
  
  public static final long OFFSET$timestamp
- OFFSET$which
  
  public static final long OFFSET$which
- OFFSET$hat
  
  public static final long OFFSET$hat
- OFFSET$value
  
  public static final long OFFSET$value
- OFFSET$padding1
  
  public static final long OFFSET$padding1
- OFFSET$padding2
  
  public static final long OFFSET$padding2
Constructor Details
- SDL_JoyHatEvent
  
  public SDL_JoyHatEvent(@NotNull @NotNull MemorySegment segment)
  
  Creates an instance of a SDL_JoyHatEvent record class.
  
  Parameters:
  
  segment - the value for the segment record component
Method Details
- allocate
  
  public static SDL_JoyHatEvent allocate(Arena arena)
- allocate
  
  public static SDL_JoyHatEvent.Ptr allocate(Arena arena, long count)
- clone
  
  public static SDL_JoyHatEvent clone(Arena arena, SDL_JoyHatEvent src)
- type
  
  @EnumType(SDL_EventType.class) public int type()
- type
  
  public SDL_JoyHatEvent type(@EnumType(SDL_EventType.class) int value)
- timestamp
  
  @NativeType("Uint64") @Unsigned public long timestamp()
- timestamp
  
  public SDL_JoyHatEvent timestamp(@NativeType("Uint64") @Unsigned long value)
- which
  
  @NativeType("SDL_JoystickID") @Unsigned public int which()
- which
  
  public SDL_JoyHatEvent which(@NativeType("SDL_JoystickID") @Unsigned int value)
- hat
  
  @NativeType("Uint8") @Unsigned public byte hat()
- hat
  
  public SDL_JoyHatEvent hat(@NativeType("Uint8") @Unsigned byte value)
- value
  
  @NativeType("Uint8") @Unsigned public byte value()
- value
  
  public SDL_JoyHatEvent value(@NativeType("Uint8") @Unsigned byte value)
- padding1
  
  @NativeType("Uint8") @Unsigned public byte padding1()
- padding1
  
  public SDL_JoyHatEvent padding1(@NativeType("Uint8") @Unsigned byte value)
- padding2
  
  @NativeType("Uint8") @Unsigned public byte padding2()
- padding2
  
  public SDL_JoyHatEvent padding2(@NativeType("Uint8") @Unsigned byte 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

Record Class SDL_JoyHatEvent

Structure

Contracts

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

LAYOUT

BYTES

PATH$type

PATH$timestamp

PATH$which

PATH$hat

PATH$value

PATH$padding1

PATH$padding2

LAYOUT$type

LAYOUT$timestamp

LAYOUT$which

LAYOUT$hat

LAYOUT$value

LAYOUT$padding1

LAYOUT$padding2

SIZE$type

SIZE$timestamp

SIZE$which

SIZE$hat

SIZE$value

SIZE$padding1

SIZE$padding2

OFFSET$type

OFFSET$timestamp

OFFSET$which

OFFSET$hat

OFFSET$value

OFFSET$padding1

OFFSET$padding2

Constructor Details

SDL_JoyHatEvent

Method Details

allocate

allocate

clone

type

type

timestamp

timestamp

which

which

hat

hat

value

value

padding1

padding1

padding2

padding2

toString

hashCode

equals

segment