comparison docs/man3/SDL_JoyBallEvent.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 .TH "SDL_JoyBallEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference"
2 .SH "NAME"
3 SDL_JoyBallEvent\- Joystick trackball motion event structure
4 .SH "STRUCTURE DEFINITION"
5 .PP
6 .nf
7 \f(CWtypedef struct{
8 Uint8 type;
9 Uint8 which;
10 Uint8 ball;
11 Sint16 xrel, yrel;
12 } SDL_JoyBallEvent;\fR
13 .fi
14 .PP
15 .SH "STRUCTURE DATA"
16 .TP 20
17 \fBtype\fR
18 \fBSDL_JOYBALLMOTION\fP
19 .TP 20
20 \fBwhich\fR
21 Joystick device index
22 .TP 20
23 \fBball\fR
24 Joystick trackball index
25 .TP 20
26 \fBxrel\fR, \fByrel\fR
27 The relative motion in the X/Y direction
28 .SH "DESCRIPTION"
29 .PP
30 \fBSDL_JoyBallEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYBALLMOTION\fP is reported\&.
31 .PP
32 A \fBSDL_JOYBALLMOTION\fP event occurs when a user moves a trackball on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBball\fR is the index of the trackball (for a more detailed explaination see the \fIJoystick section\fR)\&. Trackballs only return relative motion, this is the change in position on the ball since it was last polled (last cycle of the event loop) and it is stored in \fBxrel\fR and \fByrel\fR\&.
33 .SH "SEE ALSO"
34 .PP
35 \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetBall\fP\fR
36 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03