|
Size: 2018
Comment: add RE
|
Size: 1999
Comment: update content - w/ Sam (in progress)
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| A structure that contains mouse button event ,,structure,, ^information^ ,,(event.button.*),,. | A structure that contains mouse button event information. |
| Line 13: | Line 13: |
| ||Uint8||'''button'''||the mouse button index|| | ||Uint8||'''button'''||the index of the button that reported the event|| |
| Line 15: | Line 15: |
| ||Uint8||'''padding1'''||^8 empty bits to total 32^???|| ||Uint8||'''padding2'''||^8 empty bits to total 32^???|| |
|
| Line 26: | Line 24: |
| *[[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. | [[SDL_MouseButtonEvent]] is a member of the [[SDL_Event]] structure and is used when an event of type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP is reported. |
| Line 28: | Line 26: |
| When a mouse button press or release is detected the 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,,. | An SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP event occurs whenever a user presses a button on a mouse. When a mouse button press or release is detected the 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 occurred 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,,. |
DRAFT |
SDL_MouseButtonEvent
A structure that contains mouse button event information.
Contents
Data Fields
Uint32 |
type |
SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP |
Uint32 |
windowID |
the window with mouse focus, if any |
Uint8 |
button |
the index of the button that reported the event |
Uint8 |
state |
SDL_PRESSED or SDL_RELEASED |
int |
x |
X coordinate, relative to window |
int |
y |
Y coordinate, relative to window |
Code Examples
You can add your code example here
Remarks
SDL_MouseButtonEvent is a member of the SDL_Event structure and is used when an event of type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP is reported.
An SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP event occurs whenever a user presses a button on a mouse.
When a mouse button press or release is detected the 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 occurred 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.
Mouse wheel events are reported as buttons 4 (up) and 5 (down). Two events are generated i.e. you get an SDL_MOUSEBUTTONDOWN followed by an SDL_MOUSEBUTTONUP event.* green
Related Enumerations
Related Structures
