|
Size: 921
Comment: Update WindowID > Window*
|
Size: 1340
Comment: add category link, sync with both headers
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 12: | Line 12: |
| SDL_bool SDL_GetWindowWMInfo(SDL_Window* window, struct SDL_SysWMinfo* info) |
SDL_bool SDL_GetWindowWMInfo(SDL_Window* window, SDL_SysWMinfo* info) |
| Line 17: | Line 17: |
| ||'''window'''||the type used to identify the window|| ||'''info'''||a pointer to the [[SDL_SysWMinfo]] structure to query|| |
||'''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|| |
| Line 21: | Line 21: |
| SDL_TRUE, or SDL_FALSE if the information could not be retrieved; call [[SDL_GetError]]() for more information. | 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. |
| Line 25: | Line 25: |
| You can add your code example here | //You typically use this function like this: SDL_SysWMInfo info; SDL_VERSION(&info.version); if ( SDL_GetWindowWMInfo(&info) ) { ... } |
| Line 31: | 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. |
|
| Line 34: | Line 39: |
| [[CategoryAPI]], [[CategoryVideo]] | [[CategoryAPI]], [[CategoryVideo]], [[CategorySWM]] |
DRAFT |
SDL_GetWindowWMInfo
Use this function to get driver specific information about a window.
Contents
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 must be initialized with the SDL version, and is then filled in with information about the given window.
