Penguin

SDL_!MouseButtonEvent?

SDL_!MouseButtonEvent?

NAME STRUCTURE DEFINITION STRUCTURE DATA DESCRIPTION SEE ALSO


NAME

SDL_!MouseButtonEvent?- Mouse button event structure

STRUCTURE DEFINITION

typedef struct{ Uint8 type; Uint8 button; Uint8 state; Uint16 x, y; } SDL_!MouseButtonEvent?;

STRUCTURE DATA

type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP

button The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT)

state SDL_PRESSED or SDL_RELEASED

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

DESCRIPTION

SDL_!MouseButtonEvent? is a member of the SDL_Event union and is used when an event of type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP is reported.

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 button, the position of the mouse when this event occured is stored in the x and the y fields. Like SDL_!KeyboardEvent?, information on whether the event was a press or a release event is stored in both the type and state fields, but this should be obvious.

SEE ALSO

SDL_Event, SDL_!MouseMotionEvent?


This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.