Mercurial > sdl-ios-xcode
annotate include/SDL.h @ 4217:4c4113c2162c SDL-1.2
Fixed bug #706
Ken Bull 2009-02-25 13:22:02 PST
Adds Doxygen support for all headers (except config and boilerplate headers) in
the include folder for SDL-1.2 revision 4446.
While in general SDL is quite thoroughly commented, none of these comments are
correctly formatted for Doxygen and are generally inconsistent in their
formatting.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 21 Sep 2009 09:38:10 +0000 |
| parents | a1b03ba2fcd0 |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 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 | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 4217 | 23 /** @file SDL.h |
| 24 * Main include header for the SDL library | |
| 25 */ | |
| 0 | 26 |
| 27 #ifndef _SDL_H | |
| 28 #define _SDL_H | |
| 29 | |
|
1423
4ed717f9e509
Updated for Visual Studio Express 2005
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
30 #include "SDL_main.h" |
|
1353
7ba544e2888d
Started the process of improving configure support, and merging C types
Sam Lantinga <slouken@libsdl.org>
parents:
1335
diff
changeset
|
31 #include "SDL_stdinc.h" |
| 0 | 32 #include "SDL_audio.h" |
| 33 #include "SDL_cdrom.h" | |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
34 #include "SDL_cpuinfo.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
35 #include "SDL_endian.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
36 #include "SDL_error.h" |
| 0 | 37 #include "SDL_events.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
38 #include "SDL_loadso.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
39 #include "SDL_mutex.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
40 #include "SDL_rwops.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
41 #include "SDL_thread.h" |
|
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
42 #include "SDL_timer.h" |
| 0 | 43 #include "SDL_video.h" |
| 44 #include "SDL_version.h" | |
| 45 | |
| 46 #include "begin_code.h" | |
| 47 /* Set up for C function definitions, even when using C++ */ | |
| 48 #ifdef __cplusplus | |
| 49 extern "C" { | |
| 50 #endif | |
| 51 | |
| 4217 | 52 /** @file SDL.h |
| 53 * @note As of version 0.5, SDL is loaded dynamically into the application | |
| 54 */ | |
| 0 | 55 |
| 4217 | 56 /** @name SDL_INIT Flags |
| 57 * These are the flags which may be passed to SDL_Init() -- you should | |
| 58 * specify the subsystems which you will be using in your application. | |
| 59 */ | |
| 60 /*@{*/ | |
| 0 | 61 #define SDL_INIT_TIMER 0x00000001 |
| 62 #define SDL_INIT_AUDIO 0x00000010 | |
| 63 #define SDL_INIT_VIDEO 0x00000020 | |
| 64 #define SDL_INIT_CDROM 0x00000100 | |
| 65 #define SDL_INIT_JOYSTICK 0x00000200 | |
| 4217 | 66 #define SDL_INIT_NOPARACHUTE 0x00100000 /**< Don't catch fatal signals */ |
| 67 #define SDL_INIT_EVENTTHREAD 0x01000000 /**< Not supported on all OS's */ | |
| 0 | 68 #define SDL_INIT_EVERYTHING 0x0000FFFF |
| 4217 | 69 /*@}*/ |
| 0 | 70 |
| 4217 | 71 /** This function loads the SDL dynamically linked library and initializes |
| 72 * the subsystems specified by 'flags' (and those satisfying dependencies) | |
| 73 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup | |
| 74 * signal handlers for some commonly ignored fatal signals (like SIGSEGV) | |
| 0 | 75 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
76 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); |
| 0 | 77 |
| 4217 | 78 /** This function initializes specific SDL subsystems */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
79 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); |
| 0 | 80 |
| 4217 | 81 /** This function cleans up specific SDL subsystems */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
82 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); |
| 0 | 83 |
| 4217 | 84 /** This function returns mask of the specified subsystems which have |
| 85 * been initialized. | |
| 86 * If 'flags' is 0, it returns a mask of all initialized subsystems. | |
| 87 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
88 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); |
| 0 | 89 |
| 4217 | 90 /** This function cleans up all initialized subsystems and unloads the |
| 91 * dynamically linked library. You should call it upon all exit conditions. | |
| 0 | 92 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
93 extern DECLSPEC void SDLCALL SDL_Quit(void); |
| 0 | 94 |
| 95 /* Ends C function definitions when using C++ */ | |
| 96 #ifdef __cplusplus | |
| 97 } | |
| 98 #endif | |
| 99 #include "close_code.h" | |
| 100 | |
| 101 #endif /* _SDL_H */ |