include/SDL_haptic.h
branchgsoc2008_force_feedback
changeset 2472 3f73c88c9abb
child 2476 242d8a668ebb
equal deleted inserted replaced
2471:910af9032c73 2472:3f73c88c9abb
       
     1 /*
       
     2     SDL - Simple DirectMedia Layer
       
     3     Copyright (C) 2008 Edgar Simo
       
     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_haptic.h
       
    25  *
       
    26  * Include file for SDL haptic subsystem
       
    27  */
       
    28 
       
    29 #ifndef _SDL_haptic_h
       
    30 #define _SDL_haptic_h
       
    31 
       
    32 #include "SDL_stdinc.h"
       
    33 #include "SDL_error.h"
       
    34 
       
    35 #include "begin_code.h"
       
    36 /* Set up for C function definitions, even when using C++ */
       
    37 #ifdef __cplusplus
       
    38 /* *INDENT-OFF* */
       
    39 extern "C" {
       
    40    /* *INDENT-ON* */                                                         
       
    41 #endif
       
    42 
       
    43 /* The haptic structure used to identify an SDL haptic */
       
    44 struct _SDL_Haptic;                                                     
       
    45 typedef struct _SDL_Haptic SDL_Haptic;
       
    46 
       
    47 
       
    48 /* Different effects that can be generated */
       
    49 #define SDL_HAPTIC_CONSTANT   (1<<0)
       
    50 #define SDL_HAPTIC_PERIODIC   (1<<1)
       
    51 #define SDL_HAPTIC_RAMP       (1<<2)
       
    52 #define SDL_HAPTIC_SPRING     (1<<3)
       
    53 #define SDL_HAPTIC_FRICTION   (1<<4)
       
    54 #define SDL_HAPTIC_DAMPER     (1<<5)
       
    55 #define SDL_HAPTIC_RUMBLE     (1<<6)
       
    56 #define SDL_HAPTIC_INERTIA    (1<<7)
       
    57 #define SDL_HAPTIC_GAIN       (1<<8)
       
    58 #define SDL_HAPTIC_AUTOCENTER (1<<9)
       
    59 
       
    60 
       
    61 /* Function prototypes */
       
    62 /*
       
    63  * Count the number of joysticks attached to the system
       
    64  */
       
    65 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
       
    66 
       
    67 /*
       
    68  * Get the implementation dependent name of a joystick.
       
    69  * This can be called before any joysticks are opened.
       
    70  * If no name can be found, this function returns NULL.
       
    71  */
       
    72 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
       
    73 
       
    74 
       
    75 /* Ends C function definitions when using C++ */
       
    76 #ifdef __cplusplus
       
    77 /* *INDENT-OFF* */
       
    78 }
       
    79 /* *INDENT-ON* */
       
    80 #endif
       
    81 #include "close_code.h"
       
    82 
       
    83 #endif /* _SDL_haptic_h */
       
    84 
       
    85 /* vi: set ts=4 sw=4 expandtab: */
       
    86 
       
    87