SDL  2.0
SDL_mouse.c File Reference
#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 "../SDL_hints_c.h"
#include "../video/SDL_sysvideo.h"
#include "../core/windows/SDL_windows.h"
+ Include dependency graph for SDL_mouse.c:

Go to the source code of this file.

Functions

static int SDL_PrivateSendMouseMotion (SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
 
static void SDL_MouseDoubleClickTimeChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
static void SDL_MouseDoubleClickRadiusChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
static void SDL_MouseNormalSpeedScaleChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
static void SDL_MouseRelativeSpeedScaleChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
static void SDL_TouchMouseEventsChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
static void SDL_MouseTouchEventsChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
 
int SDL_MouseInit (void)
 
void SDL_SetDefaultCursor (SDL_Cursor *cursor)
 
SDL_MouseSDL_GetMouse (void)
 
SDL_WindowSDL_GetMouseFocus (void)
 Get the window which currently has mouse focus. More...
 
void SDL_SetMouseFocus (SDL_Window *window)
 
static SDL_bool SDL_UpdateMouseFocus (SDL_Window *window, int x, int y, Uint32 buttonstate, SDL_bool send_mouse_motion)
 
int SDL_SendMouseMotion (SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
 
static int GetScaledMouseDelta (float scale, int value, float *accum)
 
static SDL_MouseClickStateGetMouseClickState (SDL_Mouse *mouse, Uint8 button)
 
static int SDL_PrivateSendMouseButton (SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button, int clicks)
 
int SDL_SendMouseButtonClicks (SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button, int clicks)
 
int SDL_SendMouseButton (SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button)
 
int SDL_SendMouseWheel (SDL_Window *window, SDL_MouseID mouseID, float x, float y, SDL_MouseWheelDirection direction)
 
void SDL_MouseQuit (void)
 
Uint32 SDL_GetMouseState (int *x, int *y)
 Retrieve the current state of the mouse. More...
 
Uint32 SDL_GetRelativeMouseState (int *x, int *y)
 Retrieve the relative 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...
 
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...
 
static SDL_bool ShouldUseRelativeModeWarp (SDL_Mouse *mouse)
 
int SDL_SetRelativeMouseMode (SDL_bool enabled)
 Set relative mouse mode. More...
 
SDL_bool SDL_GetRelativeMouseMode ()
 Query whether relative mouse mode is enabled. More...
 
int SDL_CaptureMouse (SDL_bool enabled)
 Capture the mouse, to track input outside an SDL window. More...
 
SDL_CursorSDL_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_CursorSDL_CreateColorCursor (SDL_Surface *surface, int hot_x, int hot_y)
 Create a color cursor. More...
 
SDL_CursorSDL_CreateSystemCursor (SDL_SystemCursor id)
 Create a system cursor. More...
 
void SDL_SetCursor (SDL_Cursor *cursor)
 Set the active cursor. More...
 
SDL_CursorSDL_GetCursor (void)
 Return the active cursor. More...
 
SDL_CursorSDL_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...
 

Variables

static SDL_Mouse SDL_mouse
 
static SDL_bool track_mouse_down = SDL_FALSE
 

Function Documentation

◆ GetMouseClickState()

static SDL_MouseClickState* GetMouseClickState ( SDL_Mouse mouse,
Uint8  button 
)
static

Definition at line 464 of file SDL_mouse.c.

465 {
466  if (button >= mouse->num_clickstates) {
467  int i, count = button + 1;
468  SDL_MouseClickState *clickstate = (SDL_MouseClickState *)SDL_realloc(mouse->clickstate, count * sizeof(*mouse->clickstate));
469  if (!clickstate) {
470  return NULL;
471  }
472  mouse->clickstate = clickstate;
473 
474  for (i = mouse->num_clickstates; i < count; ++i) {
475  SDL_zero(mouse->clickstate[i]);
476  }
477  mouse->num_clickstates = count;
478  }
479  return &mouse->clickstate[button];
480 }

References button, SDL_Mouse::clickstate, i, NULL, SDL_Mouse::num_clickstates, SDL_realloc, and SDL_zero.

Referenced by SDL_PrivateSendMouseButton().

◆ GetScaledMouseDelta()

static int GetScaledMouseDelta ( float  scale,
int  value,
float *  accum 
)
static

Definition at line 306 of file SDL_mouse.c.

307 {
308  if (scale != 1.0f) {
309  *accum += scale * value;
310  if (*accum >= 0.0f) {
311  value = (int)SDL_floor(*accum);
312  } else {
313  value = (int)SDL_ceil(*accum);
314  }
315  *accum -= value;
316  }
317  return value;
318 }

References SDL_ceil, and SDL_floor.

Referenced by SDL_PrivateSendMouseMotion().

◆ SDL_CaptureMouse()

int SDL_CaptureMouse ( SDL_bool  enabled)

Capture the mouse, to track input outside an SDL window.

Parameters
enabledWhether 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.

Returns
0 on success, or -1 if not supported.

Definition at line 850 of file SDL_mouse.c.

851 {
852  SDL_Mouse *mouse = SDL_GetMouse();
853  SDL_Window *focusWindow;
854  SDL_bool isCaptured;
855 
856  if (!mouse->CaptureMouse) {
857  return SDL_Unsupported();
858  }
859 
860  focusWindow = SDL_GetKeyboardFocus();
861 
862  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
863  if (isCaptured == enabled) {
864  return 0; /* already done! */
865  }
866 
867  if (enabled) {
868  if (!focusWindow) {
869  return SDL_SetError("No window has focus");
870  } else if (mouse->CaptureMouse(focusWindow) == -1) {
871  return -1; /* CaptureMouse() should call SetError */
872  }
873  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
874  } else {
875  if (mouse->CaptureMouse(NULL) == -1) {
876  return -1; /* CaptureMouse() should call SetError */
877  }
878  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
879  }
880 
881  return 0;
882 }

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_CreateColorCursor()

SDL_Cursor* SDL_CreateColorCursor ( SDL_Surface surface,
int  hot_x,
int  hot_y 
)

Create a color cursor.

See also
SDL_FreeCursor()

Definition at line 934 of file SDL_mouse.c.

935 {
936  SDL_Mouse *mouse = SDL_GetMouse();
937  SDL_Surface *temp = NULL;
939 
940  if (!surface) {
941  SDL_SetError("Passed NULL cursor surface");
942  return NULL;
943  }
944 
945  if (!mouse->CreateCursor) {
946  SDL_SetError("Cursors are not currently supported");
947  return NULL;
948  }
949 
950  /* Sanity check the hot spot */
951  if ((hot_x < 0) || (hot_y < 0) ||
952  (hot_x >= surface->w) || (hot_y >= surface->h)) {
953  SDL_SetError("Cursor hot spot doesn't lie within cursor");
954  return NULL;
955  }
956 
957  if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
959  if (!temp) {
960  return NULL;
961  }
962  surface = temp;
963  }
964 
965  cursor = mouse->CreateCursor(surface, hot_x, hot_y);
966  if (cursor) {
967  cursor->next = mouse->cursors;
968  mouse->cursors = cursor;
969  }
970 
971  SDL_FreeSurface(temp);
972 
973  return cursor;
974 }

References SDL_Mouse::CreateCursor, cursor, SDL_Mouse::cursors, hot_x, SDL_Cursor::next, NULL, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_GetMouse(), SDL_PIXELFORMAT_ARGB8888, and SDL_SetError.

Referenced by SDL_CreateCursor().

◆ 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.
See also
SDL_FreeCursor()

Definition at line 885 of file SDL_mouse.c.

887 {
890  int x, y;
891  Uint32 *pixel;
892  Uint8 datab = 0, maskb = 0;
893  const Uint32 black = 0xFF000000;
894  const Uint32 white = 0xFFFFFFFF;
895  const Uint32 transparent = 0x00000000;
896 
897  /* Make sure the width is a multiple of 8 */
898  w = ((w + 7) & ~7);
899 
900  /* Create the surface from a bitmap */
901  surface = SDL_CreateRGBSurface(0, w, h, 32,
902  0x00FF0000,
903  0x0000FF00,
904  0x000000FF,
905  0xFF000000);
906  if (!surface) {
907  return NULL;
908  }
909  for (y = 0; y < h; ++y) {
910  pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
911  for (x = 0; x < w; ++x) {
912  if ((x % 8) == 0) {
913  datab = *data++;
914  maskb = *mask++;
915  }
916  if (maskb & 0x80) {
917  *pixel++ = (datab & 0x80) ? black : white;
918  } else {
919  *pixel++ = (datab & 0x80) ? black : transparent;
920  }
921  datab <<= 1;
922  maskb <<= 1;
923  }
924  }
925 
927 
929 
930  return cursor;
931 }

References cursor, hot_x, NULL, SDL_CreateColorCursor(), SDL_CreateRGBSurface, and SDL_FreeSurface.

◆ SDL_CreateSystemCursor()

SDL_Cursor* SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 977 of file SDL_mouse.c.

978 {
979  SDL_Mouse *mouse = SDL_GetMouse();
981 
982  if (!mouse->CreateSystemCursor) {
983  SDL_SetError("CreateSystemCursor is not currently supported");
984  return NULL;
985  }
986 
987  cursor = mouse->CreateSystemCursor(id);
988  if (cursor) {
989  cursor->next = mouse->cursors;
990  mouse->cursors = cursor;
991  }
992 
993  return cursor;
994 }

References SDL_Mouse::CreateSystemCursor, cursor, SDL_Mouse::cursors, SDL_Cursor::next, NULL, SDL_GetMouse(), and SDL_SetError.

◆ SDL_FreeCursor()

void SDL_FreeCursor ( SDL_Cursor cursor)

Frees a cursor created with SDL_CreateCursor() or similar functions.

See also
SDL_CreateCursor()
SDL_CreateColorCursor()
SDL_CreateSystemCursor()

Definition at line 1063 of file SDL_mouse.c.

1064 {
1065  SDL_Mouse *mouse = SDL_GetMouse();
1066  SDL_Cursor *curr, *prev;
1067 
1068  if (!cursor) {
1069  return;
1070  }
1071 
1072  if (cursor == mouse->def_cursor) {
1073  return;
1074  }
1075  if (cursor == mouse->cur_cursor) {
1076  SDL_SetCursor(mouse->def_cursor);
1077  }
1078 
1079  for (prev = NULL, curr = mouse->cursors; curr;
1080  prev = curr, curr = curr->next) {
1081  if (curr == cursor) {
1082  if (prev) {
1083  prev->next = curr->next;
1084  } else {
1085  mouse->cursors = curr->next;
1086  }
1087 
1088  if (mouse->FreeCursor) {
1089  mouse->FreeCursor(curr);
1090  }
1091  return;
1092  }
1093  }
1094 }

References SDL_Mouse::cur_cursor, 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_GetCursor()

SDL_Cursor* SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 1041 of file SDL_mouse.c.

1042 {
1043  SDL_Mouse *mouse = SDL_GetMouse();
1044 
1045  if (!mouse) {
1046  return NULL;
1047  }
1048  return mouse->cur_cursor;
1049 }

References SDL_Mouse::cur_cursor, NULL, and SDL_GetMouse().

◆ SDL_GetDefaultCursor()

SDL_Cursor* SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 1052 of file SDL_mouse.c.

1053 {
1054  SDL_Mouse *mouse = SDL_GetMouse();
1055 
1056  if (!mouse) {
1057  return NULL;
1058  }
1059  return mouse->def_cursor;
1060 }

References SDL_Mouse::def_cursor, NULL, and SDL_GetMouse().

◆ SDL_GetGlobalMouseState()

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.

Note
SDL_GetMouseState() returns the mouse position as SDL understands it from the last pump of the event queue. This function, however, queries the OS for the current mouse position, and as such, might be a slightly less efficient function. Unless you know what you're doing and have a good reason to use this function, you probably want SDL_GetMouseState() instead.
Parameters
xReturns the current X coord, relative to the desktop. Can be NULL.
yReturns the current Y coord, relative to the desktop. Can be NULL.
Returns
The current button state as a bitmask, which can be tested using the SDL_BUTTON(X) macros.
See also
SDL_GetMouseState

Definition at line 722 of file SDL_mouse.c.

723 {
724  SDL_Mouse *mouse = SDL_GetMouse();
725  int tmpx, tmpy;
726 
727  /* make sure these are never NULL for the backend implementations... */
728  if (!x) {
729  x = &tmpx;
730  }
731  if (!y) {
732  y = &tmpy;
733  }
734 
735  *x = *y = 0;
736 
737  if (!mouse->GetGlobalMouseState) {
738  return 0;
739  }
740 
741  return mouse->GetGlobalMouseState(x, y);
742 }

References SDL_Mouse::GetGlobalMouseState, and SDL_GetMouse().

◆ SDL_GetMouse()

◆ SDL_GetMouseFocus()

SDL_Window* SDL_GetMouseFocus ( void  )

Get the window which currently has mouse focus.

Definition at line 176 of file SDL_mouse.c.

177 {
178  SDL_Mouse *mouse = SDL_GetMouse();
179 
180  return mouse->focus;
181 }

References SDL_Mouse::focus, and SDL_GetMouse().

◆ SDL_GetMouseState()

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 692 of file SDL_mouse.c.

693 {
694  SDL_Mouse *mouse = SDL_GetMouse();
695 
696  if (x) {
697  *x = mouse->x;
698  }
699  if (y) {
700  *y = mouse->y;
701  }
702  return mouse->buttonstate;
703 }

References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_Mouse::x, and SDL_Mouse::y.

◆ SDL_GetRelativeMouseMode()

SDL_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 842 of file SDL_mouse.c.

843 {
844  SDL_Mouse *mouse = SDL_GetMouse();
845 
846  return mouse->relative_mode;
847 }

References SDL_Mouse::relative_mode, and SDL_GetMouse().

◆ SDL_GetRelativeMouseState()

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 706 of file SDL_mouse.c.

707 {
708  SDL_Mouse *mouse = SDL_GetMouse();
709 
710  if (x) {
711  *x = mouse->xdelta;
712  }
713  if (y) {
714  *y = mouse->ydelta;
715  }
716  mouse->xdelta = 0;
717  mouse->ydelta = 0;
718  return mouse->buttonstate;
719 }

References SDL_Mouse::buttonstate, SDL_GetMouse(), SDL_Mouse::xdelta, and SDL_Mouse::ydelta.

◆ SDL_MouseDoubleClickRadiusChanged()

static void SDL_MouseDoubleClickRadiusChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 64 of file SDL_mouse.c.

65 {
66  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
67 
68  if (hint && *hint) {
69  mouse->double_click_radius = SDL_atoi(hint);
70  } else {
71  mouse->double_click_radius = 32; /* 32 pixels seems about right for touch interfaces */
72  }
73 }

References SDL_Mouse::double_click_radius, and SDL_atoi.

Referenced by SDL_MouseInit().

◆ SDL_MouseDoubleClickTimeChanged()

static void SDL_MouseDoubleClickTimeChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 48 of file SDL_mouse.c.

49 {
50  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
51 
52  if (hint && *hint) {
53  mouse->double_click_time = SDL_atoi(hint);
54  } else {
55 #ifdef __WIN32__
56  mouse->double_click_time = GetDoubleClickTime();
57 #else
58  mouse->double_click_time = 500;
59 #endif
60  }
61 }

References SDL_Mouse::double_click_time, and SDL_atoi.

Referenced by SDL_MouseInit().

◆ SDL_MouseInit()

int SDL_MouseInit ( void  )

Definition at line 127 of file SDL_mouse.c.

References SDL_Mouse::cursor_shown, SDL_AddHintCallback, SDL_FALSE, SDL_GetMouse(), SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS, SDL_HINT_MOUSE_DOUBLE_CLICK_TIME, SDL_HINT_MOUSE_NORMAL_SPEED_SCALE, SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE, SDL_HINT_MOUSE_TOUCH_EVENTS, SDL_HINT_TOUCH_MOUSE_EVENTS, SDL_MouseDoubleClickRadiusChanged(), SDL_MouseDoubleClickTimeChanged(), SDL_MouseNormalSpeedScaleChanged(), SDL_MouseRelativeSpeedScaleChanged(), SDL_MouseTouchEventsChanged(), SDL_TouchMouseEventsChanged(), SDL_TRUE, SDL_zerop, and SDL_Mouse::was_touch_mouse_events.

Referenced by SDL_VideoInit().

◆ SDL_MouseNormalSpeedScaleChanged()

static void SDL_MouseNormalSpeedScaleChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 76 of file SDL_mouse.c.

77 {
78  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
79 
80  if (hint && *hint) {
81  mouse->normal_speed_scale = (float)SDL_atof(hint);
82  } else {
83  mouse->normal_speed_scale = 1.0f;
84  }
85 }

References SDL_Mouse::normal_speed_scale, and SDL_atof.

Referenced by SDL_MouseInit(), and SDL_MouseQuit().

◆ SDL_MouseQuit()

void SDL_MouseQuit ( void  )

◆ SDL_MouseRelativeSpeedScaleChanged()

static void SDL_MouseRelativeSpeedScaleChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 88 of file SDL_mouse.c.

89 {
90  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
91 
92  if (hint && *hint) {
93  mouse->relative_speed_scale = (float)SDL_atof(hint);
94  } else {
95  mouse->relative_speed_scale = 1.0f;
96  }
97 }

References SDL_Mouse::relative_speed_scale, and SDL_atof.

Referenced by SDL_MouseInit(), and SDL_MouseQuit().

◆ SDL_MouseTouchEventsChanged()

static void SDL_MouseTouchEventsChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 108 of file SDL_mouse.c.

109 {
110  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
111  SDL_bool default_value;
112 
113 #if defined(__ANDROID__) || (defined(__IPHONEOS__) && !defined(__TVOS__))
114  default_value = SDL_TRUE;
115 #else
116  default_value = SDL_FALSE;
117 #endif
118  mouse->mouse_touch_events = SDL_GetStringBoolean(hint, default_value);
119 
120  if (mouse->mouse_touch_events) {
122  }
123 }

References SDL_Mouse::mouse_touch_events, SDL_AddTouch(), SDL_FALSE, SDL_GetStringBoolean(), SDL_MOUSE_TOUCHID, SDL_TOUCH_DEVICE_DIRECT, and SDL_TRUE.

Referenced by SDL_MouseInit().

◆ SDL_PrivateSendMouseButton()

static int SDL_PrivateSendMouseButton ( SDL_Window window,
SDL_MouseID  mouseID,
Uint8  state,
Uint8  button,
int  clicks 
)
static

Definition at line 483 of file SDL_mouse.c.

484 {
485  SDL_Mouse *mouse = SDL_GetMouse();
486  int posted;
487  Uint32 type;
488  Uint32 buttonstate = mouse->buttonstate;
489 
490  /* SDL_HINT_MOUSE_TOUCH_EVENTS: controlling whether mouse events should generate synthetic touch events */
491  if (mouse->mouse_touch_events) {
492  if (mouseID != SDL_TOUCH_MOUSEID && button == SDL_BUTTON_LEFT) {
493  if (state == SDL_PRESSED) {
495  } else {
497  }
498  if (window) {
499  float fx = (float)mouse->x / (float)window->w;
500  float fy = (float)mouse->y / (float)window->h;
502  }
503  }
504  }
505 
506  /* SDL_HINT_TOUCH_MOUSE_EVENTS: if not set, discard synthetic mouse events coming from platform layer */
507  if (mouse->touch_mouse_events == 0) {
508  if (mouseID == SDL_TOUCH_MOUSEID) {
509  return 0;
510  }
511  }
512 
513  /* Figure out which event to perform */
514  switch (state) {
515  case SDL_PRESSED:
517  buttonstate |= SDL_BUTTON(button);
518  break;
519  case SDL_RELEASED:
521  buttonstate &= ~SDL_BUTTON(button);
522  break;
523  default:
524  /* Invalid state -- bail */
525  return 0;
526  }
527 
528  /* We do this after calculating buttonstate so button presses gain focus */
529  if (window && state == SDL_PRESSED) {
530  SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate, SDL_TRUE);
531  }
532 
533  if (buttonstate == mouse->buttonstate) {
534  /* Ignore this event, no state change */
535  return 0;
536  }
537  mouse->buttonstate = buttonstate;
538 
539  if (clicks < 0) {
540  SDL_MouseClickState *clickstate = GetMouseClickState(mouse, button);
541  if (clickstate) {
542  if (state == SDL_PRESSED) {
543  Uint32 now = SDL_GetTicks();
544 
545  if (SDL_TICKS_PASSED(now, clickstate->last_timestamp + mouse->double_click_time) ||
546  SDL_abs(mouse->x - clickstate->last_x) > mouse->double_click_radius ||
547  SDL_abs(mouse->y - clickstate->last_y) > mouse->double_click_radius) {
548  clickstate->click_count = 0;
549  }
550  clickstate->last_timestamp = now;
551  clickstate->last_x = mouse->x;
552  clickstate->last_y = mouse->y;
553  if (clickstate->click_count < 255) {
554  ++clickstate->click_count;
555  }
556  }
557  clicks = clickstate->click_count;
558  } else {
559  clicks = 1;
560  }
561  }
562 
563  /* Post the event, if desired */
564  posted = 0;
567  event.type = type;
568  event.button.windowID = mouse->focus ? mouse->focus->id : 0;
569  event.button.which = mouseID;
570  event.button.state = state;
571  event.button.button = button;
572  event.button.clicks = (Uint8) SDL_min(clicks, 255);
573  event.button.x = mouse->x;
574  event.button.y = mouse->y;
575  posted = (SDL_PushEvent(&event) > 0);
576  }
577 
578  /* We do this after dispatching event so button releases can lose focus */
579  if (window && state == SDL_RELEASED) {
580  SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate, SDL_TRUE);
581  }
582 
583  return posted;
584 }

References button, SDL_Mouse::buttonstate, SDL_MouseClickState::click_count, SDL_Mouse::double_click_radius, SDL_Mouse::double_click_time, SDL_Mouse::focus, GetMouseClickState(), SDL_Window::id, SDL_MouseClickState::last_timestamp, SDL_MouseClickState::last_x, SDL_MouseClickState::last_y, SDL_Mouse::mouse_touch_events, SDL_abs, SDL_BUTTON, SDL_BUTTON_LEFT, SDL_ENABLE, SDL_FALSE, SDL_GetEventState, SDL_GetMouse(), SDL_GetTicks(), SDL_min, SDL_MOUSE_TOUCHID, SDL_MOUSEBUTTONDOWN, SDL_MOUSEBUTTONUP, SDL_PRESSED, SDL_PushEvent, SDL_RELEASED, SDL_SendTouch(), SDL_TICKS_PASSED, SDL_TOUCH_MOUSEID, SDL_TRUE, SDL_UpdateMouseFocus(), state, SDL_Mouse::touch_mouse_events, track_mouse_down, SDL_Mouse::x, and SDL_Mouse::y.

Referenced by SDL_SendMouseButton(), and SDL_SendMouseButtonClicks().

◆ SDL_PrivateSendMouseMotion()

static int SDL_PrivateSendMouseMotion ( SDL_Window window,
SDL_MouseID  mouseID,
int  relative,
int  x,
int  y 
)
static

Definition at line 321 of file SDL_mouse.c.

322 {
323  SDL_Mouse *mouse = SDL_GetMouse();
324  int posted;
325  int xrel;
326  int yrel;
327 
328  /* SDL_HINT_MOUSE_TOUCH_EVENTS: controlling whether mouse events should generate synthetic touch events */
329  if (mouse->mouse_touch_events) {
330  if (mouseID != SDL_TOUCH_MOUSEID && !relative && track_mouse_down) {
331  if (window) {
332  float fx = (float)x / (float)window->w;
333  float fy = (float)y / (float)window->h;
335  }
336  }
337  }
338 
339  /* SDL_HINT_TOUCH_MOUSE_EVENTS: if not set, discard synthetic mouse events coming from platform layer */
340  if (mouse->touch_mouse_events == 0) {
341  if (mouseID == SDL_TOUCH_MOUSEID) {
342  return 0;
343  }
344  }
345 
346  if (mouseID != SDL_TOUCH_MOUSEID && mouse->relative_mode_warp) {
347  int center_x = 0, center_y = 0;
348  SDL_GetWindowSize(window, &center_x, &center_y);
349  center_x /= 2;
350  center_y /= 2;
351  if (x == center_x && y == center_y) {
352  mouse->last_x = center_x;
353  mouse->last_y = center_y;
354  return 0;
355  }
356  SDL_WarpMouseInWindow(window, center_x, center_y);
357  }
358 
359  if (relative) {
360  if (mouse->relative_mode) {
363  } else {
366  }
367  xrel = x;
368  yrel = y;
369  x = (mouse->last_x + xrel);
370  y = (mouse->last_y + yrel);
371  } else {
372  xrel = x - mouse->last_x;
373  yrel = y - mouse->last_y;
374  }
375 
376  /* Ignore relative motion when first positioning the mouse */
377  if (!mouse->has_position) {
378  xrel = 0;
379  yrel = 0;
380  mouse->has_position = SDL_TRUE;
381  } else if (!xrel && !yrel) { /* Drop events that don't change state */
382 #ifdef DEBUG_MOUSE
383  printf("Mouse event didn't change state - dropped!\n");
384 #endif
385  return 0;
386  }
387 
388  /* Ignore relative motion positioning the first touch */
389  if (mouseID == SDL_TOUCH_MOUSEID && !mouse->buttonstate) {
390  xrel = 0;
391  yrel = 0;
392  }
393 
394  /* Update internal mouse coordinates */
395  if (!mouse->relative_mode) {
396  mouse->x = x;
397  mouse->y = y;
398  } else {
399  mouse->x += xrel;
400  mouse->y += yrel;
401  }
402 
403  /* make sure that the pointers find themselves inside the windows,
404  unless we have the mouse captured. */
405  if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
406  int x_max = 0, y_max = 0;
407 
408  /* !!! FIXME: shouldn't this be (window) instead of (mouse->focus)? */
409  SDL_GetWindowSize(mouse->focus, &x_max, &y_max);
410  --x_max;
411  --y_max;
412 
413  if (mouse->x > x_max) {
414  mouse->x = x_max;
415  }
416  if (mouse->x < 0) {
417  mouse->x = 0;
418  }
419 
420  if (mouse->y > y_max) {
421  mouse->y = y_max;
422  }
423  if (mouse->y < 0) {
424  mouse->y = 0;
425  }
426  }
427 
428  mouse->xdelta += xrel;
429  mouse->ydelta += yrel;
430 
431  /* Move the mouse cursor, if needed */
432  if (mouse->cursor_shown && !mouse->relative_mode &&
433  mouse->MoveCursor && mouse->cur_cursor) {
434  mouse->MoveCursor(mouse->cur_cursor);
435  }
436 
437  /* Post the event, if desired */
438  posted = 0;
441  event.motion.type = SDL_MOUSEMOTION;
442  event.motion.windowID = mouse->focus ? mouse->focus->id : 0;
443  event.motion.which = mouseID;
444  /* Set us pending (or clear during a normal mouse movement event) as having triggered */
446  event.motion.state = mouse->buttonstate;
447  event.motion.x = mouse->x;
448  event.motion.y = mouse->y;
449  event.motion.xrel = xrel;
450  event.motion.yrel = yrel;
451  posted = (SDL_PushEvent(&event) > 0);
452  }
453  if (relative) {
454  mouse->last_x = mouse->x;
455  mouse->last_y = mouse->y;
456  } else {
457  /* Use unclamped values if we're getting events outside the window */
458  mouse->last_x = x;
459  mouse->last_y = y;
460  }
461  return posted;
462 }

References SDL_Mouse::buttonstate, SDL_Mouse::cur_cursor, SDL_Mouse::cursor_shown, SDL_Mouse::focus, GetScaledMouseDelta(), SDL_Mouse::has_position, SDL_Window::id, SDL_Mouse::last_x, SDL_Mouse::last_y, SDL_Mouse::mouse_touch_events, SDL_Mouse::MoveCursor, SDL_Mouse::normal_speed_scale, SDL_Mouse::relative_mode, SDL_Mouse::relative_mode_warp, SDL_Mouse::relative_speed_scale, SDL_Mouse::scale_accum_x, SDL_Mouse::scale_accum_y, SDL_ENABLE, SDL_FALSE, SDL_GetEventState, SDL_GetMouse(), SDL_GetWindowSize, SDL_MOUSE_TOUCHID, SDL_MOUSEMOTION, SDL_PushEvent, SDL_SendTouchMotion(), SDL_TOUCH_MOUSEID, SDL_TRUE, SDL_WarpMouseInWindow(), SDL_WINDOW_MOUSE_CAPTURE, SDL_Mouse::touch_mouse_events, track_mouse_down, SDL_Mouse::was_touch_mouse_events, SDL_Mouse::x, SDL_Mouse::xdelta, SDL_Mouse::y, and SDL_Mouse::ydelta.

Referenced by SDL_SendMouseMotion(), and SDL_UpdateMouseFocus().

◆ SDL_SendMouseButton()

int SDL_SendMouseButton ( SDL_Window window,
SDL_MouseID  mouseID,
Uint8  state,
Uint8  button 
)

Definition at line 594 of file SDL_mouse.c.

595 {
596  return SDL_PrivateSendMouseButton(window, mouseID, state, button, -1);
597 }

References button, SDL_PrivateSendMouseButton(), and state.

Referenced by SDL_BApp::_HandleMouseButton(), and SDL_SendTouch().

◆ SDL_SendMouseButtonClicks()

int SDL_SendMouseButtonClicks ( SDL_Window window,
SDL_MouseID  mouseID,
Uint8  state,
Uint8  button,
int  clicks 
)

Definition at line 587 of file SDL_mouse.c.

588 {
589  clicks = SDL_max(clicks, 0);
590  return SDL_PrivateSendMouseButton(window, mouseID, state, button, clicks);
591 }

References button, SDL_max, SDL_PrivateSendMouseButton(), and state.

◆ SDL_SendMouseMotion()

int SDL_SendMouseMotion ( SDL_Window window,
SDL_MouseID  mouseID,
int  relative,
int  x,
int  y 
)

Definition at line 293 of file SDL_mouse.c.

294 {
295  if (window && !relative) {
296  SDL_Mouse *mouse = SDL_GetMouse();
297  if (!SDL_UpdateMouseFocus(window, x, y, mouse->buttonstate, (mouseID == SDL_TOUCH_MOUSEID) ? SDL_FALSE : SDL_TRUE)) {
298  return 0;
299  }
300  }
301 
302  return SDL_PrivateSendMouseMotion(window, mouseID, relative, x, y);
303 }

References SDL_Mouse::buttonstate, SDL_FALSE, SDL_GetMouse(), SDL_PrivateSendMouseMotion(), SDL_TOUCH_MOUSEID, SDL_TRUE, and SDL_UpdateMouseFocus().

Referenced by SDL_BApp::_HandleMouseMove(), SDL_SendTouch(), SDL_SendTouchMotion(), and SDL_WarpMouseInWindow().

◆ SDL_SendMouseWheel()

int SDL_SendMouseWheel ( SDL_Window window,
SDL_MouseID  mouseID,
float  x,
float  y,
SDL_MouseWheelDirection  direction 
)

Definition at line 600 of file SDL_mouse.c.

601 {
602  SDL_Mouse *mouse = SDL_GetMouse();
603  int posted;
604  int integral_x, integral_y;
605 
606  if (window) {
608  }
609 
610  if (x == 0.0f && y == 0.0f) {
611  return 0;
612  }
613 
614  mouse->accumulated_wheel_x += x;
615  if (mouse->accumulated_wheel_x > 0) {
616  integral_x = (int)SDL_floor(mouse->accumulated_wheel_x);
617  } else if (mouse->accumulated_wheel_x < 0) {
618  integral_x = (int)SDL_ceil(mouse->accumulated_wheel_x);
619  } else {
620  integral_x = 0;
621  }
622  mouse->accumulated_wheel_x -= integral_x;
623 
624  mouse->accumulated_wheel_y += y;
625  if (mouse->accumulated_wheel_y > 0) {
626  integral_y = (int)SDL_floor(mouse->accumulated_wheel_y);
627  } else if (mouse->accumulated_wheel_y < 0) {
628  integral_y = (int)SDL_ceil(mouse->accumulated_wheel_y);
629  } else {
630  integral_y = 0;
631  }
632  mouse->accumulated_wheel_y -= integral_y;
633 
634  /* Post the event, if desired */
635  posted = 0;
638  event.type = SDL_MOUSEWHEEL;
639  event.wheel.windowID = mouse->focus ? mouse->focus->id : 0;
640  event.wheel.which = mouseID;
641 #if 0 /* Uncomment this when it goes in for SDL 2.1 */
642  event.wheel.preciseX = x;
643  event.wheel.preciseY = y;
644 #endif
645  event.wheel.x = integral_x;
646  event.wheel.y = integral_y;
647  event.wheel.direction = (Uint32)direction;
648  posted = (SDL_PushEvent(&event) > 0);
649  }
650  return posted;
651 }

References SDL_Mouse::accumulated_wheel_x, SDL_Mouse::accumulated_wheel_y, SDL_Mouse::focus, SDL_Window::id, SDL_ceil, SDL_ENABLE, SDL_floor, SDL_GetEventState, SDL_GetMouse(), SDL_MOUSEWHEEL, SDL_PushEvent, and SDL_SetMouseFocus().

Referenced by SDL_BApp::_HandleMouseWheel().

◆ SDL_SetCursor()

void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

Definition at line 1001 of file SDL_mouse.c.

1002 {
1003  SDL_Mouse *mouse = SDL_GetMouse();
1004 
1005  /* Set the new cursor */
1006  if (cursor) {
1007  /* Make sure the cursor is still valid for this mouse */
1008  if (cursor != mouse->def_cursor) {
1009  SDL_Cursor *found;
1010  for (found = mouse->cursors; found; found = found->next) {
1011  if (found == cursor) {
1012  break;
1013  }
1014  }
1015  if (!found) {
1016  SDL_SetError("Cursor not associated with the current mouse");
1017  return;
1018  }
1019  }
1020  mouse->cur_cursor = cursor;
1021  } else {
1022  if (mouse->focus) {
1023  cursor = mouse->cur_cursor;
1024  } else {
1025  cursor = mouse->def_cursor;
1026  }
1027  }
1028 
1029  if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
1030  if (mouse->ShowCursor) {
1031  mouse->ShowCursor(cursor);
1032  }
1033  } else {
1034  if (mouse->ShowCursor) {
1035  mouse->ShowCursor(NULL);
1036  }
1037  }
1038 }

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().

◆ SDL_SetDefaultCursor()

void SDL_SetDefaultCursor ( SDL_Cursor cursor)

Definition at line 159 of file SDL_mouse.c.

160 {
161  SDL_Mouse *mouse = SDL_GetMouse();
162 
163  mouse->def_cursor = cursor;
164  if (!mouse->cur_cursor) {
166  }
167 }

References SDL_Mouse::cur_cursor, cursor, SDL_Mouse::def_cursor, SDL_GetMouse(), and SDL_SetCursor().

◆ SDL_SetMouseFocus()

void SDL_SetMouseFocus ( SDL_Window window)

Definition at line 203 of file SDL_mouse.c.

204 {
205  SDL_Mouse *mouse = SDL_GetMouse();
206 
207  if (mouse->focus == window) {
208  return;
209  }
210 
211  /* Actually, this ends up being a bad idea, because most operating
212  systems have an implicit grab when you press the mouse button down
213  so you can drag things out of the window and then get the mouse up
214  when it happens. So, #if 0...
215  */
216 #if 0
217  if (mouse->focus && !window) {
218  /* We won't get anymore mouse messages, so reset mouse state */
219  SDL_ResetMouse();
220  }
221 #endif
222 
223  /* See if the current window has lost focus */
224  if (mouse->focus) {
226  }
227 
228  mouse->focus = window;
229  mouse->has_position = SDL_FALSE;
230 
231  if (mouse->focus) {
233  }
234 
235  /* Update cursor visibility */
237 }

References SDL_Mouse::focus, SDL_Mouse::has_position, NULL, SDL_FALSE, SDL_GetMouse(), SDL_SendWindowEvent(), SDL_SetCursor(), SDL_WINDOWEVENT_ENTER, and SDL_WINDOWEVENT_LEAVE.

Referenced by SDL_BApp::_HandleMouseFocus(), SDL_DestroyWindow(), SDL_OnWindowFocusGained(), SDL_SendMouseWheel(), SDL_SetRelativeMouseMode(), and SDL_UpdateMouseFocus().

◆ SDL_SetRelativeMouseMode()

int SDL_SetRelativeMouseMode ( SDL_bool  enabled)

Set relative mouse mode.

Parameters
enabledWhether or not to enable relative mode
Returns
0 on success, or -1 if relative mode is not supported.

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.

Note
This function will flush any pending mouse motion.
See also
SDL_GetRelativeMouseMode()

Definition at line 788 of file SDL_mouse.c.

789 {
790  SDL_Mouse *mouse = SDL_GetMouse();
791  SDL_Window *focusWindow = SDL_GetKeyboardFocus();
792 
793  if (enabled == mouse->relative_mode) {
794  return 0;
795  }
796 
797  /* Set the relative mode */
798  if (!enabled && mouse->relative_mode_warp) {
799  mouse->relative_mode_warp = SDL_FALSE;
800  } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
801  mouse->relative_mode_warp = SDL_TRUE;
802  } else if (!mouse->SetRelativeMouseMode || mouse->SetRelativeMouseMode(enabled) < 0) {
803  if (enabled) {
804  /* Fall back to warp mode if native relative mode failed */
805  if (!mouse->WarpMouse) {
806  return SDL_SetError("No relative mode implementation available");
807  }
808  mouse->relative_mode_warp = SDL_TRUE;
809  }
810  }
811  mouse->relative_mode = enabled;
812  mouse->scale_accum_x = 0.0f;
813  mouse->scale_accum_y = 0.0f;
814 
815  if (enabled && focusWindow) {
816  /* Center it in the focused window to prevent clicks from going through
817  * to background windows.
818  */
819  SDL_SetMouseFocus(focusWindow);
820  SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
821  }
822 
823  if (mouse->focus) {
824  SDL_UpdateWindowGrab(mouse->focus);
825 
826  /* Put the cursor back to where the application expects it */
827  if (!enabled) {
828  SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
829  }
830  }
831 
832  /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
834 
835  /* Update cursor visibility */
837 
838  return 0;
839 }

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_SetError, SDL_SetMouseFocus(), SDL_TRUE, SDL_UpdateWindowGrab(), SDL_WarpMouseInWindow(), SDL_Mouse::SetRelativeMouseMode, ShouldUseRelativeModeWarp(), SDL_Window::w, SDL_Mouse::WarpMouse, SDL_Mouse::x, and SDL_Mouse::y.

Referenced by SDL_MouseQuit().

◆ SDL_ShowCursor()

int SDL_ShowCursor ( int  toggle)

Toggle whether or not the cursor is shown.

Parameters
toggle1 to show the cursor, 0 to hide it, -1 to query the current state.
Returns
1 if the cursor is shown, or 0 if the cursor is hidden.

Definition at line 1097 of file SDL_mouse.c.

1098 {
1099  SDL_Mouse *mouse = SDL_GetMouse();
1100  SDL_bool shown;
1101 
1102  if (!mouse) {
1103  return 0;
1104  }
1105 
1106  shown = mouse->cursor_shown;
1107  if (toggle >= 0) {
1108  if (toggle) {
1109  mouse->cursor_shown = SDL_TRUE;
1110  } else {
1111  mouse->cursor_shown = SDL_FALSE;
1112  }
1113  if (mouse->cursor_shown != shown) {
1115  }
1116  }
1117  return shown;
1118 }

References SDL_Mouse::cursor_shown, NULL, SDL_FALSE, SDL_GetMouse(), SDL_SetCursor(), and SDL_TRUE.

Referenced by SDL_MouseQuit().

◆ SDL_TouchMouseEventsChanged()

static void SDL_TouchMouseEventsChanged ( void userdata,
const char *  name,
const char *  oldValue,
const char *  hint 
)
static

Definition at line 100 of file SDL_mouse.c.

101 {
102  SDL_Mouse *mouse = (SDL_Mouse *)userdata;
103 
105 }

References SDL_GetStringBoolean(), SDL_TRUE, and SDL_Mouse::touch_mouse_events.

Referenced by SDL_MouseInit().

◆ SDL_UpdateMouseFocus()

static SDL_bool SDL_UpdateMouseFocus ( SDL_Window window,
int  x,
int  y,
Uint32  buttonstate,
SDL_bool  send_mouse_motion 
)
static

Definition at line 241 of file SDL_mouse.c.

242 {
243  SDL_Mouse *mouse = SDL_GetMouse();
244  SDL_bool inWindow = SDL_TRUE;
245 
246  if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
247  int w, h;
249  if (x < 0 || y < 0 || x >= w || y >= h) {
250  inWindow = SDL_FALSE;
251  }
252  }
253 
254 /* Linux doesn't give you mouse events outside your window unless you grab
255  the pointer.
256 
257  Windows doesn't give you mouse events outside your window unless you call
258  SetCapture().
259 
260  Both of these are slightly scary changes, so for now we'll punt and if the
261  mouse leaves the window you'll lose mouse focus and reset button state.
262 */
263 #ifdef SUPPORT_DRAG_OUTSIDE_WINDOW
264  if (!inWindow && !buttonstate) {
265 #else
266  if (!inWindow) {
267 #endif
268  if (window == mouse->focus) {
269 #ifdef DEBUG_MOUSE
270  printf("Mouse left window, synthesizing move & focus lost event\n");
271 #endif
272  if (send_mouse_motion) {
274  }
276  }
277  return SDL_FALSE;
278  }
279 
280  if (window != mouse->focus) {
281 #ifdef DEBUG_MOUSE
282  printf("Mouse entered window, synthesizing focus gain & move event\n");
283 #endif
285  if (send_mouse_motion) {
287  }
288  }
289  return SDL_TRUE;
290 }

References 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().

◆ SDL_WarpMouseGlobal()

int SDL_WarpMouseGlobal ( int  x,
int  y 
)

Moves the mouse to the given position in global screen space.

Parameters
xThe x coordinate
yThe y coordinate
Returns
0 on success, -1 on error (usually: unsupported by a platform).
Note
This function generates a mouse motion event

Definition at line 765 of file SDL_mouse.c.

766 {
767  SDL_Mouse *mouse = SDL_GetMouse();
768 
769  if (mouse->WarpMouseGlobal) {
770  return mouse->WarpMouseGlobal(x, y);
771  }
772 
773  return SDL_Unsupported();
774 }

References SDL_GetMouse(), SDL_Unsupported, and SDL_Mouse::WarpMouseGlobal.

◆ SDL_WarpMouseInWindow()

void SDL_WarpMouseInWindow ( SDL_Window window,
int  x,
int  y 
)

Moves the mouse to the given position within the window.

Parameters
windowThe window to move the mouse into, or NULL for the current mouse focus
xThe x coordinate within the window
yThe y coordinate within the window
Note
This function generates a mouse motion event

Definition at line 745 of file SDL_mouse.c.

746 {
747  SDL_Mouse *mouse = SDL_GetMouse();
748 
749  if (window == NULL) {
750  window = mouse->focus;
751  }
752 
753  if (window == NULL) {
754  return;
755  }
756 
757  if (mouse->WarpMouse) {
758  mouse->WarpMouse(window, x, y);
759  } else {
760  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
761  }
762 }

References SDL_Mouse::focus, SDL_Mouse::mouseID, NULL, SDL_GetMouse(), SDL_SendMouseMotion(), and SDL_Mouse::WarpMouse.

Referenced by SDL_PrivateSendMouseMotion(), and SDL_SetRelativeMouseMode().

◆ ShouldUseRelativeModeWarp()

static SDL_bool ShouldUseRelativeModeWarp ( SDL_Mouse mouse)
static

Definition at line 777 of file SDL_mouse.c.

778 {
779  if (!mouse->WarpMouse) {
780  /* Need this functionality for relative mode warp implementation */
781  return SDL_FALSE;
782  }
783 
785 }

References SDL_FALSE, SDL_GetHintBoolean, SDL_HINT_MOUSE_RELATIVE_MODE_WARP, and SDL_Mouse::WarpMouse.

Referenced by SDL_SetRelativeMouseMode().

Variable Documentation

◆ SDL_mouse

SDL_Mouse SDL_mouse
static

Definition at line 39 of file SDL_mouse.c.

Referenced by SDL_GetMouse().

◆ track_mouse_down

SDL_bool track_mouse_down = SDL_FALSE
static

Definition at line 42 of file SDL_mouse.c.

Referenced by SDL_PrivateSendMouseButton(), and SDL_PrivateSendMouseMotion().

SDL_GetMouse
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:170
SDL_zero
#define SDL_zero(x)
Definition: SDL_stdinc.h:418
SDL_WINDOW_MOUSE_CAPTURE
@ SDL_WINDOW_MOUSE_CAPTURE
Definition: SDL_video.h:115
ShouldUseRelativeModeWarp
static SDL_bool ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
Definition: SDL_mouse.c:777
SDL_TOUCH_DEVICE_DIRECT
@ SDL_TOUCH_DEVICE_DIRECT
Definition: SDL_touch.h:47
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179
SDL_Mouse::WarpMouseGlobal
int(* WarpMouseGlobal)(int x, int y)
Definition: SDL_mouse_c.h:64
SDL_Mouse::CaptureMouse
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
SDL_Mouse::buttonstate
Uint32 buttonstate
Definition: SDL_mouse_c.h:85
mask
GLenum GLint GLuint mask
Definition: SDL_opengl_glext.h:660
scale
GLenum GLenum GLenum GLenum GLenum scale
Definition: SDL_opengl_glext.h:9378
SDL_Surface
A collection of pixels used in software blitting.
Definition: SDL_surface.h:71
SDL_Cursor
Definition: SDL_mouse_c.h:31
SDL_FlushEvent
#define SDL_FlushEvent
Definition: SDL_dynapi_overrides.h:120
SDL_ConvertSurfaceFormat
#define SDL_ConvertSurfaceFormat
Definition: SDL_dynapi_overrides.h:464
SDL_abs
#define SDL_abs
Definition: SDL_dynapi_overrides.h:381
SDL_Mouse::scale_accum_y
float scale_accum_y
Definition: SDL_mouse_c.h:92
SDL_HINT_TOUCH_MOUSE_EVENTS
#define SDL_HINT_TOUCH_MOUSE_EVENTS
A variable controlling whether touch events should generate synthetic mouse events.
Definition: SDL_hints.h:348
SDL_Mouse::cursors
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:103
SDL_ceil
#define SDL_ceil
Definition: SDL_dynapi_overrides.h:426
NULL
#define NULL
Definition: begin_code.h:167
surface
EGLSurface surface
Definition: eglext.h:248
SDL_TouchMouseEventsChanged
static void SDL_TouchMouseEventsChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:100
SDL_PrivateSendMouseMotion
static int SDL_PrivateSendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:321
SDL_zerop
#define SDL_zerop(x)
Definition: SDL_stdinc.h:419
SDL_Mouse::scale_accum_x
float scale_accum_x
Definition: SDL_mouse_c.h:91
SDL_MouseDoubleClickTimeChanged
static void SDL_MouseDoubleClickTimeChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:48
SDL_WINDOWEVENT_ENTER
@ SDL_WINDOWEVENT_ENTER
Definition: SDL_video.h:162
SDL_CreateColorCursor
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.c:934
SDL_Mouse::touch_mouse_events
SDL_bool touch_mouse_events
Definition: SDL_mouse_c.h:95
SDL_MouseClickState
Definition: SDL_mouse_c.h:37
count
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
SDL_Mouse::double_click_radius
int double_click_radius
Definition: SDL_mouse_c.h:94
SDL_SendTouch
int SDL_SendTouch(SDL_TouchID id, SDL_FingerID fingerid, SDL_Window *window, SDL_bool down, float x, float y, float pressure)
Definition: SDL_touch.c:242
SDL_Mouse::normal_speed_scale
float normal_speed_scale
Definition: SDL_mouse_c.h:89
SDL_MouseNormalSpeedScaleChanged
static void SDL_MouseNormalSpeedScaleChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:76
SDL_Mouse::accumulated_wheel_x
float accumulated_wheel_x
Definition: SDL_mouse_c.h:83
SDL_Mouse::y
int y
Definition: SDL_mouse_c.h:79
SDL_MOUSEBUTTONUP
@ SDL_MOUSEBUTTONUP
Definition: SDL_events.h:107
SDL_realloc
#define SDL_realloc
Definition: SDL_dynapi_overrides.h:376
SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS
#define SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS
A variable setting the double click radius, in pixels.
Definition: SDL_hints.h:305
SDL_SetCursor
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:1001
SDL_floor
#define SDL_floor
Definition: SDL_dynapi_overrides.h:431
SDL_Mouse::SetRelativeMouseMode
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDL_ENABLE
#define SDL_ENABLE
Definition: SDL_events.h:760
SDL_RELEASED
#define SDL_RELEASED
Definition: SDL_events.h:49
h
GLfloat GLfloat GLfloat GLfloat h
Definition: SDL_opengl_glext.h:1949
SDL_SetMouseFocus
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:203
SDL_WarpMouseInWindow
void SDL_WarpMouseInWindow(SDL_Window *window, int x, int y)
Moves the mouse to the given position within the window.
Definition: SDL_mouse.c:745
SDL_ShowCursor
int SDL_ShowCursor(int toggle)
Toggle whether or not the cursor is shown.
Definition: SDL_mouse.c:1097
data
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:75
SDL_GetKeyboardFocus
#define SDL_GetKeyboardFocus
Definition: SDL_dynapi_overrides.h:216
SDL_MouseTouchEventsChanged
static void SDL_MouseTouchEventsChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:108
SDL_TOUCH_MOUSEID
#define SDL_TOUCH_MOUSEID
Definition: SDL_touch.h:61
SDL_GetWindowSize
#define SDL_GetWindowSize
Definition: SDL_dynapi_overrides.h:527
SDL_Mouse::mouse_touch_events
SDL_bool mouse_touch_events
Definition: SDL_mouse_c.h:96
SDL_Window::w
int w
Definition: SDL_sysvideo.h:81
SDL_Mouse::was_touch_mouse_events
SDL_bool was_touch_mouse_events
Definition: SDL_mouse_c.h:97
SDL_PRESSED
#define SDL_PRESSED
Definition: SDL_events.h:50
SDL_Mouse::ydelta
int ydelta
Definition: SDL_mouse_c.h:81
SDL_CaptureMouse
int SDL_CaptureMouse(SDL_bool enabled)
Capture the mouse, to track input outside an SDL window.
Definition: SDL_mouse.c:850
SDL_GetHintBoolean
#define SDL_GetHintBoolean
Definition: SDL_dynapi_overrides.h:608
event
struct _cl_event * event
Definition: SDL_opengl_glext.h:2652
SDL_Mouse::MoveCursor
void(* MoveCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:55
SDL_AddTouch
int SDL_AddTouch(SDL_TouchID touchID, SDL_TouchDeviceType type, const char *name)
Definition: SDL_touch.c:155
SDL_Mouse::relative_mode
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
SDL_MOUSEMOTION
@ SDL_MOUSEMOTION
Definition: SDL_events.h:105
SDL_BUTTON_LEFT
#define SDL_BUTTON_LEFT
Definition: SDL_mouse.h:282
SDL_atof
#define SDL_atof
Definition: SDL_dynapi_overrides.h:411
x
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
SDL_Mouse::WarpMouse
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61
SDL_UpdateMouseFocus
static SDL_bool SDL_UpdateMouseFocus(SDL_Window *window, int x, int y, Uint32 buttonstate, SDL_bool send_mouse_motion)
Definition: SDL_mouse.c:241
SDL_GetEventState
#define SDL_GetEventState(type)
Definition: SDL_events.h:773
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
f
GLfloat f
Definition: SDL_opengl_glext.h:1873
SDL_PushEvent
#define SDL_PushEvent
Definition: SDL_dynapi_overrides.h:125
SDL_max
#define SDL_max(x, y)
Definition: SDL_stdinc.h:407
SDL_mouse
static SDL_Mouse SDL_mouse
Definition: SDL_mouse.c:39
GetMouseClickState
static SDL_MouseClickState * GetMouseClickState(SDL_Mouse *mouse, Uint8 button)
Definition: SDL_mouse.c:464
SDL_MouseClickState::click_count
Uint8 click_count
Definition: SDL_mouse_c.h:40
SDL_Mouse::relative_speed_scale
float relative_speed_scale
Definition: SDL_mouse_c.h:90
SDL_MouseClickState::last_timestamp
Uint32 last_timestamp
Definition: SDL_mouse_c.h:39
SDL_SendMouseMotion
int SDL_SendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:293
SDL_Mouse::def_cursor
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:104
SDL_FreeSurface
#define SDL_FreeSurface
Definition: SDL_dynapi_overrides.h:446
SDL_MOUSEWHEEL
@ SDL_MOUSEWHEEL
Definition: SDL_events.h:108
GetScaledMouseDelta
static int GetScaledMouseDelta(float scale, int value, float *accum)
Definition: SDL_mouse.c:306
SDL_Cursor::next
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
SDL_GetTicks
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
SDL_min
#define SDL_min(x, y)
Definition: SDL_stdinc.h:406
SDL_UpdateWindowGrab
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2541
SDL_Mouse
Definition: SDL_mouse_c.h:44
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_Mouse::CreateSystemCursor
SDL_Cursor *(* CreateSystemCursor)(SDL_SystemCursor id)
Definition: SDL_mouse_c.h:49
SDL_PIXELFORMAT_ARGB8888
@ SDL_PIXELFORMAT_ARGB8888
Definition: SDL_pixels.h:251
SDL_Mouse::relative_mode_warp
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:88
hot_x
int uint32_t uint32_t uint32_t uint32_t uint32_t int drmModeModeInfoPtr mode int uint32_t uint32_t uint32_t uint32_t int32_t hot_x
Definition: SDL_kmsdrmsym.h:57
SDL_MouseDoubleClickRadiusChanged
static void SDL_MouseDoubleClickRadiusChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:64
SDL_Mouse::focus
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_Window::h
int h
Definition: SDL_sysvideo.h:81
SDL_Mouse::accumulated_wheel_y
float accumulated_wheel_y
Definition: SDL_mouse_c.h:84
cursor
SDL_Cursor * cursor
Definition: testwm2.c:40
SDL_Mouse::ShowCursor
int(* ShowCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:52
y
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
SDL_Mouse::num_clickstates
int num_clickstates
Definition: SDL_mouse_c.h:100
SDL_MOUSE_TOUCHID
#define SDL_MOUSE_TOUCHID
Definition: SDL_touch.h:64
SDL_CreateRGBSurface
#define SDL_CreateRGBSurface
Definition: SDL_dynapi_overrides.h:444
SDL_Mouse::xdelta
int xdelta
Definition: SDL_mouse_c.h:80
SDL_atoi
#define SDL_atoi
Definition: SDL_dynapi_overrides.h:410
SDL_Mouse::last_y
int last_y
Definition: SDL_mouse_c.h:82
SDL_SetRelativeMouseMode
int SDL_SetRelativeMouseMode(SDL_bool enabled)
Set relative mouse mode.
Definition: SDL_mouse.c:788
SDL_HINT_MOUSE_DOUBLE_CLICK_TIME
#define SDL_HINT_MOUSE_DOUBLE_CLICK_TIME
A variable setting the double click time, in milliseconds.
Definition: SDL_hints.h:300
SDL_MouseRelativeSpeedScaleChanged
static void SDL_MouseRelativeSpeedScaleChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
Definition: SDL_mouse.c:88
SDL_AddHintCallback
#define SDL_AddHintCallback
Definition: SDL_dynapi_overrides.h:192
SDL_Mouse::last_x
int last_x
Definition: SDL_mouse_c.h:82
SDL_Mouse::x
int x
Definition: SDL_mouse_c.h:78
value
GLsizei const GLfloat * value
Definition: SDL_opengl_glext.h:701
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_Mouse::clickstate
SDL_MouseClickState * clickstate
Definition: SDL_mouse_c.h:101
SDL_Window::id
Uint32 id
Definition: SDL_sysvideo.h:77
SDL_HINT_MOUSE_TOUCH_EVENTS
#define SDL_HINT_MOUSE_TOUCH_EVENTS
A variable controlling whether mouse events should generate synthetic touch events.
Definition: SDL_hints.h:358
SDL_Mouse::has_position
SDL_bool has_position
Definition: SDL_mouse_c.h:86
SDL_SendTouchMotion
int SDL_SendTouchMotion(SDL_TouchID id, SDL_FingerID fingerid, SDL_Window *window, float x, float y, float pressure)
Definition: SDL_touch.c:356
SDL_Mouse::FreeCursor
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
SDL_HINT_MOUSE_NORMAL_SPEED_SCALE
#define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE
A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in rela...
Definition: SDL_hints.h:310
SDL_Mouse::CreateCursor
SDL_Cursor *(* CreateCursor)(SDL_Surface *surface, int hot_x, int hot_y)
Definition: SDL_mouse_c.h:46
SDL_SendWindowEvent
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
Definition: SDL_windowevents.c:74
SDL_Mouse::GetGlobalMouseState
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73
SDL_Mouse::mouseID
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76
SDL_MOUSEBUTTONDOWN
@ SDL_MOUSEBUTTONDOWN
Definition: SDL_events.h:106
enabled
GLenum GLenum GLsizei const GLuint GLboolean enabled
Definition: SDL_opengl_glext.h:2482
SDL_GetStringBoolean
SDL_bool SDL_GetStringBoolean(const char *value, SDL_bool default_value)
Definition: SDL_hints.c:123
SDL_TICKS_PASSED
#define SDL_TICKS_PASSED(A, B)
Compare SDL ticks values, and return true if A has passed B.
Definition: SDL_timer.h:56
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_FreeCursor
void SDL_FreeCursor(SDL_Cursor *cursor)
Frees a cursor created with SDL_CreateCursor() or similar functions.
Definition: SDL_mouse.c:1063
SDL_Event
General event structure.
Definition: SDL_events.h:559
SDL_DelHintCallback
#define SDL_DelHintCallback
Definition: SDL_dynapi_overrides.h:193
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
SDL_Unsupported
#define SDL_Unsupported()
Definition: SDL_error.h:53
track_mouse_down
static SDL_bool track_mouse_down
Definition: SDL_mouse.c:42
SDL_BUTTON
#define SDL_BUTTON(X)
Definition: SDL_mouse.h:281
SDL_HINT_MOUSE_RELATIVE_MODE_WARP
#define SDL_HINT_MOUSE_RELATIVE_MODE_WARP
A variable controlling whether relative mouse mode is implemented using mouse warping.
Definition: SDL_hints.h:326
SDL_MouseClickState::last_y
int last_y
Definition: SDL_mouse_c.h:38
SDL_MouseClickState::last_x
int last_x
Definition: SDL_mouse_c.h:38
SDL_Window::flags
Uint32 flags
Definition: SDL_sysvideo.h:84
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1571
state
struct xkb_state * state
Definition: SDL_waylandsym.h:114
SDL_Mouse::double_click_time
Uint32 double_click_time
Definition: SDL_mouse_c.h:93
button
SDL_Texture * button
Definition: testgamecontroller.c:67
i
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
SDL_Mouse::cur_cursor
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:105
SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE
#define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE
A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode.
Definition: SDL_hints.h:315
SDL_WINDOWEVENT_LEAVE
@ SDL_WINDOWEVENT_LEAVE
Definition: SDL_video.h:163
SDL_Mouse::cursor_shown
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:106
w
GLubyte GLubyte GLubyte GLubyte w
Definition: SDL_opengl_glext.h:734
SDL_PrivateSendMouseButton
static int SDL_PrivateSendMouseButton(SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button, int clicks)
Definition: SDL_mouse.c:483