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

Referenced by _mouseStateCheck(), SDL_GetMouseFocus(), and SDL_PrivateSendMouseButton().

◆ SDL_BUTTON_LEFT

#define SDL_BUTTON_LEFT   1

Definition at line 282 of file SDL_mouse.h.

Referenced by SDL_BWin::_MouseButtonEvent(), _mouseStateCheck(), and loop().

◆ SDL_BUTTON_LMASK

#define SDL_BUTTON_LMASK   SDL_BUTTON(SDL_BUTTON_LEFT)

Definition at line 287 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

◆ SDL_BUTTON_MIDDLE

#define SDL_BUTTON_MIDDLE   2

Definition at line 283 of file SDL_mouse.h.

Referenced by SDL_BWin::_MouseButtonEvent(), and _mouseStateCheck().

◆ SDL_BUTTON_MMASK

#define SDL_BUTTON_MMASK   SDL_BUTTON(SDL_BUTTON_MIDDLE)

Definition at line 288 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

◆ SDL_BUTTON_RIGHT

#define SDL_BUTTON_RIGHT   3

Definition at line 284 of file SDL_mouse.h.

Referenced by SDL_BWin::_MouseButtonEvent(), and _mouseStateCheck().

◆ SDL_BUTTON_RMASK

#define SDL_BUTTON_RMASK   SDL_BUTTON(SDL_BUTTON_RIGHT)

Definition at line 289 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

◆ SDL_BUTTON_X1

#define SDL_BUTTON_X1   4

Definition at line 285 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

◆ SDL_BUTTON_X1MASK

#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)

Definition at line 290 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

◆ SDL_BUTTON_X2

#define SDL_BUTTON_X2   5

Definition at line 286 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

◆ SDL_BUTTON_X2MASK

#define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)

Definition at line 291 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

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_MouseWheelDirection
Scroll direction types for the Scroll event.
Definition: SDL_mouse.h:66

◆ 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 */
SDL_SystemCursor
Cursor types for SDL_CreateSystemCursor().
Definition: SDL_mouse.h:46

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

759 {
760  SDL_Mouse *mouse = SDL_GetMouse();
761  SDL_Window *focusWindow;
762  SDL_bool isCaptured;
763 
764  if (!mouse->CaptureMouse) {
765  return SDL_Unsupported();
766  }
767 
768  focusWindow = SDL_GetKeyboardFocus();
769 
770  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
771  if (isCaptured == enabled) {
772  return 0; /* already done! */
773  }
774 
775  if (enabled) {
776  if (!focusWindow) {
777  return SDL_SetError("No window has focus");
778  } else if (mouse->CaptureMouse(focusWindow) == -1) {
779  return -1; /* CaptureMouse() should call SetError */
780  }
781  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
782  } else {
783  if (mouse->CaptureMouse(NULL) == -1) {
784  return -1; /* CaptureMouse() should call SetError */
785  }
786  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
787  }
788 
789  return 0;
790 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
#define SDL_GetKeyboardFocus
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:139
#define SDL_SetError
The type used to identify a window.
Definition: SDL_sysvideo.h:73
Uint32 flags
Definition: SDL_sysvideo.h:83
#define SDL_Unsupported()
Definition: SDL_error.h:53

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

843 {
844  SDL_Mouse *mouse = SDL_GetMouse();
845  SDL_Surface *temp = NULL;
847 
848  if (!surface) {
849  SDL_SetError("Passed NULL cursor surface");
850  return NULL;
851  }
852 
853  if (!mouse->CreateCursor) {
854  SDL_SetError("Cursors are not currently supported");
855  return NULL;
856  }
857 
858  /* Sanity check the hot spot */
859  if ((hot_x < 0) || (hot_y < 0) ||
860  (hot_x >= surface->w) || (hot_y >= surface->h)) {
861  SDL_SetError("Cursor hot spot doesn't lie within cursor");
862  return NULL;
863  }
864 
865  if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
867  if (!temp) {
868  return NULL;
869  }
870  surface = temp;
871  }
872 
873  cursor = mouse->CreateCursor(surface, hot_x, hot_y);
874  if (cursor) {
875  cursor->next = mouse->cursors;
876  mouse->cursors = cursor;
877  }
878 
879  SDL_FreeSurface(temp);
880 
881  return cursor;
882 }
#define SDL_ConvertSurfaceFormat
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:99
SDL_Cursor *(* CreateCursor)(SDL_Surface *surface, int hot_x, int hot_y)
Definition: SDL_mouse_c.h:46
#define SDL_FreeSurface
SDL_Cursor * cursor
#define NULL
Definition: begin_code.h:164
SDL_PixelFormat * format
Definition: SDL_surface.h:72
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
#define SDL_SetError
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:55

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

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

795 {
798  int x, y;
799  Uint32 *pixel;
800  Uint8 datab = 0, maskb = 0;
801  const Uint32 black = 0xFF000000;
802  const Uint32 white = 0xFFFFFFFF;
803  const Uint32 transparent = 0x00000000;
804 
805  /* Make sure the width is a multiple of 8 */
806  w = ((w + 7) & ~7);
807 
808  /* Create the surface from a bitmap */
809  surface = SDL_CreateRGBSurface(0, w, h, 32,
810  0x00FF0000,
811  0x0000FF00,
812  0x000000FF,
813  0xFF000000);
814  if (!surface) {
815  return NULL;
816  }
817  for (y = 0; y < h; ++y) {
818  pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
819  for (x = 0; x < w; ++x) {
820  if ((x % 8) == 0) {
821  datab = *data++;
822  maskb = *mask++;
823  }
824  if (maskb & 0x80) {
825  *pixel++ = (datab & 0x80) ? black : white;
826  } else {
827  *pixel++ = (datab & 0x80) ? black : transparent;
828  }
829  datab <<= 1;
830  maskb <<= 1;
831  }
832  }
833 
834  cursor = SDL_CreateColorCursor(surface, hot_x, hot_y);
835 
836  SDL_FreeSurface(surface);
837 
838  return cursor;
839 }
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.c:842
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
GLfloat GLfloat GLfloat GLfloat h
EGLSurface surface
Definition: eglext.h:248
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:1974
uint32_t Uint32
Definition: SDL_stdinc.h:181
void * pixels
Definition: SDL_surface.h:75
#define SDL_FreeSurface
uint8_t Uint8
Definition: SDL_stdinc.h:157
GLenum GLint GLuint mask
GLubyte GLubyte GLubyte GLubyte w
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
SDL_Cursor * cursor
#define NULL
Definition: begin_code.h:164
#define SDL_CreateRGBSurface
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:55

◆ SDL_CreateSystemCursor()

SDL_Cursor* SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 885 of file SDL_mouse.c.

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

886 {
887  SDL_Mouse *mouse = SDL_GetMouse();
889 
890  if (!mouse->CreateSystemCursor) {
891  SDL_SetError("CreateSystemCursor is not currently supported");
892  return NULL;
893  }
894 
895  cursor = mouse->CreateSystemCursor(id);
896  if (cursor) {
897  cursor->next = mouse->cursors;
898  mouse->cursors = cursor;
899  }
900 
901  return cursor;
902 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:99
SDL_Cursor * cursor
#define NULL
Definition: begin_code.h:164
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

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

972 {
973  SDL_Mouse *mouse = SDL_GetMouse();
974  SDL_Cursor *curr, *prev;
975 
976  if (!cursor) {
977  return;
978  }
979 
980  if (cursor == mouse->def_cursor) {
981  return;
982  }
983  if (cursor == mouse->cur_cursor) {
984  SDL_SetCursor(mouse->def_cursor);
985  }
986 
987  for (prev = NULL, curr = mouse->cursors; curr;
988  prev = curr, curr = curr->next) {
989  if (curr == cursor) {
990  if (prev) {
991  prev->next = curr->next;
992  } else {
993  mouse->cursors = curr->next;
994  }
995 
996  if (mouse->FreeCursor) {
997  mouse->FreeCursor(curr);
998  }
999  return;
1000  }
1001  }
1002 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:909
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:99
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
#define NULL
Definition: begin_code.h:164
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:101
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:100

◆ SDL_GetCursor()

SDL_Cursor* SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 949 of file SDL_mouse.c.

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

950 {
951  SDL_Mouse *mouse = SDL_GetMouse();
952 
953  if (!mouse) {
954  return NULL;
955  }
956  return mouse->cur_cursor;
957 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
#define NULL
Definition: begin_code.h:164
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:101

◆ SDL_GetDefaultCursor()

SDL_Cursor* SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 960 of file SDL_mouse.c.

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

961 {
962  SDL_Mouse *mouse = SDL_GetMouse();
963 
964  if (!mouse) {
965  return NULL;
966  }
967  return mouse->def_cursor;
968 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
#define NULL
Definition: begin_code.h:164
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:100

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

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

634 {
635  SDL_Mouse *mouse = SDL_GetMouse();
636  int tmpx, tmpy;
637 
638  /* make sure these are never NULL for the backend implementations... */
639  if (!x) {
640  x = &tmpx;
641  }
642  if (!y) {
643  y = &tmpy;
644  }
645 
646  *x = *y = 0;
647 
648  if (!mouse->GetGlobalMouseState) {
649  SDL_assert(0 && "This should really be implemented for every target.");
650  return 0;
651  }
652 
653  return mouse->GetGlobalMouseState(x, y);
654 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
#define SDL_assert(condition)
Definition: SDL_assert.h:169

◆ SDL_GetMouseFocus()

SDL_Window* SDL_GetMouseFocus ( void  )

Get the window which currently has mouse focus.

Definition at line 124 of file SDL_mouse.c.

References SDL_Mouse::buttonstate, SDL_Mouse::focus, i, SDL_Mouse::mouseID, SDL_assert, SDL_BUTTON, SDL_GetMouse(), SDL_RELEASED, and SDL_SendMouseButton().

125 {
126  SDL_Mouse *mouse = SDL_GetMouse();
127 
128  return mouse->focus;
129 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
SDL_Window * focus
Definition: SDL_mouse_c.h:77

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

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

604 {
605  SDL_Mouse *mouse = SDL_GetMouse();
606 
607  if (x) {
608  *x = mouse->x;
609  }
610  if (y) {
611  *y = mouse->y;
612  }
613  return mouse->buttonstate;
614 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
Uint32 buttonstate
Definition: SDL_mouse_c.h:85
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574

◆ SDL_GetRelativeMouseMode()

SDL_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 750 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

751 {
752  SDL_Mouse *mouse = SDL_GetMouse();
753 
754  return mouse->relative_mode;
755 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87

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

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

618 {
619  SDL_Mouse *mouse = SDL_GetMouse();
620 
621  if (x) {
622  *x = mouse->xdelta;
623  }
624  if (y) {
625  *y = mouse->ydelta;
626  }
627  mouse->xdelta = 0;
628  mouse->ydelta = 0;
629  return mouse->buttonstate;
630 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
Uint32 buttonstate
Definition: SDL_mouse_c.h:85
int ydelta
Definition: SDL_mouse_c.h:81
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int xdelta
Definition: SDL_mouse_c.h:80

◆ SDL_SetCursor()

void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

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

910 {
911  SDL_Mouse *mouse = SDL_GetMouse();
912 
913  /* Set the new cursor */
914  if (cursor) {
915  /* Make sure the cursor is still valid for this mouse */
916  if (cursor != mouse->def_cursor) {
917  SDL_Cursor *found;
918  for (found = mouse->cursors; found; found = found->next) {
919  if (found == cursor) {
920  break;
921  }
922  }
923  if (!found) {
924  SDL_SetError("Cursor not associated with the current mouse");
925  return;
926  }
927  }
928  mouse->cur_cursor = cursor;
929  } else {
930  if (mouse->focus) {
931  cursor = mouse->cur_cursor;
932  } else {
933  cursor = mouse->def_cursor;
934  }
935  }
936 
937  if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
938  if (mouse->ShowCursor) {
939  mouse->ShowCursor(cursor);
940  }
941  } else {
942  if (mouse->ShowCursor) {
943  mouse->ShowCursor(NULL);
944  }
945  }
946 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
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:99
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:102
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
SDL_Cursor * cursor
#define NULL
Definition: begin_code.h:164
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
#define SDL_SetError
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:101
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:100

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

References SDL_Mouse::focus, SDL_Window::h, NULL, SDL_Mouse::relative_mode, SDL_Mouse::relative_mode_warp, SDL_Mouse::scale_accum_x, SDL_Mouse::scale_accum_y, SDL_FALSE, SDL_FlushEvent, SDL_GetKeyboardFocus, SDL_GetMouse(), SDL_MOUSEMOTION, SDL_SetCursor(), SDL_SetMouseFocus(), SDL_TRUE, SDL_UpdateWindowGrab(), SDL_WarpMouseInWindow(), SDL_Mouse::SetRelativeMouseMode, ShouldUseRelativeModeWarp(), SDL_Window::w, SDL_Mouse::x, and SDL_Mouse::y.

Referenced by SDL_MouseQuit().

700 {
701  SDL_Mouse *mouse = SDL_GetMouse();
702  SDL_Window *focusWindow = SDL_GetKeyboardFocus();
703 
704  if (enabled == mouse->relative_mode) {
705  return 0;
706  }
707 
708  if (enabled && focusWindow) {
709  /* Center it in the focused window to prevent clicks from going through
710  * to background windows.
711  */
712  SDL_SetMouseFocus(focusWindow);
713  SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
714  }
715 
716  /* Set the relative mode */
717  if (!enabled && mouse->relative_mode_warp) {
718  mouse->relative_mode_warp = SDL_FALSE;
719  } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
720  mouse->relative_mode_warp = SDL_TRUE;
721  } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
722  if (enabled) {
723  /* Fall back to warp mode if native relative mode failed */
724  mouse->relative_mode_warp = SDL_TRUE;
725  }
726  }
727  mouse->relative_mode = enabled;
728  mouse->scale_accum_x = 0.0f;
729  mouse->scale_accum_y = 0.0f;
730 
731  if (mouse->focus) {
732  SDL_UpdateWindowGrab(mouse->focus);
733 
734  /* Put the cursor back to where the application expects it */
735  if (!enabled) {
736  SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
737  }
738  }
739 
740  /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
742 
743  /* Update cursor visibility */
745 
746  return 0;
747 }
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2427
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:88
SDL_Window * focus
Definition: SDL_mouse_c.h:77
#define SDL_FlushEvent
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
float scale_accum_y
Definition: SDL_mouse_c.h:92
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:909
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:151
#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:657
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
float scale_accum_x
Definition: SDL_mouse_c.h:91
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:164
The type used to identify a window.
Definition: SDL_sysvideo.h:73
static SDL_bool ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
Definition: SDL_mouse.c:689

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

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

Referenced by SDL_MouseQuit().

1006 {
1007  SDL_Mouse *mouse = SDL_GetMouse();
1008  SDL_bool shown;
1009 
1010  if (!mouse) {
1011  return 0;
1012  }
1013 
1014  shown = mouse->cursor_shown;
1015  if (toggle >= 0) {
1016  if (toggle) {
1017  mouse->cursor_shown = SDL_TRUE;
1018  } else {
1019  mouse->cursor_shown = SDL_FALSE;
1020  }
1021  if (mouse->cursor_shown != shown) {
1023  }
1024  }
1025  return shown;
1026 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:909
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:102
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:139

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

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

678 {
679  SDL_Mouse *mouse = SDL_GetMouse();
680 
681  if (mouse->WarpMouseGlobal) {
682  return mouse->WarpMouseGlobal(x, y);
683  }
684 
685  return SDL_Unsupported();
686 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
int(* WarpMouseGlobal)(int x, int y)
Definition: SDL_mouse_c.h:64
#define SDL_Unsupported()
Definition: SDL_error.h:53

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

658 {
659  SDL_Mouse *mouse = SDL_GetMouse();
660 
661  if (window == NULL) {
662  window = mouse->focus;
663  }
664 
665  if (window == NULL) {
666  return;
667  }
668 
669  if (mouse->WarpMouse) {
670  mouse->WarpMouse(window, x, y);
671  } else {
672  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
673  }
674 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:112
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
SDL_Window * focus
Definition: SDL_mouse_c.h:77
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:237
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
#define NULL
Definition: begin_code.h:164
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61