Wiki Page Content

Revision 4 as of 2010-08-13 03:29:58

Clear message

DRAFT

SDL_GetMouseState

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

Contents

  1. SDL_GetMouseState
    1. Syntax
    2. Function Parameters
    3. Return Value
    4. Code Examples
    5. Remarks
    6. Related Functions

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

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