src/thread/SDL_systhread.h
author Ryan C. Gordon
Sun, 02 Oct 2011 00:29:16 -0400
changeset 5969 3a041d215edc
parent 5535 96594ac5fd1a
child 6138 4c64952a58fb
permissions -rw-r--r--
1.3 API CHANGE: Add support for naming threads.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2011 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_config.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.h"
    29 
    30 /* This function creates a thread, passing args to SDL_RunThread(),
    31    saves a system-dependent thread id in thread->id, and returns 0
    32    on success.
    33 */
    34 #ifdef SDL_PASSED_BEGINTHREAD_ENDTHREAD
    35 extern int SDL_SYS_CreateThread(SDL_Thread * thread, void *args,
    36                                 pfnSDL_CurrentBeginThread pfnBeginThread,
    37                                 pfnSDL_CurrentEndThread pfnEndThread);
    38 #else
    39 extern int SDL_SYS_CreateThread(SDL_Thread * thread, void *args);
    40 #endif
    41 
    42 /* This function does any necessary setup in the child thread */
    43 extern void SDL_SYS_SetupThread(const char *name);
    44 
    45 /* This function sets the current thread priority */
    46 extern int SDL_SYS_SetThreadPriority(SDL_ThreadPriority priority);
    47 
    48 /* This function waits for the thread to finish and frees any data
    49    allocated by SDL_SYS_CreateThread()
    50  */
    51 extern void SDL_SYS_WaitThread(SDL_Thread * thread);
    52 
    53 #endif /* _SDL_systhread_h */
    54 
    55 /* vi: set ts=4 sw=4 expandtab: */