pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added a typedef for the thread function to simplify documentation

Browse source
This commit is contained in:
Sam Lantinga 2010-08-28 22:56:52 -07:00
parent dc0f95c447
commit 09ad8038b8
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/SDL_thread.h
View file

@ -50,6 +50,11 @@ typedef struct SDL_Thread SDL_Thread;
/* The SDL thread ID */ /* The SDL thread ID */
typedef unsigned long SDL_threadID; typedef unsigned long SDL_threadID;
/* The function passed to SDL_CreateThread()
It is passed a void* user context parameter and returns an int.
*/
typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
#if defined(__WIN32__) && !defined(HAVE_LIBC) #if defined(__WIN32__) && !defined(HAVE_LIBC)
/** /**
* \file SDL_thread.h * \file SDL_thread.h
@ -100,7 +105,7 @@ typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
* Create a thread. * Create a thread.
*/ */
extern DECLSPEC SDL_Thread *SDLCALL extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * f) (void *), void *data, SDL_CreateThread(SDL_ThreadFunction fn, void *data,
pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentBeginThread pfnBeginThread,
pfnSDL_CurrentEndThread pfnEndThread); pfnSDL_CurrentEndThread pfnEndThread);
@ -125,7 +130,7 @@ SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
* Create a thread. * Create a thread.
*/ */
extern DECLSPEC SDL_Thread *SDLCALL extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * fn) (void *), void *data); SDL_CreateThread(SDL_ThreadFunction fn, void *data);
#endif #endif