SDL  2.0
SDL_mouse.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_mouse.h:
+ This graph shows which files directly or indirectly include this file:

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_WindowSDL_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_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...
 

Detailed Description

Include file for SDL mouse event handling.

Definition in file SDL_mouse.h.

Macro Definition Documentation

◆ SDL_BUTTON

#define SDL_BUTTON (   X)    (1 << ((X)-1))

Used as a mask when testing buttons in buttonstate.

  • Button 1: Left mouse button
  • Button 2: Middle mouse button
  • Button 3: Right mouse button

Definition at line 282 of file SDL_mouse.h.

◆ SDL_BUTTON_LEFT

#define SDL_BUTTON_LEFT   1

Definition at line 283 of file SDL_mouse.h.

◆ SDL_BUTTON_LMASK

#define SDL_BUTTON_LMASK   SDL_BUTTON(SDL_BUTTON_LEFT)

Definition at line 288 of file SDL_mouse.h.

◆ SDL_BUTTON_MIDDLE

#define SDL_BUTTON_MIDDLE   2

Definition at line 284 of file SDL_mouse.h.

◆ SDL_BUTTON_MMASK

#define SDL_BUTTON_MMASK   SDL_BUTTON(SDL_BUTTON_MIDDLE)

Definition at line 289 of file SDL_mouse.h.

◆ SDL_BUTTON_RIGHT

#define SDL_BUTTON_RIGHT   3

Definition at line 285 of file SDL_mouse.h.

◆ SDL_BUTTON_RMASK

#define SDL_BUTTON_RMASK   SDL_BUTTON(SDL_BUTTON_RIGHT)

Definition at line 290 of file SDL_mouse.h.

◆ SDL_BUTTON_X1

#define SDL_BUTTON_X1   4

Definition at line 286 of file SDL_mouse.h.

◆ SDL_BUTTON_X1MASK

#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)

Definition at line 291 of file SDL_mouse.h.

◆ SDL_BUTTON_X2

#define SDL_BUTTON_X2   5

Definition at line 287 of file SDL_mouse.h.

◆ SDL_BUTTON_X2MASK

#define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)

Definition at line 292 of file SDL_mouse.h.

Enumeration Type Documentation

◆ SDL_MouseWheelDirection

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.

67 {
68  SDL_MOUSEWHEEL_NORMAL, /**< The scroll direction is normal */
69  SDL_MOUSEWHEEL_FLIPPED /**< The scroll direction is flipped / natural */

◆ SDL_SystemCursor

Cursor types for SDL_CreateSystemCursor().

Enumerator
SDL_SYSTEM_CURSOR_ARROW 

Arrow

SDL_SYSTEM_CURSOR_IBEAM 

I-beam

SDL_SYSTEM_CURSOR_WAIT 

Wait

SDL_SYSTEM_CURSOR_CROSSHAIR 

Crosshair

SDL_SYSTEM_CURSOR_WAITARROW 

Small wait cursor (or Wait if not available)

SDL_SYSTEM_CURSOR_SIZENWSE 

Double arrow pointing northwest and southeast

SDL_SYSTEM_CURSOR_SIZENESW 

Double arrow pointing northeast and southwest

SDL_SYSTEM_CURSOR_SIZEWE 

Double arrow pointing west and east

SDL_SYSTEM_CURSOR_SIZENS 

Double arrow pointing north and south

SDL_SYSTEM_CURSOR_SIZEALL 

Four pointed arrow pointing north, south, east, and west

SDL_SYSTEM_CURSOR_NO 

Slashed circle or crossbones

SDL_SYSTEM_CURSOR_HAND 

Hand

SDL_NUM_SYSTEM_CURSORS 

Definition at line 46 of file SDL_mouse.h.

47 {
48  SDL_SYSTEM_CURSOR_ARROW, /**< Arrow */
49  SDL_SYSTEM_CURSOR_IBEAM, /**< I-beam */
50  SDL_SYSTEM_CURSOR_WAIT, /**< Wait */
51  SDL_SYSTEM_CURSOR_CROSSHAIR, /**< Crosshair */
52  SDL_SYSTEM_CURSOR_WAITARROW, /**< Small wait cursor (or Wait if not available) */
53  SDL_SYSTEM_CURSOR_SIZENWSE, /**< Double arrow pointing northwest and southeast */
54  SDL_SYSTEM_CURSOR_SIZENESW, /**< Double arrow pointing northeast and southwest */
55  SDL_SYSTEM_CURSOR_SIZEWE, /**< Double arrow pointing west and east */
56  SDL_SYSTEM_CURSOR_SIZENS, /**< Double arrow pointing north and south */
57  SDL_SYSTEM_CURSOR_SIZEALL, /**< Four pointed arrow pointing north, south, east, and west */
58  SDL_SYSTEM_CURSOR_NO, /**< Slashed circle or crossbones */
59  SDL_SYSTEM_CURSOR_HAND, /**< Hand */

Function Documentation

◆ 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 287 of file SDL_dynapi_procs.h.

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_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 281 of file SDL_dynapi_procs.h.

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

SDL_GetMouse
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:170
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
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_SYSTEM_CURSOR_HAND
@ SDL_SYSTEM_CURSOR_HAND
Definition: SDL_mouse.h:59
SDL_Mouse::CaptureMouse
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
SDL_NUM_SYSTEM_CURSORS
@ SDL_NUM_SYSTEM_CURSORS
Definition: SDL_mouse.h:60
SDL_Mouse::buttonstate
Uint32 buttonstate
Definition: SDL_mouse_c.h:85
mask
GLenum GLint GLuint mask
Definition: SDL_opengl_glext.h:660
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_SYSTEM_CURSOR_WAITARROW
@ SDL_SYSTEM_CURSOR_WAITARROW
Definition: SDL_mouse.h:52
SDL_Mouse::scale_accum_y
float scale_accum_y
Definition: SDL_mouse_c.h:92
SDL_Mouse::cursors
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:103
NULL
#define NULL
Definition: begin_code.h:167
surface
EGLSurface surface
Definition: eglext.h:248
SDL_SYSTEM_CURSOR_CROSSHAIR
@ SDL_SYSTEM_CURSOR_CROSSHAIR
Definition: SDL_mouse.h:51
SDL_SYSTEM_CURSOR_SIZENESW
@ SDL_SYSTEM_CURSOR_SIZENESW
Definition: SDL_mouse.h:54
SDL_Mouse::scale_accum_x
float scale_accum_x
Definition: SDL_mouse_c.h:91
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::y
int y
Definition: SDL_mouse_c.h:79
SDL_SetCursor
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:1001
SDL_Mouse::SetRelativeMouseMode
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
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
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_Window::w
int w
Definition: SDL_sysvideo.h:81
SDL_Mouse::ydelta
int ydelta
Definition: SDL_mouse_c.h:81
SDL_Mouse::relative_mode
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
SDL_MOUSEMOTION
@ SDL_MOUSEMOTION
Definition: SDL_events.h:105
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
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
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_SYSTEM_CURSOR_SIZEALL
@ SDL_SYSTEM_CURSOR_SIZEALL
Definition: SDL_mouse.h:57
SDL_Cursor::next
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
SDL_SystemCursor
SDL_SystemCursor
Cursor types for SDL_CreateSystemCursor().
Definition: SDL_mouse.h:47
SDL_SYSTEM_CURSOR_IBEAM
@ SDL_SYSTEM_CURSOR_IBEAM
Definition: SDL_mouse.h:49
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_MOUSEWHEEL_FLIPPED
@ SDL_MOUSEWHEEL_FLIPPED
Definition: SDL_mouse.h:69
SDL_Mouse::focus
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_Window::h
int h
Definition: SDL_sysvideo.h:81
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_CreateRGBSurface
#define SDL_CreateRGBSurface
Definition: SDL_dynapi_overrides.h:444
SDL_SYSTEM_CURSOR_NO
@ SDL_SYSTEM_CURSOR_NO
Definition: SDL_mouse.h:58
SDL_Mouse::xdelta
int xdelta
Definition: SDL_mouse_c.h:80
SDL_Mouse::x
int x
Definition: SDL_mouse_c.h:78
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_SYSTEM_CURSOR_WAIT
@ SDL_SYSTEM_CURSOR_WAIT
Definition: SDL_mouse.h:50
SDL_Mouse::FreeCursor
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
SDL_Mouse::CreateCursor
SDL_Cursor *(* CreateCursor)(SDL_Surface *surface, int hot_x, int hot_y)
Definition: SDL_mouse_c.h:46
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_SYSTEM_CURSOR_SIZEWE
@ SDL_SYSTEM_CURSOR_SIZEWE
Definition: SDL_mouse.h:55
enabled
GLenum GLenum GLsizei const GLuint GLboolean enabled
Definition: SDL_opengl_glext.h:2482
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_MOUSEWHEEL_NORMAL
@ SDL_MOUSEWHEEL_NORMAL
Definition: SDL_mouse.h:68
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
SDL_Unsupported
#define SDL_Unsupported()
Definition: SDL_error.h:53
SDL_SYSTEM_CURSOR_SIZENWSE
@ SDL_SYSTEM_CURSOR_SIZENWSE
Definition: SDL_mouse.h:53
SDL_MouseWheelDirection
SDL_MouseWheelDirection
Scroll direction types for the Scroll event.
Definition: SDL_mouse.h:67
SDL_SYSTEM_CURSOR_ARROW
@ SDL_SYSTEM_CURSOR_ARROW
Definition: SDL_mouse.h:48
SDL_SYSTEM_CURSOR_SIZENS
@ SDL_SYSTEM_CURSOR_SIZENS
Definition: SDL_mouse.h:56
SDL_Window::flags
Uint32 flags
Definition: SDL_sysvideo.h:84
SDL_Mouse::cur_cursor
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:105
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