SDL_mouse.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:5k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /*
  2.     SDL - Simple DirectMedia Layer
  3.     Copyright (C) 1997-2006 Sam Lantinga
  4.     This library is free software; you can redistribute it and/or
  5.     modify it under the terms of the GNU Lesser General Public
  6.     License as published by the Free Software Foundation; either
  7.     version 2.1 of the License, or (at your option) any later version.
  8.     This library is distributed in the hope that it will be useful,
  9.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.     Lesser General Public License for more details.
  12.     You should have received a copy of the GNU Lesser General Public
  13.     License along with this library; if not, write to the Free Software
  14.     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  15.     Sam Lantinga
  16.     slouken@libsdl.org
  17. */
  18. /* Include file for SDL mouse event handling */
  19. #ifndef _SDL_mouse_h
  20. #define _SDL_mouse_h
  21. #include "SDL_stdinc.h"
  22. #include "SDL_error.h"
  23. #include "SDL_video.h"
  24. #include "begin_code.h"
  25. /* Set up for C function definitions, even when using C++ */
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. typedef struct WMcursor WMcursor; /* Implementation dependent */
  30. typedef struct SDL_Cursor {
  31. SDL_Rect area; /* The area of the mouse cursor */
  32. Sint16 hot_x, hot_y; /* The "tip" of the cursor */
  33. Uint8 *data; /* B/W cursor data */
  34. Uint8 *mask; /* B/W cursor mask */
  35. Uint8 *save[2]; /* Place to save cursor area */
  36. WMcursor *wm_cursor; /* Window-manager cursor */
  37. } SDL_Cursor;
  38. /* Function prototypes */
  39. /*
  40.  * Retrieve the current state of the mouse.
  41.  * The current button state is returned as a button bitmask, which can
  42.  * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
  43.  * current mouse cursor position.  You can pass NULL for either x or y.
  44.  */
  45. extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
  46. /*
  47.  * Retrieve the current state of the mouse.
  48.  * The current button state is returned as a button bitmask, which can
  49.  * be tested using the SDL_BUTTON(X) macros, and x and y are set to the
  50.  * mouse deltas since the last call to SDL_GetRelativeMouseState().
  51.  */
  52. extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
  53. /*
  54.  * Set the position of the mouse cursor (generates a mouse motion event)
  55.  */
  56. extern DECLSPEC void SDLCALL SDL_WarpMouse(Uint16 x, Uint16 y);
  57. /*
  58.  * Create a cursor using the specified data and mask (in MSB format).
  59.  * The cursor width must be a multiple of 8 bits.
  60.  *
  61.  * The cursor is created in black and white according to the following:
  62.  * data  mask    resulting pixel on screen
  63.  *  0     1       White
  64.  *  1     1       Black
  65.  *  0     0       Transparent
  66.  *  1     0       Inverted color if possible, black if not.
  67.  *
  68.  * Cursors created with this function must be freed with SDL_FreeCursor().
  69.  */
  70. extern DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor
  71. (Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y);
  72. /*
  73.  * Set the currently active cursor to the specified one.
  74.  * If the cursor is currently visible, the change will be immediately 
  75.  * represented on the display.
  76.  */
  77. extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor *cursor);
  78. /*
  79.  * Returns the currently active cursor.
  80.  */
  81. extern DECLSPEC SDL_Cursor * SDLCALL SDL_GetCursor(void);
  82. /*
  83.  * Deallocates a cursor created with SDL_CreateCursor().
  84.  */
  85. extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor *cursor);
  86. /*
  87.  * Toggle whether or not the cursor is shown on the screen.
  88.  * The cursor start off displayed, but can be turned off.
  89.  * SDL_ShowCursor() returns 1 if the cursor was being displayed
  90.  * before the call, or 0 if it was not.  You can query the current
  91.  * state by passing a 'toggle' value of -1.
  92.  */
  93. extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
  94. /* Used as a mask when testing buttons in buttonstate
  95.    Button 1: Left mouse button
  96.    Button 2: Middle mouse button
  97.    Button 3: Right mouse button
  98.    Button 4: Mouse wheel up  (may also be a real button)
  99.    Button 5: Mouse wheel down (may also be a real button)
  100.  */
  101. #define SDL_BUTTON(X) (1 << ((X)-1))
  102. #define SDL_BUTTON_LEFT 1
  103. #define SDL_BUTTON_MIDDLE 2
  104. #define SDL_BUTTON_RIGHT 3
  105. #define SDL_BUTTON_WHEELUP 4
  106. #define SDL_BUTTON_WHEELDOWN 5
  107. #define SDL_BUTTON_X1 6
  108. #define SDL_BUTTON_X2 7
  109. #define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT)
  110. #define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE)
  111. #define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT)
  112. #define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
  113. #define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
  114. /* Ends C function definitions when using C++ */
  115. #ifdef __cplusplus
  116. }
  117. #endif
  118. #include "close_code.h"
  119. #endif /* _SDL_mouse_h */