diff docs/man3/SDL_Init.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_Init.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,41 @@
+.TH "SDL_Init" "3" "Mon 12 Mar 2001, 01:03" "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, Mon 12 Mar 2001, 01:03