include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 06 Mar 2002 11:23:08 +0000
changeset 297 f6ffac90895c
parent 251 b8688cfdc232
child 337 9154ec9ca3d2
permissions -rw-r--r--
Updated copyright information for 2002
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@297
     3
    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002  Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@0
     6
    modify it under the terms of the GNU Library General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@0
     8
    version 2 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@0
    13
    Library General Public License for more details.
slouken@0
    14
slouken@0
    15
    You should have received a copy of the GNU Library General Public
slouken@0
    16
    License along with this library; if not, write to the Free
slouken@0
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifdef SAVE_RCSID
slouken@0
    24
static char rcsid =
slouken@0
    25
 "@(#) $Id$";
slouken@0
    26
#endif
slouken@0
    27
slouken@0
    28
#ifndef _SDL_thread_h
slouken@0
    29
#define _SDL_thread_h
slouken@0
    30
slouken@0
    31
/* Header for the SDL thread management routines 
slouken@0
    32
slouken@0
    33
	These are independent of the other SDL routines.
slouken@0
    34
*/
slouken@0
    35
slouken@0
    36
#include "SDL_main.h"
slouken@0
    37
#include "SDL_types.h"
slouken@0
    38
slouken@0
    39
/* Thread synchronization primitives */
slouken@0
    40
#include "SDL_mutex.h"
slouken@0
    41
slouken@0
    42
#include "begin_code.h"
slouken@0
    43
/* Set up for C function definitions, even when using C++ */
slouken@0
    44
#ifdef __cplusplus
slouken@0
    45
extern "C" {
slouken@0
    46
#endif
slouken@0
    47
slouken@0
    48
/* The SDL thread structure, defined in SDL_thread.c */
slouken@0
    49
struct SDL_Thread;
slouken@0
    50
typedef struct SDL_Thread SDL_Thread;
slouken@0
    51
slouken@0
    52
/* Create a thread */
slouken@0
    53
extern DECLSPEC SDL_Thread * SDL_CreateThread(int (*fn)(void *), void *data);
slouken@0
    54
slouken@0
    55
/* Get the 32-bit thread identifier for the current thread */
slouken@0
    56
extern DECLSPEC Uint32 SDL_ThreadID(void);
slouken@0
    57
slouken@0
    58
/* Get the 32-bit thread identifier for the specified thread,
slouken@0
    59
   equivalent to SDL_ThreadID() if the specified thread is NULL.
slouken@0
    60
 */
slouken@0
    61
extern DECLSPEC Uint32 SDL_GetThreadID(SDL_Thread *thread);
slouken@0
    62
slouken@0
    63
/* Wait for a thread to finish.
slouken@0
    64
   The return code for the thread function is placed in the area
slouken@0
    65
   pointed to by 'status', if 'status' is not NULL.
slouken@0
    66
 */
slouken@0
    67
extern DECLSPEC void SDL_WaitThread(SDL_Thread *thread, int *status);
slouken@0
    68
slouken@0
    69
/* Forcefully kill a thread without worrying about its state */
slouken@0
    70
extern DECLSPEC void SDL_KillThread(SDL_Thread *thread);
slouken@0
    71
slouken@0
    72
slouken@0
    73
/* Ends C function definitions when using C++ */
slouken@0
    74
#ifdef __cplusplus
slouken@0
    75
}
slouken@0
    76
#endif
slouken@0
    77
#include "close_code.h"
slouken@0
    78
slouken@0
    79
#endif /* _SDL_thread_h */