Mercurial > sdl-ios-xcode
diff docs/man3/SDL_JoystickOpen.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_JoystickOpen.3 Thu Apr 26 16:45:43 2001 +0000 @@ -0,0 +1,51 @@ +.TH "SDL_JoystickOpen" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.SH "NAME" +SDL_JoystickOpen\- Opens a joystick for use\&. +.SH "SYNOPSIS" +.PP +\fB#include "SDL\&.h" +.sp +\fBSDL_Joystick *\fBSDL_JoystickOpen\fP\fR(\fBint index\fR); +.SH "DESCRIPTION" +.PP +Opens a joystick for use within SDL\&. The \fBindex\fR refers to the N\&'th joystick in the system\&. A joystick must be opened before it game be used\&. +.SH "RETURN VALUE" +.PP +Returns a \fBSDL_Joystick\fR structure on success\&. \fBNULL\fR on failure\&. +.SH "EXAMPLES" +.PP +.PP +.nf +\f(CWSDL_Joystick *joy; +// Check for joystick +if(SDL_NumJoysticks()>0){ + // Open joystick + joy=SDL_JoystickOpen(0); + + if(joy) + { + printf("Opened Joystick 0 +"); + printf("Name: %s +", SDL_JoystickName(0)); + printf("Number of Axes: %s +", SDL_JoystickNumAxes(joy)); + printf("Number of Buttons: %s +", SDL_JoystickNumButtons(joy)); + printf("Number of Balls: %s +", SDL_JoystickNumBalls(joy)); + } + else + printf("Couldn\&'t open Joystick 0 +"); + + // Close if opened + if(SDL_JoystickOpened(0)) + SDL_JoystickClose(joy); +}\fR +.fi +.PP +.SH "SEE ALSO" +.PP +\fI\fBSDL_JoystickClose\fP\fR +...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03