Record Class SDL_UserEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_UserEvent

All Implemented Interfaces:

IPointer, ISDL_UserEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_UserEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_UserEvent

A user-defined event type (event.user.*)

This event is unique; it is never created by SDL, but only by the application. The event can be pushed onto the event queue using SDL_PushEvent(). The contents of the structure members are completely up to the programmer; the only requirement is that '''type''' is a value obtained from SDL_RegisterEvents().

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_UserEvent {
    Uint32 type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    Sint32 code;
    void* data1;
    void* data2;
} SDL_UserEvent;

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_UserEvent.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.OfInt	LAYOUT$code
static final AddressLayout	LAYOUT$data1
static final AddressLayout	LAYOUT$data2
static final ValueLayout.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$windowID
static final long	OFFSET$code
static final long	OFFSET$data1
static final long	OFFSET$data2
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$windowID
static final MemoryLayout.PathElement	PATH$code
static final MemoryLayout.PathElement	PATH$data1
static final MemoryLayout.PathElement	PATH$data2
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$windowID
static final long	SIZE$code
static final long	SIZE$data1
static final long	SIZE$data2
static final long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$windowID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_UserEvent	allocate(Arena arena)
static SDL_UserEvent.Ptr	allocate(Arena arena, long count)
static SDL_UserEvent	clone(Arena arena, SDL_UserEvent src)
int	code()
SDL_UserEvent	code(int value)
MemorySegment	data1()
SDL_UserEvent	data1(@Nullable IPointer pointer)
void	data1(MemorySegment value)
MemorySegment	data2()
SDL_UserEvent	data2(@Nullable IPointer pointer)
void	data2(MemorySegment 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.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	timestamp()
SDL_UserEvent	timestamp(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_UserEvent	type(int value)
int	windowID()
SDL_UserEvent	windowID(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$windowID

public static final MemoryLayout.PathElement PATH$windowID

PATH$code

public static final MemoryLayout.PathElement PATH$code

PATH$data1

public static final MemoryLayout.PathElement PATH$data1

PATH$data2

public static final MemoryLayout.PathElement PATH$data2

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$timestamp

public static final ValueLayout.OfLong LAYOUT$timestamp

LAYOUT$windowID

public static final ValueLayout.OfInt LAYOUT$windowID

LAYOUT$code

public static final ValueLayout.OfInt LAYOUT$code

LAYOUT$data1

public static final AddressLayout LAYOUT$data1

LAYOUT$data2

public static final AddressLayout LAYOUT$data2

SIZE$type

public static final long SIZE$type

SIZE$timestamp

public static final long SIZE$timestamp

SIZE$windowID

public static final long SIZE$windowID

SIZE$code

public static final long SIZE$code

SIZE$data1

public static final long SIZE$data1

SIZE$data2

public static final long SIZE$data2

OFFSET$type

public static final long OFFSET$type

OFFSET$timestamp

public static final long OFFSET$timestamp

OFFSET$windowID

public static final long OFFSET$windowID

OFFSET$code

public static final long OFFSET$code

OFFSET$data1

public static final long OFFSET$data1

OFFSET$data2

public static final long OFFSET$data2

Constructor Details

SDL_UserEvent

public SDL_UserEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_UserEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_UserEvent allocate(Arena arena)

allocate

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

clone

public static SDL_UserEvent clone(Arena arena,
 SDL_UserEvent src)

type

@NativeType("Uint32")
@Unsigned
public int type()

type

public SDL_UserEvent type(@NativeType("Uint32") @Unsigned
 int value)

timestamp

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

timestamp

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

windowID

@NativeType("SDL_WindowID")
@Unsigned
public int windowID()

windowID

public SDL_UserEvent windowID(@NativeType("SDL_WindowID") @Unsigned
 int value)

code

@NativeType("Sint32")
public int code()

code

public SDL_UserEvent code(@NativeType("Sint32")
 int value)

data1

@Pointer(comment="void*")
public MemorySegment data1()

data1

public void data1(@Pointer(comment="void*")
 MemorySegment value)

data1

public SDL_UserEvent data1(@Nullable
 @Nullable IPointer pointer)

data2

@Pointer(comment="void*")
public MemorySegment data2()

data2

public void data2(@Pointer(comment="void*")
 MemorySegment value)

data2

public SDL_UserEvent data2(@Nullable
 @Nullable IPointer pointer)

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