src/events/SDL_mouse_c.h
author Sam Lantinga
Wed, 04 Jun 2014 10:55:26 -0700
changeset 8815 c6d0a457f3b2
parent 8149 681eb46b8ac4
child 8953 dc80dc0bd22e
permissions -rw-r--r--
Added an API function to warp the mouse cursor in global screen space: SDL_WarpMouseGlobal()
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "../SDL_internal.h"
    22 
    23 #ifndef _SDL_mouse_c_h
    24 #define _SDL_mouse_c_h
    25 
    26 #include "SDL_mouse.h"
    27 
    28 typedef Uint32 SDL_MouseID;
    29 
    30 struct SDL_Cursor
    31 {
    32     struct SDL_Cursor *next;
    33     void *driverdata;
    34 };
    35 
    36 typedef struct
    37 {
    38     int last_x, last_y;
    39     Uint32 last_timestamp;
    40     Uint8 click_count;
    41 } SDL_MouseClickState;
    42 
    43 typedef struct
    44 {
    45     /* Create a cursor from a surface */
    46     SDL_Cursor *(*CreateCursor) (SDL_Surface * surface, int hot_x, int hot_y);
    47 
    48     /* Create a system cursor */
    49     SDL_Cursor *(*CreateSystemCursor) (SDL_SystemCursor id);
    50 
    51     /* Show the specified cursor, or hide if cursor is NULL */
    52     int (*ShowCursor) (SDL_Cursor * cursor);
    53 
    54     /* This is called when a mouse motion event occurs */
    55     void (*MoveCursor) (SDL_Cursor * cursor);
    56 
    57     /* Free a window manager cursor */
    58     void (*FreeCursor) (SDL_Cursor * cursor);
    59 
    60     /* Warp the mouse to (x,y) within a window */
    61     void (*WarpMouse) (SDL_Window * window, int x, int y);
    62 
    63     /* Warp the mouse to (x,y) in screen space */
    64     void (*WarpMouseGlobal) (int x, int y);
    65 
    66     /* Set relative mode */
    67     int (*SetRelativeMouseMode) (SDL_bool enabled);
    68 
    69     /* Data common to all mice */
    70     SDL_MouseID mouseID;
    71     SDL_Window *focus;
    72     int x;
    73     int y;
    74     int xdelta;
    75     int ydelta;
    76     int last_x, last_y;         /* the last reported x and y coordinates */
    77     Uint32 buttonstate;
    78     SDL_bool relative_mode;
    79     SDL_bool relative_mode_warp;
    80 
    81     /* Data for double-click tracking */
    82     int num_clickstates;
    83     SDL_MouseClickState *clickstate;
    84 
    85     SDL_Cursor *cursors;
    86     SDL_Cursor *def_cursor;
    87     SDL_Cursor *cur_cursor;
    88     SDL_bool cursor_shown;
    89 
    90     /* Driver-dependent data. */
    91     void *driverdata;
    92 } SDL_Mouse;
    93 
    94 
    95 /* Initialize the mouse subsystem */
    96 extern int SDL_MouseInit(void);
    97 
    98 /* Get the mouse state structure */
    99 SDL_Mouse *SDL_GetMouse(void);
   100 
   101 /* Set the default double-click interval */
   102 extern void SDL_SetDoubleClickTime(Uint32 interval);
   103 
   104 /* Set the default mouse cursor */
   105 extern void SDL_SetDefaultCursor(SDL_Cursor * cursor);
   106 
   107 /* Set the mouse focus window */
   108 extern void SDL_SetMouseFocus(SDL_Window * window);
   109 
   110 /* Send a mouse motion event */
   111 extern int SDL_SendMouseMotion(SDL_Window * window, SDL_MouseID mouseID, int relative, int x, int y);
   112 
   113 /* Send a mouse button event */
   114 extern int SDL_SendMouseButton(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button);
   115 
   116 /* Send a mouse wheel event */
   117 extern int SDL_SendMouseWheel(SDL_Window * window, SDL_MouseID mouseID, int x, int y);
   118 
   119 /* Shutdown the mouse subsystem */
   120 extern void SDL_MouseQuit(void);
   121 
   122 #endif /* _SDL_mouse_c_h */
   123 
   124 /* vi: set ts=4 sw=4 expandtab: */