Record Class SDL_GamepadBinding_Output

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GamepadBinding_Output

All Implemented Interfaces:

IPointer, ISDL_GamepadBinding_Output

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GamepadBinding_Output(@NotNull MemorySegment segment)
extends Record
implements ISDL_GamepadBinding_Output

Represents a pointer to a SDL_GamepadBinding_Output structure in native memory.

Structure

typedef struct SDL_GamepadBinding_Output {
    SDL_GamepadButton button; // optional
    SDL_GamepadBinding_Output_Axis axis; // optional
} SDL_GamepadBinding_Output;

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_GamepadBinding_Output.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 UnionLayout	LAYOUT
static final StructLayout	LAYOUT$axis
static final ValueLayout.OfInt	LAYOUT$button
static final long	OFFSET$axis
static final long	OFFSET$button
static final MemoryLayout.PathElement	PATH$axis
static final MemoryLayout.PathElement	PATH$button
static final long	SIZE$axis
static final long	SIZE$button

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GamepadBinding_Output	allocate(Arena arena)
static SDL_GamepadBinding_Output.Ptr	allocate(Arena arena, long count)
@NotNull SDL_GamepadBinding_Output_Axis	axis()
SDL_GamepadBinding_Output	axis(@NotNull SDL_GamepadBinding_Output_Axis value)
SDL_GamepadBinding_Output	axis(Consumer<@NotNull SDL_GamepadBinding_Output_Axis> consumer)
int	button()
SDL_GamepadBinding_Output	button(int value)
static SDL_GamepadBinding_Output	clone(Arena arena, SDL_GamepadBinding_Output 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.
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 UnionLayout LAYOUT

BYTES

public static final long BYTES

PATH$button

public static final MemoryLayout.PathElement PATH$button

PATH$axis

public static final MemoryLayout.PathElement PATH$axis

LAYOUT$button

public static final ValueLayout.OfInt LAYOUT$button

LAYOUT$axis

public static final StructLayout LAYOUT$axis

SIZE$button

public static final long SIZE$button

SIZE$axis

public static final long SIZE$axis

OFFSET$button

public static final long OFFSET$button

OFFSET$axis

public static final long OFFSET$axis

Constructor Details

SDL_GamepadBinding_Output

public SDL_GamepadBinding_Output(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GamepadBinding_Output record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GamepadBinding_Output allocate(Arena arena)

allocate

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

clone

public static SDL_GamepadBinding_Output clone(Arena arena,
 SDL_GamepadBinding_Output src)

button

@EnumType(SDL_GamepadButton.class)
public int button()

button

public SDL_GamepadBinding_Output button(@EnumType(SDL_GamepadButton.class)
 int value)

axis

@NotNull
public @NotNull SDL_GamepadBinding_Output_Axis axis()

axis

public SDL_GamepadBinding_Output axis(@NotNull
 @NotNull SDL_GamepadBinding_Output_Axis value)

axis

public SDL_GamepadBinding_Output axis(Consumer<@NotNull SDL_GamepadBinding_Output_Axis> consumer)

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