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