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

756 {
757  SDL_Mouse *mouse = SDL_GetMouse();
758  SDL_Window *focusWindow;
759  SDL_bool isCaptured;
760 
761  if (!mouse->CaptureMouse) {
762  return SDL_Unsupported();
763  }
764 
765  focusWindow = SDL_GetKeyboardFocus();
766 
767  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
768  if (isCaptured == enabled) {
769  return 0; /* already done! */
770  }
771 
772  if (enabled) {
773  if (!focusWindow) {
774  return SDL_SetError("No window has focus");
775  } else if (mouse->CaptureMouse(focusWindow) == -1) {
776  return -1; /* CaptureMouse() should call SetError */
777  }
778  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
779  } else {
780  if (mouse->CaptureMouse(NULL) == -1) {
781  return -1; /* CaptureMouse() should call SetError */
782  }
783  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
784  }
785 
786  return 0;
787 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
#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 839 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().

840 {
841  SDL_Mouse *mouse = SDL_GetMouse();
842  SDL_Surface *temp = NULL;
844 
845  if (!surface) {
846  SDL_SetError("Passed NULL cursor surface");
847  return NULL;
848  }
849 
850  if (!mouse->CreateCursor) {
851  SDL_SetError("Cursors are not currently supported");
852  return NULL;
853  }
854 
855  /* Sanity check the hot spot */
856  if ((hot_x < 0) || (hot_y < 0) ||
857  (hot_x >= surface->w) || (hot_y >= surface->h)) {
858  SDL_SetError("Cursor hot spot doesn't lie within cursor");
859  return NULL;
860  }
861 
862  if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
864  if (!temp) {
865  return NULL;
866  }
867  surface = temp;
868  }
869 
870  cursor = mouse->CreateCursor(surface, hot_x, hot_y);
871  if (cursor) {
872  cursor->next = mouse->cursors;
873  mouse->cursors = cursor;
874  }
875 
876  SDL_FreeSurface(temp);
877 
878  return cursor;
879 }
#define SDL_ConvertSurfaceFormat
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 790 of file SDL_mouse.c.

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

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

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

883 {
884  SDL_Mouse *mouse = SDL_GetMouse();
886 
887  if (!mouse->CreateSystemCursor) {
888  SDL_SetError("CreateSystemCursor is not currently supported");
889  return NULL;
890  }
891 
892  cursor = mouse->CreateSystemCursor(id);
893  if (cursor) {
894  cursor->next = mouse->cursors;
895  mouse->cursors = cursor;
896  }
897 
898  return cursor;
899 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 968 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().

969 {
970  SDL_Mouse *mouse = SDL_GetMouse();
971  SDL_Cursor *curr, *prev;
972 
973  if (!cursor) {
974  return;
975  }
976 
977  if (cursor == mouse->def_cursor) {
978  return;
979  }
980  if (cursor == mouse->cur_cursor) {
981  SDL_SetCursor(mouse->def_cursor);
982  }
983 
984  for (prev = NULL, curr = mouse->cursors; curr;
985  prev = curr, curr = curr->next) {
986  if (curr == cursor) {
987  if (prev) {
988  prev->next = curr->next;
989  } else {
990  mouse->cursors = curr->next;
991  }
992 
993  if (mouse->FreeCursor) {
994  mouse->FreeCursor(curr);
995  }
996  return;
997  }
998  }
999 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:906
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 946 of file SDL_mouse.c.

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

947 {
948  SDL_Mouse *mouse = SDL_GetMouse();
949 
950  if (!mouse) {
951  return NULL;
952  }
953  return mouse->cur_cursor;
954 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
#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 957 of file SDL_mouse.c.

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

958 {
959  SDL_Mouse *mouse = SDL_GetMouse();
960 
961  if (!mouse) {
962  return NULL;
963  }
964  return mouse->def_cursor;
965 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
#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 630 of file SDL_mouse.c.

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

631 {
632  SDL_Mouse *mouse = SDL_GetMouse();
633  int tmpx, tmpy;
634 
635  /* make sure these are never NULL for the backend implementations... */
636  if (!x) {
637  x = &tmpx;
638  }
639  if (!y) {
640  y = &tmpy;
641  }
642 
643  *x = *y = 0;
644 
645  if (!mouse->GetGlobalMouseState) {
646  SDL_assert(0 && "This should really be implemented for every target.");
647  return 0;
648  }
649 
650  return mouse->GetGlobalMouseState(x, y);
651 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 122 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().

123 {
124  SDL_Mouse *mouse = SDL_GetMouse();
125 
126  return mouse->focus;
127 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 600 of file SDL_mouse.c.

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

601 {
602  SDL_Mouse *mouse = SDL_GetMouse();
603 
604  if (x) {
605  *x = mouse->x;
606  }
607  if (y) {
608  *y = mouse->y;
609  }
610  return mouse->buttonstate;
611 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 747 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

748 {
749  SDL_Mouse *mouse = SDL_GetMouse();
750 
751  return mouse->relative_mode;
752 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 614 of file SDL_mouse.c.

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

615 {
616  SDL_Mouse *mouse = SDL_GetMouse();
617 
618  if (x) {
619  *x = mouse->xdelta;
620  }
621  if (y) {
622  *y = mouse->ydelta;
623  }
624  mouse->xdelta = 0;
625  mouse->ydelta = 0;
626  return mouse->buttonstate;
627 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 906 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().

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

697 {
698  SDL_Mouse *mouse = SDL_GetMouse();
699  SDL_Window *focusWindow = SDL_GetKeyboardFocus();
700 
701  if (enabled == mouse->relative_mode) {
702  return 0;
703  }
704 
705  if (enabled && focusWindow) {
706  /* Center it in the focused window to prevent clicks from going through
707  * to background windows.
708  */
709  SDL_SetMouseFocus(focusWindow);
710  SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
711  }
712 
713  /* Set the relative mode */
714  if (!enabled && mouse->relative_mode_warp) {
715  mouse->relative_mode_warp = SDL_FALSE;
716  } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
717  mouse->relative_mode_warp = SDL_TRUE;
718  } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
719  if (enabled) {
720  /* Fall back to warp mode if native relative mode failed */
721  mouse->relative_mode_warp = SDL_TRUE;
722  }
723  }
724  mouse->relative_mode = enabled;
725  mouse->scale_accum_x = 0.0f;
726  mouse->scale_accum_y = 0.0f;
727 
728  if (mouse->focus) {
729  SDL_UpdateWindowGrab(mouse->focus);
730 
731  /* Put the cursor back to where the application expects it */
732  if (!enabled) {
733  SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
734  }
735  }
736 
737  /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
739 
740  /* Update cursor visibility */
742 
743  return 0;
744 }
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2427
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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:906
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:149
#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:654
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:686

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

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

Referenced by SDL_MouseQuit().

1003 {
1004  SDL_Mouse *mouse = SDL_GetMouse();
1005  SDL_bool shown;
1006 
1007  if (!mouse) {
1008  return 0;
1009  }
1010 
1011  shown = mouse->cursor_shown;
1012  if (toggle >= 0) {
1013  if (toggle) {
1014  mouse->cursor_shown = SDL_TRUE;
1015  } else {
1016  mouse->cursor_shown = SDL_FALSE;
1017  }
1018  if (mouse->cursor_shown != shown) {
1020  }
1021  }
1022  return shown;
1023 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:906
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 674 of file SDL_mouse.c.

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

675 {
676  SDL_Mouse *mouse = SDL_GetMouse();
677 
678  if (mouse->WarpMouseGlobal) {
679  return mouse->WarpMouseGlobal(x, y);
680  }
681 
682  return SDL_Unsupported();
683 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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 654 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().

655 {
656  SDL_Mouse *mouse = SDL_GetMouse();
657 
658  if (window == NULL) {
659  window = mouse->focus;
660  }
661 
662  if (window == NULL) {
663  return;
664  }
665 
666  if (mouse->WarpMouse) {
667  mouse->WarpMouse(window, x, y);
668  } else {
669  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
670  }
671 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:110
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:235
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