Skip to content

TSdlEventKind

The types of events that can be delivered.

Definition

Unit: Neslib.Sdl3.Events

type TSdlEventKind = (First, Quit, Terminating, LowMemory, WillEnterBackground, DidEnterBackground, WillEnterForeground, DidEnterForeground, LocaleChanged, SystemThemeChanged, DisplayOrientation, DisplayAdded, DisplayRemoved, DisplayMoved, DisplayDesktopModeChanged...)

Enumeration Values

First = SDL_EVENT_FIRST

Unused (do not remove)


Quit = SDL_EVENT_QUIT

User-requested quit


Terminating = SDL_EVENT_TERMINATING

The application is being terminated by the OS. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in


LowMemory = SDL_EVENT_LOW_MEMORY

The application is low on memory, free memory if possible. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in applicationDidReceiveMemoryWarning(). Called on Android in onTrimMemory().


WillEnterBackground = SDL_EVENT_WILL_ENTER_BACKGROUND

The application is about to enter the background. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in applicationWillResignActive(). Called on Android in onPause().


DidEnterBackground = SDL_EVENT_DID_ENTER_BACKGROUND

The application did enter the background and may not get CPU for some time. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in applicationDidEnterBackground(). Called on Android in onPause().


WillEnterForeground = SDL_EVENT_WILL_ENTER_FOREGROUND

The application is about to enter the foreground. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in applicationWillEnterForeground(). Called on Android in onResume().


DidEnterForeground = SDL_EVENT_DID_ENTER_FOREGROUND

The application is now interactive. This event must be handled in a callback set with TSdlEvents.AddWatch. Called on iOS in applicationDidBecomeActive(). Called on Android in onResume().


LocaleChanged = SDL_EVENT_LOCALE_CHANGED

The user's locale preferences have changed.


SystemThemeChanged = SDL_EVENT_SYSTEM_THEME_CHANGED

The system theme changed


DisplayOrientation = SDL_EVENT_DISPLAY_ORIENTATION

Display orientation has changed to Data1


DisplayAdded = SDL_EVENT_DISPLAY_ADDED

Display has been added to the system


DisplayRemoved = SDL_EVENT_DISPLAY_REMOVED

Display has been removed from the system


DisplayMoved = SDL_EVENT_DISPLAY_MOVED

Display has changed position


DisplayDesktopModeChanged = SDL_EVENT_DISPLAY_DESKTOP_MODE_CHANGED

Display has changed desktop mode


DisplayCurrentModeChanged = SDL_EVENT_DISPLAY_CURRENT_MODE_CHANGED

Display has changed current mode


DisplayContentScaleChanged = SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED

Display has changed content scale


DisplayFirst = SDL_EVENT_DISPLAY_FIRST


DisplayLast = SDL_EVENT_DISPLAY_LAST


WindowShown = SDL_EVENT_WINDOW_SHOWN

Window has been shown


WindowHidden = SDL_EVENT_WINDOW_HIDDEN

Window has been hidden


WindowExposed = SDL_EVENT_WINDOW_EXPOSED

Window has been exposed and should be redrawn, and can be redrawn directly from event watchers for this event


WindowMoved = SDL_EVENT_WINDOW_MOVED

Window has been moved to Data1, Data2


WindowResized = SDL_EVENT_WINDOW_RESIZED

Window has been resized to Data1 x Data2


WindowPixelSizeChanged = SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED

The pixel size of the window has changed to Data1 x Data2


WindowMetalViewResized = SDL_EVENT_WINDOW_METAL_VIEW_RESIZED

The pixel size of a Metal view associated with the window has changed


WindowMinimized = SDL_EVENT_WINDOW_MINIMIZED

Window has been minimized


WindowMaximized = SDL_EVENT_WINDOW_MAXIMIZED

Window has been maximized


WindowRestored = SDL_EVENT_WINDOW_RESTORED

Window has been restored to normal size and position


WindowMouseEnter = SDL_EVENT_WINDOW_MOUSE_ENTER

Window has gained mouse focus


WindowMouseLeave = SDL_EVENT_WINDOW_MOUSE_LEAVE

Window has lost mouse focus


WindowFocusGained = SDL_EVENT_WINDOW_FOCUS_GAINED

Window has gained keyboard focus


WindowFocusLost = SDL_EVENT_WINDOW_FOCUS_LOST

Window has lost keyboard focus


WindowCloseRequested = SDL_EVENT_WINDOW_CLOSE_REQUESTED

The window manager requests that the window be closed


WindowHitTest = SDL_EVENT_WINDOW_HIT_TEST

Window had a hit test that wasn't TSdlHitTestResult.Normal


WindowIccProfChanged = SDL_EVENT_WINDOW_ICCPROF_CHANGED

The ICC profile of the window's display has changed


WindowDisplayChanged = SDL_EVENT_WINDOW_DISPLAY_CHANGED

Window has been moved to display data1


WindowDisplayScaleChanged = SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED

Window display scale has been changed


WindowSafeAreaChanged = SDL_EVENT_WINDOW_SAFE_AREA_CHANGED

The window safe area has been changed


WindowOccluded = SDL_EVENT_WINDOW_OCCLUDED

The window has been occluded


WindowEnterFullscreen = SDL_EVENT_WINDOW_ENTER_FULLSCREEN

The window has entered fullscreen mode


WindowLeaveFullscreen = SDL_EVENT_WINDOW_LEAVE_FULLSCREEN

The window has left fullscreen mode


WindowDestroyed = SDL_EVENT_WINDOW_DESTROYED

The window with the associated ID is being or has been destroyed. If this message is being handled in an event watcher, the window handle is still valid and can still be used to retrieve any properties associated with the window. Otherwise, the handle has already been destroyed and all resources associated with it are invalid


WindowHdrStateChanged = SDL_EVENT_WINDOW_HDR_STATE_CHANGED

Window HDR properties have changed


WindowFirst = SDL_EVENT_WINDOW_FIRST


WindowLast = SDL_EVENT_WINDOW_LAST


KeyDown = SDL_EVENT_KEY_DOWN

Key pressed


KeyUp = SDL_EVENT_KEY_UP

Key released


TextEditing = SDL_EVENT_TEXT_EDITING

Keyboard text editing (composition)


TextInput = SDL_EVENT_TEXT_INPUT

Keyboard text input


KeymapChanged = SDL_EVENT_KEYMAP_CHANGED

Keymap changed due to a system event such as an input language or keyboard layout change.


KeyboardAdded = SDL_EVENT_KEYBOARD_ADDED

A new keyboard has been inserted into the system


KeyboardRemoved = SDL_EVENT_KEYBOARD_REMOVED

A keyboard has been removed


TextEditingCandidates = SDL_EVENT_TEXT_EDITING_CANDIDATES

Keyboard text editing candidates


MouseMotion = SDL_EVENT_MOUSE_MOTION

Mouse moved


MouseButtonDown = SDL_EVENT_MOUSE_BUTTON_DOWN

Mouse button pressed


MouseButtonUp = SDL_EVENT_MOUSE_BUTTON_UP

Mouse button released


MouseWheel = SDL_EVENT_MOUSE_WHEEL

Mouse wheel motion


MouseAdded = SDL_EVENT_MOUSE_ADDED

A new mouse has been inserted into the system


MouseRemoved = SDL_EVENT_MOUSE_REMOVED

A mouse has been removed


JoystickAxisMotion = SDL_EVENT_JOYSTICK_AXIS_MOTION

Joystick axis motion


JoystickBallMotion = SDL_EVENT_JOYSTICK_BALL_MOTION

Joystick trackball motion


JoystickHatMotion = SDL_EVENT_JOYSTICK_HAT_MOTION

Joystick hat position change


JoystickButtonDown = SDL_EVENT_JOYSTICK_BUTTON_DOWN

Joystick button pressed


JoystickButtonUp = SDL_EVENT_JOYSTICK_BUTTON_UP

Joystick button released


JoystickAdded = SDL_EVENT_JOYSTICK_ADDED

A new joystick has been inserted into the system


JoystickRemoved = SDL_EVENT_JOYSTICK_REMOVED

An opened joystick has been removed


JoystickBatteryUpdated = SDL_EVENT_JOYSTICK_BATTERY_UPDATED

Joystick battery level change


JoystickUpdateComplete = SDL_EVENT_JOYSTICK_UPDATE_COMPLETE

Joystick update is complete


GamepadAxisMotion = SDL_EVENT_GAMEPAD_AXIS_MOTION

Gamepad axis motion


GamepadButtonDown = SDL_EVENT_GAMEPAD_BUTTON_DOWN

Gamepad button pressed


GamepadButtonUp = SDL_EVENT_GAMEPAD_BUTTON_UP

Gamepad button released


GamepadAdded = SDL_EVENT_GAMEPAD_ADDED

A new gamepad has been inserted into the system


GamepadRemoved = SDL_EVENT_GAMEPAD_REMOVED

A gamepad has been removed


GamepadRemapped = SDL_EVENT_GAMEPAD_REMAPPED

The gamepad mapping was updated


GamepadTouchpadDown = SDL_EVENT_GAMEPAD_TOUCHPAD_DOWN

Gamepad touchpad was touched


GamepadTouchpadMotion = SDL_EVENT_GAMEPAD_TOUCHPAD_MOTION

Gamepad touchpad finger was moved


GamepadTouchpadUp = SDL_EVENT_GAMEPAD_TOUCHPAD_UP

Gamepad touchpad finger was lifted


GamepadSensorUpdate = SDL_EVENT_GAMEPAD_SENSOR_UPDATE

Gamepad sensor was updated


GamepadUpdateComplete = SDL_EVENT_GAMEPAD_UPDATE_COMPLETE

Gamepad update is complete


GamepadSteamHandleUpdated = SDL_EVENT_GAMEPAD_STEAM_HANDLE_UPDATED

Gamepad Steam handle has changed


FingerDown = SDL_EVENT_FINGER_DOWN


Finger = SDL_EVENT_FINGER_UP


FingerMotion = SDL_EVENT_FINGER_MOTION


FingerCanceled = SDL_EVENT_FINGER_CANCELED


ClipboardUpdate = SDL_EVENT_CLIPBOARD_UPDATE

The clipboard or primary selection changed


DropFile = SDL_EVENT_DROP_FILE

The system requests a file open


DropText = SDL_EVENT_DROP_TEXT

text/plain drag-and-drop event


DropBegin = SDL_EVENT_DROP_BEGIN

A new set of drops is beginning (NULL filename)


DropComplete = SDL_EVENT_DROP_COMPLETE

Current set of drops is now complete (NULL filename)


DropPosition = SDL_EVENT_DROP_POSITION

Position while moving over the window


AudioDeviceAdded = SDL_EVENT_AUDIO_DEVICE_ADDED

A new audio device is available


AudioDeviceRemoved = SDL_EVENT_AUDIO_DEVICE_REMOVED

An audio device has been removed.


AudioDeviceFormatChanged = SDL_EVENT_AUDIO_DEVICE_FORMAT_CHANGED

An audio device's format has been changed by the system.


SensorUpdate = SDL_EVENT_SENSOR_UPDATE

A sensor was updated


PenProximityIn = SDL_EVENT_PEN_PROXIMITY_IN

Pressure-sensitive pen has become available


PenProximityOut = SDL_EVENT_PEN_PROXIMITY_OUT

Pressure-sensitive pen has become unavailable


PenDown = SDL_EVENT_PEN_DOWN

Pressure-sensitive pen touched drawing surface


PenUp = SDL_EVENT_PEN_UP

Pressure-sensitive pen stopped touching drawing surface


PenButtonDown = SDL_EVENT_PEN_BUTTON_DOWN

Pressure-sensitive pen button pressed


PenButtonUp = SDL_EVENT_PEN_BUTTON_UP

Pressure-sensitive pen button released


PenMotion = SDL_EVENT_PEN_MOTION

Pressure-sensitive pen is moving on the tablet


PenAxis = SDL_EVENT_PEN_AXIS

Pressure-sensitive pen angle/pressure/etc changed


CameraDeviceAdded = SDL_EVENT_CAMERA_DEVICE_ADDED

A new camera device is available


CameraDeviceRemoved = SDL_EVENT_CAMERA_DEVICE_REMOVED

A camera device has been removed.


CameraDeviceApproved = SDL_EVENT_CAMERA_DEVICE_APPROVED

A camera device has been approved for use by the user.


CameraDeviceDenied = SDL_EVENT_CAMERA_DEVICE_DENIED

A camera device has been denied for use by the user.


RenderTargetsResert = SDL_EVENT_RENDER_TARGETS_RESET

The render targets have been reset and their contents need to be updated


RenderDeviceReset = SDL_EVENT_RENDER_DEVICE_RESET

The device has been reset and all textures need to be recreated


RenderDeviceLost = SDL_EVENT_RENDER_DEVICE_LOST

The device has been lost and can't be recovered.


PollSentinel = SDL_EVENT_POLL_SENTINEL

Signals the end of an event poll cycle


Last = SDL_EVENT_LAST

This last event is only for bounding internal arrays