My Project
|
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"
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) |
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. | |
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. | |
DECLSPEC SDL_Cursor *SDLCALL | SDL_GetCursor (void) |
Return the active cursor. | |
DECLSPEC SDL_Cursor *SDLCALL | SDL_GetDefaultCursor (void) |
Return the default cursor. | |
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... | |
Include file for SDL mouse event handling.
#define SDL_BUTTON | ( | X | ) | (1 << ((X)-1)) |
Used as a mask when testing buttons in buttonstate.
enum SDL_SystemCursor |
Cursor types for SDL_CreateSystemCursor().
DECLSPEC int SDLCALL SDL_CaptureMouse | ( | SDL_bool | enabled | ) |
Capture the mouse, to track input outside an SDL window.
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.
DECLSPEC SDL_Cursor* SDLCALL SDL_CreateColorCursor | ( | SDL_Surface * | surface, |
int | hot_x, | ||
int | hot_y | ||
) |
Create a color cursor.
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. |
DECLSPEC SDL_Cursor* SDLCALL SDL_CreateSystemCursor | ( | SDL_SystemCursor | id | ) |
Create a system cursor.
DECLSPEC void SDLCALL SDL_FreeCursor | ( | SDL_Cursor * | cursor | ) |
Frees a cursor created with SDL_CreateCursor() or similar functions.
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.
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. |
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.
DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode | ( | void | ) |
Query whether relative mouse mode is enabled.
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().
DECLSPEC int SDLCALL SDL_SetRelativeMouseMode | ( | SDL_bool | enabled | ) |
Set relative mouse mode.
enabled | Whether or not to enable relative mode |
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.
DECLSPEC int SDLCALL SDL_ShowCursor | ( | int | toggle | ) |
Toggle whether or not the cursor is shown.
toggle | 1 to show the cursor, 0 to hide it, -1 to query the current state. |
DECLSPEC int SDLCALL SDL_WarpMouseGlobal | ( | int | x, |
int | y | ||
) |
Moves the mouse to the given position in global screen space.
x | The x coordinate |
y | The y coordinate |
DECLSPEC void SDLCALL SDL_WarpMouseInWindow | ( | SDL_Window * | window, |
int | x, | ||
int | y | ||
) |
Moves the mouse to the given position within the window.
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 |