Wiki Page Content

Revision 4 as of 2010-07-26 01:11:52

Clear message

DRAFT

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

a pointer to the window about which information is being requested

info

a pointer to the [[SDL_SysWMinfo]] structure to query; see Remarks for details

Return Value

SDL_TRUE if the function is implemented and the version member the info struct is valid, or SDL_FALSE if the information could not be retrieved; call SDL_GetError() for more information.

Code Examples

//You typically use this function like this:
SDL_SysWMInfo info;
SDL_VERSION(&info.version);
if ( SDL_GetWindowWMInfo(&info) ) { ... }

Remarks

Include SDL_syswm.h for the declaration of SDL_SysWMinfo.

info requires that this structure, [[SDL_SysWMinfo]], must be initialized with the SDL version, and is then filled in with information about the given window.


CategoryAPI, CategoryVideo, CategorySWM

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