|
Size: 3489
Comment:
|
Size: 3546
Comment: formatting update
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| #pragma section-numbers off | |
| Line 4: | Line 5: |
| `SDL_Init` initializes the SDL library. This must be called before using any other SDL function. | Initializes the SDL library. This must be called before using any other SDL function. |
| Line 6: | Line 7: |
| <<TableOfContents(3)>> | <<TableOfContents()>> |
| Line 10: | Line 11: |
| #include "SDL.h" |
|
| Line 19: | Line 18: |
| ||SDL_INIT_TIMER||Initialize timer subsystem|| ||SDL_INIT_AUDIO||Initialize audio subsystem|| ||SDL_INIT_VIDEO||Initialize video subsystem|| ||SDL_INIT_CDROM||Initialize CD-ROM subsystem|| ||SDL_INIT_JOYSTICK||Initialize joystick subsystem|| ||SDL_INIT_HAPTIC||Initialize haptic (force feedback) subsystem|| ||SDL_INIT_EVERYTHING||Initialize all of the above subsystems|| ||SDL_INIT_NOPARACHUTE||Don't catch fatal signals|| ||SDL_INIT_EVENTTHREAD||Run the event loop in a separate thread (not supported by all OSs)|| |
||'''SDL_INIT_TIMER'''||initialize timer subsystem|| ||'''SDL_INIT_AUDIO'''||initialize audio subsystem|| ||'''SDL_INIT_VIDEO'''||initialize video subsystem|| ||'''SDL_INIT_CDROM'''||initialize CD-ROM subsystem|| ||'''SDL_INIT_JOYSTICK'''||initialize joystick subsystem|| ||'''SDL_INIT_HAPTIC'''||initialize haptic (force feedback) subsystem|| ||'''SDL_INIT_EVERYTHING'''||initialize all of the above subsystems|| ||'''SDL_INIT_NOPARACHUTE'''||don't catch fatal signals|| ||'''SDL_INIT_EVENTTHREAD'''||run the event loop in a separate thread (not supported by all OSs)|| |
| Line 30: | Line 29: |
| Returns `0` if successful, `-1` otherwise. | Returns 0 if successful, -1 otherwise. |
| Line 129: | Line 128: |
| [[SDL_InitSubSystem]], [[SDL_WasInit]], [[SDL_Quit]] | [[SDL_InitSubSystem]] [[SDL_WasInit]] [[SDL_Quit]] |
| Line 132: | Line 133: |
| [[CategoryAPI]] [[CategoryAPIInitialization]] |
[[CategoryAPI]] [[CategoryAPIInitialization]] |
SDL_Init
Initializes the SDL library. This must be called before using any other SDL function.
Contents
Syntax
int SDL_Init (Uint32 flags);
Function Parameters
These are the flags which may be passed to SDL_Init() -- you should specify the subsystems which you will be using in your application:
SDL_INIT_TIMER |
initialize timer subsystem |
SDL_INIT_AUDIO |
initialize audio subsystem |
SDL_INIT_VIDEO |
initialize video subsystem |
SDL_INIT_CDROM |
initialize CD-ROM subsystem |
SDL_INIT_JOYSTICK |
initialize joystick subsystem |
SDL_INIT_HAPTIC |
initialize haptic (force feedback) subsystem |
SDL_INIT_EVERYTHING |
initialize all of the above subsystems |
SDL_INIT_NOPARACHUTE |
don't catch fatal signals |
SDL_INIT_EVENTTHREAD |
run the event loop in a separate thread (not supported by all OSs) |
Return Value
Returns 0 if successful, -1 otherwise.
If this function fails, you can usually get an error message through SDL_GetError, but not always. Specifically, if pth_init() fails, no error message is set.
Code Examples
C
#include "SDL.h"
int main(int, char**) {
if (SDL_Init(SDL_INIT_VIDEO|SDL_INIT_TIMER) != 0) {
fprintf(stderr,
"\nUnable to initialize SDL: %s\n",
SDL_GetError()
);
return 1;
}
atexit(SDL_Quit);
/* ... */
return 0;
}
C++
#include <exception>
#include <string>
#include "SDL.h"
class InitError: public std::exception {
public:
InitError();
InitError(const std::string&);
virtual ~InitError() throw();
virtual const char* what() const throw();
private:
std::string msg;
};
InitError::InitError():
exception(), msg(SDL_GetError()) {}
InitError::InitError(const std::string& m):
exception(), msg(m) {}
InitError::~InitError() throw() {}
const char* InitError::what() const throw() {
return msg.c_str();
}
class SDL {
public:
SDL(Uint32 flags = 0) throw(InitError);
virtual ~SDL();
};
SDL::SDL(Uint32 flags) throw(InitError) {
if (SDL_Init(flags) != 0)
throw InitError();
}
SDL::~SDL() {
SDL_Quit();
}
/* ... */
#include <iostream>
int main(int argc, char **argv) {
try {
SDL sdl(SDL_INIT_VIDEO|SDL_INIT_TIMER);
/* ... */
return 0;
}
catch (const InitError& err) {
std::cerr
<< "Error while initializing SDL: "
<< err.what() << std::endl;
}
return 1;
}
Remarks
This function loads the SDL dynamically linked library and initializes the subsystems specified by 'flags' (and those satisfying dependencies). Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup signal handlers for some commonly ignored fatal signals (like SIGSEGV).
You can call SDL_Init(0) or SDL_Init(SDL_INIT_NOPARACHUTE) to initialize SDL without initializing any subsystems.
Note that the event system is actually started by the video subsystem, so using SDL_INIT_EVENTTHREAD without SDL_INIT_VIDEO is pointless.
Related Functions
