Added a usage example for SDL_GetWMInfo()
authorSam Lantinga <slouken@libsdl.org>
Tue, 30 Nov 2004 15:21:29 +0000
changeset 9998be85fa59cf3
parent 998 0e6627072f7a
child 1000 fbeac9312843
Added a usage example for SDL_GetWMInfo()
include/SDL_syswm.h
     1.1 --- a/include/SDL_syswm.h	Tue Nov 30 14:45:08 2004 +0000
     1.2 +++ b/include/SDL_syswm.h	Tue Nov 30 15:21:29 2004 +0000
     1.3 @@ -188,6 +188,11 @@
     1.4   * It fills the structure pointed to by 'info' with custom information and
     1.5   * returns 1 if the function is implemented.  If it's not implemented, or
     1.6   * the version member of the 'info' structure is invalid, it returns 0. 
     1.7 + *
     1.8 + * You typically use this function like this:
     1.9 + * SDL_SysWMInfo info;
    1.10 + * SDL_VERSION(&info.version);
    1.11 + * if ( SDL_GetWMInfo(&info) ) { ... }
    1.12   */
    1.13  extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info);
    1.14