Wiki Page Content

Differences between revisions 3 and 4
Revision 3 as of 2010-03-11 21:16:36
Size: 1130
Editor: SheenaSmith
Comment:
Revision 4 as of 2010-08-13 03:29:58
Size: 1284
Editor: SheenaSmith
Comment: update content - changeset 4465
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
Use this function to retrieve the current state of the specified mouse. Use this function to retrieve the current state of the mouse.
Line 17: Line 17:
||'''x'''||the x coordinate of the mouse cursor position||
||'''y'''||the y coordinate of the mouse cursor position||
||'''x'''||^the x coordinate of the mouse cursor position relative to the focus window^||
||'''y'''||^the y coordinate of the mouse cursor position relative to the focus window^||
Line 29: Line 29:
The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, 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'''. The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and '''x''' and '''y''' are set to the mouse cursor position relative to the focus window for the current,,ly selected,, mouse. You can pass NULL for either '''x''' or '''y'''.

<<Color2(green,Should the first sentence be split into two? Should the subscripted portion be removed to reflect the lack of multi-mouse support?)>>
Line 32: Line 34:
 .[[SDL_GetRelativeMouseState]]??? ''because it does essentially the same thing differently''  .[[SDL_GetRelativeMouseState]] ???

DRAFT

SDL_GetMouseState

Use this function to retrieve the current state of the mouse.

Syntax

Uint8 SDL_GetMouseState(int* x,
                        int* y)

Function Parameters

x

the x coordinate of the mouse cursor position relative to the focus window

y

the y coordinate of the mouse cursor position relative to the focus window

Return Value

Returns an 8 bit button bitmask of the current button state. ???

Code Examples

You can add your code example here

Remarks

The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, 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.

green


CategoryAPI, CategoryMouse

None: SDL_GetMouseState (last edited 2016-11-28 21:41:43 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit