SDL 3.0
SDL_system.h File Reference
+ Include dependency graph for SDL_system.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef union _XEvent XEvent
 
typedef SDL_bool(* SDL_X11EventHook) (void *userdata, XEvent *xevent)
 

Functions

void SDL_SetX11EventHook (SDL_X11EventHook callback, void *userdata)
 
SDL_bool SDL_IsTablet (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)
 

Typedef Documentation

◆ SDL_X11EventHook

typedef SDL_bool(* SDL_X11EventHook) (void *userdata, XEvent *xevent)

Definition at line 139 of file SDL_system.h.

◆ XEvent

typedef union _XEvent XEvent

CategorySystem

Platform-specific SDL API functions.

Definition at line 138 of file SDL_system.h.

Function Documentation

◆ SDL_IsTablet()

SDL_bool SDL_IsTablet ( void  )
extern

Query if the current device is a tablet.

If SDL can't determine this, it will return SDL_FALSE.

Returns
SDL_TRUE if the device is a tablet, SDL_FALSE otherwise.
Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationDidEnterBackground()

void SDL_OnApplicationDidEnterBackground ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationDidEnterForeground()

void SDL_OnApplicationDidEnterForeground ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationDidReceiveMemoryWarning()

void SDL_OnApplicationDidReceiveMemoryWarning ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationWillEnterBackground()

void SDL_OnApplicationWillEnterBackground ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationWillEnterForeground()

void SDL_OnApplicationWillEnterForeground ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_OnApplicationWillTerminate()

void SDL_OnApplicationWillTerminate ( void  )
extern

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.

Since
This function is available since SDL 3.0.0.

◆ SDL_SetX11EventHook()

void SDL_SetX11EventHook ( SDL_X11EventHook  callback,
void *  userdata 
)
extern

Set a callback for every X11 event.

The callback may modify the event, and should return SDL_TRUE if the event should continue to be processed, or SDL_FALSE to prevent further processing.

Parameters
callbackthe SDL_X11EventHook function to call.
userdataa pointer to pass to every iteration of callback.
Since
This function is available since SDL 3.0.0.