include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 12 Jan 2011 15:42:26 -0800
changeset 4986 8431f59485d0
parent 4866 f42e8db53f78
child 5062 e8916fe9cfc8
permissions -rw-r--r--
Renderer didn't advertise texture format SDL_PIXELFORMAT_ABGR8888
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 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 
    23 #ifndef _SDL_thread_h
    24 #define _SDL_thread_h
    25 
    26 /**
    27  *  \file SDL_thread.h
    28  *  
    29  *  Header for the SDL thread management routines.
    30  */
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 
    35 /* Thread synchronization primitives */
    36 #include "SDL_mutex.h"
    37 
    38 #include "begin_code.h"
    39 /* Set up for C function definitions, even when using C++ */
    40 #ifdef __cplusplus
    41 /* *INDENT-OFF* */
    42 extern "C" {
    43 /* *INDENT-ON* */
    44 #endif
    45 
    46 /* The SDL thread structure, defined in SDL_thread.c */
    47 struct SDL_Thread;
    48 typedef struct SDL_Thread SDL_Thread;
    49 
    50 /* The SDL thread ID */
    51 typedef unsigned long SDL_threadID;
    52 
    53 /* The function passed to SDL_CreateThread()
    54    It is passed a void* user context parameter and returns an int.
    55  */
    56 typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
    57 
    58 #if defined(__WIN32__) && !defined(HAVE_LIBC)
    59 /**
    60  *  \file SDL_thread.h
    61  *  
    62  *  We compile SDL into a DLL. This means, that it's the DLL which
    63  *  creates a new thread for the calling process with the SDL_CreateThread()
    64  *  API. There is a problem with this, that only the RTL of the SDL.DLL will
    65  *  be initialized for those threads, and not the RTL of the calling 
    66  *  application!
    67  *  
    68  *  To solve this, we make a little hack here.
    69  *  
    70  *  We'll always use the caller's _beginthread() and _endthread() APIs to
    71  *  start a new thread. This way, if it's the SDL.DLL which uses this API,
    72  *  then the RTL of SDL.DLL will be used to create the new thread, and if it's
    73  *  the application, then the RTL of the application will be used.
    74  *  
    75  *  So, in short:
    76  *  Always use the _beginthread() and _endthread() of the calling runtime 
    77  *  library!
    78  */
    79 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
    80 #ifndef _WIN32_WCE
    81 #include <process.h>            /* This has _beginthread() and _endthread() defined! */
    82 #endif
    83 
    84 #ifdef __GNUC__
    85 typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    86                                                              unsigned
    87                                                              (__stdcall *
    88                                                               func) (void *),
    89                                                              void *arg,
    90                                                              unsigned,
    91                                                              unsigned
    92                                                              *threadID);
    93 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
    94 #else
    95 typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    96                                                         unsigned (__stdcall *
    97                                                                   func) (void
    98                                                                          *),
    99                                                         void *arg, unsigned,
   100                                                         unsigned *threadID);
   101 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
   102 #endif
   103 
   104 /**
   105  *  Create a thread.
   106  */
   107 extern DECLSPEC SDL_Thread *SDLCALL
   108 SDL_CreateThread(SDL_ThreadFunction fn, void *data,
   109                  pfnSDL_CurrentBeginThread pfnBeginThread,
   110                  pfnSDL_CurrentEndThread pfnEndThread);
   111 
   112 #if defined(_WIN32_WCE)
   113 
   114 /**
   115  *  Create a thread.
   116  */
   117 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
   118 
   119 #else
   120 
   121 /**
   122  *  Create a thread.
   123  */
   124 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
   125 
   126 #endif
   127 #else
   128 
   129 /**
   130  *  Create a thread.
   131  */
   132 extern DECLSPEC SDL_Thread *SDLCALL
   133 SDL_CreateThread(SDL_ThreadFunction fn, void *data);
   134 
   135 #endif
   136 
   137 /**
   138  *  Get the thread identifier for the current thread.
   139  */
   140 extern DECLSPEC SDL_threadID SDLCALL SDL_ThreadID(void);
   141 
   142 /**
   143  *  Get the thread identifier for the specified thread.
   144  *  
   145  *  Equivalent to SDL_ThreadID() if the specified thread is NULL.
   146  */
   147 extern DECLSPEC SDL_threadID SDLCALL SDL_GetThreadID(SDL_Thread * thread);
   148 
   149 /**
   150  *  Wait for a thread to finish.
   151  *  
   152  *  The return code for the thread function is placed in the area
   153  *  pointed to by \c status, if \c status is not NULL.
   154  */
   155 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
   156 
   157 
   158 /* Ends C function definitions when using C++ */
   159 #ifdef __cplusplus
   160 /* *INDENT-OFF* */
   161 }
   162 /* *INDENT-ON* */
   163 #endif
   164 #include "close_code.h"
   165 
   166 #endif /* _SDL_thread_h */
   167 
   168 /* vi: set ts=4 sw=4 expandtab: */