This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_thread.h
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Simple DirectMedia Layer
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
22
23
24
*/
#ifndef _SDL_thread_h
#define _SDL_thread_h
26
27
28
* \file SDL_thread.h
*
* Header for the SDL thread management routines.
31
#include "SDL_stdinc.h"
32
#include "SDL_error.h"
33
34
35
36
37
38
39
/* Thread synchronization primitives */
#include "SDL_mutex.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
40
/* *INDENT-OFF* */
41
extern "C" {
42
/* *INDENT-ON* */
43
44
45
46
47
48
#endif
/* The SDL thread structure, defined in SDL_thread.c */
struct SDL_Thread;
typedef struct SDL_Thread SDL_Thread;
49
50
51
/* The SDL thread ID */
typedef unsigned long SDL_threadID;
52
53
54
55
56
57
58
59
60
61
/* The SDL thread priority
*
* Note: On many systems you require special privileges to set high priority.
*/
typedef enum {
SDL_THREAD_PRIORITY_LOW,
SDL_THREAD_PRIORITY_NORMAL,
SDL_THREAD_PRIORITY_HIGH
} SDL_ThreadPriority;
62
63
64
65
66
/* 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);
67
#if defined(__WIN32__) && !defined(HAVE_LIBC)
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
* \file SDL_thread.h
*
* We compile SDL into a DLL. This means, that it's the DLL which
* creates a new thread for the calling process with the SDL_CreateThread()
* API. There is a problem with this, that only the RTL of the SDL.DLL will
* be initialized for those threads, and not the RTL of the calling
* application!
*
* To solve this, we make a little hack here.
*
* We'll always use the caller's _beginthread() and _endthread() APIs to
* start a new thread. This way, if it's the SDL.DLL which uses this API,
* then the RTL of SDL.DLL will be used to create the new thread, and if it's
* the application, then the RTL of the application will be used.
*
* So, in short:
* Always use the _beginthread() and _endthread() of the calling runtime
* library!
*/
88
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
89
#ifndef _WIN32_WCE
90
#include <process.h> /* This has _beginthread() and _endthread() defined! */
91
92
#endif
93
#ifdef __GNUC__
94
95
96
97
98
99
100
101
102
typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
unsigned
(__stdcall *
func) (void *),
void *arg,
unsigned,
unsigned
*threadID);
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
104
105
106
107
108
109
110
typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
unsigned (__stdcall *
func) (void
*),
void *arg, unsigned,
unsigned *threadID);
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
112
113
114
115
/**
* Create a thread.
*/
116
extern DECLSPEC SDL_Thread *SDLCALL
117
SDL_CreateThread(SDL_ThreadFunction fn, void *data,
118
119
pfnSDL_CurrentBeginThread pfnBeginThread,
pfnSDL_CurrentEndThread pfnEndThread);
120
121
#if defined(_WIN32_WCE)
122
123
124
125
/**
* Create a thread.
*/
126
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
129
130
131
132
/**
* Create a thread.
*/
133
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
136
#else
137
138
139
140
/**
* Create a thread.
*/
141
extern DECLSPEC SDL_Thread *SDLCALL
142
SDL_CreateThread(SDL_ThreadFunction fn, void *data);
144
#endif
146
/**
147
* Get the thread identifier for the current thread.
148
*/
149
extern DECLSPEC SDL_threadID SDLCALL SDL_ThreadID(void);
151
/**
152
* Get the thread identifier for the specified thread.
153
154
*
* Equivalent to SDL_ThreadID() if the specified thread is NULL.
155
*/
156
extern DECLSPEC SDL_threadID SDLCALL SDL_GetThreadID(SDL_Thread * thread);
159
* Set the priority for the current thread
161
extern DECLSPEC int SDLCALL SDL_SetThreadPriority(SDL_ThreadPriority priority);
163
164
165
166
167
/**
* Wait for a thread to finish.
*
* The return code for the thread function is placed in the area
* pointed to by \c status, if \c status is not NULL.
168
*/
169
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
170
171
172
173
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
174
/* *INDENT-OFF* */
175
}
176
/* *INDENT-ON* */
177
178
179
180
#endif
#include "close_code.h"
#endif /* _SDL_thread_h */
181
182
/* vi: set ts=4 sw=4 expandtab: */