Record Class SDL_ClipboardEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_ClipboardEvent

All Implemented Interfaces:

IPointer, ISDL_ClipboardEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_ClipboardEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_ClipboardEvent

An event triggered when the clipboard contents have changed (event.clipboard.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_ClipboardEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    bool owner;
    Sint32 num_mime_types;
    char const** mime_types;
} SDL_ClipboardEvent;

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_ClipboardEvent.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$mime_types
static final ValueLayout.OfInt	LAYOUT$num_mime_types
static final ValueLayout.OfBoolean	LAYOUT$owner
static final ValueLayout.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$mime_types
static final long	OFFSET$num_mime_types
static final long	OFFSET$owner
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$mime_types
static final MemoryLayout.PathElement	PATH$num_mime_types
static final MemoryLayout.PathElement	PATH$owner
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$mime_types
static final long	SIZE$num_mime_types
static final long	SIZE$owner
static final long	SIZE$timestamp
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_ClipboardEvent	allocate(Arena arena)
static SDL_ClipboardEvent.Ptr	allocate(Arena arena, long count)
static SDL_ClipboardEvent	clone(Arena arena, SDL_ClipboardEvent 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.
@Nullable PointerPtr	mime_types()	Note: the returned PointerPtr does not have correct PointerPtr.size() property.
SDL_ClipboardEvent	mime_types(@Nullable PointerPtr value)
MemorySegment	mime_typesRaw()
void	mime_typesRaw(MemorySegment value)
int	num_mime_types()
SDL_ClipboardEvent	num_mime_types(int value)
boolean	owner()
SDL_ClipboardEvent	owner(boolean value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	timestamp()
SDL_ClipboardEvent	timestamp(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_ClipboardEvent	type(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$owner

public static final MemoryLayout.PathElement PATH$owner

PATH$num_mime_types

public static final MemoryLayout.PathElement PATH$num_mime_types

PATH$mime_types

public static final MemoryLayout.PathElement PATH$mime_types

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$timestamp

public static final ValueLayout.OfLong LAYOUT$timestamp

LAYOUT$owner

public static final ValueLayout.OfBoolean LAYOUT$owner

LAYOUT$num_mime_types

public static final ValueLayout.OfInt LAYOUT$num_mime_types

LAYOUT$mime_types

public static final AddressLayout LAYOUT$mime_types

SIZE$type

public static final long SIZE$type

SIZE$timestamp

public static final long SIZE$timestamp

SIZE$owner

public static final long SIZE$owner

SIZE$num_mime_types

public static final long SIZE$num_mime_types

SIZE$mime_types

public static final long SIZE$mime_types

OFFSET$type

public static final long OFFSET$type

OFFSET$timestamp

public static final long OFFSET$timestamp

OFFSET$owner

public static final long OFFSET$owner

OFFSET$num_mime_types

public static final long OFFSET$num_mime_types

OFFSET$mime_types

public static final long OFFSET$mime_types

Constructor Details

SDL_ClipboardEvent

public SDL_ClipboardEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_ClipboardEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_ClipboardEvent allocate(Arena arena)

allocate

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

clone

public static SDL_ClipboardEvent clone(Arena arena,
 SDL_ClipboardEvent src)

type

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

type

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

timestamp

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

timestamp

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

owner

@NativeType("boolean")
public boolean owner()

owner

public SDL_ClipboardEvent owner(@NativeType("boolean")
 boolean value)

num_mime_types

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

num_mime_types

public SDL_ClipboardEvent num_mime_types(@NativeType("Sint32")
 int value)

mime_types

@Nullable
public @Nullable PointerPtr mime_types()

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

mime_types

public SDL_ClipboardEvent mime_types(@Nullable
 @Nullable PointerPtr value)

mime_typesRaw

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

mime_typesRaw

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