This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_mouse.h
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
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
24
25
26
27
/**
* \file SDL_mouse.h
*
* Include file for SDL mouse event handling
*/
28
29
30
31
#ifndef _SDL_mouse_h
#define _SDL_mouse_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
35
36
37
38
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
39
/* *INDENT-OFF* */
40
extern "C" {
41
/* *INDENT-ON* */
42
43
#endif
44
typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
45
46
/* Function prototypes */
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* \fn int SDL_GetNumMice(void)
*
* \brief Get the number of mouse input devices available.
*
* \sa SDL_SelectMouse()
*/
extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
/* \fn int SDL_SelectMouse(int index)
*
* \brief Set the index of the currently selected mouse.
*
* \return The index of the currently selected mouse.
*
* \note You can query the currently selected mouse by passing an index of -1.
*
* \sa SDL_GetNumMice()
*/
extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
/* \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
*
* \brief Get the window which currently has focus for the currently selected mouse.
*/
extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void);
74
/*
75
76
77
78
* \fn Uint8 SDL_GetMouseState(int *x, int *y)
*
* \brief Retrieve the current state of the mouse.
*
79
80
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
81
82
* mouse cursor position relative to the focus window for the currently
* 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
88
89
90
* \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
*
* \brief Retrieve the current state of the mouse.
*
91
92
93
94
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
* mouse deltas since the last call to SDL_GetRelativeMouseState().
*/
95
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
96
97
/*
98
99
100
101
102
103
104
105
106
* \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y)
*
* \brief Moves the currently selected mouse to the given position within the window.
*
* \param windowID The window to move the mouse into, or 0 for the current mouse focus
* \param x The x coordinate within the window
* \param y The y coordinate within the window
*
* \note This function generates a mouse motion event
107
*/
108
109
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
int x, int y);
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
* Create a cursor using the specified data and mask (in MSB format).
* The cursor width must be a multiple of 8 bits.
*
* The cursor is created in black and white according to the following:
* data mask resulting pixel on screen
* 0 1 White
* 1 1 Black
* 0 0 Transparent
* 1 0 Inverted color if possible, black if not.
*
* Cursors created with this function must be freed with SDL_FreeCursor().
*/
124
125
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor
(Uint8 * data, Uint8 * mask, int w, int h, int hot_x, int hot_y);
126
127
128
129
130
131
/*
* Set the currently active cursor to the specified one.
* If the cursor is currently visible, the change will be immediately
* represented on the display.
*/
132
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
133
134
135
136
/*
* Returns the currently active cursor.
*/
137
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
138
139
140
141
/*
* Deallocates a cursor created with SDL_CreateCursor().
*/
142
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
143
144
145
146
147
148
149
150
/*
* Toggle whether or not the cursor is shown on the screen.
* The cursor start off displayed, but can be turned off.
* SDL_ShowCursor() returns 1 if the cursor was being displayed
* before the call, or 0 if it was not. You can query the current
* state by passing a 'toggle' value of -1.
*/
151
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
152
153
154
155
156
/* Used as a mask when testing buttons in buttonstate
Button 1: Left mouse button
Button 2: Middle mouse button
Button 3: Right mouse button
157
158
Button 4: Mouse wheel up (may also be a real button)
Button 5: Mouse wheel down (may also be a real button)
159
*/
160
#define SDL_BUTTON(X) (1 << ((X)-1))
161
162
163
#define SDL_BUTTON_LEFT 1
#define SDL_BUTTON_MIDDLE 2
#define SDL_BUTTON_RIGHT 3
164
165
#define SDL_BUTTON_WHEELUP 4
#define SDL_BUTTON_WHEELDOWN 5
166
167
168
169
170
171
172
#define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT)
#define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE)
#define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT)
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
173
/* *INDENT-OFF* */
174
}
175
/* *INDENT-ON* */
176
177
178
179
#endif
#include "close_code.h"
#endif /* _SDL_mouse_h */
180
181
/* vi: set ts=4 sw=4 expandtab: */