2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997-2006 Sam Lantinga
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.
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.
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
26 * Main include header for the SDL library
29 * \mainpage Simple DirectMedia Layer (SDL)
31 http://www.libsdl.org/
33 * \section intro_sec Introduction
35 This is the Simple DirectMedia Layer, a general API that provides low
36 level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
37 and 2D framebuffer across multiple platforms.
39 The current version supports Linux, Windows, Windows CE, BeOS, MacOS,
40 Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX.
41 The code contains support for Dreamcast, Atari, AIX, OSF/Tru64,
42 RISC OS, SymbianOS, and OS/2, but these are not officially supported.
44 SDL is written in C, but works with C++ natively, and has bindings to
45 several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
46 Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
47 Pike, Pliant, Python, Ruby, and Smalltalk.
49 This library is distributed under GNU LGPL version 2, which can be
50 found in the file "COPYING". This license allows you to use SDL
51 freely in commercial programs as long as you link with the dynamic
54 The best way to learn how to use SDL is to check out the header files in
55 the "include" subdirectory and the programs in the "test" subdirectory.
56 The header files and test programs are well commented and always up to date.
57 More documentation is available in HTML format in "docs/index.html", and
58 a documentation wiki is available online at:
59 http://www.libsdl.org/cgi/docwiki.cgi
61 The test programs in the "test" subdirectory are in the public domain.
63 Frequently asked questions are answered online:
64 http://www.libsdl.org/faq.php
66 If you need help with the library, or just want to discuss SDL related
67 issues, you can join the developers mailing list:
68 http://www.libsdl.org/mailing-list.php
71 Sam Lantinga (slouken@libsdl.org)
78 #include "SDL_stdinc.h"
79 #include "SDL_audio.h"
80 #include "SDL_cdrom.h"
81 #include "SDL_cpuinfo.h"
82 #include "SDL_endian.h"
83 #include "SDL_error.h"
84 #include "SDL_events.h"
85 #include "SDL_loadso.h"
86 #include "SDL_mutex.h"
87 #include "SDL_rwops.h"
88 #include "SDL_thread.h"
89 #include "SDL_timer.h"
90 #include "SDL_video.h"
91 #include "SDL_version.h"
92 #include "SDL_compat.h"
94 #include "begin_code.h"
95 /* Set up for C function definitions, even when using C++ */
102 /* As of version 0.5, SDL is loaded dynamically into the application */
104 /* These are the flags which may be passed to SDL_Init() -- you should
105 specify the subsystems which you will be using in your application.
107 #define SDL_INIT_TIMER 0x00000001
108 #define SDL_INIT_AUDIO 0x00000010
109 #define SDL_INIT_VIDEO 0x00000020
110 #define SDL_INIT_CDROM 0x00000100
111 #define SDL_INIT_JOYSTICK 0x00000200
112 #define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */
113 #define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */
114 #define SDL_INIT_EVERYTHING 0x0000FFFF
116 /* This function loads the SDL dynamically linked library and initializes
117 * the subsystems specified by 'flags' (and those satisfying dependencies)
118 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
119 * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
121 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
123 /* This function initializes specific SDL subsystems */
124 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
126 /* This function cleans up specific SDL subsystems */
127 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
129 /* This function returns mask of the specified subsystems which have
131 If 'flags' is 0, it returns a mask of all initialized subsystems.
133 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
135 /* This function cleans up all initialized subsystems and unloads the
136 * dynamically linked library. You should call it upon all exit conditions.
138 extern DECLSPEC void SDLCALL SDL_Quit(void);
140 /* Ends C function definitions when using C++ */
146 #include "close_code.h"
150 /* vi: set ts=4 sw=4 expandtab: */