author Sam Lantinga <>
Sun, 28 May 2006 13:04:16 +0000
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.

    SDL - Simple DirectMedia Layer
    Copyright (C) 1997-2006 Sam Lantinga

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga

 * \file SDL_mouse.h
 * Include file for SDL mouse event handling

#ifndef _SDL_mouse_h
#define _SDL_mouse_h

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

#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */

typedef struct WMcursor WMcursor;       /* Implementation dependent */
typedef struct SDL_Cursor
    SDL_Rect area;              /* The area of the mouse cursor */
    Sint16 hot_x, hot_y;        /* The "tip" of the cursor */
    Uint8 *data;                /* B/W cursor data */
    Uint8 *mask;                /* B/W cursor mask */
    Uint8 *save[2];             /* Place to save cursor area */
    WMcursor *wm_cursor;        /* Window-manager cursor */
} SDL_Cursor;

/* Function prototypes */
 * 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
 * current mouse cursor position.  You can pass NULL for either x or y.
extern DECLSPEC Uint8 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 deltas since the last call to SDL_GetRelativeMouseState().
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState (int *x, int *y);

 * Set the position of the mouse cursor (generates a mouse motion event)
extern DECLSPEC void SDLCALL SDL_WarpMouse (Uint16 x, Uint16 y);

 * Create a cursor using the specified 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.
 * Cursors created with this function must be freed with SDL_FreeCursor().
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor
    (Uint8 * data, Uint8 * mask, int w, int h, int hot_x, int hot_y);

 * Set the currently active cursor to the specified one.
 * If the cursor is currently visible, the change will be immediately 
 * represented on the display.
extern DECLSPEC void SDLCALL SDL_SetCursor (SDL_Cursor * cursor);

 * Returns the currently active cursor.
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor (void);

 * Deallocates a cursor created with SDL_CreateCursor().
extern DECLSPEC void SDLCALL SDL_FreeCursor (SDL_Cursor * cursor);

 * Toggle whether or not the cursor is shown on the screen.
 * The cursor start off displayed, but can be turned off.
 * SDL_ShowCursor() returns 1 if the cursor was being displayed
 * before the call, or 0 if it was not.  You can query the current
 * state by passing a 'toggle' value of -1.
extern DECLSPEC int SDLCALL SDL_ShowCursor (int toggle);

/* Used as a mask when testing buttons in buttonstate
   Button 1:	Left mouse button
   Button 2:	Middle mouse button
   Button 3:	Right mouse button
   Button 4:	Mouse wheel up	 (may also be a real button)
   Button 5:	Mouse wheel down (may also be a real button)
#define SDL_BUTTON(X)		(1 << ((X)-1))
#define SDL_BUTTON_LEFT		1

/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
/* *INDENT-ON* */
#include "close_code.h"

#endif /* _SDL_mouse_h */

/* vi: set ts=4 sw=4 expandtab: */