SDL
2.0
|
#include "../SDL_internal.h"
#include "SDL_assert.h"
#include "SDL_hints.h"
#include "SDL_timer.h"
#include "SDL_events.h"
#include "SDL_events_c.h"
#include "default_cursor.h"
#include "../video/SDL_sysvideo.h"
Go to the source code of this file.
Variables | |
static SDL_Mouse | SDL_mouse |
static Uint32 | SDL_double_click_time = 500 |
static int | SDL_double_click_radius = 1 |
|
static |
Definition at line 307 of file SDL_mouse.c.
References button, SDL_Mouse::clickstate, i, NULL, SDL_Mouse::num_clickstates, SDL_realloc, and SDL_zero.
Referenced by SDL_PrivateSendMouseButton().
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 632 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 716 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 667 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 759 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 845 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 823 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 834 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 509 of file SDL_mouse.c.
References SDL_Mouse::GetGlobalMouseState, SDL_assert, and SDL_GetMouse().
Definition at line 66 of file SDL_mouse.c.
References SDL_mouse.
Referenced by SDL_CaptureMouse(), SDL_CreateColorCursor(), SDL_CreateSystemCursor(), SDL_FreeCursor(), SDL_GetCursor(), SDL_GetDefaultCursor(), SDL_GetGlobalMouseState(), SDL_GetMouseFocus(), SDL_GetMouseState(), SDL_GetRelativeMouseMode(), SDL_GetRelativeMouseState(), SDL_MouseInit(), SDL_MouseQuit(), SDL_OnWindowFocusGained(), SDL_PrivateSendMouseButton(), SDL_PrivateSendMouseMotion(), SDL_ResetMouse(), SDL_SendMouseMotion(), SDL_SendMouseWheel(), SDL_SetCursor(), SDL_SetDefaultCursor(), SDL_SetMouseFocus(), SDL_SetRelativeMouseMode(), SDL_ShowCursor(), SDL_UpdateMouseFocus(), SDL_UpdateWindowGrab(), SDL_WarpMouseGlobal(), and SDL_WarpMouseInWindow().
SDL_Window* SDL_GetMouseFocus | ( | void | ) |
Get the window which currently has mouse focus.
Definition at line 78 of file SDL_mouse.c.
References SDL_Mouse::focus, and SDL_GetMouse().
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 479 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 624 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 493 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_Mouse::xdelta, and SDL_Mouse::ydelta.
int SDL_MouseInit | ( | void | ) |
Definition at line 45 of file SDL_mouse.c.
References SDL_Mouse::cursor_shown, SDL_GetMouse(), and SDL_TRUE.
Referenced by SDL_VideoInit().
Definition at line 449 of file SDL_mouse.c.
References SDL_Mouse::CaptureMouse, SDL_Mouse::clickstate, cursor, SDL_Mouse::cursors, SDL_Mouse::def_cursor, SDL_Mouse::FreeCursor, SDL_Cursor::next, SDL_CaptureMouse(), SDL_FALSE, SDL_free(), SDL_FreeCursor(), SDL_GetMouse(), SDL_SetRelativeMouseMode(), SDL_ShowCursor(), and SDL_zerop.
Referenced by SDL_VideoQuit().
|
static |
Definition at line 326 of file SDL_mouse.c.
References button, SDL_Mouse::buttonstate, SDL_MouseClickState::click_count, SDL_Mouse::focus, GetMouseClickState(), SDL_Window::id, SDL_MouseClickState::last_timestamp, SDL_MouseClickState::last_x, SDL_MouseClickState::last_y, SDL_abs, SDL_BUTTON, SDL_double_click_radius, SDL_double_click_time, SDL_ENABLE, SDL_GetEventState, SDL_GetMouse(), SDL_GetTicks(), SDL_min, SDL_MOUSEBUTTONDOWN, SDL_MOUSEBUTTONUP, SDL_PRESSED, SDL_PushEvent, SDL_RELEASED, SDL_TICKS_PASSED, SDL_UpdateMouseFocus(), state, SDL_Mouse::x, and SDL_Mouse::y.
Referenced by SDL_SendMouseButton(), and SDL_SendMouseButtonClicks().
|
static |
Definition at line 201 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_Mouse::cur_cursor, SDL_Mouse::cursor_shown, SDL_Window::flags, SDL_Mouse::focus, SDL_Window::id, SDL_Mouse::last_x, SDL_Mouse::last_y, SDL_Mouse::MoveCursor, SDL_Mouse::relative_mode, SDL_Mouse::relative_mode_warp, SDL_ENABLE, SDL_GetEventState, SDL_GetMouse(), SDL_GetWindowSize, SDL_MOUSEMOTION, SDL_PushEvent, SDL_WarpMouseInWindow(), SDL_WINDOW_MOUSE_CAPTURE, SDL_Mouse::x, SDL_Mouse::xdelta, SDL_Mouse::y, and SDL_Mouse::ydelta.
Referenced by SDL_SendMouseMotion(), and SDL_UpdateMouseFocus().
Definition at line 86 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().
Referenced by SDL_SetMouseFocus().
int SDL_SendMouseButton | ( | SDL_Window * | window, |
SDL_MouseID | mouseID, | ||
Uint8 | state, | ||
Uint8 | button | ||
) |
Definition at line 414 of file SDL_mouse.c.
References SDL_PrivateSendMouseButton().
Referenced by SDL_BApp::_HandleMouseButton(), and SDL_ResetMouse().
int SDL_SendMouseButtonClicks | ( | SDL_Window * | window, |
SDL_MouseID | mouseID, | ||
Uint8 | state, | ||
Uint8 | button, | ||
int | clicks | ||
) |
Definition at line 407 of file SDL_mouse.c.
References SDL_max, and SDL_PrivateSendMouseButton().
int SDL_SendMouseMotion | ( | SDL_Window * | window, |
SDL_MouseID | mouseID, | ||
int | relative, | ||
int | x, | ||
int | y | ||
) |
Definition at line 188 of file SDL_mouse.c.
References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_PrivateSendMouseMotion(), and SDL_UpdateMouseFocus().
Referenced by SDL_BApp::_HandleMouseMove(), IsSDLWindowEventPending(), and SDL_WarpMouseInWindow().
int SDL_SendMouseWheel | ( | SDL_Window * | window, |
SDL_MouseID | mouseID, | ||
int | x, | ||
int | y, | ||
SDL_MouseWheelDirection | direction | ||
) |
Definition at line 420 of file SDL_mouse.c.
References SDL_Mouse::focus, SDL_Window::id, SDL_ENABLE, SDL_GetEventState, SDL_GetMouse(), SDL_MOUSEWHEEL, SDL_PushEvent, and SDL_SetMouseFocus().
Referenced by SDL_BApp::_HandleMouseWheel().
void SDL_SetCursor | ( | SDL_Cursor * | cursor | ) |
Set the active cursor.
Definition at line 783 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().
void SDL_SetDefaultCursor | ( | SDL_Cursor * | cursor | ) |
Definition at line 55 of file SDL_mouse.c.
References SDL_Mouse::cur_cursor, cursor, SDL_Mouse::def_cursor, SDL_GetMouse(), and SDL_SetCursor().
void SDL_SetMouseFocus | ( | SDL_Window * | window | ) |
Definition at line 103 of file SDL_mouse.c.
References SDL_Mouse::focus, NULL, SDL_GetMouse(), SDL_ResetMouse(), SDL_SendWindowEvent(), SDL_SetCursor(), SDL_WINDOWEVENT_ENTER, SDL_WINDOWEVENT_LEAVE, and window.
Referenced by SDL_BApp::_HandleMouseFocus(), SDL_DestroyWindow(), SDL_OnWindowFocusGained(), SDL_SendMouseWheel(), SDL_SetRelativeMouseMode(), and SDL_UpdateMouseFocus().
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 575 of file SDL_mouse.c.
References SDL_Mouse::focus, SDL_Window::h, NULL, SDL_Mouse::relative_mode, SDL_Mouse::relative_mode_warp, 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 879 of file SDL_mouse.c.
References SDL_Mouse::cursor_shown, NULL, SDL_FALSE, SDL_GetMouse(), SDL_SetCursor(), and SDL_TRUE.
Referenced by SDL_MouseQuit().
|
static |
Definition at line 140 of file SDL_mouse.c.
References SDL_Window::flags, SDL_Mouse::focus, SDL_Mouse::mouseID, NULL, SDL_FALSE, SDL_GetMouse(), SDL_GetWindowSize, SDL_PrivateSendMouseMotion(), SDL_SetMouseFocus(), SDL_TRUE, and SDL_WINDOW_MOUSE_CAPTURE.
Referenced by SDL_PrivateSendMouseButton(), and SDL_SendMouseMotion().
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 553 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 533 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().
Definition at line 565 of file SDL_mouse.c.
References SDL_FALSE, SDL_GetHintBoolean, SDL_HINT_MOUSE_RELATIVE_MODE_WARP, SDL_TRUE, and SDL_Mouse::SetRelativeMouseMode.
Referenced by SDL_SetRelativeMouseMode().
|
static |
Definition at line 38 of file SDL_mouse.c.
Referenced by SDL_PrivateSendMouseButton().
|
static |
Definition at line 37 of file SDL_mouse.c.
Referenced by SDL_PrivateSendMouseButton(), and SDL_SetDoubleClickTime().
|
static |
Definition at line 36 of file SDL_mouse.c.
Referenced by SDL_GetMouse().