| 1 | .TH "SDL_MouseButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
| 2 | .SH "NAME" |
| 3 | SDL_MouseButtonEvent \- Mouse button event structure |
| 4 | .SH "STRUCTURE DEFINITION" |
| 5 | .PP |
| 6 | .nf |
| 7 | \f(CWtypedef struct{ |
| 8 | Uint8 type; |
| 9 | Uint8 button; |
| 10 | Uint8 state; |
| 11 | Uint16 x, y; |
| 12 | } SDL_MouseButtonEvent;\fR |
| 13 | .fi |
| 14 | .PP |
| 15 | .SH "STRUCTURE DATA" |
| 16 | .TP 20 |
| 17 | \fBtype\fR |
| 18 | \fBSDL_MOUSEBUTTONDOWN\fP or \fBSDL_MOUSEBUTTONUP\fP |
| 19 | .TP 20 |
| 20 | \fBbutton\fR |
| 21 | The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT) |
| 22 | .TP 20 |
| 23 | \fBstate\fR |
| 24 | \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP |
| 25 | .TP 20 |
| 26 | \fBx\fR, \fBy\fR |
| 27 | The X/Y coordinates of the mouse at press/release time |
| 28 | .SH "DESCRIPTION" |
| 29 | .PP |
| 30 | \fBSDL_MouseButtonEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_MOUSEBUTTONDOWN\fP or \fBSDL_MOUSEBUTTONUP\fP is reported\&. |
| 31 | .PP |
| 32 | When a mouse button press or release is detected then number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into \fBbutton\fR, the position of the mouse when this event occured is stored in the \fBx\fR and the \fBy\fR fields\&. Like \fI\fBSDL_KeyboardEvent\fR\fR, information on whether the event was a press or a release event is stored in both the \fBtype\fR and \fBstate\fR fields, but this should be obvious\&. |
| 33 | .SH "SEE ALSO" |
| 34 | .PP |
| 35 | \fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseMotionEvent\fR\fR |
| 36 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |