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(). 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 279 of file SDL_mouse.h.

Referenced by _mouseStateCheck(), SDL_ResetMouse(), and SDL_SendMouseButton().

#define SDL_BUTTON_LEFT   1

Definition at line 280 of file SDL_mouse.h.

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

#define SDL_BUTTON_LMASK   SDL_BUTTON(SDL_BUTTON_LEFT)

Definition at line 285 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_MIDDLE   2

Definition at line 281 of file SDL_mouse.h.

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

#define SDL_BUTTON_MMASK   SDL_BUTTON(SDL_BUTTON_MIDDLE)

Definition at line 286 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_RIGHT   3

Definition at line 282 of file SDL_mouse.h.

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

#define SDL_BUTTON_RMASK   SDL_BUTTON(SDL_BUTTON_RIGHT)

Definition at line 287 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_X1   4

Definition at line 283 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)

Definition at line 288 of file SDL_mouse.h.

Referenced by SDLTest_CommonEvent().

#define SDL_BUTTON_X2   5

Definition at line 284 of file SDL_mouse.h.

Referenced by _mouseStateCheck().

#define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)

Definition at line 289 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 628 of file SDL_mouse.c.

References SDL_Mouse::CaptureMouse, SDL_Window::flags, NULL, SDL_GetKeyboardFocus, SDL_GetMouse(), SDL_SetError, SDL_Unsupported, and SDL_WINDOW_MOUSE_CAPTURE.

Referenced by SDL_MouseQuit().

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

Create a color cursor.

See also
SDL_FreeCursor()

Definition at line 712 of file SDL_mouse.c.

References SDL_Mouse::CreateCursor, cursor, SDL_Mouse::cursors, SDL_Surface::format, SDL_PixelFormat::format, SDL_Surface::h, SDL_Cursor::next, NULL, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_GetMouse(), SDL_PIXELFORMAT_ARGB8888, SDL_SetError, and SDL_Surface::w.

Referenced by SDL_CreateCursor().

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

Create a cursor, using the specified bitmap data and mask (in MSB format).

The cursor width must be a multiple of 8 bits.

The cursor is created in black and white according to the following:

data mask resulting pixel on screen
0 1 White
1 1 Black
0 0 Transparent
1 0 Inverted color if possible, black if not.
See also
SDL_FreeCursor()

Definition at line 663 of file SDL_mouse.c.

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

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

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 755 of file SDL_mouse.c.

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

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

Frees a cursor created with SDL_CreateCursor().

See also
SDL_CreateCursor()

Definition at line 841 of file SDL_mouse.c.

References SDL_Mouse::cur_cursor, SDL_Mouse::cursors, SDL_Mouse::def_cursor, SDL_Mouse::FreeCursor, SDL_Cursor::next, NULL, SDL_GetMouse(), and SDL_SetCursor().

Referenced by SDL_MouseQuit().

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

Return the active cursor.

Definition at line 819 of file SDL_mouse.c.

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

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

Return the default cursor.

Definition at line 830 of file SDL_mouse.c.

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

831 {
832  SDL_Mouse *mouse = SDL_GetMouse();
833 
834  if (!mouse) {
835  return NULL;
836  }
837  return mouse->def_cursor;
838 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
#define NULL
Definition: begin_code.h:143
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:92
Uint32 SDL_GetGlobalMouseState ( int *  x,
int *  y 
)

Get the current state of the mouse, in relation to the desktop.

This works just like SDL_GetMouseState(), but the coordinates will be reported relative to the top-left of the desktop. This can be useful if you need to track the mouse outside of a specific window and SDL_CaptureMouse() doesn't fit your needs. For example, it could be useful if you need to track the mouse while dragging a window, where coordinates relative to a window might not be in sync at all times.

Note
SDL_GetMouseState() returns the mouse position as SDL understands it from the last pump of the event queue. This function, however, queries the OS for the current mouse position, and as such, might be a slightly less efficient function. Unless you know what you're doing and have a good reason to use this function, you probably want SDL_GetMouseState() instead.
Parameters
xReturns the current X coord, relative to the desktop. Can be NULL.
yReturns the current Y coord, relative to the desktop. Can be NULL.
Returns
The current button state as a bitmask, which can be tested using the SDL_BUTTON(X) macros.
See also
SDL_GetMouseState

Definition at line 495 of file SDL_mouse.c.

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

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

Get the window which currently has mouse focus.

Definition at line 78 of file SDL_mouse.c.

References SDL_Mouse::focus, and SDL_GetMouse().

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

Retrieve the current state of the mouse.

The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and x and y are set to the mouse cursor position relative to the focus window for the currently selected mouse. You can pass NULL for either x or y.

Definition at line 465 of file SDL_mouse.c.

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

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

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 620 of file SDL_mouse.c.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

621 {
622  SDL_Mouse *mouse = SDL_GetMouse();
623 
624  return mouse->relative_mode;
625 }
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:66
SDL_bool relative_mode
Definition: SDL_mouse_c.h:84
Uint32 SDL_GetRelativeMouseState ( int *  x,
int *  y 
)

Retrieve the relative state of the mouse.

The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and x and y are set to the mouse deltas since the last call to SDL_GetRelativeMouseState().

Definition at line 479 of file SDL_mouse.c.

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

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

Set the active cursor.

Definition at line 779 of file SDL_mouse.c.

References SDL_Mouse::cur_cursor, cursor, SDL_Mouse::cursor_shown, SDL_Mouse::cursors, SDL_Mouse::def_cursor, SDL_Mouse::focus, SDL_Cursor::next, NULL, SDL_Mouse::relative_mode, SDL_GetMouse(), SDL_SetError, and SDL_Mouse::ShowCursor.

Referenced by SDL_FreeCursor(), SDL_SetDefaultCursor(), SDL_SetMouseFocus(), SDL_SetRelativeMouseMode(), and SDL_ShowCursor().

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

Set relative mouse mode.

Parameters
enabledWhether or not to enable relative mode
Returns
0 on success, or -1 if relative mode is not supported.

While the mouse is in relative mode, the cursor is hidden, and the driver will try to report continuous motion in the current window. Only relative motion events will be delivered, the mouse position will not change.

Note
This function will flush any pending mouse motion.
See also
SDL_GetRelativeMouseMode()

Definition at line 571 of file SDL_mouse.c.

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

Referenced by SDL_MouseQuit().

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

Toggle whether or not the cursor is shown.

Parameters
toggle1 to show the cursor, 0 to hide it, -1 to query the current state.
Returns
1 if the cursor is shown, or 0 if the cursor is hidden.

Definition at line 875 of file SDL_mouse.c.

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

Referenced by SDL_MouseQuit().

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

Moves the mouse to the given position in global screen space.

Parameters
xThe x coordinate
yThe y coordinate
Returns
0 on success, -1 on error (usually: unsupported by a platform).
Note
This function generates a mouse motion event

Definition at line 539 of file SDL_mouse.c.

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

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

Moves the mouse to the given position within the window.

Parameters
windowThe window to move the mouse into, or NULL for the current mouse focus
xThe x coordinate within the window
yThe y coordinate within the window
Note
This function generates a mouse motion event

Definition at line 519 of file SDL_mouse.c.

References SDL_Mouse::focus, SDL_Mouse::mouseID, NULL, SDL_GetMouse(), SDL_SendMouseMotion(), and SDL_Mouse::WarpMouse.

Referenced by SDL_PrivateSendMouseMotion(), and SDL_SetRelativeMouseMode().

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