mirror of
https://github.com/joel16/SDL2.git
synced 2024-12-13 22:38:34 +00:00
37 lines
1.3 KiB
Groff
37 lines
1.3 KiB
Groff
.TH "SDL_JoyButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
|
|
.SH "NAME"
|
|
SDL_JoyButtonEvent\- Joystick button event structure
|
|
.SH "STRUCTURE DEFINITION"
|
|
.PP
|
|
.nf
|
|
\f(CWtypedef struct{
|
|
Uint8 type;
|
|
Uint8 which;
|
|
Uint8 button;
|
|
Uint8 state;
|
|
} SDL_JoyButtonEvent;\fR
|
|
.fi
|
|
.PP
|
|
.SH "STRUCTURE DATA"
|
|
.TP 20
|
|
\fBtype\fR
|
|
\fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP
|
|
.TP 20
|
|
\fBwhich\fR
|
|
Joystick device index
|
|
.TP 20
|
|
\fBbutton\fR
|
|
Joystick button index
|
|
.TP 20
|
|
\fBstate\fR
|
|
\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBSDL_JoyButtonEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP is reported\&.
|
|
.PP
|
|
A \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP event occurs when ever a user presses or releases a button on a joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBbutton\fR is the index of the button (for a more detailed explaination see the \fIJoystick section\fR)\&. \fBstate\fR is the current state or the button which is either \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP\&.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetButton\fP\fR
|
|
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59
|