Mercurial > sdl-ios-xcode

comparison include/SDL.h @ 3348:c02af6912b3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Eric Wing to Sam Also noticed the SDL.h header in 1.3 didn't have the /** for the methods while testing. Attached is a quick fix patch.
author Sam Lantinga <slouken@libsdl.org>
date Tue, 06 Oct 2009 03:34:10 +0000
parents 1ed5d432e468
children d3baf5ac4e37
comparison
equal deleted inserted replaced
3347:0dc3d85ce0ac 3348:c02af6912b3c
112 #define SDL_INIT_HAPTIC 0x00001000 112 #define SDL_INIT_HAPTIC 0x00001000
113 #define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */ 113 #define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */
114 #define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */ 114 #define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */
115 #define SDL_INIT_EVERYTHING 0x0000FFFF 115 #define SDL_INIT_EVERYTHING 0x0000FFFF
116 116
117 /* This function loads the SDL dynamically linked library and initializes 117 /**
118 * This function loads the SDL dynamically linked library and initializes
118 * the subsystems specified by 'flags' (and those satisfying dependencies) 119 * the subsystems specified by 'flags' (and those satisfying dependencies)
119 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup 120 * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
120 * signal handlers for some commonly ignored fatal signals (like SIGSEGV) 121 * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
121 */ 122 */
122 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); 123 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
123 124
124 /* This function initializes specific SDL subsystems */ 125 /**
126 * This function initializes specific SDL subsystems
127 */
125 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); 128 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
126 129
127 /* This function cleans up specific SDL subsystems */ 130 /** This function cleans up specific SDL subsystems */
128 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); 131 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
129 132
130 /* This function returns mask of the specified subsystems which have 133 /**
134 This function returns mask of the specified subsystems which have
131 been initialized. 135 been initialized.
132 If 'flags' is 0, it returns a mask of all initialized subsystems. 136 If 'flags' is 0, it returns a mask of all initialized subsystems.
133 */ 137 */
134 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); 138 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
135 139
136 /* This function cleans up all initialized subsystems and unloads the 140 /**
141 * This function cleans up all initialized subsystems and unloads the
137 * dynamically linked library. You should call it upon all exit conditions. 142 * dynamically linked library. You should call it upon all exit conditions.
138 */ 143 */
139 extern DECLSPEC void SDLCALL SDL_Quit(void); 144 extern DECLSPEC void SDLCALL SDL_Quit(void);
140 145
141 /* Ends C function definitions when using C++ */ 146 /* Ends C function definitions when using C++ */