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.

◆ SDL_BUTTON_LEFT

#define SDL_BUTTON_LEFT   1

Definition at line 282 of file SDL_mouse.h.

◆ SDL_BUTTON_LMASK

#define SDL_BUTTON_LMASK   SDL_BUTTON(SDL_BUTTON_LEFT)

Definition at line 287 of file SDL_mouse.h.

◆ SDL_BUTTON_MIDDLE

#define SDL_BUTTON_MIDDLE   2

Definition at line 283 of file SDL_mouse.h.

◆ SDL_BUTTON_MMASK

#define SDL_BUTTON_MMASK   SDL_BUTTON(SDL_BUTTON_MIDDLE)

Definition at line 288 of file SDL_mouse.h.

◆ SDL_BUTTON_RIGHT

#define SDL_BUTTON_RIGHT   3

Definition at line 284 of file SDL_mouse.h.

◆ SDL_BUTTON_RMASK

#define SDL_BUTTON_RMASK   SDL_BUTTON(SDL_BUTTON_RIGHT)

Definition at line 289 of file SDL_mouse.h.

◆ SDL_BUTTON_X1

#define SDL_BUTTON_X1   4

Definition at line 285 of file SDL_mouse.h.

◆ SDL_BUTTON_X1MASK

#define SDL_BUTTON_X1MASK   SDL_BUTTON(SDL_BUTTON_X1)

Definition at line 290 of file SDL_mouse.h.

◆ SDL_BUTTON_X2

#define SDL_BUTTON_X2   5

Definition at line 286 of file SDL_mouse.h.

◆ SDL_BUTTON_X2MASK

#define SDL_BUTTON_X2MASK   SDL_BUTTON(SDL_BUTTON_X2)

Definition at line 291 of file SDL_mouse.h.

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:67
@ SDL_MOUSEWHEEL_NORMAL
Definition: SDL_mouse.h:68
@ SDL_MOUSEWHEEL_FLIPPED
Definition: SDL_mouse.h:69

◆ 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:47
@ SDL_SYSTEM_CURSOR_SIZENS
Definition: SDL_mouse.h:56
@ SDL_SYSTEM_CURSOR_HAND
Definition: SDL_mouse.h:59
@ SDL_SYSTEM_CURSOR_ARROW
Definition: SDL_mouse.h:48
@ SDL_SYSTEM_CURSOR_SIZENWSE
Definition: SDL_mouse.h:53
@ SDL_SYSTEM_CURSOR_SIZENESW
Definition: SDL_mouse.h:54
@ SDL_SYSTEM_CURSOR_IBEAM
Definition: SDL_mouse.h:49
@ SDL_SYSTEM_CURSOR_NO
Definition: SDL_mouse.h:58
@ SDL_SYSTEM_CURSOR_WAITARROW
Definition: SDL_mouse.h:52
@ SDL_SYSTEM_CURSOR_SIZEALL
Definition: SDL_mouse.h:57
@ SDL_SYSTEM_CURSOR_WAIT
Definition: SDL_mouse.h:50
@ SDL_NUM_SYSTEM_CURSORS
Definition: SDL_mouse.h:60
@ SDL_SYSTEM_CURSOR_SIZEWE
Definition: SDL_mouse.h:55
@ SDL_SYSTEM_CURSOR_CROSSHAIR
Definition: SDL_mouse.h:51

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

862{
863 SDL_Mouse *mouse = SDL_GetMouse();
864 SDL_Window *focusWindow;
865 SDL_bool isCaptured;
866
867 if (!mouse->CaptureMouse) {
868 return SDL_Unsupported();
869 }
870
871 focusWindow = SDL_GetKeyboardFocus();
872
873 isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
874 if (isCaptured == enabled) {
875 return 0; /* already done! */
876 }
877
878 if (enabled) {
879 if (!focusWindow) {
880 return SDL_SetError("No window has focus");
881 } else if (mouse->CaptureMouse(focusWindow) == -1) {
882 return -1; /* CaptureMouse() should call SetError */
883 }
884 focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
885 } else {
886 if (mouse->CaptureMouse(NULL) == -1) {
887 return -1; /* CaptureMouse() should call SetError */
888 }
889 focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
890 }
891
892 return 0;
893}
#define SDL_SetError
#define SDL_GetKeyboardFocus
#define SDL_Unsupported()
Definition: SDL_error.h:53
SDL_Mouse * SDL_GetMouse(void)
Definition: SDL_mouse.c:178
GLenum GLenum GLsizei const GLuint GLboolean enabled
SDL_bool
Definition: SDL_stdinc.h:162
@ SDL_WINDOW_MOUSE_CAPTURE
Definition: SDL_video.h:116
#define NULL
Definition: begin_code.h:167
int(* CaptureMouse)(SDL_Window *window)
Definition: SDL_mouse_c.h:70
The type used to identify a window.
Definition: SDL_sysvideo.h:74
Uint32 flags
Definition: SDL_sysvideo.h:83

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

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

946{
947 SDL_Mouse *mouse = SDL_GetMouse();
948 SDL_Surface *temp = NULL;
950
951 if (!surface) {
952 SDL_SetError("Passed NULL cursor surface");
953 return NULL;
954 }
955
956 if (!mouse->CreateCursor) {
957 SDL_SetError("Cursors are not currently supported");
958 return NULL;
959 }
960
961 /* Sanity check the hot spot */
962 if ((hot_x < 0) || (hot_y < 0) ||
963 (hot_x >= surface->w) || (hot_y >= surface->h)) {
964 SDL_SetError("Cursor hot spot doesn't lie within cursor");
965 return NULL;
966 }
967
968 if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
970 if (!temp) {
971 return NULL;
972 }
973 surface = temp;
974 }
975
976 cursor = mouse->CreateCursor(surface, hot_x, hot_y);
977 if (cursor) {
978 cursor->next = mouse->cursors;
979 mouse->cursors = cursor;
980 }
981
982 SDL_FreeSurface(temp);
983
984 return cursor;
985}
#define SDL_ConvertSurfaceFormat
#define SDL_FreeSurface
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:57
@ SDL_PIXELFORMAT_ARGB8888
Definition: SDL_pixels.h:248
EGLSurface surface
Definition: eglext.h:248
struct SDL_Cursor * next
Definition: SDL_mouse_c.h:32
SDL_Cursor *(* CreateCursor)(SDL_Surface *surface, int hot_x, int hot_y)
Definition: SDL_mouse_c.h:46
SDL_Cursor * cursors
Definition: SDL_mouse_c.h:103
A collection of pixels used in software blitting.
Definition: SDL_surface.h:71
SDL_Cursor * cursor
Definition: testwm2.c:40

References SDL_Mouse::CreateCursor, cursor, SDL_Mouse::cursors, hot_x, SDL_Cursor::next, NULL, SDL_ConvertSurfaceFormat, SDL_FreeSurface, SDL_GetMouse(), SDL_PIXELFORMAT_ARGB8888, and SDL_SetError.

Referenced by SDL_CreateCursor().

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

898{
901 int x, y;
902 Uint32 *pixel;
903 Uint8 datab = 0, maskb = 0;
904 const Uint32 black = 0xFF000000;
905 const Uint32 white = 0xFFFFFFFF;
906 const Uint32 transparent = 0x00000000;
907
908 /* Make sure the width is a multiple of 8 */
909 w = ((w + 7) & ~7);
910
911 /* Create the surface from a bitmap */
913 0x00FF0000,
914 0x0000FF00,
915 0x000000FF,
916 0xFF000000);
917 if (!surface) {
918 return NULL;
919 }
920 for (y = 0; y < h; ++y) {
921 pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
922 for (x = 0; x < w; ++x) {
923 if ((x % 8) == 0) {
924 datab = *data++;
925 maskb = *mask++;
926 }
927 if (maskb & 0x80) {
928 *pixel++ = (datab & 0x80) ? black : white;
929 } else {
930 *pixel++ = (datab & 0x80) ? black : transparent;
931 }
932 datab <<= 1;
933 maskb <<= 1;
934 }
935 }
936
938
940
941 return cursor;
942}
#define SDL_CreateRGBSurface
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.c:945
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
GLenum GLint GLuint mask
GLfloat GLfloat GLfloat GLfloat h
GLubyte GLubyte GLubyte GLubyte w
uint32_t Uint32
Definition: SDL_stdinc.h:203
uint8_t Uint8
Definition: SDL_stdinc.h:179

References cursor, hot_x, NULL, SDL_CreateColorCursor(), SDL_CreateRGBSurface, and SDL_FreeSurface.

◆ SDL_CreateSystemCursor()

SDL_Cursor * SDL_CreateSystemCursor ( SDL_SystemCursor  id)

Create a system cursor.

See also
SDL_FreeCursor()

Definition at line 988 of file SDL_mouse.c.

989{
990 SDL_Mouse *mouse = SDL_GetMouse();
992
993 if (!mouse->CreateSystemCursor) {
994 SDL_SetError("CreateSystemCursor is not currently supported");
995 return NULL;
996 }
997
998 cursor = mouse->CreateSystemCursor(id);
999 if (cursor) {
1000 cursor->next = mouse->cursors;
1001 mouse->cursors = cursor;
1002 }
1003
1004 return cursor;
1005}
SDL_Cursor *(* CreateSystemCursor)(SDL_SystemCursor id)
Definition: SDL_mouse_c.h:49

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

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

1075{
1076 SDL_Mouse *mouse = SDL_GetMouse();
1077 SDL_Cursor *curr, *prev;
1078
1079 if (!cursor) {
1080 return;
1081 }
1082
1083 if (cursor == mouse->def_cursor) {
1084 return;
1085 }
1086 if (cursor == mouse->cur_cursor) {
1087 SDL_SetCursor(mouse->def_cursor);
1088 }
1089
1090 for (prev = NULL, curr = mouse->cursors; curr;
1091 prev = curr, curr = curr->next) {
1092 if (curr == cursor) {
1093 if (prev) {
1094 prev->next = curr->next;
1095 } else {
1096 mouse->cursors = curr->next;
1097 }
1098
1099 if (mouse->FreeCursor) {
1100 mouse->FreeCursor(curr);
1101 }
1102 return;
1103 }
1104 }
1105}
void SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
Definition: SDL_mouse.c:1012
SDL_Cursor * cur_cursor
Definition: SDL_mouse_c.h:105
void(* FreeCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:58
SDL_Cursor * def_cursor
Definition: SDL_mouse_c.h:104

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

Referenced by SDL_MouseQuit().

◆ SDL_GetCursor()

SDL_Cursor * SDL_GetCursor ( void  )

Return the active cursor.

Definition at line 1052 of file SDL_mouse.c.

1053{
1054 SDL_Mouse *mouse = SDL_GetMouse();
1055
1056 if (!mouse) {
1057 return NULL;
1058 }
1059 return mouse->cur_cursor;
1060}

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

◆ SDL_GetDefaultCursor()

SDL_Cursor * SDL_GetDefaultCursor ( void  )

Return the default cursor.

Definition at line 287 of file SDL_dynapi_procs.h.

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

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

734{
735 SDL_Mouse *mouse = SDL_GetMouse();
736 int tmpx, tmpy;
737
738 /* make sure these are never NULL for the backend implementations... */
739 if (!x) {
740 x = &tmpx;
741 }
742 if (!y) {
743 y = &tmpy;
744 }
745
746 *x = *y = 0;
747
748 if (!mouse->GetGlobalMouseState) {
749 return 0;
750 }
751
752 return mouse->GetGlobalMouseState(x, y);
753}
Uint32(* GetGlobalMouseState)(int *x, int *y)
Definition: SDL_mouse_c.h:73

References SDL_Mouse::GetGlobalMouseState, and SDL_GetMouse().

◆ SDL_GetMouseFocus()

SDL_Window * SDL_GetMouseFocus ( void  )

Get the window which currently has mouse focus.

Definition at line 184 of file SDL_mouse.c.

185{
186 SDL_Mouse *mouse = SDL_GetMouse();
187
188 return mouse->focus;
189}
SDL_Window * focus
Definition: SDL_mouse_c.h:77

References SDL_Mouse::focus, and SDL_GetMouse().

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

704{
705 SDL_Mouse *mouse = SDL_GetMouse();
706
707 if (x) {
708 *x = mouse->x;
709 }
710 if (y) {
711 *y = mouse->y;
712 }
713 return mouse->buttonstate;
714}
Uint32 buttonstate
Definition: SDL_mouse_c.h:85

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

◆ SDL_GetRelativeMouseMode()

SDL_bool SDL_GetRelativeMouseMode ( void  )

Query whether relative mouse mode is enabled.

See also
SDL_SetRelativeMouseMode()

Definition at line 281 of file SDL_dynapi_procs.h.

References SDL_Mouse::relative_mode, and SDL_GetMouse().

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

718{
719 SDL_Mouse *mouse = SDL_GetMouse();
720
721 if (x) {
722 *x = mouse->xdelta;
723 }
724 if (y) {
725 *y = mouse->ydelta;
726 }
727 mouse->xdelta = 0;
728 mouse->ydelta = 0;
729 return mouse->buttonstate;
730}
int ydelta
Definition: SDL_mouse_c.h:81
int xdelta
Definition: SDL_mouse_c.h:80

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

◆ SDL_SetCursor()

void SDL_SetCursor ( SDL_Cursor cursor)

Set the active cursor.

Definition at line 1012 of file SDL_mouse.c.

1013{
1014 SDL_Mouse *mouse = SDL_GetMouse();
1015
1016 /* Set the new cursor */
1017 if (cursor) {
1018 /* Make sure the cursor is still valid for this mouse */
1019 if (cursor != mouse->def_cursor) {
1020 SDL_Cursor *found;
1021 for (found = mouse->cursors; found; found = found->next) {
1022 if (found == cursor) {
1023 break;
1024 }
1025 }
1026 if (!found) {
1027 SDL_SetError("Cursor not associated with the current mouse");
1028 return;
1029 }
1030 }
1031 mouse->cur_cursor = cursor;
1032 } else {
1033 if (mouse->focus) {
1034 cursor = mouse->cur_cursor;
1035 } else {
1036 cursor = mouse->def_cursor;
1037 }
1038 }
1039
1040 if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
1041 if (mouse->ShowCursor) {
1042 mouse->ShowCursor(cursor);
1043 }
1044 } else {
1045 if (mouse->ShowCursor) {
1046 mouse->ShowCursor(NULL);
1047 }
1048 }
1049}
SDL_bool relative_mode
Definition: SDL_mouse_c.h:87
int(* ShowCursor)(SDL_Cursor *cursor)
Definition: SDL_mouse_c.h:52
SDL_bool cursor_shown
Definition: SDL_mouse_c.h:106

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

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

800{
801 SDL_Mouse *mouse = SDL_GetMouse();
802 SDL_Window *focusWindow = SDL_GetKeyboardFocus();
803
804 if (enabled == mouse->relative_mode) {
805 return 0;
806 }
807
808 /* Set the relative mode */
809 if (!enabled && mouse->relative_mode_warp) {
811 } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
813 } else if (!mouse->SetRelativeMouseMode || mouse->SetRelativeMouseMode(enabled) < 0) {
814 if (enabled) {
815 /* Fall back to warp mode if native relative mode failed */
816 if (!mouse->WarpMouse) {
817 return SDL_SetError("No relative mode implementation available");
818 }
820 }
821 }
822 mouse->relative_mode = enabled;
823 mouse->scale_accum_x = 0.0f;
824 mouse->scale_accum_y = 0.0f;
825
826 if (enabled && focusWindow) {
827 /* Center it in the focused window to prevent clicks from going through
828 * to background windows.
829 */
830 SDL_SetMouseFocus(focusWindow);
831 SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
832 }
833
834 if (mouse->focus) {
836
837 /* Put the cursor back to where the application expects it */
838 if (!enabled) {
839 SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
840 }
841 }
842
843 /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
845
846 /* Update cursor visibility */
848
849 return 0;
850}
#define SDL_FlushEvent
@ SDL_MOUSEMOTION
Definition: SDL_events.h:105
static SDL_bool ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
Definition: SDL_mouse.c:788
void SDL_WarpMouseInWindow(SDL_Window *window, int x, int y)
Moves the mouse to the given position within the window.
Definition: SDL_mouse.c:756
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:211
@ SDL_TRUE
Definition: SDL_stdinc.h:164
@ SDL_FALSE
Definition: SDL_stdinc.h:163
void SDL_UpdateWindowGrab(SDL_Window *window)
Definition: SDL_video.c:2520
float scale_accum_x
Definition: SDL_mouse_c.h:91
int(* SetRelativeMouseMode)(SDL_bool enabled)
Definition: SDL_mouse_c.h:67
void(* WarpMouse)(SDL_Window *window, int x, int y)
Definition: SDL_mouse_c.h:61
SDL_bool relative_mode_warp
Definition: SDL_mouse_c.h:88
float scale_accum_y
Definition: SDL_mouse_c.h:92

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

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

1109{
1110 SDL_Mouse *mouse = SDL_GetMouse();
1111 SDL_bool shown;
1112
1113 if (!mouse) {
1114 return 0;
1115 }
1116
1117 shown = mouse->cursor_shown;
1118 if (toggle >= 0) {
1119 if (toggle) {
1120 mouse->cursor_shown = SDL_TRUE;
1121 } else {
1122 mouse->cursor_shown = SDL_FALSE;
1123 }
1124 if (mouse->cursor_shown != shown) {
1126 }
1127 }
1128 return shown;
1129}

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

Referenced by SDL_MouseQuit().

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

777{
778 SDL_Mouse *mouse = SDL_GetMouse();
779
780 if (mouse->WarpMouseGlobal) {
781 return mouse->WarpMouseGlobal(x, y);
782 }
783
784 return SDL_Unsupported();
785}
int(* WarpMouseGlobal)(int x, int y)
Definition: SDL_mouse_c.h:64

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

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

757{
758 SDL_Mouse *mouse = SDL_GetMouse();
759
760 if (window == NULL) {
761 window = mouse->focus;
762 }
763
764 if (window == NULL) {
765 return;
766 }
767
768 if (mouse->WarpMouse) {
769 mouse->WarpMouse(window, x, y);
770 } else {
771 SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
772 }
773}
int SDL_SendMouseMotion(SDL_Window *window, SDL_MouseID mouseID, int relative, int x, int y)
Definition: SDL_mouse.c:301
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_MouseID mouseID
Definition: SDL_mouse_c.h:76

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

Referenced by SDL_PrivateSendMouseMotion(), and SDL_SetRelativeMouseMode().