club.doki7.sdl3.datatype.SDL_DisplayEvent

All Implemented Interfaces:: IPointer, ISDL_DisplayEvent

@ValueBasedCandidate @UnsafeConstructor public record SDL_DisplayEvent(@NotNull MemorySegment segment) extends Record implements ISDL_DisplayEvent

Display state change event data (event.display.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_DisplayEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_DisplayID displayID;
    Sint32 data1;
    Sint32 data2;
} SDL_DisplayEvent;

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_DisplayEvent.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$data1

static final ValueLayout.OfInt

LAYOUT$data2

static final ValueLayout.OfInt

LAYOUT$displayID

static final ValueLayout.OfLong

LAYOUT$timestamp

static final ValueLayout.OfInt

LAYOUT$type

static final long

OFFSET$data1

static final long

OFFSET$data2

static final long

OFFSET$displayID

static final long

OFFSET$timestamp

static final long

OFFSET$type

static final MemoryLayout.PathElement

PATH$data1

static final MemoryLayout.PathElement

PATH$data2

static final MemoryLayout.PathElement

PATH$displayID

static final MemoryLayout.PathElement

PATH$timestamp

static final MemoryLayout.PathElement

PATH$type

static final long

SIZE$data1

static final long

SIZE$data2

static final long

SIZE$displayID

static final long

SIZE$timestamp

static final long

SIZE$type
Constructor Summary

Constructors

Constructor

Description

SDL_DisplayEvent(@NotNull MemorySegment segment)

Creates an instance of a SDL_DisplayEvent record class.
Method Summary

Modifier and Type

Method

Description

static SDL_DisplayEvent

allocate(Arena arena)

static SDL_DisplayEvent.Ptr

allocate(Arena arena, long count)

static SDL_DisplayEvent

clone(Arena arena, SDL_DisplayEvent src)

int

data1()

SDL_DisplayEvent

data1(int value)

int

data2()

SDL_DisplayEvent

data2(int value)

int

displayID()

SDL_DisplayEvent

displayID(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.

@NotNull MemorySegment

segment()

Returns the value of the segment record component.

long

timestamp()

SDL_DisplayEvent

timestamp(long value)

final String

toString()

Returns a string representation of this record class.

int

type()

SDL_DisplayEvent

type(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$displayID
  
  public static final MemoryLayout.PathElement PATH$displayID
- PATH$data1
  
  public static final MemoryLayout.PathElement PATH$data1
- PATH$data2
  
  public static final MemoryLayout.PathElement PATH$data2
- LAYOUT$type
  
  public static final ValueLayout.OfInt LAYOUT$type
- LAYOUT$timestamp
  
  public static final ValueLayout.OfLong LAYOUT$timestamp
- LAYOUT$displayID
  
  public static final ValueLayout.OfInt LAYOUT$displayID
- LAYOUT$data1
  
  public static final ValueLayout.OfInt LAYOUT$data1
- LAYOUT$data2
  
  public static final ValueLayout.OfInt LAYOUT$data2
- SIZE$type
  
  public static final long SIZE$type
- SIZE$timestamp
  
  public static final long SIZE$timestamp
- SIZE$displayID
  
  public static final long SIZE$displayID
- SIZE$data1
  
  public static final long SIZE$data1
- SIZE$data2
  
  public static final long SIZE$data2
- OFFSET$type
  
  public static final long OFFSET$type
- OFFSET$timestamp
  
  public static final long OFFSET$timestamp
- OFFSET$displayID
  
  public static final long OFFSET$displayID
- OFFSET$data1
  
  public static final long OFFSET$data1
- OFFSET$data2
  
  public static final long OFFSET$data2
Constructor Details
- SDL_DisplayEvent
  
  public SDL_DisplayEvent(@NotNull @NotNull MemorySegment segment)
  
  Creates an instance of a SDL_DisplayEvent record class.
  
  Parameters:
  
  segment - the value for the segment record component
Method Details
- allocate
  
  public static SDL_DisplayEvent allocate(Arena arena)
- allocate
  
  public static SDL_DisplayEvent.Ptr allocate(Arena arena, long count)
- clone
  
  public static SDL_DisplayEvent clone(Arena arena, SDL_DisplayEvent src)
- type
  
  @EnumType(SDL_EventType.class) public int type()
- type
  
  public SDL_DisplayEvent type(@EnumType(SDL_EventType.class) int value)
- timestamp
  
  @NativeType("Uint64") @Unsigned public long timestamp()
- timestamp
  
  public SDL_DisplayEvent timestamp(@NativeType("Uint64") @Unsigned long value)
- displayID
  
  @NativeType("SDL_DisplayID") @Unsigned public int displayID()
- displayID
  
  public SDL_DisplayEvent displayID(@NativeType("SDL_DisplayID") @Unsigned int value)
- data1
  
  @NativeType("Sint32") public int data1()
- data1
  
  public SDL_DisplayEvent data1(@NativeType("Sint32") int value)
- data2
  
  @NativeType("Sint32") public int data2()
- data2
  
  public SDL_DisplayEvent data2(@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

Record Class SDL_DisplayEvent

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$displayID

PATH$data1

PATH$data2

LAYOUT$type

LAYOUT$timestamp

LAYOUT$displayID

LAYOUT$data1

LAYOUT$data2

SIZE$type

SIZE$timestamp

SIZE$displayID

SIZE$data1

SIZE$data2

OFFSET$type

OFFSET$timestamp

OFFSET$displayID

OFFSET$data1

OFFSET$data2

Constructor Details

SDL_DisplayEvent

Method Details

allocate

allocate

clone

type

type

timestamp

timestamp

displayID

displayID

data1

data1

data2

data2

toString

hashCode

equals

segment