include/SDL_input.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 17 Jan 2011 09:09:15 -0800
changeset 5009 b21ad135d86b
parent 4465 3e69e077cb95
child 5262 b530ef003506
permissions -rw-r--r--
Minor documentation consistency cleanup
slouken@4465
     1
/*
slouken@4465
     2
    SDL - Simple DirectMedia Layer
slouken@4465
     3
    Copyright (C) 1997-2010 Sam Lantinga
slouken@4465
     4
slouken@4465
     5
    This library is free software; you can redistribute it and/or
slouken@4465
     6
    modify it under the terms of the GNU Lesser General Public
slouken@4465
     7
    License as published by the Free Software Foundation; either
slouken@4465
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@4465
     9
slouken@4465
    10
    This library is distributed in the hope that it will be useful,
slouken@4465
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@4465
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@4465
    13
    Lesser General Public License for more details.
slouken@4465
    14
slouken@4465
    15
    You should have received a copy of the GNU Lesser General Public
slouken@4465
    16
    License along with this library; if not, write to the Free Software
slouken@4465
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@4465
    18
slouken@4465
    19
    Sam Lantinga
slouken@4465
    20
    slouken@libsdl.org
slouken@4465
    21
*/
slouken@4465
    22
slouken@4465
    23
/**
slouken@4465
    24
 *  \file SDL_input.h
slouken@4465
    25
 *  
slouken@4465
    26
 *  Include file for lowlevel SDL input device handling.
slouken@4465
    27
 *
slouken@4465
    28
 *  This talks about individual devices, and not the system cursor. If you
slouken@4465
    29
 *  just want to know when the user moves the pointer somewhere in your
slouken@4465
    30
 *  window, this is NOT the API you want. This one handles things like
slouken@4465
    31
 *  multi-touch, drawing tablets, and multiple, separate mice.
slouken@4465
    32
 *
slouken@4465
    33
 *  The other API is in SDL_mouse.h
slouken@4465
    34
 */
slouken@4465
    35
slouken@4465
    36
#ifndef _SDL_input_h
slouken@4465
    37
#define _SDL_input_h
slouken@4465
    38
slouken@4465
    39
#include "SDL_stdinc.h"
slouken@4465
    40
#include "SDL_error.h"
slouken@4465
    41
#include "SDL_video.h"
slouken@4465
    42
slouken@4465
    43
#include "begin_code.h"
slouken@4465
    44
/* Set up for C function definitions, even when using C++ */
slouken@4465
    45
#ifdef __cplusplus
slouken@4465
    46
/* *INDENT-OFF* */
slouken@4465
    47
extern "C" {
slouken@4465
    48
/* *INDENT-ON* */
slouken@4465
    49
#endif
slouken@4465
    50
slouken@4465
    51
slouken@4465
    52
/* Function prototypes */
slouken@4465
    53
slouken@4465
    54
/* !!! FIXME: real documentation
slouken@4465
    55
 * - Redetect devices
slouken@4465
    56
 * - This invalidates all existing device information from previous queries!
slouken@4465
    57
 * - There is an implicit (re)detect upon SDL_Init().
slouken@4465
    58
 */
slouken@4465
    59
extern DECLSPEC int SDLCALL SDL_RedetectInputDevices(void);
slouken@4465
    60
slouken@4465
    61
/**
slouken@4465
    62
 *  \brief Get the number of mouse input devices available.
slouken@4465
    63
 */
slouken@4465
    64
extern DECLSPEC int SDLCALL SDL_GetNumInputDevices(void);
slouken@4465
    65
slouken@4465
    66
/**
slouken@4465
    67
 *  \brief Gets the name of a device with the given index.
slouken@4465
    68
 *  
slouken@4465
    69
 *  \param index is the index of the device, whose name is to be returned.
slouken@4465
    70
 *  
slouken@4465
    71
 *  \return the name of the device with the specified index
slouken@4465
    72
 */
slouken@4465
    73
extern DECLSPEC const char *SDLCALL SDL_GetInputDeviceName(int index);
slouken@4465
    74
slouken@4465
    75
slouken@4465
    76
extern DECLSPEC int SDLCALL SDL_IsDeviceDisconnected(int index);
slouken@4465
    77
slouken@4465
    78
/* Ends C function definitions when using C++ */
slouken@4465
    79
#ifdef __cplusplus
slouken@4465
    80
/* *INDENT-OFF* */
slouken@4465
    81
}
slouken@4465
    82
/* *INDENT-ON* */
slouken@4465
    83
#endif
slouken@4465
    84
#include "close_code.h"
slouken@4465
    85
slouken@4465
    86
#endif /* _SDL_mouse_h */
slouken@4465
    87
slouken@4465
    88
/* vi: set ts=4 sw=4 expandtab: */