Work around MinGW mangling of "host:/path"
[msysgit/historical-msysgit.git] / mingw / man / man3 / SDL_JoystickOpen.3
blob3a58fee61edf068d6749c4687bf6fd825a645c06
1 .TH "SDL_JoystickOpen" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_JoystickOpen\- Opens a joystick for use\&.
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBSDL_Joystick *\fBSDL_JoystickOpen\fP\fR(\fBint index\fR);
9 .SH "DESCRIPTION"
10 .PP
11 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\&.
12 .SH "RETURN VALUE"
13 .PP
14 Returns a \fBSDL_Joystick\fR structure on success\&. \fBNULL\fR on failure\&.
15 .SH "EXAMPLES"
16 .PP
17 .PP
18 .nf
19 \f(CWSDL_Joystick *joy;
20 // Check for joystick
21 if(SDL_NumJoysticks()>0){
22   // Open joystick
23   joy=SDL_JoystickOpen(0);
24   
25   if(joy)
26   {
27     printf("Opened Joystick 0
28 ");
29     printf("Name: %s
30 ", SDL_JoystickName(0));
31     printf("Number of Axes: %d
32 ", SDL_JoystickNumAxes(joy));
33     printf("Number of Buttons: %d
34 ", SDL_JoystickNumButtons(joy));
35     printf("Number of Balls: %d
36 ", SDL_JoystickNumBalls(joy));
37   }
38   else
39     printf("Couldn\&'t open Joystick 0
40 ");
41   
42   // Close if opened
43   if(SDL_JoystickOpened(0))
44     SDL_JoystickClose(joy);
45 }\fR
46 .fi
47 .PP
48 .SH "SEE ALSO"
49 .PP
50 \fI\fBSDL_JoystickClose\fP\fR
51 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00