Mercurial > sdl-ios-xcode
diff include/SDL_syswm.h @ 999:8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Tue, 30 Nov 2004 15:21:29 +0000 |
parents | 04a403e4ccf5 |
children | 0f3aa6ab3341 |
line wrap: on
line diff
--- a/include/SDL_syswm.h Tue Nov 30 14:45:08 2004 +0000 +++ b/include/SDL_syswm.h Tue Nov 30 15:21:29 2004 +0000 @@ -188,6 +188,11 @@ * It fills the structure pointed to by 'info' with custom information and * returns 1 if the function is implemented. If it's not implemented, or * the version member of the 'info' structure is invalid, it returns 0. + * + * You typically use this function like this: + * SDL_SysWMInfo info; + * SDL_VERSION(&info.version); + * if ( SDL_GetWMInfo(&info) ) { ... } */ extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info);