.TH "SDL_MouseButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"

.SH "NAME"

SDL_MouseButtonEvent\- Mouse button event structure

.SH "STRUCTURE DEFINITION"

.PP

.nf

\f(CWtypedef struct{

Uint8 type;

Uint8 button;

Uint8 state;

Uint16 x, y;

} SDL_MouseButtonEvent;\fR

.fi

.PP

.SH "STRUCTURE DATA"

.TP 20

\fBtype\fR

\fBSDL_MOUSEBUTTONDOWN\fP or \fBSDL_MOUSEBUTTONUP\fP

.TP 20

\fBbutton\fR

The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT)

.TP 20

\fBstate\fR

\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP

.TP 20

\fBx\fR, \fBy\fR

The X/Y coordinates of the mouse at press/release time

.SH "DESCRIPTION"

.PP

\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\&.

.PP

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\&.

.SH "SEE ALSO"

.PP

\fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseMotionEvent\fR\fR

...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59