Mercurial > sdl-ios-xcode

comparison include/SDL.h @ 3407:d3baf5ac4e37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents c02af6912b3c
children c5925cd41955
comparison
equal deleted inserted replaced
3406:8ae607392409 3407:d3baf5ac4e37
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22 22
23 /** 23 /**
24 * \file SDL.h 24 * \file SDL.h
25 * 25 *
26 * Main include header for the SDL library 26 * Main include header for the SDL library
27 */ 27 */
28
28 /** 29 /**
29 * \mainpage Simple DirectMedia Layer (SDL) 30 * \mainpage Simple DirectMedia Layer (SDL)
30 31 *
31 http://www.libsdl.org/ 32 * http://www.libsdl.org/
32 33 *
33 * \section intro_sec Introduction 34 * \section intro_sec Introduction
34 35 *
35 This is the Simple DirectMedia Layer, a general API that provides low 36 * 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 * level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
37 and 2D framebuffer across multiple platforms. 38 * and 2D framebuffer across multiple platforms.
38 39 *
39 The current version supports Linux, Windows, Windows CE, BeOS, MacOS, 40 * The current version supports Linux, Windows, Windows CE, BeOS, MacOS,
40 Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX. 41 * Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX.
41 The code contains support for AIX, OSF/Tru64, RISC OS, and SymbianOS, 42 * The code contains support for AIX, OSF/Tru64, RISC OS, and SymbianOS,
42 but these are not officially supported. 43 * but these are not officially supported.
43 44 *
44 SDL is written in C, but works with C++ natively, and has bindings to 45 * 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 * several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
46 Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP, 47 * Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
47 Pike, Pliant, Python, Ruby, and Smalltalk. 48 * Pike, Pliant, Python, Ruby, and Smalltalk.
48 49 *
49 This library is distributed under GNU LGPL version 2, which can be 50 * 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 * 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 52 * freely in commercial programs as long as you link with the dynamic
52 library. 53 * library.
53 54 *
54 The best way to learn how to use SDL is to check out the header files in 55 * 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 "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 * 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 * More documentation is available in HTML format in "docs/index.html", and
58 a documentation wiki is available online at: 59 * a documentation wiki is available online at:
59 http://www.libsdl.org/cgi/docwiki.cgi 60 * http://www.libsdl.org/cgi/docwiki.cgi
60 61 *
61 The test programs in the "test" subdirectory are in the public domain. 62 * The test programs in the "test" subdirectory are in the public domain.
62 63 *
63 Frequently asked questions are answered online: 64 * Frequently asked questions are answered online:
64 http://www.libsdl.org/faq.php 65 * http://www.libsdl.org/faq.php
65 66 *
66 If you need help with the library, or just want to discuss SDL related 67 * If you need help with the library, or just want to discuss SDL related
67 issues, you can join the developers mailing list: 68 * issues, you can join the developers mailing list:
68 http://www.libsdl.org/mailing-list.php 69 * http://www.libsdl.org/mailing-list.php
69 70 *
70 Enjoy! 71 * Enjoy!
71 Sam Lantinga (slouken@libsdl.org) 72 * Sam Lantinga (slouken@libsdl.org)
72 */ 73 */
73 74
74 #ifndef _SDL_H 75 #ifndef _SDL_H
75 #define _SDL_H 76 #define _SDL_H
76 77
100 /* *INDENT-ON* */ 101 /* *INDENT-ON* */
101 #endif 102 #endif
102 103
103 /* As of version 0.5, SDL is loaded dynamically into the application */ 104 /* As of version 0.5, SDL is loaded dynamically into the application */
104 105
105 /* These are the flags which may be passed to SDL_Init() -- you should 106 /**
106 specify the subsystems which you will be using in your application. 107 * \name SDL_INIT_*
107 */ 108 *
109 * These are the flags which may be passed to SDL_Init(). You should
110 * specify the subsystems which you will be using in your application.
111 */
112 /*@{*/
108 #define SDL_INIT_TIMER 0x00000001 113 #define SDL_INIT_TIMER 0x00000001
109 #define SDL_INIT_AUDIO 0x00000010 114 #define SDL_INIT_AUDIO 0x00000010
110 #define SDL_INIT_VIDEO 0x00000020 115 #define SDL_INIT_VIDEO 0x00000020
111 #define SDL_INIT_JOYSTICK 0x00000200 116 #define SDL_INIT_JOYSTICK 0x00000200
112 #define SDL_INIT_HAPTIC 0x00001000 117 #define SDL_INIT_HAPTIC 0x00001000
113 #define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */ 118 #define SDL_INIT_NOPARACHUTE 0x00100000 /**< Don't catch fatal signals */
114 #define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */ 119 #define SDL_INIT_EVENTTHREAD 0x01000000 /**< Not supported on all OS's */
115 #define SDL_INIT_EVERYTHING 0x0000FFFF 120 #define SDL_INIT_EVERYTHING 0x0000FFFF
121 /*@}*/
116 122
117 /** 123 /**
118 * This function loads the SDL dynamically linked library and initializes 124 * This function loads the SDL dynamically linked library and initializes
119 * the subsystems specified by 'flags' (and those satisfying dependencies) 125 * the subsystems specified by \c flags (and those satisfying dependencies).
120 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup 126 * Unless the ::SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
121 * signal handlers for some commonly ignored fatal signals (like SIGSEGV) 127 * signal handlers for some commonly ignored fatal signals (like SIGSEGV).
122 */ 128 */
123 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); 129 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
124 130
125 /** 131 /**
126 * This function initializes specific SDL subsystems 132 * This function initializes specific SDL subsystems
127 */ 133 */
128 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); 134 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
129 135
130 /** This function cleans up specific SDL subsystems */ 136 /**
137 * This function cleans up specific SDL subsystems
138 */
131 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); 139 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
132 140
133 /** 141 /**
134 This function returns mask of the specified subsystems which have 142 * This function returns mask of the specified subsystems which have
135 been initialized. 143 * been initialized.
136 If 'flags' is 0, it returns a mask of all initialized subsystems. 144 *
137 */ 145 * If \c flags is 0, it returns a mask of all initialized subsystems.
146 */
138 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); 147 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
139 148
140 /** 149 /**
141 * This function cleans up all initialized subsystems and unloads the 150 * This function cleans up all initialized subsystems and unloads the
142 * dynamically linked library. You should call it upon all exit conditions. 151 * dynamically linked library. You should call it upon all exit conditions.
143 */ 152 */
144 extern DECLSPEC void SDLCALL SDL_Quit(void); 153 extern DECLSPEC void SDLCALL SDL_Quit(void);
145 154
146 /* Ends C function definitions when using C++ */ 155 /* Ends C function definitions when using C++ */
147 #ifdef __cplusplus 156 #ifdef __cplusplus