SDL-mirror/docs/man3/SDL_JoystickGetBall.3
Sam Lantinga f037300cd2 Erik Heckers fixed bug #493
Searching the installed man pages for SDL functions fails, e.g.
  man -k SDL_ |grep Video
After investigating this I found that "makewhatis", the tool that generates
the "whatis" database, reads the SDL_* man pages, but doesn't produce
entries in the "whatis" database for the SDL_* man pages.
After some more debugging I found the reason is a missing space.
After editing SDL_Init.3(.gz) and replacing
   SDL_Init\- Initializes SDL
with
   SDL_Init \- Initializes SDL
everything works fine.
After running "makewhatis" I can successfully do a
   man -k SDL_
and SDL_Init is listed in the output.

--HG--
branch : SDL-1.2
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%402660
2007-12-29 02:34:53 +00:00

37 lines
957 B
Groff

.TH "SDL_JoystickGetBall" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickGetBall \- Get relative trackball motion
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_JoystickGetBall\fP\fR(\fBSDL_Joystick *joystick, int ball, int *dx, int *dy\fR);
.SH "DESCRIPTION"
.PP
Get the \fBball\fR axis change\&.
.PP
Trackballs can only return relative motion since the last call to \fBSDL_JoystickGetBall\fP, these motion deltas a placed into \fBdx\fR and \fBdy\fR\&.
.SH "RETURN VALUE"
.PP
Returns \fB0\fR on success or \fB-1\fR on failure
.SH "EXAMPLES"
.PP
.PP
.nf
\f(CWint delta_x, delta_y;
SDL_Joystick *joy;
\&.
\&.
\&.
SDL_JoystickUpdate();
if(SDL_JoystickGetBall(joy, 0, &delta_x, &delta_y)==-1)
printf("TrackBall Read Error!
");
printf("Trackball Delta- X:%d, Y:%d
", delta_x, delta_y);\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickNumBalls\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00