Wiki Page Content

Revision 9 as of 2010-10-09 03:23:39

Clear message

SDL_GetWindowWMInfo

Use this function to get driver specific information about a window.

Syntax

SDL_bool SDL_GetWindowWMInfo(SDL_Window*    window,
                             SDL_SysWMinfo* info)

Function Parameters

window

the SDL_Window about which information is being requested

info

an SDL_SysWMinfo structure that is filled in with window information; see Remarks for details

Return Value

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.

Code Examples

#include "SDL_syswm.h"

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

Remarks

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

The info structure must be initialized with the SDL version, and is then filled in with information about the given window, as shown in the Code Example.


CategoryAPI, CategoryVideo, CategorySWM

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit