1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21#include "SDL_internal.h"
22
23// These are functions that need to be implemented by a port of SDL
24
25#ifndef SDL_systhread_h_
26#define SDL_systhread_h_
27
28#include "SDL_thread_c.h"
29
30// Set up for C function definitions, even when using C++
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35/* This function creates a thread, passing args to SDL_RunThread(),
36 saves a system-dependent thread id in thread->id, and returns 0
37 on success.
38*/
39extern bool SDL_SYS_CreateThread(SDL_Thread *thread,
40 SDL_FunctionPointer pfnBeginThread,
41 SDL_FunctionPointer pfnEndThread);
42
43// This function does any necessary setup in the child thread
44extern void SDL_SYS_SetupThread(const char *name);
45
46// This function sets the current thread priority
47extern bool SDL_SYS_SetThreadPriority(SDL_ThreadPriority priority);
48
49/* This function waits for the thread to finish and frees any data
50 allocated by SDL_SYS_CreateThread()
51 */
52extern void SDL_SYS_WaitThread(SDL_Thread *thread);
53
54// Mark thread as cleaned up as soon as it exits, without joining.
55extern void SDL_SYS_DetachThread(SDL_Thread *thread);
56
57// Initialize the global TLS data
58extern void SDL_SYS_InitTLSData(void);
59
60// Get the thread local storage for this thread
61extern SDL_TLSData *SDL_SYS_GetTLSData(void);
62
63// Set the thread local storage for this thread
64extern bool SDL_SYS_SetTLSData(SDL_TLSData *data);
65
66// Quit the global TLS data
67extern void SDL_SYS_QuitTLSData(void);
68
69// A helper function for setting up a thread with a stack size.
70extern SDL_Thread *SDL_CreateThreadWithStackSize(SDL_ThreadFunction fn, const char *name, size_t stacksize, void *data);
71
72// Ends C function definitions when using C++
73#ifdef __cplusplus
74}
75#endif
76
77#endif // SDL_systhread_h_
78