Home | History | Annotate | Download | only in SDL
      1 /*
      2     SDL - Simple DirectMedia Layer
      3     Copyright (C) 1997-2006 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 (at) libsdl.org
     21 */
     22 
     23 /* Main include header for the SDL library */
     24 
     25 #ifndef _SDL_H
     26 #define _SDL_H
     27 
     28 #include "SDL_main.h"
     29 #include "SDL_stdinc.h"
     30 #include "SDL_audio.h"
     31 #include "SDL_cdrom.h"
     32 #include "SDL_cpuinfo.h"
     33 #include "SDL_endian.h"
     34 #include "SDL_error.h"
     35 #include "SDL_events.h"
     36 #include "SDL_loadso.h"
     37 #include "SDL_mutex.h"
     38 #include "SDL_rwops.h"
     39 #include "SDL_thread.h"
     40 #include "SDL_timer.h"
     41 #include "SDL_video.h"
     42 #include "SDL_version.h"
     43 
     44 #include "begin_code.h"
     45 /* Set up for C function definitions, even when using C++ */
     46 #ifdef __cplusplus
     47 extern "C" {
     48 #endif
     49 
     50 /* As of version 0.5, SDL is loaded dynamically into the application */
     51 
     52 /* These are the flags which may be passed to SDL_Init() -- you should
     53    specify the subsystems which you will be using in your application.
     54 */
     55 #define	SDL_INIT_TIMER		0x00000001
     56 #define SDL_INIT_AUDIO		0x00000010
     57 #define SDL_INIT_VIDEO		0x00000020
     58 #define SDL_INIT_CDROM		0x00000100
     59 #define SDL_INIT_JOYSTICK	0x00000200
     60 #define SDL_INIT_NOPARACHUTE	0x00100000	/* Don't catch fatal signals */
     61 #define SDL_INIT_EVENTTHREAD	0x01000000	/* Not supported on all OS's */
     62 #define SDL_INIT_EVERYTHING	0x0000FFFF
     63 
     64 /* This function loads the SDL dynamically linked library and initializes
     65  * the subsystems specified by 'flags' (and those satisfying dependencies)
     66  * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
     67  * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
     68  */
     69 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
     70 
     71 /* This function initializes specific SDL subsystems */
     72 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
     73 
     74 /* This function cleans up specific SDL subsystems */
     75 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
     76 
     77 /* This function returns mask of the specified subsystems which have
     78    been initialized.
     79    If 'flags' is 0, it returns a mask of all initialized subsystems.
     80 */
     81 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
     82 
     83 /* This function cleans up all initialized subsystems and unloads the
     84  * dynamically linked library.  You should call it upon all exit conditions.
     85  */
     86 extern DECLSPEC void SDLCALL SDL_Quit(void);
     87 
     88 /* Ends C function definitions when using C++ */
     89 #ifdef __cplusplus
     90 }
     91 #endif
     92 #include "close_code.h"
     93 
     94 #endif /* _SDL_H */
     95