1.1 --- a/include/SDL.h Sun May 21 17:27:13 2006 +0000
1.2 +++ b/include/SDL.h Sun May 28 13:04:16 2006 +0000
1.3 @@ -20,7 +20,56 @@
1.4 slouken@libsdl.org
1.5 */
1.6
1.7 -/* Main include header for the SDL library */
1.8 +/**
1.9 + * \file SDL.h
1.10 + *
1.11 + * Main include header for the SDL library
1.12 + */
1.13 +/**
1.14 + * \mainpage Simple DirectMedia Layer (SDL)
1.15 +
1.16 +http://www.libsdl.org/
1.17 +
1.18 +* \section intro_sec Introduction
1.19 +
1.20 +This is the Simple DirectMedia Layer, a general API that provides low
1.21 +level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
1.22 +and 2D framebuffer across multiple platforms.
1.23 +
1.24 +The current version supports Linux, Windows, Windows CE, BeOS, MacOS,
1.25 +Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX.
1.26 +The code contains support for AmigaOS, Dreamcast, Atari, AIX, OSF/Tru64,
1.27 +RISC OS, SymbianOS, and OS/2, but these are not officially supported.
1.28 +
1.29 +SDL is written in C, but works with C++ natively, and has bindings to
1.30 +several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
1.31 +Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
1.32 +Pike, Pliant, Python, Ruby, and Smalltalk.
1.33 +
1.34 +This library is distributed under GNU LGPL version 2, which can be
1.35 +found in the file "COPYING". This license allows you to use SDL
1.36 +freely in commercial programs as long as you link with the dynamic
1.37 +library.
1.38 +
1.39 +The best way to learn how to use SDL is to check out the header files in
1.40 +the "include" subdirectory and the programs in the "test" subdirectory.
1.41 +The header files and test programs are well commented and always up to date.
1.42 +More documentation is available in HTML format in "docs/index.html", and
1.43 +a documentation wiki is available online at:
1.44 + http://www.libsdl.org/cgi/docwiki.cgi
1.45 +
1.46 +The test programs in the "test" subdirectory are in the public domain.
1.47 +
1.48 +Frequently asked questions are answered online:
1.49 + http://www.libsdl.org/faq.php
1.50 +
1.51 +If you need help with the library, or just want to discuss SDL related
1.52 +issues, you can join the developers mailing list:
1.53 + http://www.libsdl.org/mailing-list.php
1.54 +
1.55 +Enjoy!
1.56 + Sam Lantinga (slouken@libsdl.org)
1.57 + */
1.58
1.59 #ifndef _SDL_H
1.60 #define _SDL_H
1.61 @@ -40,11 +89,14 @@
1.62 #include "SDL_timer.h"
1.63 #include "SDL_video.h"
1.64 #include "SDL_version.h"
1.65 +#include "SDL_compat.h"
1.66
1.67 #include "begin_code.h"
1.68 /* Set up for C function definitions, even when using C++ */
1.69 #ifdef __cplusplus
1.70 +/* *INDENT-OFF* */
1.71 extern "C" {
1.72 +/* *INDENT-ON* */
1.73 #endif
1.74
1.75 /* As of version 0.5, SDL is loaded dynamically into the application */
1.76 @@ -57,8 +109,8 @@
1.77 #define SDL_INIT_VIDEO 0x00000020
1.78 #define SDL_INIT_CDROM 0x00000100
1.79 #define SDL_INIT_JOYSTICK 0x00000200
1.80 -#define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */
1.81 -#define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */
1.82 +#define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */
1.83 +#define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */
1.84 #define SDL_INIT_EVERYTHING 0x0000FFFF
1.85
1.86 /* This function loads the SDL dynamically linked library and initializes
1.87 @@ -66,29 +118,33 @@
1.88 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
1.89 * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
1.90 */
1.91 -extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
1.92 +extern DECLSPEC int SDLCALL SDL_Init (Uint32 flags);
1.93
1.94 /* This function initializes specific SDL subsystems */
1.95 -extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
1.96 +extern DECLSPEC int SDLCALL SDL_InitSubSystem (Uint32 flags);
1.97
1.98 /* This function cleans up specific SDL subsystems */
1.99 -extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
1.100 +extern DECLSPEC void SDLCALL SDL_QuitSubSystem (Uint32 flags);
1.101
1.102 /* This function returns mask of the specified subsystems which have
1.103 been initialized.
1.104 If 'flags' is 0, it returns a mask of all initialized subsystems.
1.105 */
1.106 -extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
1.107 +extern DECLSPEC Uint32 SDLCALL SDL_WasInit (Uint32 flags);
1.108
1.109 /* This function cleans up all initialized subsystems and unloads the
1.110 * dynamically linked library. You should call it upon all exit conditions.
1.111 */
1.112 -extern DECLSPEC void SDLCALL SDL_Quit(void);
1.113 +extern DECLSPEC void SDLCALL SDL_Quit (void);
1.114
1.115 /* Ends C function definitions when using C++ */
1.116 #ifdef __cplusplus
1.117 +/* *INDENT-OFF* */
1.118 }
1.119 +/* *INDENT-ON* */
1.120 #endif
1.121 #include "close_code.h"
1.122
1.123 #endif /* _SDL_H */
1.124 +
1.125 +/* vi: set ts=4 sw=4 expandtab: */