sdl-ios-xcode: include/SDL_thread.h annotate

annotate include/SDL_thread.h @ 4466:ba66ff156955

Added the automated test plist file and modified .hgignore to be less aggressive. Discovered that the new plist file for the automated test was not checked in because the .hgignore file was too aggressive. I changed the .hgignore to not ignore the Xcode directory and instead added a longer list of things to ignore.

author	Eric Wing <ewing . public \|-at-\| gmail . com>
date	Wed, 12 May 2010 12:49:28 -0700
parents	f7b03b6838cb
children	82f357a91d43

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
3697 f7b03b6838cb Fixed bug #926 Sam Lantinga <slouken@libsdl.org> parents: 3578 diff changeset	3 Copyright (C) 1997-2010 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	6 modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	13 Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	15 You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	16 License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 1190 diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19 Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 0 diff changeset	20 slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	23 #ifndef _SDL_thread_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	24 #define _SDL_thread_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	25
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	26 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	27 * \file SDL_thread.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	28 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	29 * Header for the SDL thread management routines.
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	30 */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	32 #include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	33 #include "SDL_error.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	34
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 /* Thread synchronization primitives */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36 #include "SDL_mutex.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40 #ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	41 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42 extern "C" {
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	43 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 /* The SDL thread structure, defined in SDL_thread.c */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47 struct SDL_Thread;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	48 typedef struct SDL_Thread SDL_Thread;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	49
3578 0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	50 /* The SDL thread ID */
0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	51 typedef unsigned long SDL_threadID;
0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	52
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	53 #if defined(__WIN32__) && !defined(HAVE_LIBC)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	54 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	55 * \file SDL_thread.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	56 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	57 * We compile SDL into a DLL. This means, that it's the DLL which
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	58 * creates a new thread for the calling process with the SDL_CreateThread()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	59 * API. There is a problem with this, that only the RTL of the SDL.DLL will
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	60 * be initialized for those threads, and not the RTL of the calling
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	61 * application!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	62 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	63 * To solve this, we make a little hack here.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	64 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	65 * We'll always use the caller's _beginthread() and _endthread() APIs to
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	66 * start a new thread. This way, if it's the SDL.DLL which uses this API,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	67 * then the RTL of SDL.DLL will be used to create the new thread, and if it's
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	68 * the application, then the RTL of the application will be used.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	69 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	70 * So, in short:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	71 * Always use the _beginthread() and _endthread() of the calling runtime
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	72 * library!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	73 */
1471 9fb0eee04dd9 Enabled libc support on Win32, so we don't break binary compatibility in 1.2 Sam Lantinga <slouken@libsdl.org> parents: 1470 diff changeset	74 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
1465 8dfa9a6d69a5 Updated WinCE support by Dmitry (with some tweaks) Sam Lantinga <slouken@libsdl.org> parents: 1442 diff changeset	75 #ifndef _WIN32_WCE
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	76 #include <process.h> /* This has _beginthread() and _endthread() defined! */
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	77 #endif
173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	78
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	79 #ifdef __GNUC__
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	80 typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	81 unsigned
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	82 (__stdcall *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	83 func) (void *),
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	84 void *arg,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	85 unsigned,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	86 unsigned
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	87 *threadID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	88 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	89 #else
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	90 typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	91 unsigned (__stdcall *
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	92 func) (void
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	93 *),
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	94 void *arg, unsigned,
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	95 unsigned *threadID);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	96 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	97 #endif
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	98
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	99 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	100 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	101 */
2060 866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	102 extern DECLSPEC SDL_Thread *SDLCALL
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	103 SDL_CreateThread(int (SDLCALL * f) (void ), void data,
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	104 pfnSDL_CurrentBeginThread pfnBeginThread,
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	105 pfnSDL_CurrentEndThread pfnEndThread);
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	106
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	107 #if defined(_WIN32_WCE)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	108
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	109 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	110 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	111 */
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	112 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	113
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	114 #else
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	115
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	116 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	117 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	118 */
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	119 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	120
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	121 #endif
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	122 #else
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	123
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	124 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	125 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	126 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	127 extern DECLSPEC SDL_Thread *SDLCALL
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	128 SDL_CreateThread(int (SDLCALL * fn) (void ), void data);
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	129
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	130 #endif
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	131
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	132 /**
3578 0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	133 * Get the thread identifier for the current thread.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	134 */
3578 0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	135 extern DECLSPEC SDL_threadID SDLCALL SDL_ThreadID(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	136
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	137 /**
3578 0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	138 * Get the thread identifier for the specified thread.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	139 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	140 * Equivalent to SDL_ThreadID() if the specified thread is NULL.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	141 */
3578 0d1b16ee0bca Fixed bug #741 Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	142 extern DECLSPEC SDL_threadID SDLCALL SDL_GetThreadID(SDL_Thread * thread);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	143
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	144 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	145 * Wait for a thread to finish.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	146 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	147 * The return code for the thread function is placed in the area
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	148 * pointed to by \c status, if \c status is not NULL.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	149 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	150 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	151
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	152 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	153 * \deprecated This function is here for binary compatibility with legacy apps,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	154 * but in SDL 1.3 and later, it's a no-op.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	155 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	156 * You cannot forcibly kill a thread in a safe manner on many platforms. You
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	157 * should instead find a way to alert your thread that it is time to terminate,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	158 * and then have it gracefully exit on its own. Do not ever call this function!
2779 4436464c4f51 Fixed Bugzilla bug #205 Sam Lantinga <slouken@libsdl.org> parents: 2060 diff changeset	159 */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	160 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	161
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	162
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	163 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	164 #ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	165 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	166 }
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	167 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	168 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	169 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	170
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	171 #endif /* _SDL_thread_h */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	172
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1850 diff changeset	173 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_thread.h @ 4466:ba66ff156955