SDL 2.0
SDL_syswm.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "SDL_version.h"
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_syswm.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_SysWMmsg
 
struct  SDL_SysWMinfo
 

Enumerations

enum  SDL_SYSWM_TYPE {
  SDL_SYSWM_UNKNOWN ,
  SDL_SYSWM_WINDOWS ,
  SDL_SYSWM_X11 ,
  SDL_SYSWM_DIRECTFB ,
  SDL_SYSWM_COCOA ,
  SDL_SYSWM_UIKIT ,
  SDL_SYSWM_WAYLAND ,
  SDL_SYSWM_MIR ,
  SDL_SYSWM_WINRT ,
  SDL_SYSWM_ANDROID ,
  SDL_SYSWM_VIVANTE ,
  SDL_SYSWM_OS2
}
 

Functions

SDL_bool SDL_GetWindowWMInfo (SDL_Window *window, SDL_SysWMinfo *info)
 This function allows access to driver-dependent window information. More...
 

Detailed Description

Include file for SDL custom system window manager hooks.

Definition in file SDL_syswm.h.

Enumeration Type Documentation

◆ SDL_SYSWM_TYPE

These are the various supported windowing subsystems

Enumerator
SDL_SYSWM_UNKNOWN 
SDL_SYSWM_WINDOWS 
SDL_SYSWM_X11 
SDL_SYSWM_DIRECTFB 
SDL_SYSWM_COCOA 
SDL_SYSWM_UIKIT 
SDL_SYSWM_WAYLAND 
SDL_SYSWM_MIR 
SDL_SYSWM_WINRT 
SDL_SYSWM_ANDROID 
SDL_SYSWM_VIVANTE 
SDL_SYSWM_OS2 

Definition at line 119 of file SDL_syswm.h.

120{
128 SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
SDL_SYSWM_TYPE
Definition: SDL_syswm.h:120
@ SDL_SYSWM_X11
Definition: SDL_syswm.h:123
@ SDL_SYSWM_DIRECTFB
Definition: SDL_syswm.h:124
@ SDL_SYSWM_UNKNOWN
Definition: SDL_syswm.h:121
@ SDL_SYSWM_OS2
Definition: SDL_syswm.h:132
@ SDL_SYSWM_WINDOWS
Definition: SDL_syswm.h:122
@ SDL_SYSWM_UIKIT
Definition: SDL_syswm.h:126
@ SDL_SYSWM_COCOA
Definition: SDL_syswm.h:125
@ SDL_SYSWM_WAYLAND
Definition: SDL_syswm.h:127
@ SDL_SYSWM_VIVANTE
Definition: SDL_syswm.h:131
@ SDL_SYSWM_ANDROID
Definition: SDL_syswm.h:130
@ SDL_SYSWM_MIR
Definition: SDL_syswm.h:128
@ SDL_SYSWM_WINRT
Definition: SDL_syswm.h:129

Function Documentation

◆ SDL_GetWindowWMInfo()

SDL_bool SDL_GetWindowWMInfo ( SDL_Window window,
SDL_SysWMinfo info 
)

This function allows access to driver-dependent window information.

Parameters
windowThe window about which information is being requested
infoThis structure must be initialized with the SDL version, and is then filled in with information about the given window.
Returns
SDL_TRUE if the function is implemented and the version member of the info struct is valid, SDL_FALSE otherwise.

You typically use this function like this:

if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
#define SDL_GetWindowWMInfo
#define SDL_VERSION(x)
Macro to determine SDL version program was compiled against.
Definition: SDL_version.h:79
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_version version
Definition: SDL_syswm.h:199

Definition at line 3737 of file SDL_video.c.

3738{
3740
3741 if (!info) {
3742 SDL_InvalidParamError("info");
3743 return SDL_FALSE;
3744 }
3746
3747 if (!_this->GetWindowWMInfo) {
3749 return SDL_FALSE;
3750 }
3751 return (_this->GetWindowWMInfo(_this, window, info));
3752}
#define SDL_Unsupported()
Definition: SDL_error.h:53
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
@ SDL_FALSE
Definition: SDL_stdinc.h:163
static SDL_VideoDevice * _this
Definition: SDL_video.c:118
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:120
SDL_SYSWM_TYPE subsystem
Definition: SDL_syswm.h:200
SDL_bool(* GetWindowWMInfo)(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
Definition: SDL_sysvideo.h:248

References _this, CHECK_WINDOW_MAGIC, SDL_VideoDevice::GetWindowWMInfo, SDL_FALSE, SDL_InvalidParamError, SDL_SYSWM_UNKNOWN, SDL_Unsupported, and SDL_SysWMinfo::subsystem.

Referenced by SDL_MessageboxValidForDriver().