Record Class SDL_TextInputEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_TextInputEvent

All Implemented Interfaces:

IPointer, ISDL_TextInputEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_TextInputEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_TextInputEvent

Keyboard text input event structure (event.text.*)

This event will never be delivered unless text input is enabled by calling SDL_StartTextInput(). Text input is disabled by default!

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_StartTextInput
• SDL_StopTextInput

Structure

typedef struct SDL_TextInputEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    char const* text;
} SDL_TextInputEvent;

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$text

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

public static final AddressLayout LAYOUT$text

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

public static final long SIZE$text

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

public static final long OFFSET$text

Constructor Details

SDL_TextInputEvent

public SDL_TextInputEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_TextInputEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_TextInputEvent allocate(Arena arena)

allocate

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

clone

public static SDL_TextInputEvent clone(Arena arena,
 SDL_TextInputEvent src)

type

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

type

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

timestamp

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

timestamp

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

windowID

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

windowID

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

text

@Nullable
public @Nullable BytePtr text()

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.

text

public SDL_TextInputEvent text(@Nullable
 @Nullable BytePtr value)

textRaw

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

textRaw

public void textRaw(@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