Record Class SDL_MessageBoxButtonData

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_MessageBoxButtonData

All Implemented Interfaces:

IPointer, ISDL_MessageBoxButtonData

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_MessageBoxButtonData(@NotNull MemorySegment segment)
extends Record
implements ISDL_MessageBoxButtonData

Individual button data.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_MessageBoxButtonData {
    SDL_MessageBoxButtonFlags flags;
    int buttonID;
    char const* text;
} SDL_MessageBoxButtonData;

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_MessageBoxButtonData.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$buttonID
static final ValueLayout.OfInt	LAYOUT$flags
static final AddressLayout	LAYOUT$text
static final long	OFFSET$buttonID
static final long	OFFSET$flags
static final long	OFFSET$text
static final MemoryLayout.PathElement	PATH$buttonID
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$text
static final long	SIZE$buttonID
static final long	SIZE$flags
static final long	SIZE$text

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_MessageBoxButtonData	allocate(Arena arena)
static SDL_MessageBoxButtonData.Ptr	allocate(Arena arena, long count)
int	buttonID()
SDL_MessageBoxButtonData	buttonID(int value)
static SDL_MessageBoxButtonData	clone(Arena arena, SDL_MessageBoxButtonData src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
SDL_MessageBoxButtonData	flags(int value)
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_MessageBoxButtonData	text(@Nullable BytePtr value)
MemorySegment	textRaw()
void	textRaw(MemorySegment value)
final String	toString()	Returns a string representation of this record class.

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

public static final MemoryLayout.PathElement PATH$flags

PATH$buttonID

public static final MemoryLayout.PathElement PATH$buttonID

PATH$text

public static final MemoryLayout.PathElement PATH$text

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$buttonID

public static final ValueLayout.OfInt LAYOUT$buttonID

LAYOUT$text

public static final AddressLayout LAYOUT$text

SIZE$flags

public static final long SIZE$flags

SIZE$buttonID

public static final long SIZE$buttonID

SIZE$text

public static final long SIZE$text

OFFSET$flags

public static final long OFFSET$flags

OFFSET$buttonID

public static final long OFFSET$buttonID

OFFSET$text

public static final long OFFSET$text

Constructor Details

SDL_MessageBoxButtonData

public SDL_MessageBoxButtonData(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_MessageBoxButtonData record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_MessageBoxButtonData allocate(Arena arena)

allocate

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

clone

public static SDL_MessageBoxButtonData clone(Arena arena,
 SDL_MessageBoxButtonData src)

flags

@EnumType(SDL_MessageBoxButtonFlags.class)
public int flags()

flags

public SDL_MessageBoxButtonData flags(@EnumType(SDL_MessageBoxButtonFlags.class)
 int value)

buttonID

public int buttonID()

buttonID

public SDL_MessageBoxButtonData buttonID(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_MessageBoxButtonData 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