Rev Author Line No. Line
23 ovan 1 /*
2     SDL - Simple DirectMedia Layer
3     Copyright (C) 1997-2009 Sam Lantinga
4  
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Lesser General Public
7     License as published by the Free Software Foundation; either
8     version 2.1 of the License, or (at your option) any later version.
9  
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     Lesser General Public License for more details.
14  
15     You should have received a copy of the GNU Lesser General Public
16     License along with this library; if not, write to the Free Software
17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  
19     Sam Lantinga
20     slouken@libsdl.org
21 */
22  
23 /** @file SDL.h
24  *  Main include header for the SDL library
25  */
26  
27 #ifndef _SDL_H
28 #define _SDL_H
29  
30 #include "SDL_main.h"
31 #include "SDL_stdinc.h"
32 #include "SDL_audio.h"
33 #include "SDL_cdrom.h"
34 #include "SDL_cpuinfo.h"
35 #include "SDL_endian.h"
36 #include "SDL_error.h"
37 #include "SDL_events.h"
38 #include "SDL_loadso.h"
39 #include "SDL_mutex.h"
40 #include "SDL_rwops.h"
41 #include "SDL_thread.h"
42 #include "SDL_timer.h"
43 #include "SDL_video.h"
44 #include "SDL_version.h"
45  
46 #include "begin_code.h"
47 /* Set up for C function definitions, even when using C++ */
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51  
52 /** @file SDL.h
53  *  @note As of version 0.5, SDL is loaded dynamically into the application
54  */
55  
56 /** @name SDL_INIT Flags
57  *  These are the flags which may be passed to SDL_Init() -- you should
58  *  specify the subsystems which you will be using in your application.
59  */
60 /*@{*/
61 #define SDL_INIT_TIMER          0x00000001
62 #define SDL_INIT_AUDIO          0x00000010
63 #define SDL_INIT_VIDEO          0x00000020
64 #define SDL_INIT_CDROM          0x00000100
65 #define SDL_INIT_JOYSTICK       0x00000200
66 #define SDL_INIT_NOPARACHUTE    0x00100000      /**< Don't catch fatal signals */
67 #define SDL_INIT_EVENTTHREAD    0x01000000      /**< Not supported on all OS's */
68 #define SDL_INIT_EVERYTHING     0x0000FFFF
69 /*@}*/
70  
71 /** This function loads the SDL dynamically linked library and initializes
72  *  the subsystems specified by 'flags' (and those satisfying dependencies)
73  *  Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
74  *  signal handlers for some commonly ignored fatal signals (like SIGSEGV)
75  */
76 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
77  
78 /** This function initializes specific SDL subsystems */
79 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
80  
81 /** This function cleans up specific SDL subsystems */
82 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
83  
84 /** This function returns mask of the specified subsystems which have
85  *  been initialized.
86  *  If 'flags' is 0, it returns a mask of all initialized subsystems.
87  */
88 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
89  
90 /** This function cleans up all initialized subsystems and unloads the
91  *  dynamically linked library.  You should call it upon all exit conditions.
92  */
93 extern DECLSPEC void SDLCALL SDL_Quit(void);
94  
95 /* Ends C function definitions when using C++ */
96 #ifdef __cplusplus
97 }
98 #endif
99 #include "close_code.h"
100  
101 #endif /* _SDL_H */