include/SDL.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 10 Feb 2006 03:19:02 +0000
changeset 1356 67114343400d
parent 1353 7ba544e2888d
child 1358 c71e05b4dc2e
permissions -rw-r--r--
*** empty log message ***
     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@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_stdinc.h"
    29 #include "SDL_error.h"
    30 #include "SDL_rwops.h"
    31 #include "SDL_timer.h"
    32 #include "SDL_audio.h"
    33 #include "SDL_cdrom.h"
    34 #include "SDL_joystick.h"
    35 #include "SDL_events.h"
    36 #include "SDL_video.h"
    37 #include "SDL_loadso.h"
    38 #include "SDL_byteorder.h"
    39 #include "SDL_version.h"
    40 
    41 #include "begin_code.h"
    42 /* Set up for C function definitions, even when using C++ */
    43 #ifdef __cplusplus
    44 extern "C" {
    45 #endif
    46 
    47 /* As of version 0.5, SDL is loaded dynamically into the application */
    48 
    49 /* These are the flags which may be passed to SDL_Init() -- you should
    50    specify the subsystems which you will be using in your application.
    51 */
    52 #define	SDL_INIT_TIMER		0x00000001
    53 #define SDL_INIT_AUDIO		0x00000010
    54 #define SDL_INIT_VIDEO		0x00000020
    55 #define SDL_INIT_CDROM		0x00000100
    56 #define SDL_INIT_JOYSTICK	0x00000200
    57 #define SDL_INIT_NOPARACHUTE	0x00100000	/* Don't catch fatal signals */
    58 #define SDL_INIT_EVENTTHREAD	0x01000000	/* Not supported on all OS's */
    59 #define SDL_INIT_EVERYTHING	0x0000FFFF
    60 
    61 /* This function loads the SDL dynamically linked library and initializes 
    62  * the subsystems specified by 'flags' (and those satisfying dependencies)
    63  * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
    64  * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
    65  */
    66 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
    67 
    68 /* This function initializes specific SDL subsystems */
    69 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
    70 
    71 /* This function cleans up specific SDL subsystems */
    72 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
    73 
    74 /* This function returns mask of the specified subsystems which have
    75    been initialized.
    76    If 'flags' is 0, it returns a mask of all initialized subsystems.
    77 */
    78 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
    79 
    80 /* This function cleans up all initialized subsystems and unloads the
    81  * dynamically linked library.  You should call it upon all exit conditions.
    82  */
    83 extern DECLSPEC void SDLCALL SDL_Quit(void);
    84 
    85 /* Ends C function definitions when using C++ */
    86 #ifdef __cplusplus
    87 }
    88 #endif
    89 #include "close_code.h"
    90 
    91 #endif /* _SDL_H */