Mercurial > sdl-ios-xcode
view docs/html/sdlinit.html @ 4928:930614179450 SDL-1.2
Patch from Haiku's Google Code-In student Daniel Marth, fixes an off-by-one issue in bwindow.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 03 Dec 2010 16:55:25 -0800 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_Init</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ "><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 SUMMARY="Header navigation 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" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlinitsubsystem.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLINIT" ></A >SDL_Init</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN440" ></A ><H2 >Name</H2 >SDL_Init -- Initializes SDL</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN443" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN444" ></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="AEN450" ></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="AEN454" ></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" > </TD ></TR ></TBODY ></TABLE ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN494" ></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="AEN499" ></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 SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="general.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlinitsubsystem.html" ACCESSKEY="N" >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" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_InitSubSystem</TD ></TR ></TABLE ></DIV ></BODY ></HTML >