diff docs/html/sdlinit.html @ 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/html/sdlinit.html	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,360 @@
+<HTML
+><HEAD
+><TITLE
+>SDL_Init</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+"><LINK
+REL="HOME"
+TITLE="SDL Library Documentation"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="General"
+HREF="general.html"><LINK
+REL="PREVIOUS"
+TITLE="General"
+HREF="general.html"><LINK
+REL="NEXT"
+TITLE="SDL_InitSubSystem"
+HREF="sdlinitsubsystem.html"></HEAD
+><BODY
+CLASS="REFENTRY"
+BGCOLOR="#FFF8DC"
+TEXT="#000000"
+LINK="#0000ee"
+VLINK="#551a8b"
+ALINK="#ff0000"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>SDL Library Documentation</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="general.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="sdlinitsubsystem.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><H1
+><A
+NAME="SDLINIT"
+>SDL_Init</A
+></H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN401"
+></A
+><H2
+>Name</H2
+>SDL_Init&nbsp;--&nbsp;Initializes SDL</DIV
+><DIV
+CLASS="REFSYNOPSISDIV"
+><A
+NAME="AEN404"
+></A
+><H2
+>Synopsis</H2
+><DIV
+CLASS="FUNCSYNOPSIS"
+><A
+NAME="AEN405"
+></A
+><P
+></P
+><PRE
+CLASS="FUNCSYNOPSISINFO"
+>#include "SDL.h"</PRE
+><P
+><CODE
+><CODE
+CLASS="FUNCDEF"
+>int <B
+CLASS="FSFUNC"
+>SDL_Init</B
+></CODE
+>(Uint32 flags);</CODE
+></P
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN411"
+></A
+><H2
+>Description</H2
+><P
+>Initializes SDL. This should be called before all other SDL functions. The <TT
+CLASS="PARAMETER"
+><I
+>flags</I
+></TT
+> parameter specifies what part(s) of SDL to initialize.</P
+><DIV
+CLASS="INFORMALTABLE"
+><A
+NAME="AEN415"
+></A
+><P
+></P
+><TABLE
+BORDER="1"
+CLASS="CALSTABLE"
+><TBODY
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_TIMER</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initializes the <A
+HREF="time.html"
+>timer</A
+> subsystem.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_AUDIO</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initializes the <A
+HREF="audio.html"
+>audio</A
+> subsystem.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_VIDEO</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initializes the <A
+HREF="video.html"
+>video</A
+> subsystem.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_CDROM</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initializes the <A
+HREF="cdrom.html"
+>cdrom</A
+> subsystem.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_JOYSTICK</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initializes the <A
+HREF="joystick.html"
+>joystick</A
+> subsystem.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_EVERYTHING</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Initialize all of the above.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_NOPARACHUTE</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Prevents SDL from catching fatal signals.</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_INIT_EVENTTHREAD</TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>&nbsp;</TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN455"
+></A
+><H2
+>Return Value</H2
+><P
+>Returns <SPAN
+CLASS="RETURNVALUE"
+>-1</SPAN
+> on an error or <SPAN
+CLASS="RETURNVALUE"
+>0</SPAN
+> on success.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN460"
+></A
+><H2
+>See Also</H2
+><P
+><A
+HREF="sdlquit.html"
+><TT
+CLASS="FUNCTION"
+>SDL_Quit</TT
+></A
+>,
+<A
+HREF="sdlinitsubsystem.html"
+><TT
+CLASS="FUNCTION"
+>SDL_InitSubSystem</TT
+></A
+></P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="general.html"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="sdlinitsubsystem.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>General</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="general.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>SDL_InitSubSystem</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file