Record Class SDL_TouchFingerEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_TouchFingerEvent

All Implemented Interfaces:

IPointer, ISDL_TouchFingerEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_TouchFingerEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_TouchFingerEvent

Touch finger event structure (event.tfinger.*)

Coordinates in this event are normalized. x and y are normalized to a range between 0.0f and 1.0f, relative to the window, so (0,0) is the top left and (1,1) is the bottom right. Delta coordinates dx and dy are normalized in the ranges of -1.0f (traversed all the way from the bottom or right to all the way up or left) to 1.0f (traversed all the way from the top or left to all the way down or right).

Note that while the coordinates are normalized, they are not clamped, which means in some circumstances you can get a value outside of this range. For example, a renderer using logical presentation might give a negative value when the touch is in the letterboxing. Some platforms might report a touch outside of the window, which will also be outside of the range.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_TouchFingerEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_TouchID touchID;
    SDL_FingerID fingerID;
    float x;
    float y;
    float dx;
    float dy;
    float pressure;
    SDL_WindowID windowID;
} SDL_TouchFingerEvent;

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_TouchFingerEvent.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$dx
static final ValueLayout.OfFloat	LAYOUT$dy
static final ValueLayout.OfLong	LAYOUT$fingerID
static final ValueLayout.OfFloat	LAYOUT$pressure
static final ValueLayout.OfLong	LAYOUT$timestamp
static final ValueLayout.OfLong	LAYOUT$touchID
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$windowID
static final ValueLayout.OfFloat	LAYOUT$x
static final ValueLayout.OfFloat	LAYOUT$y
static final long	OFFSET$dx
static final long	OFFSET$dy
static final long	OFFSET$fingerID
static final long	OFFSET$pressure
static final long	OFFSET$timestamp
static final long	OFFSET$touchID
static final long	OFFSET$type
static final long	OFFSET$windowID
static final long	OFFSET$x
static final long	OFFSET$y
static final MemoryLayout.PathElement	PATH$dx
static final MemoryLayout.PathElement	PATH$dy
static final MemoryLayout.PathElement	PATH$fingerID
static final MemoryLayout.PathElement	PATH$pressure
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$touchID
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$windowID
static final MemoryLayout.PathElement	PATH$x
static final MemoryLayout.PathElement	PATH$y
static final long	SIZE$dx
static final long	SIZE$dy
static final long	SIZE$fingerID
static final long	SIZE$pressure
static final long	SIZE$timestamp
static final long	SIZE$touchID
static final long	SIZE$type
static final long	SIZE$windowID
static final long	SIZE$x
static final long	SIZE$y

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_TouchFingerEvent	allocate(Arena arena)
static SDL_TouchFingerEvent.Ptr	allocate(Arena arena, long count)
static SDL_TouchFingerEvent	clone(Arena arena, SDL_TouchFingerEvent src)
float	dx()
SDL_TouchFingerEvent	dx(float value)
float	dy()
SDL_TouchFingerEvent	dy(float value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	fingerID()
SDL_TouchFingerEvent	fingerID(long value)
final int	hashCode()	Returns a hash code value for this object.
float	pressure()
SDL_TouchFingerEvent	pressure(float value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	timestamp()
SDL_TouchFingerEvent	timestamp(long value)
final String	toString()	Returns a string representation of this record class.
long	touchID()
SDL_TouchFingerEvent	touchID(long value)
int	type()
SDL_TouchFingerEvent	type(int value)
int	windowID()
SDL_TouchFingerEvent	windowID(int value)
float	x()
SDL_TouchFingerEvent	x(float value)
float	y()
SDL_TouchFingerEvent	y(float 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$timestamp

public static final MemoryLayout.PathElement PATH$timestamp

PATH$touchID

public static final MemoryLayout.PathElement PATH$touchID

PATH$fingerID

public static final MemoryLayout.PathElement PATH$fingerID

PATH$x

public static final MemoryLayout.PathElement PATH$x

PATH$y

public static final MemoryLayout.PathElement PATH$y

PATH$dx

public static final MemoryLayout.PathElement PATH$dx

PATH$dy

public static final MemoryLayout.PathElement PATH$dy

PATH$pressure

public static final MemoryLayout.PathElement PATH$pressure

PATH$windowID

public static final MemoryLayout.PathElement PATH$windowID

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$timestamp

public static final ValueLayout.OfLong LAYOUT$timestamp

LAYOUT$touchID

public static final ValueLayout.OfLong LAYOUT$touchID

LAYOUT$fingerID

public static final ValueLayout.OfLong LAYOUT$fingerID

LAYOUT$x

public static final ValueLayout.OfFloat LAYOUT$x

LAYOUT$y

public static final ValueLayout.OfFloat LAYOUT$y

LAYOUT$dx

public static final ValueLayout.OfFloat LAYOUT$dx

LAYOUT$dy

public static final ValueLayout.OfFloat LAYOUT$dy

LAYOUT$pressure

public static final ValueLayout.OfFloat LAYOUT$pressure

LAYOUT$windowID

public static final ValueLayout.OfInt LAYOUT$windowID

SIZE$type

public static final long SIZE$type

SIZE$timestamp

public static final long SIZE$timestamp

SIZE$touchID

public static final long SIZE$touchID

SIZE$fingerID

public static final long SIZE$fingerID

SIZE$x

public static final long SIZE$x

SIZE$y

public static final long SIZE$y

SIZE$dx

public static final long SIZE$dx

SIZE$dy

public static final long SIZE$dy

SIZE$pressure

public static final long SIZE$pressure

SIZE$windowID

public static final long SIZE$windowID

OFFSET$type

public static final long OFFSET$type

OFFSET$timestamp

public static final long OFFSET$timestamp

OFFSET$touchID

public static final long OFFSET$touchID

OFFSET$fingerID

public static final long OFFSET$fingerID

OFFSET$x

public static final long OFFSET$x

OFFSET$y

public static final long OFFSET$y

OFFSET$dx

public static final long OFFSET$dx

OFFSET$dy

public static final long OFFSET$dy

OFFSET$pressure

public static final long OFFSET$pressure

OFFSET$windowID

public static final long OFFSET$windowID

Constructor Details

SDL_TouchFingerEvent

public SDL_TouchFingerEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_TouchFingerEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_TouchFingerEvent allocate(Arena arena)

allocate

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

clone

public static SDL_TouchFingerEvent clone(Arena arena,
 SDL_TouchFingerEvent src)

type

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

type

public SDL_TouchFingerEvent type(@EnumType(SDL_EventType.class)
 int value)

timestamp

@NativeType("Uint64")
@Unsigned
public long timestamp()

timestamp

public SDL_TouchFingerEvent timestamp(@NativeType("Uint64") @Unsigned
 long value)

touchID

@NativeType("SDL_TouchID")
@Unsigned
public long touchID()

touchID

public SDL_TouchFingerEvent touchID(@NativeType("SDL_TouchID") @Unsigned
 long value)

fingerID

@NativeType("SDL_FingerID")
@Unsigned
public long fingerID()

fingerID

public SDL_TouchFingerEvent fingerID(@NativeType("SDL_FingerID") @Unsigned
 long value)

x

public float x()

x

public SDL_TouchFingerEvent x(float value)

y

public float y()

y

public SDL_TouchFingerEvent y(float value)

dx

public float dx()

dx

public SDL_TouchFingerEvent dx(float value)

dy

public float dy()

dy

public SDL_TouchFingerEvent dy(float value)

pressure

public float pressure()

pressure

public SDL_TouchFingerEvent pressure(float value)

windowID

@NativeType("SDL_WindowID")
@Unsigned
public int windowID()

windowID

public SDL_TouchFingerEvent windowID(@NativeType("SDL_WindowID") @Unsigned
 int 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