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

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_version.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Data Structures
struct	SDL_SysWMmsg
struct	SDL_SysWMinfo
Functions
DECLSPEC int SDLCALL	SDL_GetWMInfo (SDL_SysWMinfo *info)

---

Detailed Description

Include file for SDL custom system window manager hooks

Your application has access to a special type of event 'SDL_SYSWMEVENT', which contains window-manager specific information and arrives whenever an unhandled window event occurs. This event is ignored by default, but you can enable it with SDL_EventState()

---

Function Documentation

DECLSPEC int SDLCALL SDL_GetWMInfo

(

SDL_SysWMinfo *

info

)

This function gives you custom hooks into the window manager information. It fills the structure pointed to by 'info' with custom information and returns 1 if the function is implemented. If it's not implemented, or the version member of the 'info' structure is invalid, it returns 0.

You typically use this function like this:

 SDL_SysWMInfo info;
 SDL_VERSION(&info.version);
 if ( SDL_GetWMInfo(&info) ) { ... }