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 "close_code.h"

Go to the source code of this file.

Classes
struct	SDL_SysWMinfo
struct	SDL_SysWMmsg

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 }

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.

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().

Definition in file SDL_syswm.h.

Typedef Documentation

typedef struct SDL_SysWMinfo SDL_SysWMinfo

Definition at line 205 of file SDL_syswm.h.

Enumeration Type Documentation

enum 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

Definition at line 99 of file SDL_syswm.h.

Function Documentation

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) ) { ... }
*  

Definition at line 3002 of file SDL_video.c.

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

Referenced by Zeni::Video_DX9::init(), SDL_MessageboxValidForDriver(), and Zeni::Window::Window().