#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"

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)

Typedefs
typedef struct SDL_Cursor	SDL_Cursor

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
DECLSPEC SDL_Window *SDLCALL	SDL_GetMouseFocus (void)
	Get the window which currently has mouse focus. More...

DECLSPEC Uint32 SDLCALL	SDL_GetMouseState (int x, int y)
	Retrieve the current state of the mouse. More...

DECLSPEC Uint32 SDLCALL	SDL_GetGlobalMouseState (int x, int y)
	Get the current state of the mouse, in relation to the desktop. More...

DECLSPEC Uint32 SDLCALL	SDL_GetRelativeMouseState (int x, int y)
	Retrieve the relative state of the mouse. More...

DECLSPEC void SDLCALL	SDL_WarpMouseInWindow (SDL_Window *window, int x, int y)
	Moves the mouse to the given position within the window. More...

DECLSPEC int SDLCALL	SDL_WarpMouseGlobal (int x, int y)
	Moves the mouse to the given position in global screen space. More...

DECLSPEC int SDLCALL	SDL_SetRelativeMouseMode (SDL_bool enabled)
	Set relative mouse mode. More...

DECLSPEC int SDLCALL	SDL_CaptureMouse (SDL_bool enabled)
	Capture the mouse, to track input outside an SDL window. More...

DECLSPEC SDL_bool SDLCALL	SDL_GetRelativeMouseMode (void)
	Query whether relative mouse mode is enabled. More...

DECLSPEC SDL_Cursor *SDLCALL	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). More...

DECLSPEC SDL_Cursor *SDLCALL	SDL_CreateColorCursor (SDL_Surface *surface, int hot_x, int hot_y)
	Create a color cursor. More...

DECLSPEC SDL_Cursor *SDLCALL	SDL_CreateSystemCursor (SDL_SystemCursor id)
	Create a system cursor. More...

DECLSPEC void SDLCALL	SDL_SetCursor (SDL_Cursor *cursor)
	Set the active cursor. More...

DECLSPEC SDL_Cursor *SDLCALL	SDL_GetCursor (void)
	Return the active cursor. More...

DECLSPEC SDL_Cursor *SDLCALL	SDL_GetDefaultCursor (void)
	Return the default cursor. More...

DECLSPEC void SDLCALL	SDL_FreeCursor (SDL_Cursor *cursor)
	Frees a cursor created with SDL_CreateCursor() or similar functions. More...

DECLSPEC int SDLCALL	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.

Typedef Documentation

◆ SDL_Cursor

typedef struct SDL_Cursor SDL_Cursor

Implementation dependent

Definition at line 41 of file SDL_mouse.h.

Enumeration Type Documentation

◆ SDL_MouseWheelDirection

enum 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.

 {
     SDL_MOUSEWHEEL_NORMAL,    
     SDL_MOUSEWHEEL_FLIPPED    
 } SDL_MouseWheelDirection;

◆ SDL_SystemCursor

enum 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.

 {
     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
 } SDL_SystemCursor;

Function Documentation

◆ SDL_CaptureMouse()

DECLSPEC int SDLCALL SDL_CaptureMouse ( SDL_bool enabled )

Capture the mouse, to track input outside an SDL window.

Parameters

enabled Whether 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.

◆ SDL_CreateColorCursor()

DECLSPEC SDL_Cursor* SDLCALL SDL_CreateColorCursor	(	SDL_Surface *	surface,
		int	hot_x,
		int	hot_y
	)

Create a color cursor.

See also: SDL_FreeCursor()

◆ SDL_CreateCursor()

DECLSPEC SDL_Cursor* SDLCALL 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()

◆ SDL_CreateSystemCursor()

DECLSPEC SDL_Cursor* SDLCALL SDL_CreateSystemCursor ( SDL_SystemCursor id )

Create a system cursor.

See also: SDL_FreeCursor()

◆ SDL_FreeCursor()

DECLSPEC void SDLCALL SDL_FreeCursor ( SDL_Cursor * cursor )

Frees a cursor created with SDL_CreateCursor() or similar functions.

See also: SDL_CreateCursor(); SDL_CreateColorCursor(); SDL_CreateSystemCursor()

◆ SDL_GetCursor()

DECLSPEC SDL_Cursor* SDLCALL SDL_GetCursor ( void )

Return the active cursor.

◆ SDL_GetDefaultCursor()

DECLSPEC SDL_Cursor* SDLCALL SDL_GetDefaultCursor ( void )

Return the default cursor.

◆ SDL_GetGlobalMouseState()

DECLSPEC Uint32 SDLCALL 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

x	Returns the current X coord, relative to the desktop. Can be NULL.
y	Returns 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

◆ SDL_GetMouseFocus()

DECLSPEC SDL_Window* SDLCALL SDL_GetMouseFocus ( void )

Get the window which currently has mouse focus.

◆ SDL_GetMouseState()

DECLSPEC Uint32 SDLCALL 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.

◆ SDL_GetRelativeMouseMode()

DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode ( void )

Query whether relative mouse mode is enabled.

See also: SDL_SetRelativeMouseMode()

◆ SDL_GetRelativeMouseState()

DECLSPEC Uint32 SDLCALL 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().

◆ SDL_SetCursor()

DECLSPEC void SDLCALL SDL_SetCursor ( SDL_Cursor * cursor )

Set the active cursor.

◆ SDL_SetRelativeMouseMode()

DECLSPEC int SDLCALL SDL_SetRelativeMouseMode ( SDL_bool enabled )

Set relative mouse mode.

Parameters

enabled Whether 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()

◆ SDL_ShowCursor()

DECLSPEC int SDLCALL SDL_ShowCursor ( int toggle )

Toggle whether or not the cursor is shown.

Parameters

toggle 1 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.

◆ SDL_WarpMouseGlobal()

DECLSPEC int SDLCALL SDL_WarpMouseGlobal	(	int	x,
		int	y
	)

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

Parameters

x	The x coordinate
y	The y coordinate

Returns: 0 on success, -1 on error (usually: unsupported by a platform).

Note: This function generates a mouse motion event

◆ SDL_WarpMouseInWindow()

DECLSPEC void SDLCALL SDL_WarpMouseInWindow	(	SDL_Window *	window,
		int	x,
		int	y
	)

Moves the mouse to the given position within the window.

Parameters

window	The window to move the mouse into, or NULL for the current mouse focus
x	The x coordinate within the window
y	The y coordinate within the window

Note: This function generates a mouse motion event

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ SDL_BUTTON

◆ SDL_BUTTON_LEFT

◆ SDL_BUTTON_LMASK

◆ SDL_BUTTON_MIDDLE

◆ SDL_BUTTON_MMASK

◆ SDL_BUTTON_RIGHT

◆ SDL_BUTTON_RMASK

◆ SDL_BUTTON_X1

◆ SDL_BUTTON_X1MASK

◆ SDL_BUTTON_X2

◆ SDL_BUTTON_X2MASK

Typedef Documentation

◆ SDL_Cursor

Enumeration Type Documentation

◆ SDL_MouseWheelDirection

◆ SDL_SystemCursor

Function Documentation

◆ SDL_CaptureMouse()

◆ SDL_CreateColorCursor()

◆ SDL_CreateCursor()

◆ SDL_CreateSystemCursor()

◆ SDL_FreeCursor()

◆ SDL_GetCursor()

◆ SDL_GetDefaultCursor()

◆ SDL_GetGlobalMouseState()

◆ SDL_GetMouseFocus()

◆ SDL_GetMouseState()

◆ SDL_GetRelativeMouseMode()

◆ SDL_GetRelativeMouseState()

◆ SDL_SetCursor()

◆ SDL_SetRelativeMouseMode()

◆ SDL_ShowCursor()

◆ SDL_WarpMouseGlobal()

◆ SDL_WarpMouseInWindow()