Mercurial > sdl-ios-xcode

comparison include/SDL_mouse.h @ 2765:f55c87ae336b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Final merge of Google Summer of Code 2008 work... Bring SDL to iPhone and iPod Touch by Holmes Futrell, mentored by Sam Lantinga
author Sam Lantinga <slouken@libsdl.org>
date Sat, 04 Oct 2008 06:46:59 +0000
parents abacf2555bb4
children 99210400e8b9
comparison
equal deleted inserted replaced
2764:4868c0df2e83 2765:f55c87ae336b
77 * \sa SDL_GetNumMice() 77 * \sa SDL_GetNumMice()
78 */ 78 */
79 extern DECLSPEC int SDLCALL SDL_SelectMouse(int index); 79 extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
80 80
81 /** 81 /**
82 * \fn SDL_WindowID SDL_GetMouseFocusWindow(void) 82 * \fn SDL_WindowID SDL_GetMouseFocusWindow(int index)
83 * 83 *
84 * \brief Get the window which currently has focus for the currently selected mouse. 84 * \brief Get the window which currently has focus for the currently selected mouse.
85 */ 85 */
86 extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(int index); 86 extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(int index);
87 87
88 /** 88 /**
89 * \fn int SDL_SetRelativeMouseMode(SDL_bool enabled) 89 * \fn int SDL_SetRelativeMouseMode(int index, SDL_bool enabled)
90 * 90 *
91 * \brief Set relative mouse mode for the currently selected mouse. 91 * \brief Set relative mouse mode for the currently selected mouse.
92 * 92 *
93 * \param enabled Whether or not to enable relative mode 93 * \param enabled Whether or not to enable relative mode
94 * 94 *
105 */ 105 */
106 extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(int index, 106 extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(int index,
107 SDL_bool enabled); 107 SDL_bool enabled);
108 108
109 /** 109 /**
110 * \fn SDL_bool SDL_GetRelativeMouseMode() 110 * \fn SDL_bool SDL_GetRelativeMouseMode(int index)
111 * 111 *
112 * \brief Query whether relative mouse mode is enabled for the currently selected mouse. 112 * \brief Query whether relative mouse mode is enabled for the currently selected mouse.
113 * 113 *
114 * \sa SDL_SetRelativeMouseMode() 114 * \sa SDL_SetRelativeMouseMode()
115 */ 115 */
116 extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(int index); 116 extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(int index);
117 117
118 /** 118 /**
119 * \fn Uint8 SDL_GetMouseState(int *x, int *y) 119 * \fn Uint8 SDL_GetMouseState(int index, int *x, int *y)
120 * 120 *
121 * \brief Retrieve the current state of the currently selected mouse. 121 * \brief Retrieve the current state of the currently selected mouse.
122 * 122 *
123 * The current button state is returned as a button bitmask, which can 123 * The current button state is returned as a button bitmask, which can
124 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the 124 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
126 * selected mouse. You can pass NULL for either x or y. 126 * selected mouse. You can pass NULL for either x or y.
127 */ 127 */
128 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int index, int *x, int *y); 128 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int index, int *x, int *y);
129 129
130 /** 130 /**
131 * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y) 131 * \fn Uint8 SDL_GetRelativeMouseState(int index, int *x, int *y)
132 * 132 *
133 * \brief Retrieve the state of the currently selected mouse. 133 * \brief Retrieve the state of the currently selected mouse.
134 * 134 *
135 * The current button state is returned as a button bitmask, which can 135 * The current button state is returned as a button bitmask, which can
136 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the 136 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the