include/SDL_mouse.h
author Szymon Wilczek <kazeuser@gmail.com>
Wed, 06 Aug 2008 08:48:43 +0000
branchgsoc2008_manymouse
changeset 3776 a9c2a7071874
parent 3774 8b5b67000dc0
permissions -rw-r--r--
upgraded functions
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  * \file SDL_mouse.h
    25  *
    26  * Include file for SDL mouse event handling
    27  */
    28 
    29 #ifndef _SDL_mouse_h
    30 #define _SDL_mouse_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 #include "SDL_video.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 /* *INDENT-OFF* */
    40 extern "C" {
    41 /* *INDENT-ON* */
    42 #endif
    43 
    44 typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
    45 
    46 /* Function prototypes */
    47 
    48 /**
    49  * \fn int SDL_GetNumMice(void)
    50  *
    51  * \brief Get the number of mouse input devices available.
    52  *
    53  * \sa SDL_SelectMouse()
    54  */
    55 extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
    56 
    57 /**
    58  * \fn int SDL_SelectMouse(int index)
    59  *
    60  * \brief Set the index of the currently selected mouse.
    61  *
    62  * \return The index of the previously selected mouse.
    63  *
    64  * \note You can query the currently selected mouse by passing an index of -1.
    65  *
    66  * \sa SDL_GetNumMice()
    67  */
    68 extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
    69 
    70 /**
    71  * \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
    72  *
    73  * \brief Get the window which currently has focus for the currently selected mouse.
    74  */
    75 extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(int index);
    76 
    77 /**
    78  * \fn int SDL_SetRelativeMouseMode(SDL_bool enabled)
    79  *
    80  * \brief Set relative mouse mode for the currently selected mouse.
    81  *
    82  * \param enabled Whether or not to enable relative mode
    83  *
    84  * \return 0 on success, or -1 if relative mode is not supported.
    85  *
    86  * While the mouse is in relative mode, the cursor is hidden, and the
    87  * driver will try to report continuous motion in the current window.
    88  * Only relative motion events will be delivered, the mouse position
    89  * will not change.
    90  *
    91  * \note This function will flush any pending mouse motion.
    92  *
    93  * \sa SDL_GetRelativeMouseMode()
    94  */
    95 extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(int index, SDL_bool enabled);
    96 
    97 /**
    98  * \fn SDL_bool SDL_GetRelativeMouseMode()
    99  *
   100  * \brief Query whether relative mouse mode is enabled for the currently selected mouse.
   101  *
   102  * \sa SDL_SetRelativeMouseMode()
   103  */
   104 extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(int index);
   105 
   106 /**
   107  * \fn Uint8 SDL_GetMouseState(int *x, int *y)
   108  *
   109  * \brief Retrieve the current state of the currently selected mouse.
   110  *
   111  * The current button state is returned as a button bitmask, which can
   112  * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
   113  * mouse cursor position relative to the focus window for the currently
   114  * selected mouse.  You can pass NULL for either x or y.
   115  */
   116 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int index, int *x, int *y);
   117 
   118 /**
   119  * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
   120  *
   121  * \brief Retrieve the state of the currently selected mouse.
   122  *
   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
   125  * mouse deltas since the last call to SDL_GetRelativeMouseState().
   126  */
   127 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int index, int *x, int *y);
   128 
   129 /**
   130  * \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y)
   131  *
   132  * \brief Moves the currently selected mouse to the given position within the window.
   133  *
   134  * \param windowID The window to move the mouse into, or 0 for the current mouse focus
   135  * \param x The x coordinate within the window
   136  * \param y The y coordinate within the window
   137  *
   138  * \note This function generates a mouse motion event
   139  */
   140 extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
   141                                                    int x, int y);
   142 
   143 /**
   144  * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y)
   145  *
   146  * \brief Create a cursor for the currently selected mouse, using the
   147  *        specified bitmap data and mask (in MSB format).
   148  *
   149  * The cursor width must be a multiple of 8 bits.
   150  *
   151  * The cursor is created in black and white according to the following:
   152  * data  mask    resulting pixel on screen
   153  *  0     1       White
   154  *  1     1       Black
   155  *  0     0       Transparent
   156  *  1     0       Inverted color if possible, black if not.
   157  *
   158  * \sa SDL_FreeCursor()
   159  */
   160 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
   161                                                      const Uint8 * mask,
   162                                                      int w, int h, int hot_x,
   163                                                      int hot_y);
   164 
   165 /**
   166  * \fn void SDL_SetCursor(SDL_Cursor * cursor)
   167  *
   168  * \brief Set the active cursor for the currently selected mouse.
   169  *
   170  * \note The cursor must have been created for the selected mouse.
   171  */
   172 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
   173 
   174 /**
   175  * \fn SDL_Cursor *SDL_GetCursor(void)
   176  *
   177  * \brief Return the active cursor for the currently selected mouse.
   178  */
   179 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
   180 
   181 /**
   182  * \fn void SDL_FreeCursor(SDL_Cursor * cursor)
   183  *
   184  * \brief Frees a cursor created with SDL_CreateCursor().
   185  *
   186  * \sa SDL_CreateCursor()
   187  */
   188 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
   189 
   190 /**
   191  * \fn int SDL_ShowCursor(int toggle)
   192  *
   193  * \brief Toggle whether or not the cursor is shown for the currently selected mouse.
   194  *
   195  * \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current state.
   196  *
   197  * \return 1 if the cursor is shown, or 0 if the cursor is hidden.
   198  */
   199 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
   200 
   201 /* Used as a mask when testing buttons in buttonstate
   202    Button 1:	Left mouse button
   203    Button 2:	Middle mouse button
   204    Button 3:	Right mouse button
   205  */
   206 
   207 extern DECLSPEC int SDLCALL SDL_GetNumOfMice(void);
   208 
   209 extern DECLSPEC char* SDLCALL SDL_GetMouseName(int index);
   210 
   211 extern DECLSPEC int SDLCALL SDL_GetCursorsNumber(int index);
   212 
   213 extern DECLSPEC int SDLCALL SDL_GetCurrentCursor(int index);
   214 
   215 #define SDL_BUTTON(X)		(1 << ((X)-1))
   216 #define SDL_BUTTON_LEFT		1
   217 #define SDL_BUTTON_MIDDLE	2
   218 #define SDL_BUTTON_RIGHT	3
   219 #define SDL_BUTTON_X1		4
   220 #define SDL_BUTTON_X2		5
   221 #define SDL_BUTTON_LMASK	SDL_BUTTON(SDL_BUTTON_LEFT)
   222 #define SDL_BUTTON_MMASK	SDL_BUTTON(SDL_BUTTON_MIDDLE)
   223 #define SDL_BUTTON_RMASK	SDL_BUTTON(SDL_BUTTON_RIGHT)
   224 #define SDL_BUTTON_X1MASK	SDL_BUTTON(SDL_BUTTON_X1)
   225 #define SDL_BUTTON_X2MASK	SDL_BUTTON(SDL_BUTTON_X2)
   226 
   227 
   228 /* Ends C function definitions when using C++ */
   229 #ifdef __cplusplus
   230 /* *INDENT-OFF* */
   231 }
   232 /* *INDENT-ON* */
   233 #endif
   234 #include "close_code.h"
   235 
   236 #endif /* _SDL_mouse_h */
   237 
   238 /* vi: set ts=4 sw=4 expandtab: */