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 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)
 

Typedef Documentation

◆ SDL_X11EventHook

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

Definition at line 133 of file SDL_system.h.

◆ XEvent

typedef union _XEvent XEvent

CategorySystem

Platform-specific SDL API functions.

Definition at line 132 of file SDL_system.h.

Enumeration Type Documentation

◆ SDL_Sandbox

Application sandbox environment.

Since
This enum is available since SDL 3.2.0.
Enumerator
SDL_SANDBOX_NONE 
SDL_SANDBOX_UNKNOWN_CONTAINER 
SDL_SANDBOX_FLATPAK 
SDL_SANDBOX_SNAP 
SDL_SANDBOX_MACOS 

Definition at line 583 of file SDL_system.h.

584{
SDL_Sandbox
Definition SDL_system.h:584
@ SDL_SANDBOX_FLATPAK
Definition SDL_system.h:587
@ SDL_SANDBOX_SNAP
Definition SDL_system.h:588
@ SDL_SANDBOX_UNKNOWN_CONTAINER
Definition SDL_system.h:586
@ SDL_SANDBOX_MACOS
Definition SDL_system.h:589
@ SDL_SANDBOX_NONE
Definition SDL_system.h:585

Function Documentation

◆ SDL_GetSandbox()

SDL_Sandbox SDL_GetSandbox ( void  )
extern

Get the application sandbox environment, if any.

Returns
the application sandbox environment or SDL_SANDBOX_NONE if the application is not running in a sandbox environment.
Since
This function is available since SDL 3.1.6.

◆ SDL_IsTablet()

bool SDL_IsTablet ( void  )
extern

Query if the current device is a tablet.

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

Returns
true if the device is a tablet, false otherwise.
Since
This function is available since SDL 3.1.3.

◆ SDL_IsTV()

bool SDL_IsTV ( void  )
extern

Query if the current device is a TV.

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

Returns
true if the device is a TV, false otherwise.
Since
This function is available since SDL 3.1.3.

◆ 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.1.3.

◆ 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.1.3.

◆ 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.1.3.

◆ 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.1.3.

◆ 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.1.3.

◆ 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.1.3.

◆ 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 true if the event should continue to be processed, or 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.1.3.