SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_keyboard.h>
#include <SDL3/SDL_video.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Typedefs | |
typedef union _XEvent | XEvent |
typedef bool(* | SDL_X11EventHook) (void *userdata, XEvent *xevent) |
Enumerations | |
enum | SDL_Sandbox { SDL_SANDBOX_NONE = 0 , SDL_SANDBOX_UNKNOWN_CONTAINER , SDL_SANDBOX_FLATPAK , SDL_SANDBOX_SNAP , SDL_SANDBOX_MACOS } |
Functions | |
void | SDL_SetX11EventHook (SDL_X11EventHook callback, void *userdata) |
bool | SDL_IsTablet (void) |
bool | SDL_IsTV (void) |
SDL_Sandbox | SDL_GetSandbox (void) |
void | SDL_OnApplicationWillTerminate (void) |
void | SDL_OnApplicationDidReceiveMemoryWarning (void) |
void | SDL_OnApplicationWillEnterBackground (void) |
void | SDL_OnApplicationDidEnterBackground (void) |
void | SDL_OnApplicationWillEnterForeground (void) |
void | SDL_OnApplicationDidEnterForeground (void) |
A callback to be used with SDL_SetX11EventHook.
This callback may modify the event, and should return true if the event should continue to be processed, or false to prevent further processing.
As this is processing an event directly from the X11 event loop, this callback should do the minimum required work and return quickly.
userdata | the app-defined pointer provided to SDL_SetX11EventHook. |
xevent | a pointer to an Xlib XEvent union to process. |
\threadsafety This may only be called (by SDL) from the thread handling the X11 event loop.
Definition at line 161 of file SDL_system.h.
typedef union _XEvent XEvent |
Platform-specific SDL API functions. These are functions that deal with needs of specific operating systems, that didn't make sense to offer as platform-independent, generic APIs.
Most apps can make do without these functions, but they can be useful for integrating with other parts of a specific system, adding platform-specific polish to an app, or solving problems that only affect one target.
Definition at line 139 of file SDL_system.h.
enum SDL_Sandbox |
Application sandbox environment.
Enumerator | |
---|---|
SDL_SANDBOX_NONE | |
SDL_SANDBOX_UNKNOWN_CONTAINER | |
SDL_SANDBOX_FLATPAK | |
SDL_SANDBOX_SNAP | |
SDL_SANDBOX_MACOS |
Definition at line 628 of file SDL_system.h.
SDL_Sandbox SDL_GetSandbox | ( | void | ) |
Get the application sandbox environment, if any.
bool SDL_IsTablet | ( | void | ) |
Query if the current device is a tablet.
If SDL can't determine this, it will return false.
bool SDL_IsTV | ( | void | ) |
Query if the current device is a TV.
If SDL can't determine this, it will return false.
void SDL_OnApplicationDidEnterBackground | ( | void | ) |
Let iOS apps with external event handling report onApplicationDidEnterBackground.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_OnApplicationDidEnterForeground | ( | void | ) |
Let iOS apps with external event handling report onApplicationDidBecomeActive.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_OnApplicationDidReceiveMemoryWarning | ( | void | ) |
Let iOS apps with external event handling report onApplicationDidReceiveMemoryWarning.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_OnApplicationWillEnterBackground | ( | void | ) |
Let iOS apps with external event handling report onApplicationWillResignActive.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_OnApplicationWillEnterForeground | ( | void | ) |
Let iOS apps with external event handling report onApplicationWillEnterForeground.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_OnApplicationWillTerminate | ( | void | ) |
Let iOS apps with external event handling report onApplicationWillTerminate.
This functions allows iOS apps that have their own event handling to hook into SDL to generate SDL events. This maps directly to an iOS-specific event, but since it doesn't do anything iOS-specific internally, it is available on all platforms, in case it might be useful for some specific paradigm. Most apps do not need to use this directly; SDL's internal event code will handle all this for windows created by SDL_CreateWindow!
\threadsafety It is safe to call this function from any thread.
void SDL_SetX11EventHook | ( | SDL_X11EventHook | callback, |
void * | userdata | ||
) |
Set a callback for every X11 event.
The callback may modify the event, and should return true if the event should continue to be processed, or false to prevent further processing.
callback | the SDL_X11EventHook function to call. |
userdata | a pointer to pass to every iteration of callback . |