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_PrivateSendMouseButton(), and SDL_ResetMouse().

◆ SDL_BUTTON_LEFT

#define SDL_BUTTON_LEFT   1

Definition at line 282 of file SDL_mouse.h.

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

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

633 {
634  SDL_Mouse *mouse = SDL_GetMouse();
635  SDL_Window *focusWindow;
636  SDL_bool isCaptured;
637 
638  if (!mouse->CaptureMouse) {
639  return SDL_Unsupported();
640  }
641 
642  focusWindow = SDL_GetKeyboardFocus();
643 
644  isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
645  if (isCaptured == enabled) {
646  return 0; /* already done! */
647  }
648 
649  if (enabled) {
650  if (!focusWindow) {
651  return SDL_SetError("No window has focus");
652  } else if (mouse->CaptureMouse(focusWindow) == -1) {
653  return -1; /* CaptureMouse() should call SetError */
654  }
655  focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
656  } else {
657  if (mouse->CaptureMouse(NULL) == -1) {
658  return -1; /* CaptureMouse() should call SetError */
659  }
660  focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
661  }
662 
663  return 0;
664 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#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:143
SDL_bool
Definition: SDL_stdinc.h:130
#define SDL_SetError
The type used to identify a window.
Definition: SDL_sysvideo.h:71
Uint32 flags
Definition: SDL_sysvideo.h:81
#define SDL_Unsupported()
Definition: SDL_error.h:53

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

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

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

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

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

◆ SDL_CreateSystemCursor()

SDL_Cursor* SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 759 of file SDL_mouse.c.

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

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

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

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

◆ SDL_GetCursor()

SDL_Cursor* SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 823 of file SDL_mouse.c.

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

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

◆ SDL_GetDefaultCursor()

SDL_Cursor* SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 834 of file SDL_mouse.c.

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

835 {
836  SDL_Mouse *mouse = SDL_GetMouse();
837 
838  if (!mouse) {
839  return NULL;
840  }
841  return mouse->def_cursor;
842 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#define NULL
Definition: begin_code.h:143
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92

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

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

510 {
511  SDL_Mouse *mouse = SDL_GetMouse();
512  int tmpx, tmpy;
513 
514  /* make sure these are never NULL for the backend implementations... */
515  if (!x) {
516  x = &tmpx;
517  }
518  if (!y) {
519  y = &tmpy;
520  }
521 
522  *x = *y = 0;
523 
524  if (!mouse->GetGlobalMouseState) {
525  SDL_assert(0 && "This should really be implemented for every target.");
526  return 0;
527  }
528 
529  return mouse->GetGlobalMouseState(x, y);
530 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
#define SDL_assert(condition)
Definition: SDL_assert.h:167

◆ SDL_GetMouseFocus()

SDL_Window* SDL_GetMouseFocus ( void  )

Get the window which currently has mouse focus.

Definition at line 78 of file SDL_mouse.c.

References SDL_Mouse::focus, and SDL_GetMouse().

79 {
80  SDL_Mouse *mouse = SDL_GetMouse();
81 
82  return mouse->focus;
83 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_Window * focus
Definition: SDL_mouse_c.h:77

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

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

480 {
481  SDL_Mouse *mouse = SDL_GetMouse();
482 
483  if (x) {
484  *x = mouse->x;
485  }
486  if (y) {
487  *y = mouse->y;
488  }
489  return mouse->buttonstate;
490 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567

◆ SDL_GetRelativeMouseMode()

SDL_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 624 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

625 {
626  SDL_Mouse *mouse = SDL_GetMouse();
627 
628  return mouse->relative_mode;
629 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84

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

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

494 {
495  SDL_Mouse *mouse = SDL_GetMouse();
496 
497  if (x) {
498  *x = mouse->xdelta;
499  }
500  if (y) {
501  *y = mouse->ydelta;
502  }
503  mouse->xdelta = 0;
504  mouse->ydelta = 0;
505  return mouse->buttonstate;
506 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
Uint32 buttonstate
Definition: SDL_mouse_c.h:83
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
int ydelta
Definition: SDL_mouse_c.h:81
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
int xdelta
Definition: SDL_mouse_c.h:80

◆ SDL_SetCursor()

void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

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

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

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

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

Referenced by SDL_MouseQuit().

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

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

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

Referenced by SDL_MouseQuit().

880 {
881  SDL_Mouse *mouse = SDL_GetMouse();
882  SDL_bool shown;
883 
884  if (!mouse) {
885  return 0;
886  }
887 
888  shown = mouse->cursor_shown;
889  if (toggle >= 0) {
890  if (toggle) {
891  mouse->cursor_shown = SDL_TRUE;
892  } else {
893  mouse->cursor_shown = SDL_FALSE;
894  }
895  if (mouse->cursor_shown != shown) {
897  }
898  }
899  return shown;
900 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:783
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:94
#define NULL
Definition: begin_code.h:143
SDL_bool
Definition: SDL_stdinc.h:130

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

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

554 {
555  SDL_Mouse *mouse = SDL_GetMouse();
556 
557  if (mouse->WarpMouseGlobal) {
558  return mouse->WarpMouseGlobal(x, y);
559  }
560 
561  return SDL_Unsupported();
562 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
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 533 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().

534 {
535  SDL_Mouse *mouse = SDL_GetMouse();
536 
537  if (window == NULL) {
538  window = mouse->focus;
539  }
540 
541  if (window == NULL) {
542  return;
543  }
544 
545  if (mouse->WarpMouse) {
546  mouse->WarpMouse(window, x, y);
547  } else {
548  SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
549  }
550 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1567
SDL_Window * focus
Definition: SDL_mouse_c.h:77
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1567
int SDL_SendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:188
#define NULL
Definition: begin_code.h:143
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61