/Users/hercules/trunk/SDL/include/SDL_mouse.h

Go to the documentation of this file.

/*
    SDL - Simple DirectMedia Layer
    Copyright (C) 1997-2009 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
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    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
    slouken@libsdl.org
*/

#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* */
#endif

typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */

/* Function prototypes */

extern DECLSPEC int SDLCALL SDL_GetNumMice(void);

extern DECLSPEC char *SDLCALL SDL_GetMouseName(int index);

extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);

extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(int index);

extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(int index,
                                                     SDL_bool enabled);

extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(int index);

extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int index, int *x, int *y);

extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int index, int *x,
                                                        int *y);

extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
                                                   int x, int y);

extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
                                                     const Uint8 * mask,
                                                     int w, int h, int hot_x,
                                                     int hot_y);

extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);

extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);

extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);

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
 */

extern DECLSPEC int SDLCALL SDL_GetCursorsNumber(int index);

extern DECLSPEC int SDLCALL SDL_GetCurrentCursor(int index);

#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)


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

#endif /* _SDL_mouse_h */

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

---