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"

Go to the source code of this file.

Classes
struct	SDL_SysWMmsg
struct	SDL_SysWMinfo

Typedefs
typedef struct SDL_SysWMinfo	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 }

Functions
DECLSPEC SDL_bool SDLCALL	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.

Enumeration Type Documentation

SDL_SYSWM_TYPE

enum SDL_SYSWM_TYPE

These are the various supported windowing subsystems

Function Documentation

SDL_GetWindowWMInfo()

DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo	(	SDL_Window *	window,
		SDL_SysWMinfo *	info
	)

This function allows access to driver-dependent window information.

Parameters

window	The window about which information is being requested
info	This 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:

SDL_SysWMinfo info;
SDL_VERSION(&info.version);
if ( SDL_GetWindowWMInfo(window, &info) ) { ... }