Record Class SDL_MouseDeviceEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_MouseDeviceEvent

All Implemented Interfaces:

IPointer, ISDL_MouseDeviceEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_MouseDeviceEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_MouseDeviceEvent

Mouse device event structure (event.mdevice.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_MouseDeviceEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_MouseID which;
} SDL_MouseDeviceEvent;

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_MouseDeviceEvent.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.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$which
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$which
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$which
static final long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$which

Constructor Summary

Constructors

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

Method Summary

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

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_MouseDeviceEvent

public SDL_MouseDeviceEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_MouseDeviceEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_MouseDeviceEvent allocate(Arena arena)

allocate

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

clone

public static SDL_MouseDeviceEvent clone(Arena arena,
 SDL_MouseDeviceEvent src)

type

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

type

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

timestamp

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

timestamp

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

which

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

which

public SDL_MouseDeviceEvent which(@NativeType("SDL_MouseID") @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