Record Class SDL_JoyButtonEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_JoyButtonEvent

All Implemented Interfaces:

IPointer, ISDL_JoyButtonEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_JoyButtonEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_JoyButtonEvent

Joystick button event structure (event.jbutton.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_JoyButtonEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_JoystickID which;
    Uint8 button;
    bool down;
    Uint8 padding1;
    Uint8 padding2;
} SDL_JoyButtonEvent;

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_JoyButtonEvent.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$button
static final ValueLayout.OfBoolean	LAYOUT$down
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.OfInt	LAYOUT$which
static final long	OFFSET$button
static final long	OFFSET$down
static final long	OFFSET$padding1
static final long	OFFSET$padding2
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$which
static final MemoryLayout.PathElement	PATH$button
static final MemoryLayout.PathElement	PATH$down
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$which
static final long	SIZE$button
static final long	SIZE$down
static final long	SIZE$padding1
static final long	SIZE$padding2
static final long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$which

Constructor Summary

Constructors

Constructor	Description
SDL_JoyButtonEvent(@NotNull MemorySegment segment)	Creates an instance of a SDL_JoyButtonEvent record class.

Method Summary

Modifier and Type	Method	Description
static SDL_JoyButtonEvent	allocate(Arena arena)
static SDL_JoyButtonEvent.Ptr	allocate(Arena arena, long count)
byte	button()
SDL_JoyButtonEvent	button(byte value)
static SDL_JoyButtonEvent	clone(Arena arena, SDL_JoyButtonEvent src)
boolean	down()
SDL_JoyButtonEvent	down(boolean value)
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	padding1()
SDL_JoyButtonEvent	padding1(byte value)
byte	padding2()
SDL_JoyButtonEvent	padding2(byte value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	timestamp()
SDL_JoyButtonEvent	timestamp(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_JoyButtonEvent	type(int value)
int	which()
SDL_JoyButtonEvent	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$button

public static final MemoryLayout.PathElement PATH$button

PATH$down

public static final MemoryLayout.PathElement PATH$down

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

public static final ValueLayout.OfByte LAYOUT$button

LAYOUT$down

public static final ValueLayout.OfBoolean LAYOUT$down

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

public static final long SIZE$button

SIZE$down

public static final long SIZE$down

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

public static final long OFFSET$button

OFFSET$down

public static final long OFFSET$down

OFFSET$padding1

public static final long OFFSET$padding1

OFFSET$padding2

public static final long OFFSET$padding2

Constructor Details

SDL_JoyButtonEvent

public SDL_JoyButtonEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_JoyButtonEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_JoyButtonEvent allocate(Arena arena)

allocate

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

clone

public static SDL_JoyButtonEvent clone(Arena arena,
 SDL_JoyButtonEvent src)

type

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

type

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

timestamp

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

timestamp

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

which

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

which

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

button

@NativeType("Uint8")
@Unsigned
public byte button()

button

public SDL_JoyButtonEvent button(@NativeType("Uint8") @Unsigned
 byte value)

down

@NativeType("boolean")
public boolean down()

down

public SDL_JoyButtonEvent down(@NativeType("boolean")
 boolean value)

padding1

@NativeType("Uint8")
@Unsigned
public byte padding1()

padding1

public SDL_JoyButtonEvent padding1(@NativeType("Uint8") @Unsigned
 byte value)

padding2

@NativeType("Uint8")
@Unsigned
public byte padding2()

padding2

public SDL_JoyButtonEvent 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