Record Class SDL_VirtualJoystickSensorDesc

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_VirtualJoystickSensorDesc

All Implemented Interfaces:

IPointer, ISDL_VirtualJoystickSensorDesc

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_VirtualJoystickSensorDesc(@NotNull MemorySegment segment)
extends Record
implements ISDL_VirtualJoystickSensorDesc

The structure that describes a virtual joystick sensor.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_VirtualJoystickDesc

Structure

typedef struct SDL_VirtualJoystickSensorDesc {
    SDL_SensorType type;
    float rate;
} SDL_VirtualJoystickSensorDesc;

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_VirtualJoystickSensorDesc.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.OfFloat	LAYOUT$rate
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$rate
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$rate
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$rate
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_VirtualJoystickSensorDesc	allocate(Arena arena)
static SDL_VirtualJoystickSensorDesc.Ptr	allocate(Arena arena, long count)
static SDL_VirtualJoystickSensorDesc	clone(Arena arena, SDL_VirtualJoystickSensorDesc 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.
float	rate()
SDL_VirtualJoystickSensorDesc	rate(float value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_VirtualJoystickSensorDesc	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$rate

public static final MemoryLayout.PathElement PATH$rate

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$rate

public static final ValueLayout.OfFloat LAYOUT$rate

SIZE$type

public static final long SIZE$type

SIZE$rate

public static final long SIZE$rate

OFFSET$type

public static final long OFFSET$type

OFFSET$rate

public static final long OFFSET$rate

Constructor Details

SDL_VirtualJoystickSensorDesc

public SDL_VirtualJoystickSensorDesc(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_VirtualJoystickSensorDesc record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_VirtualJoystickSensorDesc allocate(Arena arena)

allocate

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

clone

public static SDL_VirtualJoystickSensorDesc clone(Arena arena,
 SDL_VirtualJoystickSensorDesc src)

type

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

type

public SDL_VirtualJoystickSensorDesc type(@EnumType(SDL_SensorType.class)
 int value)

rate

public float rate()

rate

public SDL_VirtualJoystickSensorDesc rate(float 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