include/SDL_mouse.h
author Ryan C. Gordon <icculus@icculus.org>
Sat, 24 May 2014 01:30:37 -0400
changeset 8927 be64f5daf64b
parent 8149 681eb46b8ac4
child 8945 04248c700ada
permissions -rw-r--r--
Implemented SDL_CaptureMouse().
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@0
    21
slouken@1895
    22
/**
slouken@3407
    23
 *  \file SDL_mouse.h
slouken@7191
    24
 *
slouken@3407
    25
 *  Include file for SDL mouse event handling.
slouken@1895
    26
 */
slouken@0
    27
slouken@0
    28
#ifndef _SDL_mouse_h
slouken@0
    29
#define _SDL_mouse_h
slouken@0
    30
slouken@1356
    31
#include "SDL_stdinc.h"
slouken@1358
    32
#include "SDL_error.h"
slouken@0
    33
#include "SDL_video.h"
slouken@0
    34
slouken@0
    35
#include "begin_code.h"
slouken@0
    36
/* Set up for C function definitions, even when using C++ */
slouken@0
    37
#ifdef __cplusplus
slouken@0
    38
extern "C" {
slouken@0
    39
#endif
slouken@0
    40
slouken@1895
    41
typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
slouken@0
    42
mikesart@6675
    43
/**
mikesart@6675
    44
 * \brief Cursor types for SDL_CreateSystemCursor.
mikesart@6675
    45
 */
mikesart@6675
    46
typedef enum
mikesart@6675
    47
{
icculus@7067
    48
    SDL_SYSTEM_CURSOR_ARROW,     /**< Arrow */
icculus@7067
    49
    SDL_SYSTEM_CURSOR_IBEAM,     /**< I-beam */
icculus@7067
    50
    SDL_SYSTEM_CURSOR_WAIT,      /**< Wait */
icculus@7067
    51
    SDL_SYSTEM_CURSOR_CROSSHAIR, /**< Crosshair */
icculus@7067
    52
    SDL_SYSTEM_CURSOR_WAITARROW, /**< Small wait cursor (or Wait if not available) */
icculus@7067
    53
    SDL_SYSTEM_CURSOR_SIZENWSE,  /**< Double arrow pointing northwest and southeast */
icculus@7067
    54
    SDL_SYSTEM_CURSOR_SIZENESW,  /**< Double arrow pointing northeast and southwest */
icculus@7067
    55
    SDL_SYSTEM_CURSOR_SIZEWE,    /**< Double arrow pointing west and east */
icculus@7067
    56
    SDL_SYSTEM_CURSOR_SIZENS,    /**< Double arrow pointing north and south */
icculus@7067
    57
    SDL_SYSTEM_CURSOR_SIZEALL,   /**< Four pointed arrow pointing north, south, east, and west */
icculus@7067
    58
    SDL_SYSTEM_CURSOR_NO,        /**< Slashed circle or crossbones */
icculus@7067
    59
    SDL_SYSTEM_CURSOR_HAND,      /**< Hand */
slouken@6677
    60
    SDL_NUM_SYSTEM_CURSORS
mikesart@6675
    61
} SDL_SystemCursor;
slouken@4465
    62
slouken@0
    63
/* Function prototypes */
slouken@1895
    64
slouken@1895
    65
/**
slouken@4465
    66
 *  \brief Get the window which currently has mouse focus.
slouken@1895
    67
 */
slouken@4465
    68
extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
slouken@1895
    69
slouken@1895
    70
/**
slouken@4465
    71
 *  \brief Retrieve the current state of the mouse.
slouken@7191
    72
 *
slouken@4465
    73
 *  The current button state is returned as a button bitmask, which can
slouken@4465
    74
 *  be tested using the SDL_BUTTON(X) macros, and x and y are set to the
slouken@4465
    75
 *  mouse cursor position relative to the focus window for the currently
slouken@4465
    76
 *  selected mouse.  You can pass NULL for either x or y.
kazeuser@2718
    77
 */
slouken@6673
    78
extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y);
kazeuser@2718
    79
kazeuser@2718
    80
/**
slouken@4465
    81
 *  \brief Retrieve the relative state of the mouse.
slouken@4465
    82
 *
slouken@4465
    83
 *  The current button state is returned as a button bitmask, which can
slouken@4465
    84
 *  be tested using the SDL_BUTTON(X) macros, and x and y are set to the
slouken@4465
    85
 *  mouse deltas since the last call to SDL_GetRelativeMouseState().
slouken@1895
    86
 */
slouken@6673
    87
extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
slouken@1895
    88
slouken@1895
    89
/**
slouken@4465
    90
 *  \brief Moves the mouse to the given position within the window.
slouken@7191
    91
 *
slouken@4465
    92
 *  \param window The window to move the mouse into, or NULL for the current mouse focus
slouken@4465
    93
 *  \param x The x coordinate within the window
slouken@4465
    94
 *  \param y The y coordinate within the window
slouken@7191
    95
 *
slouken@4465
    96
 *  \note This function generates a mouse motion event
slouken@1895
    97
 */
slouken@4465
    98
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
slouken@4465
    99
                                                   int x, int y);
slouken@1895
   100
slouken@1895
   101
/**
slouken@4465
   102
 *  \brief Set relative mouse mode.
slouken@7191
   103
 *
slouken@3407
   104
 *  \param enabled Whether or not to enable relative mode
slouken@4465
   105
 *
slouken@3407
   106
 *  \return 0 on success, or -1 if relative mode is not supported.
slouken@7191
   107
 *
slouken@3407
   108
 *  While the mouse is in relative mode, the cursor is hidden, and the
slouken@3407
   109
 *  driver will try to report continuous motion in the current window.
slouken@3407
   110
 *  Only relative motion events will be delivered, the mouse position
slouken@3407
   111
 *  will not change.
slouken@7191
   112
 *
slouken@3407
   113
 *  \note This function will flush any pending mouse motion.
slouken@7191
   114
 *
slouken@3407
   115
 *  \sa SDL_GetRelativeMouseMode()
slouken@1895
   116
 */
slouken@4465
   117
extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
slouken@1895
   118
slouken@1895
   119
/**
icculus@8927
   120
 *  \brief Capture the mouse, to track input outside an SDL window.
icculus@8927
   121
 *
icculus@8927
   122
 *  \param enabled Whether or not to enable capturing
icculus@8927
   123
 *
icculus@8927
   124
 *  Capturing enables your app to obtain mouse events globally, instead of
icculus@8927
   125
 *  just within your window. Not all video targets support this function.
icculus@8927
   126
 *  When capturing is enabled, the current window will get all mouse events,
icculus@8927
   127
 *  but unlike relative mode, no change is made to the cursor and it is
icculus@8927
   128
 *  not restrained to your window.
icculus@8927
   129
 *
icculus@8927
   130
 *  This function may also deny mouse input to other windows--both those in
icculus@8927
   131
 *  your application and others on the system--so you should use this
icculus@8927
   132
 *  function sparingly, and in small bursts. For example, you might want to
icculus@8927
   133
 *  track the mouse while the user is dragging something, until the user
icculus@8927
   134
 *  releases a mouse button. It is not recommended that you capture the mouse
icculus@8927
   135
 *  for long periods of time, such as the entire time your app is running.
icculus@8927
   136
 *
icculus@8927
   137
 *  While captured, mouse events still report coordinates relative to the
icculus@8927
   138
 *  current (foreground) window, but those coordinates may be outside the
icculus@8927
   139
 *  bounds of the window (including negative values). Capturing is only
icculus@8927
   140
 *  allowed for the foreground window. If the window loses focus while
icculus@8927
   141
 *  capturing, the capture will be disabled automatically.
icculus@8927
   142
 *
icculus@8927
   143
 *  While capturing is enabled, the current window will have the
icculus@8927
   144
 *  SDL_WINDOW_MOUSE_CAPTURE flag set.
icculus@8927
   145
 *
icculus@8927
   146
 *  \return 0 on success, or -1 if not supported.
icculus@8927
   147
 */
icculus@8927
   148
extern DECLSPEC int SDLCALL SDL_CaptureMouse(SDL_bool enabled);
icculus@8927
   149
icculus@8927
   150
/**
slouken@4465
   151
 *  \brief Query whether relative mouse mode is enabled.
slouken@7191
   152
 *
slouken@3407
   153
 *  \sa SDL_SetRelativeMouseMode()
slouken@1895
   154
 */
slouken@4465
   155
extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
slouken@1895
   156
slouken@1895
   157
/**
slouken@4465
   158
 *  \brief Create a cursor, using the specified bitmap data and
slouken@4465
   159
 *         mask (in MSB format).
slouken@7191
   160
 *
slouken@3407
   161
 *  The cursor width must be a multiple of 8 bits.
slouken@7191
   162
 *
slouken@3407
   163
 *  The cursor is created in black and white according to the following:
slouken@3407
   164
 *  <table>
slouken@3407
   165
 *  <tr><td> data </td><td> mask </td><td> resulting pixel on screen </td></tr>
slouken@3407
   166
 *  <tr><td>  0   </td><td>  1   </td><td> White </td></tr>
slouken@3407
   167
 *  <tr><td>  1   </td><td>  1   </td><td> Black </td></tr>
slouken@3407
   168
 *  <tr><td>  0   </td><td>  0   </td><td> Transparent </td></tr>
slouken@7191
   169
 *  <tr><td>  1   </td><td>  0   </td><td> Inverted color if possible, black
slouken@4465
   170
 *                                         if not. </td></tr>
slouken@3407
   171
 *  </table>
slouken@7191
   172
 *
slouken@3407
   173
 *  \sa SDL_FreeCursor()
slouken@0
   174
 */
slouken@1895
   175
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
slouken@1895
   176
                                                     const Uint8 * mask,
slouken@1895
   177
                                                     int w, int h, int hot_x,
slouken@1895
   178
                                                     int hot_y);
slouken@0
   179
slouken@1895
   180
/**
slouken@5473
   181
 *  \brief Create a color cursor.
slouken@7191
   182
 *
slouken@5473
   183
 *  \sa SDL_FreeCursor()
slouken@5473
   184
 */
slouken@5473
   185
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
slouken@5473
   186
                                                          int hot_x,
slouken@5473
   187
                                                          int hot_y);
slouken@5473
   188
slouken@5473
   189
/**
mikesart@6675
   190
 *  \brief Create a system cursor.
mikesart@6675
   191
 *
mikesart@6675
   192
 *  \sa SDL_FreeCursor()
mikesart@6675
   193
 */
mikesart@6675
   194
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id);
mikesart@6675
   195
mikesart@6675
   196
/**
slouken@4465
   197
 *  \brief Set the active cursor.
slouken@0
   198
 */
slouken@1895
   199
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
slouken@0
   200
slouken@1895
   201
/**
slouken@4465
   202
 *  \brief Return the active cursor.
slouken@0
   203
 */
slouken@1895
   204
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
slouken@0
   205
slouken@1895
   206
/**
jorgen@7104
   207
 *  \brief Return the default cursor.
jorgen@7104
   208
 */
jorgen@7104
   209
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void);
jorgen@7104
   210
jorgen@7104
   211
/**
slouken@3407
   212
 *  \brief Frees a cursor created with SDL_CreateCursor().
slouken@7191
   213
 *
slouken@3407
   214
 *  \sa SDL_CreateCursor()
slouken@0
   215
 */
slouken@1895
   216
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
slouken@0
   217
slouken@1895
   218
/**
slouken@4465
   219
 *  \brief Toggle whether or not the cursor is shown.
slouken@7191
   220
 *
slouken@7191
   221
 *  \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current
slouken@3407
   222
 *                state.
slouken@7191
   223
 *
slouken@3407
   224
 *  \return 1 if the cursor is shown, or 0 if the cursor is hidden.
slouken@0
   225
 */
slouken@337
   226
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
slouken@0
   227
kazeuser@2718
   228
/**
slouken@3407
   229
 *  Used as a mask when testing buttons in buttonstate.
slouken@3407
   230
 *   - Button 1:  Left mouse button
slouken@3407
   231
 *   - Button 2:  Middle mouse button
slouken@3407
   232
 *   - Button 3:  Right mouse button
slouken@3407
   233
 */
slouken@7191
   234
#define SDL_BUTTON(X)       (1 << ((X)-1))
slouken@7191
   235
#define SDL_BUTTON_LEFT     1
slouken@7191
   236
#define SDL_BUTTON_MIDDLE   2
slouken@7191
   237
#define SDL_BUTTON_RIGHT    3
slouken@7191
   238
#define SDL_BUTTON_X1       4
slouken@7191
   239
#define SDL_BUTTON_X2       5
slouken@7191
   240
#define SDL_BUTTON_LMASK    SDL_BUTTON(SDL_BUTTON_LEFT)
slouken@7191
   241
#define SDL_BUTTON_MMASK    SDL_BUTTON(SDL_BUTTON_MIDDLE)
slouken@7191
   242
#define SDL_BUTTON_RMASK    SDL_BUTTON(SDL_BUTTON_RIGHT)
slouken@7191
   243
#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)
slouken@7191
   244
#define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)
slouken@0
   245
slouken@0
   246
slouken@0
   247
/* Ends C function definitions when using C++ */
slouken@0
   248
#ifdef __cplusplus
slouken@0
   249
}
slouken@0
   250
#endif
slouken@0
   251
#include "close_code.h"
slouken@0
   252
slouken@0
   253
#endif /* _SDL_mouse_h */
slouken@1895
   254
slouken@1895
   255
/* vi: set ts=4 sw=4 expandtab: */