Mercurial > sdl-ios-xcode
view docs/html/sdljoystickopen.html @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Sun, 10 Jun 2001 19:31:57 +0000 |
parents | 74212992fb08 |
children | e5bc29de3f0a |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_JoystickOpen</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.64 "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Joystick" HREF="joystick.html"><LINK REL="PREVIOUS" TITLE="SDL_JoystickName" HREF="sdljoystickname.html"><LINK REL="NEXT" TITLE="SDL_JoystickOpened" HREF="sdljoystickopened.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="sdljoystickname.html" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdljoystickopened.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLJOYSTICKOPEN" >SDL_JoystickOpen</A ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN5549" ></A ><H2 >Name</H2 >SDL_JoystickOpen -- Opens a joystick for use.</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN5552" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN5553" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >SDL_Joystick *<B CLASS="FSFUNC" >SDL_JoystickOpen</B ></CODE >(int index);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5559" ></A ><H2 >Description</H2 ><P >Opens a joystick for use within SDL. The <TT CLASS="PARAMETER" ><I >index</I ></TT > refers to the N'th joystick in the system. A joystick must be opened before it game be used.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5563" ></A ><H2 >Return Value</H2 ><P >Returns a <SPAN CLASS="STRUCTNAME" >SDL_Joystick</SPAN > structure on success. <SPAN CLASS="RETURNVALUE" >NULL</SPAN > on failure.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5568" ></A ><H2 >Examples</H2 ><P ><PRE CLASS="PROGRAMLISTING" >SDL_Joystick *joy; // Check for joystick if(SDL_NumJoysticks()>0){ // Open joystick joy=SDL_JoystickOpen(0); if(joy) { printf("Opened Joystick 0\n"); printf("Name: %s\n", SDL_JoystickName(0)); printf("Number of Axes: %s\n", SDL_JoystickNumAxes(joy)); printf("Number of Buttons: %s\n", SDL_JoystickNumButtons(joy)); printf("Number of Balls: %s\n", SDL_JoystickNumBalls(joy)); } else printf("Couldn't open Joystick 0\n"); // Close if opened if(SDL_JoystickOpened(0)) SDL_JoystickClose(joy); }</PRE ></P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5572" ></A ><H2 >See Also</H2 ><P ><A HREF="sdljoystickclose.html" ><TT CLASS="FUNCTION" >SDL_JoystickClose</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="sdljoystickname.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="sdljoystickopened.html" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_JoystickName</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="joystick.html" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_JoystickOpened</TD ></TR ></TABLE ></DIV ></BODY ></HTML >