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 "default_cursor.h"
#include "../video/SDL_sysvideo.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)
 
int SDL_MouseInit (void)
 
void SDL_SetDefaultCursor (SDL_Cursor *cursor)
 
SDL_MouseSDL_GetMouse (void)
 
void SDL_SetDoubleClickTime (Uint32 interval)
 
SDL_WindowSDL_GetMouseFocus (void)
 Get the window which currently has mouse focus. More...
 
void SDL_ResetMouse (void)
 
void SDL_SetMouseFocus (SDL_Window *window)
 
static SDL_bool SDL_UpdateMouseFocus (SDL_Window *window, int x, int y, Uint32 buttonstate)
 
int SDL_SendMouseMotion (SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
 
static SDL_MouseClickStateGetMouseClickState (SDL_Mouse *mouse, Uint8 button)
 
int SDL_SendMouseButton (SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button)
 
int SDL_SendMouseWheel (SDL_Window *window, SDL_MouseID mouseID, int x, int 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(). More...
 
int SDL_ShowCursor (int toggle)
 Toggle whether or not the cursor is shown. More...
 

Variables

static SDL_Mouse SDL_mouse
 
static Uint32 SDL_double_click_time = 500
 
static int SDL_double_click_radius = 1
 

Function Documentation

static SDL_MouseClickState* GetMouseClickState ( SDL_Mouse mouse,
Uint8  button 
)
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_SendMouseButton().

308 {
309  if (button >= mouse->num_clickstates) {
310  int i, count = button + 1;
311  SDL_MouseClickState *clickstate = (SDL_MouseClickState *)SDL_realloc(mouse->clickstate, count * sizeof(*mouse->clickstate));
312  if (!clickstate) {
313  return NULL;
314  }
315  mouse->clickstate = clickstate;
316 
317  for (i = mouse->num_clickstates; i < count; ++i) {
318  SDL_zero(mouse->clickstate[i]);
319  }
320  mouse->num_clickstates = count;
321  }
322  return &mouse->clickstate[button];
323 }
SDL_Texture * button
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1564
SDL_MouseClickState * clickstate
Definition: SDL_mouse_c.h:89
int num_clickstates
Definition: SDL_mouse_c.h:88
#define SDL_realloc
#define SDL_zero(x)
Definition: SDL_stdinc.h:355
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:42
#define NULL
Definition: begin_code.h:143
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 628 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().

629 {
630  SDL_Mouse *mouse = SDL_GetMouse();
631  SDL_Window *focusWindow;
632  SDL_bool isCaptured;
633 
634  if (!mouse->CaptureMouse) {
635  return SDL_Unsupported();
636  }
637 
638  focusWindow = SDL_GetKeyboardFocus();
639 
640  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
641  if (isCaptured == enabled) {
642  return 0; /* already done! */
643  }
644 
645  if (enabled) {
646  if (!focusWindow) {
647  return SDL_SetError("No window has focus");
648  } else if (mouse->CaptureMouse(focusWindow) == -1) {
649  return -1; /* CaptureMouse() should call SetError */
650  }
651  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
652  } else {
653  if (mouse->CaptureMouse(NULL) == -1) {
654  return -1; /* CaptureMouse() should call SetError */
655  }
656  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
657  }
658 
659  return 0;
660 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#define SDL_GetKeyboardFocus
SDL_bool
Definition: SDL_stdinc.h:126
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:143
#define SDL_SetError
The type used to identify a window.
Definition: SDL_sysvideo.h:71
Uint32 flags
Definition: SDL_sysvideo.h:81
#define SDL_Unsupported()
Definition: SDL_error.h:53
SDL_Cursor* SDL_CreateColorCursor ( SDL_Surface surface,
int  hot_x,
int  hot_y 
)

Create a color cursor.

See also
SDL_FreeCursor()

Definition at line 712 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().

713 {
714  SDL_Mouse *mouse = SDL_GetMouse();
715  SDL_Surface *temp = NULL;
717 
718  if (!surface) {
719  SDL_SetError("Passed NULL cursor surface");
720  return NULL;
721  }
722 
723  if (!mouse->CreateCursor) {
724  SDL_SetError("Cursors are not currently supported");
725  return NULL;
726  }
727 
728  /* Sanity check the hot spot */
729  if ((hot_x < 0) || (hot_y < 0) ||
730  (hot_x >= surface->w) || (hot_y >= surface->h)) {
731  SDL_SetError("Cursor hot spot doesn't lie within cursor");
732  return NULL;
733  }
734 
735  if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
737  if (!temp) {
738  return NULL;
739  }
740  surface = temp;
741  }
742 
743  cursor = mouse->CreateCursor(surface, hot_x, hot_y);
744  if (cursor) {
745  cursor->next = mouse->cursors;
746  mouse->cursors = cursor;
747  }
748 
749  SDL_FreeSurface(temp);
750 
751  return cursor;
752 }
#define SDL_ConvertSurfaceFormat
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:91
SDL_Cursor *(* CreateCursor)(SDL_Surface *surface, int hot_x, int hot_y)
Definition: SDL_mouse_c.h:46
#define SDL_FreeSurface
SDL_Cursor * cursor
Definition: testwm2.c:40
#define NULL
Definition: begin_code.h:143
SDL_PixelFormat * format
Definition: SDL_surface.h:72
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
#define SDL_SetError
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 663 of file SDL_mouse.c.

References cursor, NULL, SDL_Surface::pitch, SDL_Surface::pixels, SDL_CreateColorCursor(), SDL_CreateRGBSurface, and SDL_FreeSurface.

665 {
666  SDL_Surface *surface;
668  int x, y;
669  Uint32 *pixel;
670  Uint8 datab = 0, maskb = 0;
671  const Uint32 black = 0xFF000000;
672  const Uint32 white = 0xFFFFFFFF;
673  const Uint32 transparent = 0x00000000;
674 
675  /* Make sure the width is a multiple of 8 */
676  w = ((w + 7) & ~7);
677 
678  /* Create the surface from a bitmap */
679  surface = SDL_CreateRGBSurface(0, w, h, 32,
680  0x00FF0000,
681  0x0000FF00,
682  0x000000FF,
683  0xFF000000);
684  if (!surface) {
685  return NULL;
686  }
687  for (y = 0; y < h; ++y) {
688  pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
689  for (x = 0; x < w; ++x) {
690  if ((x % 8) == 0) {
691  datab = *data++;
692  maskb = *mask++;
693  }
694  if (maskb & 0x80) {
695  *pixel++ = (datab & 0x80) ? black : white;
696  } else {
697  *pixel++ = (datab & 0x80) ? black : transparent;
698  }
699  datab <<= 1;
700  maskb <<= 1;
701  }
702  }
703 
704  cursor = SDL_CreateColorCursor(surface, hot_x, hot_y);
705 
706  SDL_FreeSurface(surface);
707 
708  return cursor;
709 }
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.c:712
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1967
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
void * pixels
Definition: SDL_surface.h:75
#define SDL_FreeSurface
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
SDL_Cursor * cursor
Definition: testwm2.c:40
GLenum GLint GLuint mask
#define NULL
Definition: begin_code.h:143
#define SDL_CreateRGBSurface
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
GLubyte GLubyte GLubyte GLubyte w
GLfloat GLfloat GLfloat GLfloat h
SDL_Cursor* SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 755 of file SDL_mouse.c.

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

756 {
757  SDL_Mouse *mouse = SDL_GetMouse();
759 
760  if (!mouse->CreateSystemCursor) {
761  SDL_SetError("CreateSystemCursor is not currently supported");
762  return NULL;
763  }
764 
765  cursor = mouse->CreateSystemCursor(id);
766  if (cursor) {
767  cursor->next = mouse->cursors;
768  mouse->cursors = cursor;
769  }
770 
771  return cursor;
772 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:91
SDL_Cursor * cursor
Definition: testwm2.c:40
#define NULL
Definition: begin_code.h:143
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
#define SDL_SetError
SDL_Cursor *(* CreateSystemCursor)(SDL_SystemCursor id)
Definition: SDL_mouse_c.h:49
void SDL_FreeCursor ( SDL_Cursor cursor)

Frees a cursor created with SDL_CreateCursor().

See also
SDL_CreateCursor()

Definition at line 841 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().

842 {
843  SDL_Mouse *mouse = SDL_GetMouse();
844  SDL_Cursor *curr, *prev;
845 
846  if (!cursor) {
847  return;
848  }
849 
850  if (cursor == mouse->def_cursor) {
851  return;
852  }
853  if (cursor == mouse->cur_cursor) {
854  SDL_SetCursor(mouse->def_cursor);
855  }
856 
857  for (prev = NULL, curr = mouse->cursors; curr;
858  prev = curr, curr = curr->next) {
859  if (curr == cursor) {
860  if (prev) {
861  prev->next = curr->next;
862  } else {
863  mouse->cursors = curr->next;
864  }
865 
866  if (mouse->FreeCursor) {
867  mouse->FreeCursor(curr);
868  }
869  return;
870  }
871  }
872 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:779
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:91
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
#define NULL
Definition: begin_code.h:143
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:93
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
SDL_Cursor* SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 819 of file SDL_mouse.c.

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

820 {
821  SDL_Mouse *mouse = SDL_GetMouse();
822 
823  if (!mouse) {
824  return NULL;
825  }
826  return mouse->cur_cursor;
827 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#define NULL
Definition: begin_code.h:143
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:93
SDL_Cursor* SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 830 of file SDL_mouse.c.

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

831 {
832  SDL_Mouse *mouse = SDL_GetMouse();
833 
834  if (!mouse) {
835  return NULL;
836  }
837  return mouse->def_cursor;
838 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#define NULL
Definition: begin_code.h:143
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
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 495 of file SDL_mouse.c.

References SDL_Mouse::GetGlobalMouseState, SDL_assert, and SDL_GetMouse().

496 {
497  SDL_Mouse *mouse = SDL_GetMouse();
498  int tmpx, tmpy;
499 
500  /* make sure these are never NULL for the backend implementations... */
501  if (!x) {
502  x = &tmpx;
503  }
504  if (!y) {
505  y = &tmpy;
506  }
507 
508  *x = *y = 0;
509 
510  if (!mouse->GetGlobalMouseState) {
511  SDL_assert(0 && "This should really be implemented for every target.");
512  return 0;
513  }
514 
515  return mouse->GetGlobalMouseState(x, y);
516 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
#define SDL_assert(condition)
Definition: SDL_assert.h:167
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
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().

79 {
80  SDL_Mouse *mouse = SDL_GetMouse();
81 
82  return mouse->focus;
83 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Window * focus
Definition: SDL_mouse_c.h:77
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 465 of file SDL_mouse.c.

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

466 {
467  SDL_Mouse *mouse = SDL_GetMouse();
468 
469  if (x) {
470  *x = mouse->x;
471  }
472  if (y) {
473  *y = mouse->y;
474  }
475  return mouse->buttonstate;
476 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
SDL_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 620 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

621 {
622  SDL_Mouse *mouse = SDL_GetMouse();
623 
624  return mouse->relative_mode;
625 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84
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 479 of file SDL_mouse.c.

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

480 {
481  SDL_Mouse *mouse = SDL_GetMouse();
482 
483  if (x) {
484  *x = mouse->xdelta;
485  }
486  if (y) {
487  *y = mouse->ydelta;
488  }
489  mouse->xdelta = 0;
490  mouse->ydelta = 0;
491  return mouse->buttonstate;
492 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
int ydelta
Definition: SDL_mouse_c.h:81
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
int xdelta
Definition: SDL_mouse_c.h:80
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().

46 {
47  SDL_Mouse *mouse = SDL_GetMouse();
48 
49  mouse->cursor_shown = SDL_TRUE;
50 
51  return (0);
52 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:94
void SDL_MouseQuit ( void  )

Definition at line 435 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().

436 {
437  SDL_Cursor *cursor, *next;
438  SDL_Mouse *mouse = SDL_GetMouse();
439 
440  if (mouse->CaptureMouse) {
442  }
444  SDL_ShowCursor(1);
445 
446  cursor = mouse->cursors;
447  while (cursor) {
448  next = cursor->next;
449  SDL_FreeCursor(cursor);
450  cursor = next;
451  }
452 
453  if (mouse->def_cursor && mouse->FreeCursor) {
454  mouse->FreeCursor(mouse->def_cursor);
455  }
456 
457  if (mouse->clickstate) {
458  SDL_free(mouse->clickstate);
459  }
460 
461  SDL_zerop(mouse);
462 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_MouseClickState * clickstate
Definition: SDL_mouse_c.h:89
int SDL_ShowCursor(int toggle)
Toggle whether or not the cursor is shown.
Definition: SDL_mouse.c:875
#define SDL_zerop(x)
Definition: SDL_stdinc.h:356
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:91
int SDL_CaptureMouse(SDL_bool enabled)
Capture the mouse, to track input outside an SDL window.
Definition: SDL_mouse.c:628
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
void SDL_free(void *mem)
SDL_Cursor * cursor
Definition: testwm2.c:40
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
int SDL_SetRelativeMouseMode(SDL_bool enabled)
Set relative mouse mode.
Definition: SDL_mouse.c:571
void SDL_FreeCursor(SDL_Cursor *cursor)
Frees a cursor created with SDL_CreateCursor().
Definition: SDL_mouse.c:841
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
static int SDL_PrivateSendMouseMotion ( SDL_Window window,
SDL_MouseID  mouseID,
int  relative,
int  x,
int  y 
)
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().

202 {
203  SDL_Mouse *mouse = SDL_GetMouse();
204  int posted;
205  int xrel;
206  int yrel;
207 
208  if (mouse->relative_mode_warp) {
209  int center_x = 0, center_y = 0;
210  SDL_GetWindowSize(window, &center_x, &center_y);
211  center_x /= 2;
212  center_y /= 2;
213  if (x == center_x && y == center_y) {
214  mouse->last_x = center_x;
215  mouse->last_y = center_y;
216  return 0;
217  }
218  SDL_WarpMouseInWindow(window, center_x, center_y);
219  }
220 
221  if (relative) {
222  xrel = x;
223  yrel = y;
224  x = (mouse->last_x + xrel);
225  y = (mouse->last_y + yrel);
226  } else {
227  xrel = x - mouse->last_x;
228  yrel = y - mouse->last_y;
229  }
230 
231  /* Drop events that don't change state */
232  if (!xrel && !yrel) {
233 #ifdef DEBUG_MOUSE
234  printf("Mouse event didn't change state - dropped!\n");
235 #endif
236  return 0;
237  }
238 
239  /* Update internal mouse coordinates */
240  if (!mouse->relative_mode) {
241  mouse->x = x;
242  mouse->y = y;
243  } else {
244  mouse->x += xrel;
245  mouse->y += yrel;
246  }
247 
248  /* make sure that the pointers find themselves inside the windows,
249  unless we have the mouse captured. */
250  if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
251  int x_max = 0, y_max = 0;
252 
253  // !!! FIXME: shouldn't this be (window) instead of (mouse->focus)?
254  SDL_GetWindowSize(mouse->focus, &x_max, &y_max);
255  --x_max;
256  --y_max;
257 
258  if (mouse->x > x_max) {
259  mouse->x = x_max;
260  }
261  if (mouse->x < 0) {
262  mouse->x = 0;
263  }
264 
265  if (mouse->y > y_max) {
266  mouse->y = y_max;
267  }
268  if (mouse->y < 0) {
269  mouse->y = 0;
270  }
271  }
272 
273  mouse->xdelta += xrel;
274  mouse->ydelta += yrel;
275 
276  /* Move the mouse cursor, if needed */
277  if (mouse->cursor_shown && !mouse->relative_mode &&
278  mouse->MoveCursor && mouse->cur_cursor) {
279  mouse->MoveCursor(mouse->cur_cursor);
280  }
281 
282  /* Post the event, if desired */
283  posted = 0;
286  event.motion.type = SDL_MOUSEMOTION;
287  event.motion.windowID = mouse->focus ? mouse->focus->id : 0;
288  event.motion.which = mouseID;
289  event.motion.state = mouse->buttonstate;
290  event.motion.x = mouse->x;
291  event.motion.y = mouse->y;
292  event.motion.xrel = xrel;
293  event.motion.yrel = yrel;
294  posted = (SDL_PushEvent(&event) > 0);
295  }
296  if (relative) {
297  mouse->last_x = mouse->x;
298  mouse->last_y = mouse->y;
299  } else {
300  /* Use unclamped values if we're getting events outside the window */
301  mouse->last_x = x;
302  mouse->last_y = y;
303  }
304  return posted;
305 }
int last_y
Definition: SDL_mouse_c.h:82
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
int last_x
Definition: SDL_mouse_c.h:82
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:85
SDL_Window * focus
Definition: SDL_mouse_c.h:77
#define SDL_ENABLE
Definition: SDL_events.h:718
int ydelta
Definition: SDL_mouse_c.h:81
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
void SDL_WarpMouseInWindow(SDL_Window *window, int x, int y)
Moves the mouse to the given position within the window.
Definition: SDL_mouse.c:519
#define SDL_GetWindowSize
#define SDL_GetEventState(type)
Definition: SDL_events.h:731
struct _cl_event * event
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:94
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84
#define SDL_PushEvent
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
int xdelta
Definition: SDL_mouse_c.h:80
Uint32 id
Definition: SDL_sysvideo.h:74
General event structure.
Definition: SDL_events.h:521
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:93
Uint32 flags
Definition: SDL_sysvideo.h:81
void(* MoveCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:55
void SDL_ResetMouse ( void  )

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

87 {
88  SDL_Mouse *mouse = SDL_GetMouse();
89  Uint8 i;
90 
91 #ifdef DEBUG_MOUSE
92  printf("Resetting mouse\n");
93 #endif
94  for (i = 1; i <= sizeof(mouse->buttonstate)*8; ++i) {
95  if (mouse->buttonstate & SDL_BUTTON(i)) {
96  SDL_SendMouseButton(mouse->focus, mouse->mouseID, SDL_RELEASED, i);
97  }
98  }
99  SDL_assert(mouse->buttonstate == 0);
100 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
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:42
#define SDL_assert(condition)
Definition: SDL_assert.h:167
#define SDL_BUTTON(X)
Definition: SDL_mouse.h:279
#define SDL_RELEASED
Definition: SDL_events.h:49
int SDL_SendMouseButton(SDL_Window *window, SDL_MouseID mouseID, Uint8 state, Uint8 button)
Definition: SDL_mouse.c:326
int SDL_SendMouseButton ( SDL_Window window,
SDL_MouseID  mouseID,
Uint8  state,
Uint8  button 
)

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_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_BApp::_HandleMouseButton(), and SDL_ResetMouse().

327 {
328  SDL_Mouse *mouse = SDL_GetMouse();
329  int posted;
330  Uint32 type;
331  Uint32 buttonstate = mouse->buttonstate;
332  SDL_MouseClickState *clickstate = GetMouseClickState(mouse, button);
333  Uint8 click_count;
334 
335  /* Figure out which event to perform */
336  switch (state) {
337  case SDL_PRESSED:
338  type = SDL_MOUSEBUTTONDOWN;
339  buttonstate |= SDL_BUTTON(button);
340  break;
341  case SDL_RELEASED:
342  type = SDL_MOUSEBUTTONUP;
343  buttonstate &= ~SDL_BUTTON(button);
344  break;
345  default:
346  /* Invalid state -- bail */
347  return 0;
348  }
349 
350  /* We do this after calculating buttonstate so button presses gain focus */
351  if (window && state == SDL_PRESSED) {
352  SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
353  }
354 
355  if (buttonstate == mouse->buttonstate) {
356  /* Ignore this event, no state change */
357  return 0;
358  }
359  mouse->buttonstate = buttonstate;
360 
361  if (clickstate) {
362  if (state == SDL_PRESSED) {
363  Uint32 now = SDL_GetTicks();
364 
365  if (SDL_TICKS_PASSED(now, clickstate->last_timestamp + SDL_double_click_time) ||
366  SDL_abs(mouse->x - clickstate->last_x) > SDL_double_click_radius ||
367  SDL_abs(mouse->y - clickstate->last_y) > SDL_double_click_radius) {
368  clickstate->click_count = 0;
369  }
370  clickstate->last_timestamp = now;
371  clickstate->last_x = mouse->x;
372  clickstate->last_y = mouse->y;
373  if (clickstate->click_count < 255) {
374  ++clickstate->click_count;
375  }
376  }
377  click_count = clickstate->click_count;
378  } else {
379  click_count = 1;
380  }
381 
382  /* Post the event, if desired */
383  posted = 0;
384  if (SDL_GetEventState(type) == SDL_ENABLE) {
386  event.type = type;
387  event.button.windowID = mouse->focus ? mouse->focus->id : 0;
388  event.button.which = mouseID;
389  event.button.state = state;
390  event.button.button = button;
391  event.button.clicks = click_count;
392  event.button.x = mouse->x;
393  event.button.y = mouse->y;
394  posted = (SDL_PushEvent(&event) > 0);
395  }
396 
397  /* We do this after dispatching event so button releases can lose focus */
398  if (window && state == SDL_RELEASED) {
399  SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
400  }
401 
402  return posted;
403 }
#define SDL_abs
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Texture * button
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
SDL_Window * focus
Definition: SDL_mouse_c.h:77
struct xkb_state * state
#define SDL_ENABLE
Definition: SDL_events.h:718
static int SDL_double_click_radius
Definition: SDL_mouse.c:38
#define SDL_GetEventState(type)
Definition: SDL_events.h:731
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
struct _cl_event * event
#define SDL_PushEvent
static SDL_MouseClickState * GetMouseClickState(SDL_Mouse *mouse, Uint8 button)
Definition: SDL_mouse.c:307
static SDL_bool SDL_UpdateMouseFocus(SDL_Window *window, int x, int y, Uint32 buttonstate)
Definition: SDL_mouse.c:140
Uint32 id
Definition: SDL_sysvideo.h:74
#define SDL_BUTTON(X)
Definition: SDL_mouse.h:279
General event structure.
Definition: SDL_events.h:521
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
#define SDL_PRESSED
Definition: SDL_events.h:50
static Uint32 SDL_double_click_time
Definition: SDL_mouse.c:37
#define SDL_TICKS_PASSED(A, B)
Compare SDL ticks values, and return true if A has passed B.
Definition: SDL_timer.h:56
#define SDL_RELEASED
Definition: SDL_events.h:49
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().

189 {
190  if (window && !relative) {
191  SDL_Mouse *mouse = SDL_GetMouse();
192  if (!SDL_UpdateMouseFocus(window, x, y, mouse->buttonstate)) {
193  return 0;
194  }
195  }
196 
197  return SDL_PrivateSendMouseMotion(window, mouseID, relative, x, y);
198 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
static int SDL_PrivateSendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:201
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
static SDL_bool SDL_UpdateMouseFocus(SDL_Window *window, int x, int y, Uint32 buttonstate)
Definition: SDL_mouse.c:140
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
int SDL_SendMouseWheel ( SDL_Window window,
SDL_MouseID  mouseID,
int  x,
int  y,
SDL_MouseWheelDirection  direction 
)

Definition at line 406 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().

407 {
408  SDL_Mouse *mouse = SDL_GetMouse();
409  int posted;
410 
411  if (window) {
412  SDL_SetMouseFocus(window);
413  }
414 
415  if (!x && !y) {
416  return 0;
417  }
418 
419  /* Post the event, if desired */
420  posted = 0;
423  event.type = SDL_MOUSEWHEEL;
424  event.wheel.windowID = mouse->focus ? mouse->focus->id : 0;
425  event.wheel.which = mouseID;
426  event.wheel.x = x;
427  event.wheel.y = y;
428  event.wheel.direction = (Uint32)direction;
429  posted = (SDL_PushEvent(&event) > 0);
430  }
431  return posted;
432 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
SDL_Window * focus
Definition: SDL_mouse_c.h:77
#define SDL_ENABLE
Definition: SDL_events.h:718
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:103
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
#define SDL_GetEventState(type)
Definition: SDL_events.h:731
struct _cl_event * event
#define SDL_PushEvent
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
Uint32 id
Definition: SDL_sysvideo.h:74
General event structure.
Definition: SDL_events.h:521
void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

Definition at line 779 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().

780 {
781  SDL_Mouse *mouse = SDL_GetMouse();
782 
783  /* Set the new cursor */
784  if (cursor) {
785  /* Make sure the cursor is still valid for this mouse */
786  if (cursor != mouse->def_cursor) {
787  SDL_Cursor *found;
788  for (found = mouse->cursors; found; found = found->next) {
789  if (found == cursor) {
790  break;
791  }
792  }
793  if (!found) {
794  SDL_SetError("Cursor not associated with the current mouse");
795  return;
796  }
797  }
798  mouse->cur_cursor = cursor;
799  } else {
800  if (mouse->focus) {
801  cursor = mouse->cur_cursor;
802  } else {
803  cursor = mouse->def_cursor;
804  }
805  }
806 
807  if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
808  if (mouse->ShowCursor) {
809  mouse->ShowCursor(cursor);
810  }
811  } else {
812  if (mouse->ShowCursor) {
813  mouse->ShowCursor(NULL);
814  }
815  }
816 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
int(* ShowCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:52
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:91
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:94
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84
SDL_Cursor * cursor
Definition: testwm2.c:40
#define NULL
Definition: begin_code.h:143
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
#define SDL_SetError
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:93
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
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().

56 {
57  SDL_Mouse *mouse = SDL_GetMouse();
58 
59  mouse->def_cursor = cursor;
60  if (!mouse->cur_cursor) {
61  SDL_SetCursor(cursor);
62  }
63 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:779
SDL_Cursor * cursor
Definition: testwm2.c:40
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:93
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
void SDL_SetDoubleClickTime ( Uint32  interval)

Definition at line 72 of file SDL_mouse.c.

References SDL_double_click_time.

73 {
74  SDL_double_click_time = interval;
75 }
static Uint32 SDL_double_click_time
Definition: SDL_mouse.c:37
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().

104 {
105  SDL_Mouse *mouse = SDL_GetMouse();
106 
107  if (mouse->focus == window) {
108  return;
109  }
110 
111  /* Actually, this ends up being a bad idea, because most operating
112  systems have an implicit grab when you press the mouse button down
113  so you can drag things out of the window and then get the mouse up
114  when it happens. So, #if 0...
115  */
116 #if 0
117  if (mouse->focus && !window) {
118  /* We won't get anymore mouse messages, so reset mouse state */
119  SDL_ResetMouse();
120  }
121 #endif
122 
123  /* See if the current window has lost focus */
124  if (mouse->focus) {
126  }
127 
128  mouse->focus = window;
129 
130  if (mouse->focus) {
132  }
133 
134  /* Update cursor visibility */
136 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_Window * window
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:779
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
void SDL_ResetMouse(void)
Definition: SDL_mouse.c:86
#define NULL
Definition: begin_code.h:143
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 571 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().

572 {
573  SDL_Mouse *mouse = SDL_GetMouse();
574  SDL_Window *focusWindow = SDL_GetKeyboardFocus();
575 
576  if (enabled == mouse->relative_mode) {
577  return 0;
578  }
579 
580  if (enabled && focusWindow) {
581  /* Center it in the focused window to prevent clicks from going through
582  * to background windows.
583  */
584  SDL_SetMouseFocus(focusWindow);
585  SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
586  }
587 
588  /* Set the relative mode */
589  if (!enabled && mouse->relative_mode_warp) {
590  mouse->relative_mode_warp = SDL_FALSE;
591  } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
592  mouse->relative_mode_warp = SDL_TRUE;
593  } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
594  if (enabled) {
595  /* Fall back to warp mode if native relative mode failed */
596  mouse->relative_mode_warp = SDL_TRUE;
597  }
598  }
599  mouse->relative_mode = enabled;
600 
601  if (mouse->focus) {
602  SDL_UpdateWindowGrab(mouse->focus);
603 
604  /* Put the cursor back to where the application expects it */
605  if (!enabled) {
606  SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
607  }
608  }
609 
610  /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
612 
613  /* Update cursor visibility */
615 
616  return 0;
617 }
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2227
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:85
SDL_Window * focus
Definition: SDL_mouse_c.h:77
#define SDL_FlushEvent
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:779
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:103
#define SDL_GetKeyboardFocus
void SDL_WarpMouseInWindow(SDL_Window *window, int x, int y)
Moves the mouse to the given position within the window.
Definition: SDL_mouse.c:519
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:143
The type used to identify a window.
Definition: SDL_sysvideo.h:71
static SDL_bool ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
Definition: SDL_mouse.c:551
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 875 of file SDL_mouse.c.

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

Referenced by SDL_MouseQuit().

876 {
877  SDL_Mouse *mouse = SDL_GetMouse();
878  SDL_bool shown;
879 
880  if (!mouse) {
881  return 0;
882  }
883 
884  shown = mouse->cursor_shown;
885  if (toggle >= 0) {
886  if (toggle) {
887  mouse->cursor_shown = SDL_TRUE;
888  } else {
889  mouse->cursor_shown = SDL_FALSE;
890  }
891  if (mouse->cursor_shown != shown) {
893  }
894  }
895  return shown;
896 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:779
SDL_bool
Definition: SDL_stdinc.h:126
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:94
#define NULL
Definition: begin_code.h:143
static SDL_bool SDL_UpdateMouseFocus ( SDL_Window window,
int  x,
int  y,
Uint32  buttonstate 
)
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_SendMouseButton(), and SDL_SendMouseMotion().

141 {
142  SDL_Mouse *mouse = SDL_GetMouse();
143  SDL_bool inWindow = SDL_TRUE;
144 
145  if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
146  int w, h;
147  SDL_GetWindowSize(window, &w, &h);
148  if (x < 0 || y < 0 || x >= w || y >= h) {
149  inWindow = SDL_FALSE;
150  }
151  }
152 
153 /* Linux doesn't give you mouse events outside your window unless you grab
154  the pointer.
155 
156  Windows doesn't give you mouse events outside your window unless you call
157  SetCapture().
158 
159  Both of these are slightly scary changes, so for now we'll punt and if the
160  mouse leaves the window you'll lose mouse focus and reset button state.
161 */
162 #ifdef SUPPORT_DRAG_OUTSIDE_WINDOW
163  if (!inWindow && !buttonstate) {
164 #else
165  if (!inWindow) {
166 #endif
167  if (window == mouse->focus) {
168 #ifdef DEBUG_MOUSE
169  printf("Mouse left window, synthesizing move & focus lost event\n");
170 #endif
171  SDL_PrivateSendMouseMotion(window, mouse->mouseID, 0, x, y);
173  }
174  return SDL_FALSE;
175  }
176 
177  if (window != mouse->focus) {
178 #ifdef DEBUG_MOUSE
179  printf("Mouse entered window, synthesizing focus gain & move event\n");
180 #endif
181  SDL_SetMouseFocus(window);
182  SDL_PrivateSendMouseMotion(window, mouse->mouseID, 0, x, y);
183  }
184  return SDL_TRUE;
185 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
static int SDL_PrivateSendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:201
SDL_Window * focus
Definition: SDL_mouse_c.h:77
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:103
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76
SDL_bool
Definition: SDL_stdinc.h:126
#define SDL_GetWindowSize
#define NULL
Definition: begin_code.h:143
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
GLubyte GLubyte GLubyte GLubyte w
Uint32 flags
Definition: SDL_sysvideo.h:81
GLfloat GLfloat GLfloat GLfloat h
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 539 of file SDL_mouse.c.

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

540 {
541  SDL_Mouse *mouse = SDL_GetMouse();
542 
543  if (mouse->WarpMouseGlobal) {
544  return mouse->WarpMouseGlobal(x, y);
545  }
546 
547  return SDL_Unsupported();
548 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
int(* WarpMouseGlobal)(int x, int y)
Definition: SDL_mouse_c.h:64
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
#define SDL_Unsupported()
Definition: SDL_error.h:53
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 519 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().

520 {
521  SDL_Mouse *mouse = SDL_GetMouse();
522 
523  if (window == NULL) {
524  window = mouse->focus;
525  }
526 
527  if (window == NULL) {
528  return;
529  }
530 
531  if (mouse->WarpMouse) {
532  mouse->WarpMouse(window, x, y);
533  } else {
534  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
535  }
536 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Window * focus
Definition: SDL_mouse_c.h:77
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76
int SDL_SendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:188
#define NULL
Definition: begin_code.h:143
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61
static SDL_bool ShouldUseRelativeModeWarp ( SDL_Mouse mouse)
static

Definition at line 551 of file SDL_mouse.c.

References SDL_FALSE, SDL_GetHint, SDL_HINT_MOUSE_RELATIVE_MODE_WARP, SDL_TRUE, and SDL_Mouse::SetRelativeMouseMode.

Referenced by SDL_SetRelativeMouseMode().

552 {
553  const char *hint;
554 
555  if (!mouse->SetRelativeMouseMode) {
556  return SDL_TRUE;
557  }
558 
560  if (hint) {
561  if (*hint == '0') {
562  return SDL_FALSE;
563  } else {
564  return SDL_TRUE;
565  }
566  }
567  return SDL_FALSE;
568 }
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
#define SDL_GetHint
#define SDL_HINT_MOUSE_RELATIVE_MODE_WARP
A variable controlling whether relative mouse mode is implemented using mouse warping.
Definition: SDL_hints.h:244

Variable Documentation

int SDL_double_click_radius = 1
static

Definition at line 38 of file SDL_mouse.c.

Referenced by SDL_SendMouseButton().

Uint32 SDL_double_click_time = 500
static

Definition at line 37 of file SDL_mouse.c.

Referenced by SDL_SendMouseButton(), and SDL_SetDoubleClickTime().

SDL_Mouse SDL_mouse
static

Definition at line 36 of file SDL_mouse.c.

Referenced by SDL_GetMouse().