Record Class SDL_PenTouchEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_PenTouchEvent

All Implemented Interfaces:

IPointer, ISDL_PenTouchEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_PenTouchEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_PenTouchEvent

Pressure-sensitive pen touched event structure (event.ptouch.*)

These events come when a pen touches a surface (a tablet, etc), or lifts off from one.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_PenTouchEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    SDL_PenID which;
    SDL_PenInputFlags pen_state;
    float x;
    float y;
    bool eraser;
    bool down;
} SDL_PenTouchEvent;

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_PenTouchEvent.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.OfBoolean	LAYOUT$down
static final ValueLayout.OfBoolean	LAYOUT$eraser
static final ValueLayout.OfInt	LAYOUT$pen_state
static final ValueLayout.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$which
static final ValueLayout.OfInt	LAYOUT$windowID
static final ValueLayout.OfFloat	LAYOUT$x
static final ValueLayout.OfFloat	LAYOUT$y
static final long	OFFSET$down
static final long	OFFSET$eraser
static final long	OFFSET$pen_state
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$which
static final long	OFFSET$windowID
static final long	OFFSET$x
static final long	OFFSET$y
static final MemoryLayout.PathElement	PATH$down
static final MemoryLayout.PathElement	PATH$eraser
static final MemoryLayout.PathElement	PATH$pen_state
static final MemoryLayout.PathElement	PATH$timestamp
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$which
static final MemoryLayout.PathElement	PATH$windowID
static final MemoryLayout.PathElement	PATH$x
static final MemoryLayout.PathElement	PATH$y
static final long	SIZE$down
static final long	SIZE$eraser
static final long	SIZE$pen_state
static final long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$which
static final long	SIZE$windowID
static final long	SIZE$x
static final long	SIZE$y

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$windowID

PATH$which

public static final MemoryLayout.PathElement PATH$which

PATH$pen_state

public static final MemoryLayout.PathElement PATH$pen_state

PATH$x

public static final MemoryLayout.PathElement PATH$x

PATH$y

public static final MemoryLayout.PathElement PATH$y

PATH$eraser

public static final MemoryLayout.PathElement PATH$eraser

PATH$down

public static final MemoryLayout.PathElement PATH$down

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$timestamp

public static final ValueLayout.OfLong LAYOUT$timestamp

LAYOUT$windowID

public static final ValueLayout.OfInt LAYOUT$windowID

LAYOUT$which

public static final ValueLayout.OfInt LAYOUT$which

LAYOUT$pen_state

public static final ValueLayout.OfInt LAYOUT$pen_state

LAYOUT$x

public static final ValueLayout.OfFloat LAYOUT$x

LAYOUT$y

public static final ValueLayout.OfFloat LAYOUT$y

LAYOUT$eraser

public static final ValueLayout.OfBoolean LAYOUT$eraser

LAYOUT$down

public static final ValueLayout.OfBoolean LAYOUT$down

SIZE$type

public static final long SIZE$type

SIZE$timestamp

public static final long SIZE$timestamp

SIZE$windowID

public static final long SIZE$windowID

SIZE$which

public static final long SIZE$which

SIZE$pen_state

public static final long SIZE$pen_state

SIZE$x

public static final long SIZE$x

SIZE$y

public static final long SIZE$y

SIZE$eraser

public static final long SIZE$eraser

SIZE$down

public static final long SIZE$down

OFFSET$type

public static final long OFFSET$type

OFFSET$timestamp

public static final long OFFSET$timestamp

OFFSET$windowID

public static final long OFFSET$windowID

OFFSET$which

public static final long OFFSET$which

OFFSET$pen_state

public static final long OFFSET$pen_state

OFFSET$x

public static final long OFFSET$x

OFFSET$y

public static final long OFFSET$y

OFFSET$eraser

public static final long OFFSET$eraser

OFFSET$down

public static final long OFFSET$down

Constructor Details

SDL_PenTouchEvent

public SDL_PenTouchEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_PenTouchEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_PenTouchEvent allocate(Arena arena)

allocate

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

clone

public static SDL_PenTouchEvent clone(Arena arena,
 SDL_PenTouchEvent src)

type

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

type

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

timestamp

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

timestamp

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

windowID

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

windowID

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

which

@NativeType("SDL_PenID")
@Unsigned
public int which()

which

public SDL_PenTouchEvent which(@NativeType("SDL_PenID") @Unsigned
 int value)

pen_state

@EnumType(SDL_PenInputFlags.class)
public int pen_state()

pen_state

public SDL_PenTouchEvent pen_state(@EnumType(SDL_PenInputFlags.class)
 int value)

x

public float x()

x

public SDL_PenTouchEvent x(float value)

y

public float y()

y

public SDL_PenTouchEvent y(float value)

eraser

@NativeType("boolean")
public boolean eraser()

eraser

public SDL_PenTouchEvent eraser(@NativeType("boolean")
 boolean value)

down

@NativeType("boolean")
public boolean down()

down

public SDL_PenTouchEvent down(@NativeType("boolean")
 boolean 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