Record Class SDL_HapticLeftRight

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_HapticLeftRight

All Implemented Interfaces:

IPointer, ISDL_HapticLeftRight

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_HapticLeftRight(@NotNull MemorySegment segment)
extends Record
implements ISDL_HapticLeftRight

A structure containing a template for a Left/Right effect.

This struct is exclusively for the SDL_HAPTIC_LEFTRIGHT effect.

The Left/Right effect is used to explicitly control the large and small motors, commonly found in modern game controllers. The small (right) motor is high frequency, and the large (left) motor is low frequency.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_HAPTIC_LEFTRIGHT
• SDL_HapticEffect

Structure

typedef struct SDL_HapticLeftRight {
    Uint16 type;
    Uint32 length;
    Uint16 large_magnitude;
    Uint16 small_magnitude;
} SDL_HapticLeftRight;

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_HapticLeftRight.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$large_magnitude
static final ValueLayout.OfInt	LAYOUT$length
static final ValueLayout.OfShort	LAYOUT$small_magnitude
static final ValueLayout.OfShort	LAYOUT$type
static final long	OFFSET$large_magnitude
static final long	OFFSET$length
static final long	OFFSET$small_magnitude
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$large_magnitude
static final MemoryLayout.PathElement	PATH$length
static final MemoryLayout.PathElement	PATH$small_magnitude
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$large_magnitude
static final long	SIZE$length
static final long	SIZE$small_magnitude
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$length

PATH$large_magnitude

public static final MemoryLayout.PathElement PATH$large_magnitude

PATH$small_magnitude

public static final MemoryLayout.PathElement PATH$small_magnitude

LAYOUT$type

public static final ValueLayout.OfShort LAYOUT$type

LAYOUT$length

public static final ValueLayout.OfInt LAYOUT$length

LAYOUT$large_magnitude

public static final ValueLayout.OfShort LAYOUT$large_magnitude

LAYOUT$small_magnitude

public static final ValueLayout.OfShort LAYOUT$small_magnitude

SIZE$type

public static final long SIZE$type

SIZE$length

public static final long SIZE$length

SIZE$large_magnitude

public static final long SIZE$large_magnitude

SIZE$small_magnitude

public static final long SIZE$small_magnitude

OFFSET$type

public static final long OFFSET$type

OFFSET$length

public static final long OFFSET$length

OFFSET$large_magnitude

public static final long OFFSET$large_magnitude

OFFSET$small_magnitude

public static final long OFFSET$small_magnitude

Constructor Details

SDL_HapticLeftRight

public SDL_HapticLeftRight(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_HapticLeftRight record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_HapticLeftRight allocate(Arena arena)

allocate

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

clone

public static SDL_HapticLeftRight clone(Arena arena,
 SDL_HapticLeftRight src)

type

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

type

public SDL_HapticLeftRight type(@NativeType("Uint16") @Unsigned
 short value)

length

@NativeType("Uint32")
@Unsigned
public int length()

length

public SDL_HapticLeftRight length(@NativeType("Uint32") @Unsigned
 int value)

large_magnitude

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

large_magnitude

public SDL_HapticLeftRight large_magnitude(@NativeType("Uint16") @Unsigned
 short value)

small_magnitude

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

small_magnitude

public SDL_HapticLeftRight small_magnitude(@NativeType("Uint16") @Unsigned
 short 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