Added a usage example for SDL_GetWMInfo()

libsdl-org · Nov 30, 2004 · f67e11e · f67e11e
1 parent ab31999
commit f67e11e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/include/SDL_syswm.h b/include/SDL_syswm.h
@@ -188,6 +188,11 @@ typedef struct SDL_SysWMinfo {
  * 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);