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

annotate include/SDL_thread.h @ 3486:c87dbbde2bc2

Fixed bug #891 Mason Wheeler 2009-11-23 06:59:48 PST There's code in SDL_RecreateWindow specifically to handle SDL_WINDOW_FOREIGN, but it appears to have been overlooked in the allowed_flags constant. This causes the line window->flags = (flags & allowed_flags); to strip SDL_WINDOW_FOREIGN from the window's flags, which breaks some code in WIN_WindowProc in SDL_win32Events.c that treats foreign windows differently. This can be trivially fixed by defining allowed_flags as const Uint32 allowed_flags = (SDL_WINDOW_FULLSCREEN | SDL_WINDOW_OPENGL | SDL_WINDOW_BORDERLESS | SDL_WINDOW_RESIZABLE | SDL_WINDOW_INPUT_GRABBED | SDL_WINDOW_FOREIGN);

author	Sam Lantinga <slouken@libsdl.org>
date	Tue, 24 Nov 2009 04:59:50 +0000
parents	d3baf5ac4e37
children	0d1b16ee0bca

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
2859 99210400e8b9 Updated copyright date Sam Lantinga <slouken@libsdl.org> parents: 2779 diff changeset	3 Copyright (C) 1997-2009 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
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	50 #if defined(__WIN32__) && !defined(HAVE_LIBC)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	51 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	52 * \file SDL_thread.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	53 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	54 * 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	55 * 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	56 * 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	57 * 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	58 * application!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	59 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	60 * To solve this, we make a little hack here.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	61 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	62 * 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	63 * 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	64 * 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	65 * 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	66 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	67 * So, in short:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	68 * 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	69 * library!
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	70 */
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	71 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
1465 8dfa9a6d69a5 Updated WinCE support by Dmitry (with some tweaks) Sam Lantinga <slouken@libsdl.org> parents: 1442 diff changeset	72 #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	73 #include <process.h> /* This has _beginthread() and _endthread() defined! */
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	74 #endif
173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	75
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	76 #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	77 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	78 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	79 (__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	80 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	81 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	82 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	83 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	84 *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	85 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	86 #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	87 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	88 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	89 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	90 *),
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 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	92 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	93 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	94 #endif
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	95
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	96 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	97 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	98 */
2060 866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	99 extern DECLSPEC SDL_Thread *SDLCALL
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	100 SDL_CreateThread(int (SDLCALL * f) (void ), void data,
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	101 pfnSDL_CurrentBeginThread pfnBeginThread,
866052b01ee5 indent is evil Sam Lantinga <slouken@libsdl.org> parents: 2049 diff changeset	102 pfnSDL_CurrentEndThread pfnEndThread);
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	103
3269 a67a961e2171 Removed outdated OS/2 support Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	104 #if defined(_WIN32_WCE)
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	105
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	106 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	107 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	108 */
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	109 #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	110
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	111 #else
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	112
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	113 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	114 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	115 */
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	116 #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	117
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	118 #endif
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	119 #else
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	120
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	121 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	122 * Create a thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	123 */
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	124 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	125 SDL_CreateThread(int (SDLCALL * fn) (void ), void data);
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	126
1190 173c063d4f55 OS/2 port! Ryan C. Gordon <icculus@icculus.org> parents: 930 diff changeset	127 #endif
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	128
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	129 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	130 * Get the 32-bit thread identifier for the current thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	131 */
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	132 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	133
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	134 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	135 * Get the 32-bit thread identifier for the specified thread.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	136 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	137 * Equivalent to SDL_ThreadID() if the specified thread is NULL.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	138 */
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	139 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	140
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	141 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	142 * Wait for a thread to finish.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	143 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	144 * 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	145 * pointed to by \c status, if \c status is not NULL.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	146 */
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	147 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	148
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	149 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	150 * \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	151 * 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	152 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3269 diff changeset	153 * 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	154 * 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	155 * 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	156 */
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	157 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	158
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	159
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	160 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	161 #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	162 /* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	163 }
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	164 /* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	165 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	166 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	167
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	168 #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	169
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	170 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_thread.h @ 3486:c87dbbde2bc2