include/SDL_mouse.h
branchSDL-1.3
changeset 1722 5daa04d862f1
parent 1673 624e1412fbba
child 1724 6c63fc2bd986
     1.1 --- a/include/SDL_mouse.h	Fri Jun 30 05:50:35 2006 +0000
     1.2 +++ b/include/SDL_mouse.h	Fri Jun 30 08:18:44 2006 +0000
     1.3 @@ -75,9 +75,38 @@
     1.4  extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void);
     1.5  
     1.6  /**
     1.7 + * \fn int SDL_SetRelativeMouseMode(SDL_bool enabled)
     1.8 + *
     1.9 + * \brief Set relative mouse mode for the currently selected mouse.
    1.10 + *
    1.11 + * \param enabled Whether or not to enable relative mode
    1.12 + *
    1.13 + * \return 0 on success, or -1 if relative mode is not supported.
    1.14 + *
    1.15 + * While the mouse is in relative mode, the cursor is hidden, and the
    1.16 + * driver will try to report continuous motion in the current window.
    1.17 + * Only relative motion events will be delivered, the mouse position
    1.18 + * will not change.
    1.19 + *
    1.20 + * \note This function will flush any pending mouse motion.
    1.21 + *
    1.22 + * \sa SDL_GetRelativeMouseMode()
    1.23 + */
    1.24 +extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
    1.25 +
    1.26 +/**
    1.27 + * \fn SDL_bool SDL_GetRelativeMouseMode()
    1.28 + *
    1.29 + * \brief Query whether relative mouse mode is enabled for the currently selected mouse.
    1.30 + *
    1.31 + * \sa SDL_SetRelativeMouseMode()
    1.32 + */
    1.33 +extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode();
    1.34 +
    1.35 +/**
    1.36   * \fn Uint8 SDL_GetMouseState(int *x, int *y)
    1.37   *
    1.38 - * \brief Retrieve the current state of the mouse.
    1.39 + * \brief Retrieve the current state of the currently selected mouse.
    1.40   *
    1.41   * The current button state is returned as a button bitmask, which can
    1.42   * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
    1.43 @@ -89,7 +118,7 @@
    1.44  /**
    1.45   * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
    1.46   *
    1.47 - * \brief Retrieve the current state of the mouse.
    1.48 + * \brief Retrieve the state of the currently selected mouse.
    1.49   *
    1.50   * The current button state is returned as a button bitmask, which can
    1.51   * be tested using the SDL_BUTTON(X) macros, and x and y are set to the