Skip to content

TSdlUserEvent

A user-defined event type (event.user.* )

This event is unique; it is never created by SDL, but only by the application. The event can be pushed onto the event queue using TSdlEvents.Push. The contents of the record members are completely up to the programmer; the only requirement is that 'Kind' is a value obtained from TSdlEvents.Register.

Definition

Unit: Neslib.Sdl3.Events

type TSdlUserEvent = record ... end;

Properties

Name Description
Code User defined event code
Data1 User defined data pointer
Data2 User defined data pointer
Kind Event kind (registered with TSdlEvents.Register)
Timestamp In nanoseconds, populated using SdlGetTicksNS
Window The associated window, if any
WindowID The ID of the associated window, if any

Property Descriptions

Code

User defined event code

property Code: Integer read FHandle.code

Type: Integer


Data1

User defined data pointer

property Data1: Pointer read FHandle.data1

Type: Pointer


Data2

User defined data pointer

property Data2: Pointer read FHandle.data2

Type: Pointer


Kind

Event kind (registered with TSdlEvents.Register)

property Kind: TSdlEventKind read GetKind

Type: TSdlEventKind


Timestamp

In nanoseconds, populated using SdlGetTicksNS

property Timestamp: UInt64 read FHandle.timestamp

Type: UInt64


Window

The associated window, if any

property Window: TSdlWindow read GetWindow

Type: TSdlWindow


WindowID

The ID of the associated window, if any

property WindowID: TSdlWindowID read FHandle.windowID

Type: TSdlWindowID