Record Class SDL_PenButtonEvent
java.lang.Object
java.lang.Record
club.doki7.sdl3.datatype.SDL_PenButtonEvent
- All Implemented Interfaces:
IPointer
,ISDL_PenButtonEvent
@ValueBasedCandidate
@UnsafeConstructor
public record SDL_PenButtonEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_PenButtonEvent
Pressure-sensitive pen button event structure (event.pbutton.*)
This is for buttons on the pen itself that the user might click. The pen itself pressing down to draw triggers a SDL_EVENT_PEN_DOWN event instead.
Since: This struct is available since SDL 3.2.0.
Structure
typedef struct SDL_PenButtonEvent {
SDL_EventType
type
;
Uint32 reserved;
Uint64 timestamp
;
SDL_WindowID windowID
;
SDL_PenID which
;
SDL_PenInputFlags
pen_state
;
float x
;
float y
;
Uint8 button
;
bool down
;
} SDL_PenButtonEvent;
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 ClassesModifier and TypeClassDescriptionstatic final record
Represents a pointer to / an array of null structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
static final StructLayout
static final ValueLayout.OfByte
static final ValueLayout.OfBoolean
static final ValueLayout.OfInt
static final ValueLayout.OfLong
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final ValueLayout.OfFloat
static final ValueLayout.OfFloat
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionSDL_PenButtonEvent
(@NotNull MemorySegment segment) Creates an instance of aSDL_PenButtonEvent
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic SDL_PenButtonEvent
static SDL_PenButtonEvent.Ptr
byte
button()
button
(byte value) static SDL_PenButtonEvent
clone
(Arena arena, SDL_PenButtonEvent src) boolean
down()
down
(boolean value) final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.int
pen_state
(int value) @NotNull MemorySegment
segment()
Returns the value of thesegment
record component.long
timestamp
(long value) final String
toString()
Returns a string representation of this record class.int
type()
type
(int value) int
which()
which
(int value) int
windowID()
windowID
(int value) float
x()
x
(float value) float
y()
y
(float value)
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$type
-
PATH$timestamp
-
PATH$windowID
-
PATH$which
-
PATH$pen_state
-
PATH$x
-
PATH$y
-
PATH$button
-
PATH$down
-
LAYOUT$type
-
LAYOUT$timestamp
-
LAYOUT$windowID
-
LAYOUT$which
-
LAYOUT$pen_state
-
LAYOUT$x
-
LAYOUT$y
-
LAYOUT$button
-
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$button
public static final long SIZE$button -
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$button
public static final long OFFSET$button -
OFFSET$down
public static final long OFFSET$down
-
-
Constructor Details
-
SDL_PenButtonEvent
Creates an instance of aSDL_PenButtonEvent
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
type
-
type
-
timestamp
-
timestamp
-
windowID
-
windowID
-
which
-
which
-
pen_state
-
pen_state
-
x
public float x() -
x
-
y
public float y() -
y
-
button
-
button
-
down
-
down
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object)
. -
segment
Returns the value of thesegment
record component.
-