From f67e11e17d90a19a4ea149d6f4da22f84ef77662 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Tue, 30 Nov 2004 15:21:29 +0000 Subject: [PATCH] Added a usage example for SDL_GetWMInfo() --- include/SDL_syswm.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/SDL_syswm.h b/include/SDL_syswm.h index 4db13d4c5..ac351987d 100644 --- 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);