Mercurial > sdl-ios-xcode

view docs/man3/SDL_Init.3 @ 2866:e532417a6977

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed SDL 1.2 compatibility problem. The API specifies that SDL_OpenAudio() will fill out the 'desired' audio spec with the correct samples and size set by the driver. This value is important since it may be used by applications that size audio buffers, etc. However, we want to allow advanced applications to call SDL_OpenAudioDevice() which gets passed a const 'desired' parameter, and have the correct data filled into the 'obtained' parameter, possibly allowing or not allowing format changes. So... 'obtained' becomes the audio format the user callback is expected to use, and we add flags to allow the application to specify which format changes are allowed. Note: We really need to add a way to query the 'obtained' audio spec.
author Sam Lantinga <slouken@libsdl.org>
date Sat, 13 Dec 2008 06:36:47 +0000
parents 546f7c1eb755
children 1238da4a7112
line wrap: on
line source

.TH "SDL_Init" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_Init \- Initializes SDL
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_Init\fP\fR(\fBUint32 flags\fR);
.SH "DESCRIPTION"
.PP
Initializes SDL\&. This should be called before all other SDL functions\&. The \fBflags\fR parameter specifies what part(s) of SDL to initialize\&.
.TP 20
\fBSDL_INIT_TIMER\fP
Initializes the \fItimer\fR subsystem\&.
.TP 20
\fBSDL_INIT_AUDIO\fP
Initializes the \fIaudio\fR subsystem\&.
.TP 20
\fBSDL_INIT_VIDEO\fP
Initializes the \fIvideo\fR subsystem\&.
.TP 20
\fBSDL_INIT_CDROM\fP
Initializes the \fIcdrom\fR subsystem\&.
.TP 20
\fBSDL_INIT_JOYSTICK\fP
Initializes the \fIjoystick\fR subsystem\&.
.TP 20
\fBSDL_INIT_EVERYTHING\fP
Initialize all of the above\&.
.TP 20
\fBSDL_INIT_NOPARACHUTE\fP
Prevents SDL from catching fatal signals\&.
.TP 20
\fBSDL_INIT_EVENTTHREAD\fP
.SH "RETURN VALUE"
.PP
Returns \fB-1\fR on an error or \fB0\fR on success\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Quit\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00