Record Class SDL_VirtualJoystickTouchpadDesc

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_VirtualJoystickTouchpadDesc

All Implemented Interfaces:

IPointer, ISDL_VirtualJoystickTouchpadDesc

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_VirtualJoystickTouchpadDesc(@NotNull MemorySegment segment)
extends Record
implements ISDL_VirtualJoystickTouchpadDesc

The structure that describes a virtual joystick touchpad.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_VirtualJoystickDesc

Structure

typedef struct SDL_VirtualJoystickTouchpadDesc {
    Uint16 nfingers;
    Uint16[3] padding;
} SDL_VirtualJoystickTouchpadDesc;

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_VirtualJoystickTouchpadDesc.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.OfShort	LAYOUT$nfingers
static final SequenceLayout	LAYOUT$padding
static final long	OFFSET$nfingers
static final long	OFFSET$padding
static final MemoryLayout.PathElement	PATH$nfingers
static final MemoryLayout.PathElement	PATH$padding
static final long	SIZE$nfingers
static final long	SIZE$padding

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_VirtualJoystickTouchpadDesc	allocate(Arena arena)
static SDL_VirtualJoystickTouchpadDesc.Ptr	allocate(Arena arena, long count)
static SDL_VirtualJoystickTouchpadDesc	clone(Arena arena, SDL_VirtualJoystickTouchpadDesc 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.
short	nfingers()
SDL_VirtualJoystickTouchpadDesc	nfingers(short value)
ShortPtr	padding()
SDL_VirtualJoystickTouchpadDesc	padding(ShortPtr value)
MemorySegment	paddingRaw()
@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 StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$nfingers

public static final MemoryLayout.PathElement PATH$nfingers

PATH$padding

public static final MemoryLayout.PathElement PATH$padding

LAYOUT$nfingers

public static final ValueLayout.OfShort LAYOUT$nfingers

LAYOUT$padding

public static final SequenceLayout LAYOUT$padding

SIZE$nfingers

public static final long SIZE$nfingers

SIZE$padding

public static final long SIZE$padding

OFFSET$nfingers

public static final long OFFSET$nfingers

OFFSET$padding

public static final long OFFSET$padding

Constructor Details

SDL_VirtualJoystickTouchpadDesc

public SDL_VirtualJoystickTouchpadDesc(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_VirtualJoystickTouchpadDesc record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_VirtualJoystickTouchpadDesc allocate(Arena arena)

allocate

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

clone

public static SDL_VirtualJoystickTouchpadDesc clone(Arena arena,
 SDL_VirtualJoystickTouchpadDesc src)

nfingers

@NativeType("Uint16")
@Unsigned
public short nfingers()

nfingers

public SDL_VirtualJoystickTouchpadDesc nfingers(@NativeType("Uint16") @Unsigned
 short value)

padding

@Pointer(comment="Uint16")
@Unsigned
public ShortPtr padding()

padding

public SDL_VirtualJoystickTouchpadDesc padding(@Pointer(comment="Uint16") @Unsigned
 ShortPtr value)

paddingRaw

public MemorySegment paddingRaw()

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