Wiki Page Content

Differences between revisions 7 and 8
Revision 7 as of 2010-09-26 00:11:39
Size: 1260
Editor: SheenaSmith
Comment: update content (w/ Sam); remove 'draft' note
Revision 8 as of 2010-09-26 00:15:31
Size: 1301
Editor: SheenaSmith
Comment: update content (w/ Sam)
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
||'''info'''||a pointer to a structure that gets filled in; see [[#Remarks|Remarks]] for details|| ||'''info'''||a pointer to an [[SDL_SysWMinfo]] structure that is filled in with window information; see [[#Remarks|Remarks]] for details||

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 window about which information is being requested

info

a pointer to 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

None: SDL_GetWindowWMInfo (last edited 2016-10-13 20:36:31 by PhilippWiesemann)

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