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:

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 ,
  SDL_SYSWM_HAIKU ,
  SDL_SYSWM_KMSDRM ,
  SDL_SYSWM_RISCOS
}
 

Functions

SDL_bool SDL_GetWindowWMInfo (SDL_Window *window, SDL_SysWMinfo *info)
 

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 
SDL_SYSWM_HAIKU 
SDL_SYSWM_KMSDRM 
SDL_SYSWM_RISCOS 

Definition at line 131 of file SDL_syswm.h.

132 {
140  SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
SDL_SYSWM_TYPE
Definition: SDL_syswm.h:132
@ SDL_SYSWM_X11
Definition: SDL_syswm.h:135
@ SDL_SYSWM_DIRECTFB
Definition: SDL_syswm.h:136
@ SDL_SYSWM_RISCOS
Definition: SDL_syswm.h:147
@ SDL_SYSWM_UNKNOWN
Definition: SDL_syswm.h:133
@ SDL_SYSWM_OS2
Definition: SDL_syswm.h:144
@ SDL_SYSWM_HAIKU
Definition: SDL_syswm.h:145
@ SDL_SYSWM_KMSDRM
Definition: SDL_syswm.h:146
@ SDL_SYSWM_WINDOWS
Definition: SDL_syswm.h:134
@ SDL_SYSWM_UIKIT
Definition: SDL_syswm.h:138
@ SDL_SYSWM_COCOA
Definition: SDL_syswm.h:137
@ SDL_SYSWM_WAYLAND
Definition: SDL_syswm.h:139
@ SDL_SYSWM_VIVANTE
Definition: SDL_syswm.h:143
@ SDL_SYSWM_ANDROID
Definition: SDL_syswm.h:142
@ SDL_SYSWM_MIR
Definition: SDL_syswm.h:140
@ SDL_SYSWM_WINRT
Definition: SDL_syswm.h:141

Function Documentation

◆ SDL_GetWindowWMInfo()

SDL_bool SDL_GetWindowWMInfo ( SDL_Window window,
SDL_SysWMinfo info 
)

Get driver-specific information about a window.

You must include SDL_syswm.h for the declaration of SDL_SysWMinfo.

The caller must initialize the info structure's version by using SDL_VERSION(&info.version), and then this function will fill in the rest of the structure with information about the given window.

Parameters
windowthe window about which information is being requested
infoan SDL_SysWMinfo structure filled in with window information
Returns
SDL_TRUE if the function is implemented and the version member of the info struct is valid, or SDL_FALSE if the information could not be retrieved; call SDL_GetError() for more information.
Since
This function is available since SDL 2.0.0.