SDL
2.0
|
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"
Go to the source code of this file.
Macros | |
#define | SDL_BUTTON(X) (1 << ((X)-1)) |
#define | SDL_BUTTON_LEFT 1 |
#define | SDL_BUTTON_MIDDLE 2 |
#define | SDL_BUTTON_RIGHT 3 |
#define | SDL_BUTTON_X1 4 |
#define | SDL_BUTTON_X2 5 |
#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) |
#define | SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1) |
#define | SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2) |
Enumerations | |
enum | SDL_SystemCursor { SDL_SYSTEM_CURSOR_ARROW, SDL_SYSTEM_CURSOR_IBEAM, SDL_SYSTEM_CURSOR_WAIT, SDL_SYSTEM_CURSOR_CROSSHAIR, SDL_SYSTEM_CURSOR_WAITARROW, SDL_SYSTEM_CURSOR_SIZENWSE, SDL_SYSTEM_CURSOR_SIZENESW, SDL_SYSTEM_CURSOR_SIZEWE, SDL_SYSTEM_CURSOR_SIZENS, SDL_SYSTEM_CURSOR_SIZEALL, SDL_SYSTEM_CURSOR_NO, SDL_SYSTEM_CURSOR_HAND, SDL_NUM_SYSTEM_CURSORS } |
Cursor types for SDL_CreateSystemCursor(). More... | |
enum | SDL_MouseWheelDirection { SDL_MOUSEWHEEL_NORMAL, SDL_MOUSEWHEEL_FLIPPED } |
Scroll direction types for the Scroll event. More... | |
Functions | |
SDL_Window * | SDL_GetMouseFocus (void) |
Get the window which currently has mouse focus. More... | |
Uint32 | SDL_GetMouseState (int *x, int *y) |
Retrieve the current state of the mouse. More... | |
Uint32 | SDL_GetGlobalMouseState (int *x, int *y) |
Get the current state of the mouse, in relation to the desktop. More... | |
Uint32 | SDL_GetRelativeMouseState (int *x, int *y) |
Retrieve the relative state of the mouse. More... | |
void | SDL_WarpMouseInWindow (SDL_Window *window, int x, int y) |
Moves the mouse to the given position within the window. More... | |
int | SDL_WarpMouseGlobal (int x, int y) |
Moves the mouse to the given position in global screen space. More... | |
int | SDL_SetRelativeMouseMode (SDL_bool enabled) |
Set relative mouse mode. More... | |
int | SDL_CaptureMouse (SDL_bool enabled) |
Capture the mouse, to track input outside an SDL window. More... | |
SDL_bool | SDL_GetRelativeMouseMode (void) |
Query whether relative mouse mode is enabled. More... | |
SDL_Cursor * | SDL_CreateCursor (const Uint8 *data, const Uint8 *mask, int w, int h, int hot_x, int hot_y) |
Create a cursor, using the specified bitmap data and mask (in MSB format). More... | |
SDL_Cursor * | SDL_CreateColorCursor (SDL_Surface *surface, int hot_x, int hot_y) |
Create a color cursor. More... | |
SDL_Cursor * | SDL_CreateSystemCursor (SDL_SystemCursor id) |
Create a system cursor. More... | |
void | SDL_SetCursor (SDL_Cursor *cursor) |
Set the active cursor. More... | |
SDL_Cursor * | SDL_GetCursor (void) |
Return the active cursor. More... | |
SDL_Cursor * | SDL_GetDefaultCursor (void) |
Return the default cursor. More... | |
void | SDL_FreeCursor (SDL_Cursor *cursor) |
Frees a cursor created with SDL_CreateCursor() or similar functions. More... | |
int | SDL_ShowCursor (int toggle) |
Toggle whether or not the cursor is shown. More... | |
Include file for SDL mouse event handling.
Definition in file SDL_mouse.h.
#define SDL_BUTTON | ( | X | ) | (1 << ((X)-1)) |
Used as a mask when testing buttons in buttonstate.
Definition at line 281 of file SDL_mouse.h.
Referenced by _mouseStateCheck(), SDL_GetMouseFocus(), and SDL_PrivateSendMouseButton().
#define SDL_BUTTON_LEFT 1 |
Definition at line 282 of file SDL_mouse.h.
Referenced by SDL_BWin::_MouseButtonEvent(), _mouseStateCheck(), and loop().
#define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT) |
Definition at line 287 of file SDL_mouse.h.
Referenced by SDLTest_CommonEvent().
#define SDL_BUTTON_MIDDLE 2 |
Definition at line 283 of file SDL_mouse.h.
Referenced by SDL_BWin::_MouseButtonEvent(), and _mouseStateCheck().
#define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE) |
Definition at line 288 of file SDL_mouse.h.
Referenced by SDLTest_CommonEvent().
#define SDL_BUTTON_RIGHT 3 |
Definition at line 284 of file SDL_mouse.h.
Referenced by SDL_BWin::_MouseButtonEvent(), and _mouseStateCheck().
#define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT) |
Definition at line 289 of file SDL_mouse.h.
Referenced by SDLTest_CommonEvent().
#define SDL_BUTTON_X1 4 |
Definition at line 285 of file SDL_mouse.h.
Referenced by _mouseStateCheck().
#define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1) |
Definition at line 290 of file SDL_mouse.h.
Referenced by SDLTest_CommonEvent().
#define SDL_BUTTON_X2 5 |
Definition at line 286 of file SDL_mouse.h.
Referenced by _mouseStateCheck().
#define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2) |
Definition at line 291 of file SDL_mouse.h.
Referenced by SDLTest_CommonEvent().
Scroll direction types for the Scroll event.
Enumerator | |
---|---|
SDL_MOUSEWHEEL_NORMAL | The scroll direction is normal |
SDL_MOUSEWHEEL_FLIPPED | The scroll direction is flipped / natural |
Definition at line 66 of file SDL_mouse.h.
enum SDL_SystemCursor |
Cursor types for SDL_CreateSystemCursor().
Definition at line 46 of file SDL_mouse.h.
int SDL_CaptureMouse | ( | SDL_bool | enabled | ) |
Capture the mouse, to track input outside an SDL window.
enabled | Whether or not to enable capturing |
Capturing enables your app to obtain mouse events globally, instead of just within your window. Not all video targets support this function. When capturing is enabled, the current window will get all mouse events, but unlike relative mode, no change is made to the cursor and it is not restrained to your window.
This function may also deny mouse input to other windows–both those in your application and others on the system–so you should use this function sparingly, and in small bursts. For example, you might want to track the mouse while the user is dragging something, until the user releases a mouse button. It is not recommended that you capture the mouse for long periods of time, such as the entire time your app is running.
While captured, mouse events still report coordinates relative to the current (foreground) window, but those coordinates may be outside the bounds of the window (including negative values). Capturing is only allowed for the foreground window. If the window loses focus while capturing, the capture will be disabled automatically.
While capturing is enabled, the current window will have the SDL_WINDOW_MOUSE_CAPTURE flag set.
Definition at line 757 of file SDL_mouse.c.
References SDL_Mouse::CaptureMouse, SDL_Window::flags, NULL, SDL_GetKeyboardFocus, SDL_GetMouse(), SDL_SetError, SDL_Unsupported, and SDL_WINDOW_MOUSE_CAPTURE.
Referenced by SDL_MouseQuit().
SDL_Cursor* SDL_CreateColorCursor | ( | SDL_Surface * | surface, |
int | hot_x, | ||
int | hot_y | ||
) |
Create a color cursor.
Definition at line 841 of file SDL_mouse.c.
References SDL_Mouse::CreateCursor, cursor, SDL_Mouse::cursors, SDL_Surface::format, SDL_PixelFormat::format, SDL_Surface::h, SDL_Cursor::next, NULL, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_GetMouse(), SDL_PIXELFORMAT_ARGB8888, SDL_SetError, and SDL_Surface::w.
Referenced by SDL_CreateCursor().
SDL_Cursor* SDL_CreateCursor | ( | const Uint8 * | data, |
const Uint8 * | mask, | ||
int | w, | ||
int | h, | ||
int | hot_x, | ||
int | hot_y | ||
) |
Create a cursor, using the specified bitmap 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. |
Definition at line 792 of file SDL_mouse.c.
References cursor, NULL, SDL_Surface::pitch, SDL_Surface::pixels, SDL_CreateColorCursor(), SDL_CreateRGBSurface, and SDL_FreeSurface.
SDL_Cursor* SDL_CreateSystemCursor | ( | SDL_SystemCursor | id | ) |
Create a system cursor.
Definition at line 884 of file SDL_mouse.c.
References SDL_Mouse::CreateSystemCursor, cursor, SDL_Mouse::cursors, SDL_Cursor::next, NULL, SDL_GetMouse(), and SDL_SetError.
void SDL_FreeCursor | ( | SDL_Cursor * | cursor | ) |
Frees a cursor created with SDL_CreateCursor() or similar functions.
Definition at line 970 of file SDL_mouse.c.
References SDL_Mouse::cur_cursor, SDL_Mouse::cursors, SDL_Mouse::def_cursor, SDL_Mouse::FreeCursor, SDL_Cursor::next, NULL, SDL_GetMouse(), and SDL_SetCursor().
Referenced by SDL_MouseQuit().
SDL_Cursor* SDL_GetCursor | ( | void | ) |
Return the active cursor.
Definition at line 948 of file SDL_mouse.c.
References SDL_Mouse::cur_cursor, NULL, and SDL_GetMouse().
SDL_Cursor* SDL_GetDefaultCursor | ( | void | ) |
Return the default cursor.
Definition at line 959 of file SDL_mouse.c.
References SDL_Mouse::def_cursor, NULL, and SDL_GetMouse().
Uint32 SDL_GetGlobalMouseState | ( | int * | x, |
int * | y | ||
) |
Get the current state of the mouse, in relation to the desktop.
This works just like SDL_GetMouseState(), but the coordinates will be reported relative to the top-left of the desktop. This can be useful if you need to track the mouse outside of a specific window and SDL_CaptureMouse() doesn't fit your needs. For example, it could be useful if you need to track the mouse while dragging a window, where coordinates relative to a window might not be in sync at all times.
x | Returns the current X coord, relative to the desktop. Can be NULL. |
y | Returns the current Y coord, relative to the desktop. Can be NULL. |
Definition at line 633 of file SDL_mouse.c.
References SDL_Mouse::GetGlobalMouseState, and SDL_GetMouse().
SDL_Window* SDL_GetMouseFocus | ( | void | ) |
Get the window which currently has mouse focus.
Definition at line 124 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_Mouse::focus, i, SDL_Mouse::mouseID, SDL_assert, SDL_BUTTON, SDL_GetMouse(), SDL_RELEASED, and SDL_SendMouseButton().
Uint32 SDL_GetMouseState | ( | int * | x, |
int * | y | ||
) |
Retrieve the current state of the mouse.
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 cursor position relative to the focus window for the currently selected mouse. You can pass NULL for either x or y.
Definition at line 603 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_Mouse::x, and SDL_Mouse::y.
Query whether relative mouse mode is enabled.
Definition at line 749 of file SDL_mouse.c.
References SDL_Mouse::relative_mode, and SDL_GetMouse().
Uint32 SDL_GetRelativeMouseState | ( | int * | x, |
int * | y | ||
) |
Retrieve the relative state of the mouse.
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().
Definition at line 617 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_Mouse::xdelta, and SDL_Mouse::ydelta.
void SDL_SetCursor | ( | SDL_Cursor * | cursor | ) |
Set the active cursor.
Definition at line 908 of file SDL_mouse.c.
References SDL_Mouse::cur_cursor, cursor, SDL_Mouse::cursor_shown, SDL_Mouse::cursors, SDL_Mouse::def_cursor, SDL_Mouse::focus, SDL_Cursor::next, NULL, SDL_Mouse::relative_mode, SDL_GetMouse(), SDL_SetError, and SDL_Mouse::ShowCursor.
Referenced by SDL_FreeCursor(), SDL_SetDefaultCursor(), SDL_SetMouseFocus(), SDL_SetRelativeMouseMode(), and SDL_ShowCursor().
int SDL_SetRelativeMouseMode | ( | SDL_bool | enabled | ) |
Set relative mouse mode.
enabled | Whether or not to enable relative mode |
While the mouse is in relative mode, the cursor is hidden, and the driver will try to report continuous motion in the current window. Only relative motion events will be delivered, the mouse position will not change.
Definition at line 698 of file SDL_mouse.c.
References SDL_Mouse::focus, SDL_Window::h, NULL, SDL_Mouse::relative_mode, SDL_Mouse::relative_mode_warp, SDL_Mouse::scale_accum_x, SDL_Mouse::scale_accum_y, SDL_FALSE, SDL_FlushEvent, SDL_GetKeyboardFocus, SDL_GetMouse(), SDL_MOUSEMOTION, SDL_SetCursor(), SDL_SetMouseFocus(), SDL_TRUE, SDL_UpdateWindowGrab(), SDL_WarpMouseInWindow(), SDL_Mouse::SetRelativeMouseMode, ShouldUseRelativeModeWarp(), SDL_Window::w, SDL_Mouse::x, and SDL_Mouse::y.
Referenced by SDL_MouseQuit().
int SDL_ShowCursor | ( | int | toggle | ) |
Toggle whether or not the cursor is shown.
toggle | 1 to show the cursor, 0 to hide it, -1 to query the current state. |
Definition at line 1004 of file SDL_mouse.c.
References SDL_Mouse::cursor_shown, NULL, SDL_FALSE, SDL_GetMouse(), SDL_SetCursor(), and SDL_TRUE.
Referenced by SDL_MouseQuit().
int SDL_WarpMouseGlobal | ( | int | x, |
int | y | ||
) |
Moves the mouse to the given position in global screen space.
x | The x coordinate |
y | The y coordinate |
Definition at line 676 of file SDL_mouse.c.
References SDL_GetMouse(), SDL_Unsupported, and SDL_Mouse::WarpMouseGlobal.
void SDL_WarpMouseInWindow | ( | SDL_Window * | window, |
int | x, | ||
int | y | ||
) |
Moves the mouse to the given position within the window.
window | The window to move the mouse into, or NULL for the current mouse focus |
x | The x coordinate within the window |
y | The y coordinate within the window |
Definition at line 656 of file SDL_mouse.c.
References SDL_Mouse::focus, SDL_Mouse::mouseID, NULL, SDL_GetMouse(), SDL_SendMouseMotion(), and SDL_Mouse::WarpMouse.
Referenced by SDL_PrivateSendMouseMotion(), and SDL_SetRelativeMouseMode().