misc/builddeps/win32/sdl/include/SDL2/SDL_mouse.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
   4
   5   This software is provided 'as-is', without any express or implied
   6   warranty.  In no event will the authors be held liable for any damages
   7   arising from the use of this software.
   8
   9   Permission is granted to anyone to use this software for any purpose,
  10   including commercial applications, and to alter it and redistribute it
  11   freely, subject to the following restrictions:
  12
  13   1. The origin of this software must not be misrepresented; you must not
  14      claim that you wrote the original software. If you use this software
  15      in a product, an acknowledgment in the product documentation would be
  16      appreciated but is not required.
  17   2. Altered source versions must be plainly marked as such, and must not be
  18      misrepresented as being the original software.
  19   3. This notice may not be removed or altered from any source distribution.
  20 */
  21
  22 /**
  23  *  \file SDL_mouse.h
  24  *
  25  *  Include file for SDL mouse event handling.
  26  */
  27
  28 #ifndef _SDL_mouse_h
  29 #define _SDL_mouse_h
  30
  31 #include "SDL_stdinc.h"
  32 #include "SDL_error.h"
  33 #include "SDL_video.h"
  34
  35 #include "begin_code.h"
  36 /* Set up for C function definitions, even when using C++ */
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
  42
  43 /**
  44  * \brief Cursor types for SDL_CreateSystemCursor.
  45  */
  46 typedef enum
  47 {
  48     SDL_SYSTEM_CURSOR_ARROW,     /**< Arrow */
  49     SDL_SYSTEM_CURSOR_IBEAM,     /**< I-beam */
  50     SDL_SYSTEM_CURSOR_WAIT,      /**< Wait */
  51     SDL_SYSTEM_CURSOR_CROSSHAIR, /**< Crosshair */
  52     SDL_SYSTEM_CURSOR_WAITARROW, /**< Small wait cursor (or Wait if not available) */
  53     SDL_SYSTEM_CURSOR_SIZENWSE,  /**< Double arrow pointing northwest and southeast */
  54     SDL_SYSTEM_CURSOR_SIZENESW,  /**< Double arrow pointing northeast and southwest */
  55     SDL_SYSTEM_CURSOR_SIZEWE,    /**< Double arrow pointing west and east */
  56     SDL_SYSTEM_CURSOR_SIZENS,    /**< Double arrow pointing north and south */
  57     SDL_SYSTEM_CURSOR_SIZEALL,   /**< Four pointed arrow pointing north, south, east, and west */
  58     SDL_SYSTEM_CURSOR_NO,        /**< Slashed circle or crossbones */
  59     SDL_SYSTEM_CURSOR_HAND,      /**< Hand */
  60     SDL_NUM_SYSTEM_CURSORS
  61 } SDL_SystemCursor;
  62
  63 /* Function prototypes */
  64
  65 /**
  66  *  \brief Get the window which currently has mouse focus.
  67  */
  68 extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
  69
  70 /**
  71  *  \brief Retrieve the current state of the mouse.
  72  *
  73  *  The current button state is returned as a button bitmask, which can
  74  *  be tested using the SDL_BUTTON(X) macros, and x and y are set to the
  75  *  mouse cursor position relative to the focus window for the currently
  76  *  selected mouse.  You can pass NULL for either x or y.
  77  */
  78 extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y);
  79
  80 /**
  81  *  \brief Retrieve the relative state of the mouse.
  82  *
  83  *  The current button state is returned as a button bitmask, which can
  84  *  be tested using the SDL_BUTTON(X) macros, and x and y are set to the
  85  *  mouse deltas since the last call to SDL_GetRelativeMouseState().
  86  */
  87 extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
  88
  89 /**
  90  *  \brief Moves the mouse to the given position within the window.
  91  *
  92  *  \param window The window to move the mouse into, or NULL for the current mouse focus
  93  *  \param x The x coordinate within the window
  94  *  \param y The y coordinate within the window
  95  *
  96  *  \note This function generates a mouse motion event
  97  */
  98 extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
  99                                                    int x, int y);
 100
 101 /**
 102  *  \brief Set relative mouse mode.
 103  *
 104  *  \param enabled Whether or not to enable relative mode
 105  *
 106  *  \return 0 on success, or -1 if relative mode is not supported.
 107  *
 108  *  While the mouse is in relative mode, the cursor is hidden, and the
 109  *  driver will try to report continuous motion in the current window.
 110  *  Only relative motion events will be delivered, the mouse position
 111  *  will not change.
 112  *
 113  *  \note This function will flush any pending mouse motion.
 114  *
 115  *  \sa SDL_GetRelativeMouseMode()
 116  */
 117 extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
 118
 119 /**
 120  *  \brief Query whether relative mouse mode is enabled.
 121  *
 122  *  \sa SDL_SetRelativeMouseMode()
 123  */
 124 extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
 125
 126 /**
 127  *  \brief Create a cursor, using the specified bitmap data and
 128  *         mask (in MSB format).
 129  *
 130  *  The cursor width must be a multiple of 8 bits.
 131  *
 132  *  The cursor is created in black and white according to the following:
 133  *  <table>
 134  *  <tr><td> data </td><td> mask </td><td> resulting pixel on screen </td></tr>
 135  *  <tr><td>  0   </td><td>  1   </td><td> White </td></tr>
 136  *  <tr><td>  1   </td><td>  1   </td><td> Black </td></tr>
 137  *  <tr><td>  0   </td><td>  0   </td><td> Transparent </td></tr>
 138  *  <tr><td>  1   </td><td>  0   </td><td> Inverted color if possible, black
 139  *                                         if not. </td></tr>
 140  *  </table>
 141  *
 142  *  \sa SDL_FreeCursor()
 143  */
 144 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
 145                                                      const Uint8 * mask,
 146                                                      int w, int h, int hot_x,
 147                                                      int hot_y);
 148
 149 /**
 150  *  \brief Create a color cursor.
 151  *
 152  *  \sa SDL_FreeCursor()
 153  */
 154 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
 155                                                           int hot_x,
 156                                                           int hot_y);
 157
 158 /**
 159  *  \brief Create a system cursor.
 160  *
 161  *  \sa SDL_FreeCursor()
 162  */
 163 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id);
 164
 165 /**
 166  *  \brief Set the active cursor.
 167  */
 168 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
 169
 170 /**
 171  *  \brief Return the active cursor.
 172  */
 173 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
 174
 175 /**
 176  *  \brief Return the default cursor.
 177  */
 178 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void);
 179
 180 /**
 181  *  \brief Frees a cursor created with SDL_CreateCursor().
 182  *
 183  *  \sa SDL_CreateCursor()
 184  */
 185 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
 186
 187 /**
 188  *  \brief Toggle whether or not the cursor is shown.
 189  *
 190  *  \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current
 191  *                state.
 192  *
 193  *  \return 1 if the cursor is shown, or 0 if the cursor is hidden.
 194  */
 195 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
 196
 197 /**
 198  *  Used as a mask when testing buttons in buttonstate.
 199  *   - Button 1:  Left mouse button
 200  *   - Button 2:  Middle mouse button
 201  *   - Button 3:  Right mouse button
 202  */
 203 #define SDL_BUTTON(X)       (1 << ((X)-1))
 204 #define SDL_BUTTON_LEFT     1
 205 #define SDL_BUTTON_MIDDLE   2
 206 #define SDL_BUTTON_RIGHT    3
 207 #define SDL_BUTTON_X1       4
 208 #define SDL_BUTTON_X2       5
 209 #define SDL_BUTTON_LMASK    SDL_BUTTON(SDL_BUTTON_LEFT)
 210 #define SDL_BUTTON_MMASK    SDL_BUTTON(SDL_BUTTON_MIDDLE)
 211 #define SDL_BUTTON_RMASK    SDL_BUTTON(SDL_BUTTON_RIGHT)
 212 #define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)
 213 #define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)
 214
 215
 216 /* Ends C function definitions when using C++ */
 217 #ifdef __cplusplus
 218 }
 219 #endif
 220 #include "close_code.h"
 221
 222 #endif /* _SDL_mouse_h */
 223
 224 /* vi: set ts=4 sw=4 expandtab: */