Return Value

Code Examples

Remarks

The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros (where X is generally 1 for the left, 2 for middle, 3 for the right button), and x and y are set to the mouse cursor position relative to the focus window for the currently selected mouse. You can pass NULL for either x or y.

Suggest splitting the first sentence into two. Should the subscripted portion be removed to reflect the lack of multi-mouse support?