include/SDL.h
changeset 0 74212992fb08
child 251 b8688cfdc232
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
       
     1 /*
       
     2     SDL - Simple DirectMedia Layer
       
     3     Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
       
     4 
       
     5     This library is free software; you can redistribute it and/or
       
     6     modify it under the terms of the GNU Library General Public
       
     7     License as published by the Free Software Foundation; either
       
     8     version 2 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     Library General Public License for more details.
       
    14 
       
    15     You should have received a copy of the GNU Library General Public
       
    16     License along with this library; if not, write to the Free
       
    17     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
       
    18 
       
    19     Sam Lantinga
       
    20     slouken@devolution.com
       
    21 */
       
    22 
       
    23 #ifdef SAVE_RCSID
       
    24 static char rcsid =
       
    25  "@(#) $Id$";
       
    26 #endif
       
    27 
       
    28 /* Main include header for the SDL library */
       
    29 
       
    30 #ifndef _SDL_H
       
    31 #define _SDL_H
       
    32 
       
    33 #include "SDL_main.h"
       
    34 #include "SDL_types.h"
       
    35 #include "SDL_getenv.h"
       
    36 #include "SDL_error.h"
       
    37 #include "SDL_rwops.h"
       
    38 #include "SDL_timer.h"
       
    39 #include "SDL_audio.h"
       
    40 #include "SDL_cdrom.h"
       
    41 #include "SDL_joystick.h"
       
    42 #include "SDL_events.h"
       
    43 #include "SDL_video.h"
       
    44 #include "SDL_byteorder.h"
       
    45 #include "SDL_version.h"
       
    46 
       
    47 #include "begin_code.h"
       
    48 /* Set up for C function definitions, even when using C++ */
       
    49 #ifdef __cplusplus
       
    50 extern "C" {
       
    51 #endif
       
    52 
       
    53 /* As of version 0.5, SDL is loaded dynamically into the application */
       
    54 
       
    55 /* These are the flags which may be passed to SDL_Init() -- you should
       
    56    specify the subsystems which you will be using in your application.
       
    57 */
       
    58 #define	SDL_INIT_TIMER		0x00000001
       
    59 #define SDL_INIT_AUDIO		0x00000010
       
    60 #define SDL_INIT_VIDEO		0x00000020
       
    61 #define SDL_INIT_CDROM		0x00000100
       
    62 #define SDL_INIT_JOYSTICK	0x00000200
       
    63 #define SDL_INIT_NOPARACHUTE	0x00100000	/* Don't catch fatal signals */
       
    64 #define SDL_INIT_EVENTTHREAD	0x01000000	/* Not supported on all OS's */
       
    65 #define SDL_INIT_EVERYTHING	0x0000FFFF
       
    66 
       
    67 /* This function loads the SDL dynamically linked library and initializes 
       
    68  * the subsystems specified by 'flags' (and those satisfying dependencies)
       
    69  * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
       
    70  * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
       
    71  */
       
    72 extern DECLSPEC int SDL_Init(Uint32 flags);
       
    73 
       
    74 /* This function initializes specific SDL subsystems */
       
    75 extern DECLSPEC int SDL_InitSubSystem(Uint32 flags);
       
    76 
       
    77 /* This function cleans up specific SDL subsystems */
       
    78 extern DECLSPEC void SDL_QuitSubSystem(Uint32 flags);
       
    79 
       
    80 /* This function returns mask of the specified subsystems which have
       
    81    been initialized.
       
    82    If 'flags' is 0, it returns a mask of all initialized subsystems.
       
    83 */
       
    84 extern DECLSPEC Uint32 SDL_WasInit(Uint32 flags);
       
    85 
       
    86 /* This function cleans up all initialized subsystems and unloads the
       
    87  * dynamically linked library.  You should call it upon all exit conditions.
       
    88  */
       
    89 extern DECLSPEC void SDL_Quit(void);
       
    90 
       
    91 /* Ends C function definitions when using C++ */
       
    92 #ifdef __cplusplus
       
    93 }
       
    94 #endif
       
    95 #include "close_code.h"
       
    96 
       
    97 #endif /* _SDL_H */