include/SDL_mouse.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 28 May 2006 13:04:16 +0000
branchSDL-1.3
changeset 1662 782fd950bd46
parent 1358 c71e05b4dc2e
child 1668 4da1ee79c9af
permissions -rw-r--r--
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.

WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid.

The code is now run through a consistent indent format:
indent -i4 -nut -nsc -br -ce

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