include/SDL_mouse.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 09 Jun 2006 06:42:42 +0000
branchSDL-1.3
changeset 1671 89f7510fe17a
parent 1670 eef792d31de8
child 1673 624e1412fbba
permissions -rw-r--r--
Moved the cursor handling into the mouse code.
Added support for multiple mice, potentially dynamically added and removed.
     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 /* \fn int SDL_GetNumMice(void)
    49  *
    50  * \brief Get the number of mouse input devices available.
    51  *
    52  * \sa SDL_SelectMouse()
    53  */
    54 extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
    55 
    56 /* \fn int SDL_SelectMouse(int index)
    57  *
    58  * \brief Set the index of the currently selected mouse.
    59  *
    60  * \return The index of the previously selected mouse.
    61  *
    62  * \note You can query the currently selected mouse by passing an index of -1.
    63  *
    64  * \sa SDL_GetNumMice()
    65  */
    66 extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
    67 
    68 /* \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
    69  *
    70  * \brief Get the window which currently has focus for the currently selected mouse.
    71  */
    72 extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void);
    73 
    74 /*
    75  * \fn Uint8 SDL_GetMouseState(int *x, int *y)
    76  *
    77  * \brief Retrieve the current state of the mouse.
    78  *
    79  * The current button state is returned as a button bitmask, which can
    80  * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
    81  * mouse cursor position relative to the focus window for the currently
    82  * selected mouse.  You can pass NULL for either x or y.
    83  */
    84 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
    85 
    86 /*
    87  * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
    88  *
    89  * \brief Retrieve the current state of the mouse.
    90  *
    91  * The current button state is returned as a button bitmask, which can
    92  * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
    93  * mouse deltas since the last call to SDL_GetRelativeMouseState().
    94  */
    95 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
    96 
    97 /*
    98  * \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y)
    99  *
   100  * \brief Moves the currently selected mouse to the given position within the window.
   101  *
   102  * \param windowID The window to move the mouse into, or 0 for the current mouse focus
   103  * \param x The x coordinate within the window
   104  * \param y The y coordinate within the window
   105  *
   106  * \note This function generates a mouse motion event
   107  */
   108 extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
   109                                                    int x, int y);
   110 
   111 /*
   112  * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y)
   113  *
   114  * \brief Create a cursor for the currently selected mouse, using the
   115  *        specified bitmap data and mask (in MSB format).
   116  *
   117  * The cursor width must be a multiple of 8 bits.
   118  *
   119  * The cursor is created in black and white according to the following:
   120  * data  mask    resulting pixel on screen
   121  *  0     1       White
   122  *  1     1       Black
   123  *  0     0       Transparent
   124  *  1     0       Inverted color if possible, black if not.
   125  *
   126  * \sa SDL_FreeCursor()
   127  */
   128 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
   129                                                      const Uint8 * mask,
   130                                                      int w, int h, int hot_x,
   131                                                      int hot_y);
   132 
   133 /*
   134  * \fn void SDL_SetCursor(SDL_Cursor * cursor)
   135  *
   136  * \brief Set the active cursor for the currently selected mouse.
   137  *
   138  * \note The cursor must have been created for the selected mouse.
   139  */
   140 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
   141 
   142 /*
   143  * \fn SDL_Cursor *SDL_GetCursor(void)
   144  *
   145  * \brief Return the active cursor for the currently selected mouse.
   146  */
   147 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
   148 
   149 /*
   150  * \fn void SDL_FreeCursor(SDL_Cursor * cursor)
   151  *
   152  * \brief Frees a cursor created with SDL_CreateCursor().
   153  *
   154  * \sa SDL_CreateCursor()
   155  */
   156 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
   157 
   158 /*
   159  * \fn int SDL_ShowCursor(int toggle)
   160  *
   161  * \brief Toggle whether or not the cursor is shown for the currently selected mouse.
   162  *
   163  * \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current state.
   164  *
   165  * \return 1 if the cursor is shown, or 0 if the cursor is hidden.
   166  */
   167 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
   168 
   169 /* Used as a mask when testing buttons in buttonstate
   170    Button 1:	Left mouse button
   171    Button 2:	Middle mouse button
   172    Button 3:	Right mouse button
   173    Button 4:	Mouse wheel up	 (may also be a real button)
   174    Button 5:	Mouse wheel down (may also be a real button)
   175  */
   176 #define SDL_BUTTON(X)		(1 << ((X)-1))
   177 #define SDL_BUTTON_LEFT		1
   178 #define SDL_BUTTON_MIDDLE	2
   179 #define SDL_BUTTON_RIGHT	3
   180 #define SDL_BUTTON_WHEELUP	4
   181 #define SDL_BUTTON_WHEELDOWN	5
   182 #define SDL_BUTTON_LMASK	SDL_BUTTON(SDL_BUTTON_LEFT)
   183 #define SDL_BUTTON_MMASK	SDL_BUTTON(SDL_BUTTON_MIDDLE)
   184 #define SDL_BUTTON_RMASK	SDL_BUTTON(SDL_BUTTON_RIGHT)
   185 
   186 
   187 /* Ends C function definitions when using C++ */
   188 #ifdef __cplusplus
   189 /* *INDENT-OFF* */
   190 }
   191 /* *INDENT-ON* */
   192 #endif
   193 #include "close_code.h"
   194 
   195 #endif /* _SDL_mouse_h */
   196 
   197 /* vi: set ts=4 sw=4 expandtab: */