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

#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(), and SDL_PrivateSendMouseButton().

#define SDL_BUTTON_LEFT   1

Definition at line 282 of file SDL_mouse.h.

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

#define SDL_BUTTON_LMASK   SDL_BUTTON(SDL_BUTTON_LEFT)

Definition at line 287 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_MIDDLE   2

Definition at line 283 of file SDL_mouse.h.

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

#define SDL_BUTTON_MMASK   SDL_BUTTON(SDL_BUTTON_MIDDLE)

Definition at line 288 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_RIGHT   3

Definition at line 284 of file SDL_mouse.h.

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

#define SDL_BUTTON_RMASK   SDL_BUTTON(SDL_BUTTON_RIGHT)

Definition at line 289 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_X1   4

Definition at line 285 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)

Definition at line 290 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_X2   5

Definition at line 286 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

#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

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

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

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

788 {
789  SDL_Mouse *mouse = SDL_GetMouse();
790  SDL_Window *focusWindow;
791  SDL_bool isCaptured;
792 
793  if (!mouse->CaptureMouse) {
794  return SDL_Unsupported();
795  }
796 
797  focusWindow = SDL_GetKeyboardFocus();
798 
799  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
800  if (isCaptured == enabled) {
801  return 0; /* already done! */
802  }
803 
804  if (enabled) {
805  if (!focusWindow) {
806  return SDL_SetError("No window has focus");
807  } else if (mouse->CaptureMouse(focusWindow) == -1) {
808  return -1; /* CaptureMouse() should call SetError */
809  }
810  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
811  } else {
812  if (mouse->CaptureMouse(NULL) == -1) {
813  return -1; /* CaptureMouse() should call SetError */
814  }
815  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
816  }
817 
818  return 0;
819 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
#define SDL_GetKeyboardFocus
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:161
#define SDL_SetError
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
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_Cursor* SDL_CreateColorCursor ( SDL_Surface surface,
int  hot_x,
int  hot_y 
)

Create a color cursor.

See also
SDL_FreeCursor()

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

872 {
873  SDL_Mouse *mouse = SDL_GetMouse();
874  SDL_Surface *temp = NULL;
876 
877  if (!surface) {
878  SDL_SetError("Passed NULL cursor surface");
879  return NULL;
880  }
881 
882  if (!mouse->CreateCursor) {
883  SDL_SetError("Cursors are not currently supported");
884  return NULL;
885  }
886 
887  /* Sanity check the hot spot */
888  if ((hot_x < 0) || (hot_y < 0) ||
889  (hot_x >= surface->w) || (hot_y >= surface->h)) {
890  SDL_SetError("Cursor hot spot doesn't lie within cursor");
891  return NULL;
892  }
893 
894  if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
896  if (!temp) {
897  return NULL;
898  }
899  surface = temp;
900  }
901 
902  cursor = mouse->CreateCursor(surface, hot_x, hot_y);
903  if (cursor) {
904  cursor->next = mouse->cursors;
905  mouse->cursors = cursor;
906  }
907 
908  SDL_FreeSurface(temp);
909 
910  return cursor;
911 }
#define SDL_ConvertSurfaceFormat
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:101
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: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_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 822 of file SDL_mouse.c.

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

824 {
827  int x, y;
828  Uint32 *pixel;
829  Uint8 datab = 0, maskb = 0;
830  const Uint32 black = 0xFF000000;
831  const Uint32 white = 0xFFFFFFFF;
832  const Uint32 transparent = 0x00000000;
833 
834  /* Make sure the width is a multiple of 8 */
835  w = ((w + 7) & ~7);
836 
837  /* Create the surface from a bitmap */
838  surface = SDL_CreateRGBSurface(0, w, h, 32,
839  0x00FF0000,
840  0x0000FF00,
841  0x000000FF,
842  0xFF000000);
843  if (!surface) {
844  return NULL;
845  }
846  for (y = 0; y < h; ++y) {
847  pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
848  for (x = 0; x < w; ++x) {
849  if ((x % 8) == 0) {
850  datab = *data++;
851  maskb = *mask++;
852  }
853  if (maskb & 0x80) {
854  *pixel++ = (datab & 0x80) ? black : white;
855  } else {
856  *pixel++ = (datab & 0x80) ? black : transparent;
857  }
858  datab <<= 1;
859  maskb <<= 1;
860  }
861  }
862 
863  cursor = SDL_CreateColorCursor(surface, hot_x, hot_y);
864 
865  SDL_FreeSurface(surface);
866 
867  return cursor;
868 }
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.c:871
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
void * pixels
Definition: SDL_surface.h:75
#define SDL_FreeSurface
uint8_t Uint8
Definition: SDL_stdinc.h:179
GLenum GLint GLuint mask
GLubyte GLubyte GLubyte GLubyte w
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
SDL_Cursor * cursor
Definition: testwm2.c:40
#define NULL
Definition: begin_code.h:164
#define SDL_CreateRGBSurface
uint32_t Uint32
Definition: SDL_stdinc.h:203
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_Cursor* SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 914 of file SDL_mouse.c.

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

915 {
916  SDL_Mouse *mouse = SDL_GetMouse();
918 
919  if (!mouse->CreateSystemCursor) {
920  SDL_SetError("CreateSystemCursor is not currently supported");
921  return NULL;
922  }
923 
924  cursor = mouse->CreateSystemCursor(id);
925  if (cursor) {
926  cursor->next = mouse->cursors;
927  mouse->cursors = cursor;
928  }
929 
930  return cursor;
931 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:101
SDL_Cursor * cursor
Definition: testwm2.c:40
#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
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 1000 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().

1001 {
1002  SDL_Mouse *mouse = SDL_GetMouse();
1003  SDL_Cursor *curr, *prev;
1004 
1005  if (!cursor) {
1006  return;
1007  }
1008 
1009  if (cursor == mouse->def_cursor) {
1010  return;
1011  }
1012  if (cursor == mouse->cur_cursor) {
1013  SDL_SetCursor(mouse->def_cursor);
1014  }
1015 
1016  for (prev = NULL, curr = mouse->cursors; curr;
1017  prev = curr, curr = curr->next) {
1018  if (curr == cursor) {
1019  if (prev) {
1020  prev->next = curr->next;
1021  } else {
1022  mouse->cursors = curr->next;
1023  }
1024 
1025  if (mouse->FreeCursor) {
1026  mouse->FreeCursor(curr);
1027  }
1028  return;
1029  }
1030  }
1031 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:938
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:101
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:103
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:102
SDL_Cursor* SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 978 of file SDL_mouse.c.

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

979 {
980  SDL_Mouse *mouse = SDL_GetMouse();
981 
982  if (!mouse) {
983  return NULL;
984  }
985  return mouse->cur_cursor;
986 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
#define NULL
Definition: begin_code.h:164
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:103
SDL_Cursor* SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 989 of file SDL_mouse.c.

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

990 {
991  SDL_Mouse *mouse = SDL_GetMouse();
992 
993  if (!mouse) {
994  return NULL;
995  }
996  return mouse->def_cursor;
997 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
#define NULL
Definition: begin_code.h:164
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:102
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 659 of file SDL_mouse.c.

References SDL_Mouse::GetGlobalMouseState, and SDL_GetMouse().

660 {
661  SDL_Mouse *mouse = SDL_GetMouse();
662  int tmpx, tmpy;
663 
664  /* make sure these are never NULL for the backend implementations... */
665  if (!x) {
666  x = &tmpx;
667  }
668  if (!y) {
669  y = &tmpy;
670  }
671 
672  *x = *y = 0;
673 
674  if (!mouse->GetGlobalMouseState) {
675  return 0;
676  }
677 
678  return mouse->GetGlobalMouseState(x, y);
679 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73
SDL_Window* SDL_GetMouseFocus ( void  )

Get the window which currently has mouse focus.

Definition at line 150 of file SDL_mouse.c.

References SDL_Mouse::focus, and SDL_GetMouse().

151 {
152  SDL_Mouse *mouse = SDL_GetMouse();
153 
154  return mouse->focus;
155 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
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 629 of file SDL_mouse.c.

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

630 {
631  SDL_Mouse *mouse = SDL_GetMouse();
632 
633  if (x) {
634  *x = mouse->x;
635  }
636  if (y) {
637  *y = mouse->y;
638  }
639  return mouse->buttonstate;
640 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
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_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 779 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

780 {
781  SDL_Mouse *mouse = SDL_GetMouse();
782 
783  return mouse->relative_mode;
784 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
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 643 of file SDL_mouse.c.

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

644 {
645  SDL_Mouse *mouse = SDL_GetMouse();
646 
647  if (x) {
648  *x = mouse->xdelta;
649  }
650  if (y) {
651  *y = mouse->ydelta;
652  }
653  mouse->xdelta = 0;
654  mouse->ydelta = 0;
655  return mouse->buttonstate;
656 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
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
void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

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

939 {
940  SDL_Mouse *mouse = SDL_GetMouse();
941 
942  /* Set the new cursor */
943  if (cursor) {
944  /* Make sure the cursor is still valid for this mouse */
945  if (cursor != mouse->def_cursor) {
946  SDL_Cursor *found;
947  for (found = mouse->cursors; found; found = found->next) {
948  if (found == cursor) {
949  break;
950  }
951  }
952  if (!found) {
953  SDL_SetError("Cursor not associated with the current mouse");
954  return;
955  }
956  }
957  mouse->cur_cursor = cursor;
958  } else {
959  if (mouse->focus) {
960  cursor = mouse->cur_cursor;
961  } else {
962  cursor = mouse->def_cursor;
963  }
964  }
965 
966  if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
967  if (mouse->ShowCursor) {
968  mouse->ShowCursor(cursor);
969  }
970  } else {
971  if (mouse->ShowCursor) {
972  mouse->ShowCursor(NULL);
973  }
974  }
975 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:101
int(* ShowCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:52
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:104
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
SDL_Cursor * cursor
Definition: testwm2.c:40
#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:103
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:102
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 725 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_SetError, SDL_SetMouseFocus(), SDL_TRUE, SDL_UpdateWindowGrab(), SDL_WarpMouseInWindow(), SDL_Mouse::SetRelativeMouseMode, ShouldUseRelativeModeWarp(), SDL_Window::w, SDL_Mouse::WarpMouse, SDL_Mouse::x, and SDL_Mouse::y.

Referenced by SDL_MouseQuit().

726 {
727  SDL_Mouse *mouse = SDL_GetMouse();
728  SDL_Window *focusWindow = SDL_GetKeyboardFocus();
729 
730  if (enabled == mouse->relative_mode) {
731  return 0;
732  }
733 
734  if (enabled && focusWindow) {
735  /* Center it in the focused window to prevent clicks from going through
736  * to background windows.
737  */
738  SDL_SetMouseFocus(focusWindow);
739  SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
740  }
741 
742  /* Set the relative mode */
743  if (!enabled && mouse->relative_mode_warp) {
744  mouse->relative_mode_warp = SDL_FALSE;
745  } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
746  mouse->relative_mode_warp = SDL_TRUE;
747  } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
748  if (enabled) {
749  /* Fall back to warp mode if native relative mode failed */
750  if (!mouse->WarpMouse) {
751  return SDL_SetError("No relative mode implementation available");
752  }
753  mouse->relative_mode_warp = SDL_TRUE;
754  }
755  }
756  mouse->relative_mode = enabled;
757  mouse->scale_accum_x = 0.0f;
758  mouse->scale_accum_y = 0.0f;
759 
760  if (mouse->focus) {
761  SDL_UpdateWindowGrab(mouse->focus);
762 
763  /* Put the cursor back to where the application expects it */
764  if (!enabled) {
765  SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
766  }
767  }
768 
769  /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
771 
772  /* Update cursor visibility */
774 
775  return 0;
776 }
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2504
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:88
SDL_Window * focus
Definition: SDL_mouse_c.h:77
#define SDL_FlushEvent
float scale_accum_y
Definition: SDL_mouse_c.h:92
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:938
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:177
#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:682
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
float scale_accum_x
Definition: SDL_mouse_c.h:91
GLenum GLenum GLsizei const GLuint GLboolean enabled
#define NULL
Definition: begin_code.h:164
#define SDL_SetError
The type used to identify a window.
Definition: SDL_sysvideo.h:73
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61
static SDL_bool ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
Definition: SDL_mouse.c:714
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 1034 of file SDL_mouse.c.

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

Referenced by SDL_MouseQuit().

1035 {
1036  SDL_Mouse *mouse = SDL_GetMouse();
1037  SDL_bool shown;
1038 
1039  if (!mouse) {
1040  return 0;
1041  }
1042 
1043  shown = mouse->cursor_shown;
1044  if (toggle >= 0) {
1045  if (toggle) {
1046  mouse->cursor_shown = SDL_TRUE;
1047  } else {
1048  mouse->cursor_shown = SDL_FALSE;
1049  }
1050  if (mouse->cursor_shown != shown) {
1052  }
1053  }
1054  return shown;
1055 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:938
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:104
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:161
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 702 of file SDL_mouse.c.

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

703 {
704  SDL_Mouse *mouse = SDL_GetMouse();
705 
706  if (mouse->WarpMouseGlobal) {
707  return mouse->WarpMouseGlobal(x, y);
708  }
709 
710  return SDL_Unsupported();
711 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
int(* WarpMouseGlobal)(int x, int y)
Definition: SDL_mouse_c.h:64
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
#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 682 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().

683 {
684  SDL_Mouse *mouse = SDL_GetMouse();
685 
686  if (window == NULL) {
687  window = mouse->focus;
688  }
689 
690  if (window == NULL) {
691  return;
692  }
693 
694  if (mouse->WarpMouse) {
695  mouse->WarpMouse(window, x, y);
696  } else {
697  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
698  }
699 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:144
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:263
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