/Users/hercules/trunk/SDL/include/SDL_syswm.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "SDL_version.h"
#include "begin_code.h"
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include "close_code.h"

Go to the source code of this file.

Data Structures
struct	SDL_SysWMmsg
struct	SDL_SysWMinfo
Typedefs
typedef struct SDL_SysWMinfo	SDL_SysWMinfo
Enumerations
enum	SDL_SYSWM_TYPE { SDL_SYSWM_X11 }
Functions
DECLSPEC SDL_bool SDLCALL	SDL_GetWindowWMInfo (SDL_WindowID windowID, SDL_SysWMinfo *info)
	This function allows access to driver-dependent window information.

---

Detailed Description

Include file for SDL custom system window manager hooks

---

Function Documentation

SDL_bool SDL_GetWindowWMInfo	(	SDL_WindowID	windowID,
		SDL_SysWMinfo *	info
	)

This function allows access to driver-dependent window information.

Get driver specific information about a window.

Parameters:

	windowID	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(&info) ) { ... }

Note:

Include SDL_syswm.h for the declaration of SDL_SysWMinfo.