Record Class SDL_PenProximityEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_PenProximityEvent

All Implemented Interfaces:

IPointer, ISDL_PenProximityEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_PenProximityEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_PenProximityEvent

Pressure-sensitive pen proximity event structure (event.pmotion.*)

When a pen becomes visible to the system (it is close enough to a tablet, etc), SDL will send an SDL_EVENT_PEN_PROXIMITY_IN event with the new pen's ID. This ID is valid until the pen leaves proximity again (has been removed from the tablet's area, the tablet has been unplugged, etc). If the same pen reenters proximity again, it will be given a new ID.

Note that "proximity" means "close enough for the tablet to know the tool is there." The pen touching and lifting off from the tablet while not leaving the area are handled by SDL_EVENT_PEN_DOWN and SDL_EVENT_PEN_UP.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_PenProximityEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    SDL_PenID which;
} SDL_PenProximityEvent;

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_PenProximityEvent.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.OfLong	LAYOUT$timestamp
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$which
static final ValueLayout.OfInt	LAYOUT$windowID
static final long	OFFSET$timestamp
static final long	OFFSET$type
static final long	OFFSET$which
static final long	OFFSET$windowID
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 long	SIZE$timestamp
static final long	SIZE$type
static final long	SIZE$which
static final long	SIZE$windowID

Constructor Summary

Constructors

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

Method Summary

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

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

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

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

Constructor Details

SDL_PenProximityEvent

public SDL_PenProximityEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_PenProximityEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_PenProximityEvent allocate(Arena arena)

allocate

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

clone

public static SDL_PenProximityEvent clone(Arena arena,
 SDL_PenProximityEvent src)

type

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

type

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

timestamp

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

timestamp

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

windowID

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

windowID

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

which

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

which

public SDL_PenProximityEvent which(@NativeType("SDL_PenID") @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