Wiki Page Content

Differences between revisions 3 and 4
Revision 3 as of 2010-07-18 06:02:51
Size: 1340
Editor: SheenaSmith
Comment: add category link, sync with both headers
Revision 4 as of 2010-07-26 01:11:52
Size: 1362
Editor: SheenaSmith
Comment: minor change
Deletions are marked like this. Additions are marked like this.
Line 34: Line 34:
'''info''' ^requires that^ this structure must be initialized with the SDL version, and is then filled in with information about the given window. '''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.

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

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