Record Class SDL_MouseWheelEvent

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_MouseWheelEvent

All Implemented Interfaces:

IPointer, ISDL_MouseWheelEvent

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_MouseWheelEvent(@NotNull MemorySegment segment)
extends Record
implements ISDL_MouseWheelEvent

Mouse wheel event structure (event.wheel.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_MouseWheelEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    SDL_MouseID which;
    float x;
    float y;
    SDL_MouseWheelDirection direction;
    float mouse_x;
    float mouse_y;
    Sint32 integer_x;
    Sint32 integer_y;
} SDL_MouseWheelEvent;

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_MouseWheelEvent.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$direction
static final ValueLayout.OfInt	LAYOUT$integer_x
static final ValueLayout.OfInt	LAYOUT$integer_y
static final ValueLayout.OfFloat	LAYOUT$mouse_x
static final ValueLayout.OfFloat	LAYOUT$mouse_y
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$direction
static final long	OFFSET$integer_x
static final long	OFFSET$integer_y
static final long	OFFSET$mouse_x
static final long	OFFSET$mouse_y
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$direction
static final MemoryLayout.PathElement	PATH$integer_x
static final MemoryLayout.PathElement	PATH$integer_y
static final MemoryLayout.PathElement	PATH$mouse_x
static final MemoryLayout.PathElement	PATH$mouse_y
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$direction
static final long	SIZE$integer_x
static final long	SIZE$integer_y
static final long	SIZE$mouse_x
static final long	SIZE$mouse_y
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_MouseWheelEvent(@NotNull MemorySegment segment)	Creates an instance of a SDL_MouseWheelEvent record class.

Method Summary

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

public static final MemoryLayout.PathElement PATH$x

PATH$y

public static final MemoryLayout.PathElement PATH$y

PATH$direction

public static final MemoryLayout.PathElement PATH$direction

PATH$mouse_x

public static final MemoryLayout.PathElement PATH$mouse_x

PATH$mouse_y

public static final MemoryLayout.PathElement PATH$mouse_y

PATH$integer_x

public static final MemoryLayout.PathElement PATH$integer_x

PATH$integer_y

public static final MemoryLayout.PathElement PATH$integer_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$x

public static final ValueLayout.OfFloat LAYOUT$x

LAYOUT$y

public static final ValueLayout.OfFloat LAYOUT$y

LAYOUT$direction

public static final ValueLayout.OfInt LAYOUT$direction

LAYOUT$mouse_x

public static final ValueLayout.OfFloat LAYOUT$mouse_x

LAYOUT$mouse_y

public static final ValueLayout.OfFloat LAYOUT$mouse_y

LAYOUT$integer_x

public static final ValueLayout.OfInt LAYOUT$integer_x

LAYOUT$integer_y

public static final ValueLayout.OfInt LAYOUT$integer_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$x

public static final long SIZE$x

SIZE$y

public static final long SIZE$y

SIZE$direction

public static final long SIZE$direction

SIZE$mouse_x

public static final long SIZE$mouse_x

SIZE$mouse_y

public static final long SIZE$mouse_y

SIZE$integer_x

public static final long SIZE$integer_x

SIZE$integer_y

public static final long SIZE$integer_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$x

public static final long OFFSET$x

OFFSET$y

public static final long OFFSET$y

OFFSET$direction

public static final long OFFSET$direction

OFFSET$mouse_x

public static final long OFFSET$mouse_x

OFFSET$mouse_y

public static final long OFFSET$mouse_y

OFFSET$integer_x

public static final long OFFSET$integer_x

OFFSET$integer_y

public static final long OFFSET$integer_y

Constructor Details

SDL_MouseWheelEvent

public SDL_MouseWheelEvent(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_MouseWheelEvent record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_MouseWheelEvent allocate(Arena arena)

allocate

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

clone

public static SDL_MouseWheelEvent clone(Arena arena,
 SDL_MouseWheelEvent src)

type

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

type

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

timestamp

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

timestamp

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

windowID

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

windowID

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

which

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

which

public SDL_MouseWheelEvent which(@NativeType("SDL_MouseID") @Unsigned
 int value)

x

public float x()

x

public SDL_MouseWheelEvent x(float value)

y

public float y()

y

public SDL_MouseWheelEvent y(float value)

direction

@EnumType(SDL_MouseWheelDirection.class)
public int direction()

direction

public SDL_MouseWheelEvent direction(@EnumType(SDL_MouseWheelDirection.class)
 int value)

mouse_x

public float mouse_x()

mouse_x

public SDL_MouseWheelEvent mouse_x(float value)

mouse_y

public float mouse_y()

mouse_y

public SDL_MouseWheelEvent mouse_y(float value)

integer_x

@NativeType("Sint32")
public int integer_x()

integer_x

public SDL_MouseWheelEvent integer_x(@NativeType("Sint32")
 int value)

integer_y

@NativeType("Sint32")
public int integer_y()

integer_y

public SDL_MouseWheelEvent integer_y(@NativeType("Sint32")
 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