club.doki7.sdl3.datatype.SDL_PenMotionEvent

All Implemented Interfaces:: IPointer, ISDL_PenMotionEvent

@ValueBasedCandidate @UnsafeConstructor public record SDL_PenMotionEvent(@NotNull MemorySegment segment) extends Record implements ISDL_PenMotionEvent

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

Depending on the hardware, you may get motion events when the pen is not touching a tablet, for tracking a pen even when it isn't drawing. You should listen for SDL_EVENT_PEN_DOWN and SDL_EVENT_PEN_UP events, or check pen_state & SDL_PEN_INPUT_DOWN to decide if a pen is "drawing" when dealing with pen motion.

Since: This struct is available since SDL 3.2.0.

Structure

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

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_PenMotionEvent.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.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$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$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$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_PenMotionEvent(@NotNull MemorySegment segment)

Creates an instance of a SDL_PenMotionEvent record class.
Method Summary

Modifier and Type

Method

Description

static SDL_PenMotionEvent

allocate(Arena arena)

static SDL_PenMotionEvent.Ptr

allocate(Arena arena, long count)

static SDL_PenMotionEvent

clone(Arena arena, SDL_PenMotionEvent 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.

int

pen_state()

SDL_PenMotionEvent

pen_state(int value)

@NotNull MemorySegment

segment()

Returns the value of the segment record component.

long

timestamp()

SDL_PenMotionEvent

timestamp(long value)

final String

toString()

Returns a string representation of this record class.

int

type()

SDL_PenMotionEvent

type(int value)

int

which()

SDL_PenMotionEvent

which(int value)

int

windowID()

SDL_PenMotionEvent

windowID(int value)

float

x()

SDL_PenMotionEvent

x(float value)

float

y()

SDL_PenMotionEvent

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
- 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
- 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
- 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
Constructor Details
- SDL_PenMotionEvent
  
  public SDL_PenMotionEvent(@NotNull @NotNull MemorySegment segment)
  
  Creates an instance of a SDL_PenMotionEvent record class.
  
  Parameters:
  
  segment - the value for the segment record component
Method Details
- allocate
  
  public static SDL_PenMotionEvent allocate(Arena arena)
- allocate
  
  public static SDL_PenMotionEvent.Ptr allocate(Arena arena, long count)
- clone
  
  public static SDL_PenMotionEvent clone(Arena arena, SDL_PenMotionEvent src)
- type
  
  @EnumType(SDL_EventType.class) public int type()
- type
  
  public SDL_PenMotionEvent type(@EnumType(SDL_EventType.class) int value)
- timestamp
  
  @NativeType("Uint64") @Unsigned public long timestamp()
- timestamp
  
  public SDL_PenMotionEvent timestamp(@NativeType("Uint64") @Unsigned long value)
- windowID
  
  @NativeType("SDL_WindowID") @Unsigned public int windowID()
- windowID
  
  public SDL_PenMotionEvent windowID(@NativeType("SDL_WindowID") @Unsigned int value)
- which
  
  @NativeType("SDL_PenID") @Unsigned public int which()
- which
  
  public SDL_PenMotionEvent which(@NativeType("SDL_PenID") @Unsigned int value)
- pen_state
  
  @EnumType(SDL_PenInputFlags.class) public int pen_state()
- pen_state
  
  public SDL_PenMotionEvent pen_state(@EnumType(SDL_PenInputFlags.class) int value)
- x
  
  public float x()
- x
  
  public SDL_PenMotionEvent x(float value)
- y
  
  public float y()
- y
  
  public SDL_PenMotionEvent y(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

Record Class SDL_PenMotionEvent

Structure

Contracts

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

LAYOUT

BYTES

PATH$type

PATH$timestamp

PATH$windowID

PATH$which

PATH$pen_state

PATH$x

PATH$y

LAYOUT$type

LAYOUT$timestamp

LAYOUT$windowID

LAYOUT$which

LAYOUT$pen_state

LAYOUT$x

LAYOUT$y

SIZE$type

SIZE$timestamp

SIZE$windowID

SIZE$which

SIZE$pen_state

SIZE$x

SIZE$y

OFFSET$type

OFFSET$timestamp

OFFSET$windowID

OFFSET$which

OFFSET$pen_state

OFFSET$x

OFFSET$y

Constructor Details

SDL_PenMotionEvent

Method Details

allocate

allocate

clone

type

type

timestamp

timestamp

windowID

windowID

which

which

pen_state

pen_state

x

x

y

y

toString

hashCode

equals

segment