src/thread/SDL_systhread.h

   1 /*
   2     SDL - Simple DirectMedia Layer
   3     Copyright (C) 1997-2009 Sam Lantinga
   4
   5     This library is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU Lesser General Public
   7     License as published by the Free Software Foundation; either
   8     version 2.1 of the License, or (at your option) any later version.
   9
  10     This library is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     Lesser General Public License for more details.
  14
  15     You should have received a copy of the GNU Lesser General Public
  16     License along with this library; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19     Sam Lantinga
  20     slouken@libsdl.org
  21 */
  22 #include "SDL_config.h"
  23
  24 /* These are functions that need to be implemented by a port of SDL */
  25
  26 #ifndef _SDL_systhread_h
  27 #define _SDL_systhread_h
  28
  29 #include "SDL_thread.h"
  30
  31 /* This function creates a thread, passing args to SDL_RunThread(),
  32    saves a system-dependent thread id in thread->id, and returns 0
  33    on success.
  34 */
  35 #ifdef SDL_PASSED_BEGINTHREAD_ENDTHREAD
  36 extern int SDL_SYS_CreateThread(SDL_Thread *thread, void *args, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
  37 #else
  38 extern int SDL_SYS_CreateThread(SDL_Thread *thread, void *args);
  39 #endif
  40
  41 /* This function does any necessary setup in the child thread */
  42 extern void SDL_SYS_SetupThread(void);
  43
  44 /* This function waits for the thread to finish and frees any data
  45    allocated by SDL_SYS_CreateThread()
  46  */
  47 extern void SDL_SYS_WaitThread(SDL_Thread *thread);
  48
  49 /* This function kills the thread and returns */
  50 extern void SDL_SYS_KillThread(SDL_Thread *thread);
  51
  52 #endif /* _SDL_systhread_h */