Record Class SDL_DropEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_DropEvent

All Implemented Interfaces:

IPointer, ISDL_DropEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_DropEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_DropEvent

An event used to drop text or request a file open by the system (event.drop.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_DropEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    float x;
    float y;
    char const* source;
    char const* data;
} SDL_DropEvent;

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_DropEvent.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 AddressLayout	LAYOUT$data
static final AddressLayout	LAYOUT$source
static final ValueLayout.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$windowID
static final ValueLayout.OfFloat	LAYOUT$x
static final ValueLayout.OfFloat	LAYOUT$y
static final long	OFFSET$data
static final long	OFFSET$source
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$windowID
static final long	OFFSET$x
static final long	OFFSET$y
static final MemoryLayout.PathElement	PATH$data
static final MemoryLayout.PathElement	PATH$source
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$windowID
static final MemoryLayout.PathElement	PATH$x
static final MemoryLayout.PathElement	PATH$y
static final long	SIZE$data
static final long	SIZE$source
static final long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$windowID
static final long	SIZE$x
static final long	SIZE$y

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_DropEvent	allocate(Arena arena)
static SDL_DropEvent.Ptr	allocate(Arena arena, long count)
static SDL_DropEvent	clone(Arena arena, SDL_DropEvent src)
@Nullable BytePtr	data()	Note: the returned BytePtr does not have correct BytePtr.size() property.
SDL_DropEvent	data(@Nullable BytePtr value)
MemorySegment	dataRaw()
void	dataRaw(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.
@Nullable BytePtr	source()	Note: the returned BytePtr does not have correct BytePtr.size() property.
SDL_DropEvent	source(@Nullable BytePtr value)
MemorySegment	sourceRaw()
void	sourceRaw(MemorySegment value)
long	timestamp()
SDL_DropEvent	timestamp(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_DropEvent	type(int value)
int	windowID()
SDL_DropEvent	windowID(int value)
float	x()
SDL_DropEvent	x(float value)
float	y()
SDL_DropEvent	y(float 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$x

public static final MemoryLayout.PathElement PATH$x

PATH$y

public static final MemoryLayout.PathElement PATH$y

PATH$source

public static final MemoryLayout.PathElement PATH$source

PATH$data

public static final MemoryLayout.PathElement PATH$data

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

public static final ValueLayout.OfFloat LAYOUT$x

LAYOUT$y

public static final ValueLayout.OfFloat LAYOUT$y

LAYOUT$source

public static final AddressLayout LAYOUT$source

LAYOUT$data

public static final AddressLayout LAYOUT$data

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

public static final long SIZE$x

SIZE$y

public static final long SIZE$y

SIZE$source

public static final long SIZE$source

SIZE$data

public static final long SIZE$data

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

public static final long OFFSET$x

OFFSET$y

public static final long OFFSET$y

OFFSET$source

public static final long OFFSET$source

OFFSET$data

public static final long OFFSET$data

Constructor Details

SDL_DropEvent

public SDL_DropEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_DropEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_DropEvent allocate(Arena arena)

allocate

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

clone

public static SDL_DropEvent clone(Arena arena,
 SDL_DropEvent src)

type

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

type

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

timestamp

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

timestamp

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

windowID

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

windowID

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

x

public float x()

x

public SDL_DropEvent x(float value)

y

public float y()

y

public SDL_DropEvent y(float value)

source

@Nullable
public @Nullable BytePtr source()

Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

source

public SDL_DropEvent source(@Nullable
 @Nullable BytePtr value)

sourceRaw

@Pointer(comment="int8_t*")
public MemorySegment sourceRaw()

sourceRaw

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

data

@Nullable
public @Nullable BytePtr data()

Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

data

public SDL_DropEvent data(@Nullable
 @Nullable BytePtr value)

dataRaw

@Pointer(comment="int8_t*")
public MemorySegment dataRaw()

dataRaw

public void dataRaw(@Pointer(comment="int8_t*")
 MemorySegment 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