dolphin-emulator/Externals/SDL/docs/man3/SDL_JoyBallEvent.3
Soren Jorvang 2db54798d7 Import SDL 1.2.14 and GLEW 1.5.4.
I am not replacing the following header files used by the Windows build,
as I don't have a Windows build setup to test. Please point the Windows
build at the header files inside these clean distribution packages and
garbage collect the duplicates: GLew/*.h and SDL/Include_1.2.


git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@5711 8ced0084-cf51-0410-be5f-012b33b47a6e
2010-06-15 23:31:13 +00:00

36 lines
1.3 KiB
Groff

.TH "SDL_JoyBallEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoyBallEvent \- Joystick trackball motion event structure
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
Uint8 type;
Uint8 which;
Uint8 ball;
Sint16 xrel, yrel;
} SDL_JoyBallEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_JOYBALLMOTION\fP
.TP 20
\fBwhich\fR
Joystick device index
.TP 20
\fBball\fR
Joystick trackball index
.TP 20
\fBxrel\fR, \fByrel\fR
The relative motion in the X/Y direction
.SH "DESCRIPTION"
.PP
\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\&.
.PP
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\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetBall\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59