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.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     1
/*
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     2
    SDL - Simple DirectMedia Layer
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
     3
    Copyright (C) 1997-2006 Sam Lantinga
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     4
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     5
    This library is free software; you can redistribute it and/or
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
     6
    modify it under the terms of the GNU Lesser General Public
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     7
    License as published by the Free Software Foundation; either
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
     8
    version 2.1 of the License, or (at your option) any later version.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     9
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    10
    This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
    13
    Lesser General Public License for more details.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    14
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
    15
    You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
    16
    License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1046
diff changeset
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    18
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    19
    Sam Lantinga
251
b8688cfdc232 Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents: 0
diff changeset
    20
    slouken@libsdl.org
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    21
*/
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    22
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    23
/**
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    24
 * \file SDL_mouse.h
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    25
 *
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    26
 * Include file for SDL mouse event handling
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    27
 */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    28
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    29
#ifndef _SDL_mouse_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    30
#define _SDL_mouse_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    31
1356
67114343400d *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 1330
diff changeset
    32
#include "SDL_stdinc.h"
1358
c71e05b4dc2e More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents: 1356
diff changeset
    33
#include "SDL_error.h"
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    34
#include "SDL_video.h"
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    35
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    36
#include "begin_code.h"
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    37
/* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    38
#ifdef __cplusplus
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    39
/* *INDENT-OFF* */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    40
extern "C" {
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
    41
/* *INDENT-ON* */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    42
#endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    43
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    44
typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    45
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    46
/* Function prototypes */
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    47
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    48
/* \fn int SDL_GetNumMice(void)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    49
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    50
 * \brief Get the number of mouse input devices available.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    51
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    52
 * \sa SDL_SelectMouse()
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    53
 */
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    54
extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    55
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    56
/* \fn int SDL_SelectMouse(int index)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    57
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    58
 * \brief Set the index of the currently selected mouse.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    59
 *
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
    60
 * \return The index of the previously selected mouse.
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    61
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    62
 * \note You can query the currently selected mouse by passing an index of -1.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    63
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    64
 * \sa SDL_GetNumMice()
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    65
 */
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    66
extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    67
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    68
/* \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    69
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    70
 * \brief Get the window which currently has focus for the currently selected mouse.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    71
 */
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    72
extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void);
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    73
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    74
/*
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    75
 * \fn Uint8 SDL_GetMouseState(int *x, int *y)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    76
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    77
 * \brief Retrieve the current state of the mouse.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    78
 *
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    79
 * The current button state is returned as a button bitmask, which can
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    80
 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    81
 * mouse cursor position relative to the focus window for the currently
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    82
 * selected mouse.  You can pass NULL for either x or y.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    83
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
    84
extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    85
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    86
/*
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    87
 * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    88
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    89
 * \brief Retrieve the current state of the mouse.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    90
 *
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    91
 * The current button state is returned as a button bitmask, which can
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    92
 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    93
 * mouse deltas since the last call to SDL_GetRelativeMouseState().
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    94
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
    95
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    96
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    97
/*
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    98
 * \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y)
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
    99
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   100
 * \brief Moves the currently selected mouse to the given position within the window.
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   101
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   102
 * \param windowID The window to move the mouse into, or 0 for the current mouse focus
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   103
 * \param x The x coordinate within the window
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   104
 * \param y The y coordinate within the window
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   105
 *
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   106
 * \note This function generates a mouse motion event
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   107
 */
1670
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   108
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
eef792d31de8 Work in progress. :)
Sam Lantinga <slouken@libsdl.org>
parents: 1668
diff changeset
   109
                                                   int x, int y);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   110
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   111
/*
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   112
 * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y)
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   113
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   114
 * \brief Create a cursor for the currently selected mouse, using the
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   115
 *        specified bitmap data and mask (in MSB format).
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   116
 *
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   117
 * The cursor width must be a multiple of 8 bits.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   118
 *
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   119
 * The cursor is created in black and white according to the following:
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   120
 * data  mask    resulting pixel on screen
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   121
 *  0     1       White
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   122
 *  1     1       Black
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   123
 *  0     0       Transparent
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   124
 *  1     0       Inverted color if possible, black if not.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   125
 *
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   126
 * \sa SDL_FreeCursor()
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   127
 */
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   128
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   129
                                                     const Uint8 * mask,
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   130
                                                     int w, int h, int hot_x,
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   131
                                                     int hot_y);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   132
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   133
/*
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   134
 * \fn void SDL_SetCursor(SDL_Cursor * cursor)
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   135
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   136
 * \brief Set the active cursor for the currently selected mouse.
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   137
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   138
 * \note The cursor must have been created for the selected mouse.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   139
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
   140
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   141
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   142
/*
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   143
 * \fn SDL_Cursor *SDL_GetCursor(void)
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   144
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   145
 * \brief Return the active cursor for the currently selected mouse.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   146
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
   147
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   148
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   149
/*
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   150
 * \fn void SDL_FreeCursor(SDL_Cursor * cursor)
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   151
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   152
 * \brief Frees a cursor created with SDL_CreateCursor().
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   153
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   154
 * \sa SDL_CreateCursor()
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   155
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
   156
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   157
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   158
/*
1671
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   159
 * \fn int SDL_ShowCursor(int toggle)
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   160
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   161
 * \brief Toggle whether or not the cursor is shown for the currently selected mouse.
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   162
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   163
 * \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current state.
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   164
 *
89f7510fe17a Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents: 1670
diff changeset
   165
 * \return 1 if the cursor is shown, or 0 if the cursor is hidden.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   166
 */
1668
4da1ee79c9af more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents: 1662
diff changeset
   167
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   168
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   169
/* Used as a mask when testing buttons in buttonstate
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   170
   Button 1:	Left mouse button
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   171
   Button 2:	Middle mouse button
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   172
   Button 3:	Right mouse button
451
24edec3cafe4 Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents: 337
diff changeset
   173
   Button 4:	Mouse wheel up	 (may also be a real button)
24edec3cafe4 Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents: 337
diff changeset
   174
   Button 5:	Mouse wheel down (may also be a real button)
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   175
 */
1330
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents: 1312
diff changeset
   176
#define SDL_BUTTON(X)		(1 << ((X)-1))
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   177
#define SDL_BUTTON_LEFT		1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   178
#define SDL_BUTTON_MIDDLE	2
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   179
#define SDL_BUTTON_RIGHT	3
451
24edec3cafe4 Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents: 337
diff changeset
   180
#define SDL_BUTTON_WHEELUP	4
24edec3cafe4 Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents: 337
diff changeset
   181
#define SDL_BUTTON_WHEELDOWN	5
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   182
#define SDL_BUTTON_LMASK	SDL_BUTTON(SDL_BUTTON_LEFT)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   183
#define SDL_BUTTON_MMASK	SDL_BUTTON(SDL_BUTTON_MIDDLE)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   184
#define SDL_BUTTON_RMASK	SDL_BUTTON(SDL_BUTTON_RIGHT)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   185
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   186
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   187
/* Ends C function definitions when using C++ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   188
#ifdef __cplusplus
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
   189
/* *INDENT-OFF* */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   190
}
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
   191
/* *INDENT-ON* */
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   192
#endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   193
#include "close_code.h"
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   194
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   195
#endif /* _SDL_mouse_h */
1662
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
   196
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents: 1358
diff changeset
   197
/* vi: set ts=4 sw=4 expandtab: */