|
Size: 1478
Comment: minor change
|
Size: 1260
Comment: update content (w/ Sam); remove 'draft' note
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 17: | Line 16: |
| ||'''window'''||^a pointer to^ the window about which information is being requested|| ||'''info'''||^a pointer to the [[SDL_SysWMinfo]] structure to query^; see [[#Remarks|Remarks]] for details|| |
||'''window'''||the window about which information is being requested|| ||'''info'''||a pointer to a structure that gets filled in; see [[#Remarks|Remarks]] for details|| |
| Line 25: | Line 24: |
| //You typically use this function like this: | #include "SDL_syswm.h" |
| Line 31: | Line 31: |
| <<Color2(green,There is a typo in the header - SysWMInfo should be SysWMinfo. Corrected above already.)>> | == Remarks == You must include SDL_syswm.h for the declaration of [[SDL_SysWMinfo]]. |
| Line 33: | Line 34: |
| == Remarks == 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 Examples|Code Example]]. |
| Line 36: | Line 36: |
| '''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. == Related Functions == |
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 a structure that gets filled in; 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.
