*  \file SDL_mouse.h

 *  

 *  Include file for SDL mouse event handling.

 *  \brief Get the number of mouse input devices available.

 *  

 *  \sa SDL_SelectMouse()

 *  \brief Gets the name of a mouse with the given index.

 *  

 *  \param index is the index of the mouse, which name is to be returned.

 *  

 *  \return the name of the mouse with the specified index

 *  \brief Set the index of the currently selected mouse.

 *  

 *  \return The index of the previously selected mouse.

 *  

 *  \note You can query the currently selected mouse by passing an index of -1.

 *  

 *  \sa SDL_GetNumMice()

 *  \brief Get the window which currently has focus for the specified mouse.

 *  \brief Set relative mouse mode for the specified mouse.

 *  

 *  \param enabled Whether or not to enable relative mode

 *  

 *  \return 0 on success, or -1 if relative mode is not supported.

 *  

 *  While the mouse is in relative mode, the cursor is hidden, and the

 *  driver will try to report continuous motion in the current window.

 *  Only relative motion events will be delivered, the mouse position

 *  will not change.

 *  

 *  \note This function will flush any pending mouse motion.

 *  

 *  \sa SDL_GetRelativeMouseMode()

 *  \brief Query whether relative mouse mode is enabled for the specified mouse.

 *  

 *  \sa SDL_SetRelativeMouseMode()

 *  \brief Retrieve the current state of the specified mouse.

 *  

 *  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.

 *  \brief Retrieve the state of the specified mouse.

 *  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 deltas since the last call to SDL_GetRelativeMouseState().

 *  \brief Moves the currently selected mouse to the given position within the window.

 *  

 *  \param windowID The window to move the mouse into, or 0 for the current mouse focus

 *  \param x The x coordinate within the window

 *  \param y The y coordinate within the window

 *  

 *  \note This function generates a mouse motion event

 *  \brief Create a cursor for the currently selected mouse, using the

 *         specified bitmap data and mask (in MSB format).

 *  

 *  The cursor width must be a multiple of 8 bits.

 *  

 *  The cursor is created in black and white according to the following:

 *  <table>

 *  <tr><td> data </td><td> mask </td><td> resulting pixel on screen </td></tr>

 *  <tr><td>  0   </td><td>  1   </td><td> White </td></tr>

 *  <tr><td>  1   </td><td>  1   </td><td> Black </td></tr>

 *  <tr><td>  0   </td><td>  0   </td><td> Transparent </td></tr>

 *  <tr><td>  1   </td><td>  0   </td><td> Inverted color if possible, black 

                                           if not. </td></tr>

 *  </table>

 *  

 *  \sa SDL_FreeCursor()

 *  \brief Set the active cursor for the currently selected mouse.

 *  

 *  \note The cursor must have been created for the selected mouse.

 *  \brief Return the active cursor for the currently selected mouse.

 *  \brief Frees a cursor created with SDL_CreateCursor().

 *  

 *  \sa SDL_CreateCursor()

 *  \brief Toggle whether or not the cursor is shown for the currently selected 

 *         mouse.

 *  

 *  \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current 

 *                state.

 *  

 *  \return 1 if the cursor is shown, or 0 if the cursor is hidden.

 *  \brief Gets the number of cursors a pointing device supports.

 *  

 *  Useful for tablet users. Useful only under Windows.

 *  

 *  \param index is the index of the pointing device, which number of cursors we

 *               want to receive.

 *  

 *  \return the number of cursors supported by the pointing device. On Windows

 *          if a device is a tablet it returns a number >=1. Normal mice always 

 *          return 1.

 *  

 *  On Linux every device reports one cursor.

 *  \brief Returns the index of the current cursor used by a specific pointing

 *         device.

 *  

 *  Useful only under Windows.

 *  

 *  \param index is the index of the pointing device, which cursor index we want

 *               to receive.

 *  

 *  \return the index of the cursor currently used by a specific pointing 

 *          device.  Always 0 under Linux. On Windows if the device isn't a 

 *          tablet it returns 0.  If the device is the tablet it returns the 

 *          cursor index.  0 - stylus, 1 - eraser, 2 - cursor.

/**

 *  Used as a mask when testing buttons in buttonstate.

 *   - Button 1:  Left mouse button

 *   - Button 2:  Middle mouse button

 *   - Button 3:  Right mouse button

 */