Simple DirectMedia Layer: /Users/hercules/trunk/SDL/include/SDL

00001 /*
00002     SDL - Simple DirectMedia Layer
00003     Copyright (C) 2008 Edgar Simo
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Lesser General Public
00007     License as published by the Free Software Foundation; either
00008     version 2.1 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Lesser General Public License for more details.
00014 
00015     You should have received a copy of the GNU Lesser General Public
00016     License along with this library; if not, write to the Free Software
00017     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00018 
00019     Sam Lantinga
00020     slouken@libsdl.org
00021 */
00022 
00089 #ifndef _SDL_haptic_h
00090 #define _SDL_haptic_h
00091 
00092 #include "SDL_stdinc.h"
00093 #include "SDL_error.h"
00094 #include "SDL_joystick.h"
00095 
00096 #include "begin_code.h"
00097 /* Set up for C function definitions, even when using C++ */
00098 #ifdef __cplusplus
00099 /* *INDENT-OFF* */
00100 extern "C" {
00101    /* *INDENT-ON* */                                                         
00102 #endif /* __cplusplus */
00103 
00113 struct _SDL_Haptic;
00114 typedef struct _SDL_Haptic SDL_Haptic;
00115 
00116 
00117 /*
00118  * Different haptic features a device can have.
00119  */
00127 #define SDL_HAPTIC_CONSTANT   (1<<0)    /* Constant effect supported */
00128 
00135 #define SDL_HAPTIC_SINE       (1<<1)    /* Sine wave effect supported */
00136 
00143 #define SDL_HAPTIC_SQUARE     (1<<2)    /* Square wave effect supported */
00144 
00151 #define SDL_HAPTIC_TRIANGLE   (1<<3)    /* Triangle wave effect supported */
00152 
00159 #define SDL_HAPTIC_SAWTOOTHUP (1<<4)    /* Sawtoothup wave effect supported */
00160 
00167 #define SDL_HAPTIC_SAWTOOTHDOWN (1<<5)  /* Sawtoothdown wave effect supported */
00168 
00175 #define SDL_HAPTIC_RAMP       (1<<6)    /* Ramp effect supported */
00176 
00184 #define SDL_HAPTIC_SPRING     (1<<7)    /* Spring effect supported - uses axes position */
00185 
00193 #define SDL_HAPTIC_DAMPER     (1<<8)    /* Damper effect supported - uses axes velocity */
00194 
00202 #define SDL_HAPTIC_INERTIA    (1<<9)    /* Inertia effect supported - uses axes acceleration */
00203 
00211 #define SDL_HAPTIC_FRICTION   (1<<10)   /* Friction effect supported - uses axes movement */
00212 
00217 #define SDL_HAPTIC_CUSTOM     (1<<11)   /* Custom effect is supported */
00218 /* These last two are features the device has, not effects */
00226 #define SDL_HAPTIC_GAIN       (1<<12)   /* Device can set global gain */
00227 
00234 #define SDL_HAPTIC_AUTOCENTER (1<<13)   /* Device can set autocenter */
00235 
00242 #define SDL_HAPTIC_STATUS     (1<<14)   /* Device can be queried for effect status */
00243 
00251 #define SDL_HAPTIC_PAUSE      (1<<15)   /* Device can be paused. */
00252 
00253 
00254 /*
00255  * Direction encodings
00256  */
00264 #define SDL_HAPTIC_POLAR      0
00265 
00272 #define SDL_HAPTIC_CARTESIAN  1
00273 
00280 #define SDL_HAPTIC_SPHERICAL  2
00281 
00282 
00283 /*
00284  * Misc defines.
00285  */
00293 #define SDL_HAPTIC_INFINITY   4294967295U
00294 
00295 
00389 typedef struct SDL_HapticDirection
00390 {
00391     Uint8 type;         
00392     Uint16 dir[3];      
00393 } SDL_HapticDirection;
00394 
00395 
00409 typedef struct SDL_HapticConstant
00410 {
00411     /* Header */
00412     Uint16 type;            
00413     SDL_HapticDirection direction;  
00415     /* Replay */
00416     Uint32 length;          
00417     Uint16 delay;           
00419     /* Trigger */
00420     Uint16 button;          
00421     Uint16 interval;        
00423     /* Constant */
00424     Sint16 level;           
00426     /* Envelope */
00427     Uint16 attack_length;   
00428     Uint16 attack_level;    
00429     Uint16 fade_length;     
00430     Uint16 fade_level;      
00431 } SDL_HapticConstant;
00491 typedef struct SDL_HapticPeriodic
00492 {
00493     /* Header */
00494     Uint16 type;        
00497     SDL_HapticDirection direction;  
00499     /* Replay */
00500     Uint32 length;      
00501     Uint16 delay;       
00503     /* Trigger */
00504     Uint16 button;      
00505     Uint16 interval;    
00507     /* Periodic */
00508     Uint16 period;      
00509     Sint16 magnitude;   
00510     Sint16 offset;      
00511     Uint16 phase;       
00513     /* Envelope */
00514     Uint16 attack_length;   
00515     Uint16 attack_level;    
00516     Uint16 fade_length; 
00517     Uint16 fade_level;  
00518 } SDL_HapticPeriodic;
00545 typedef struct SDL_HapticCondition
00546 {
00547     /* Header */
00548     Uint16 type;            
00550     SDL_HapticDirection direction;  
00552     /* Replay */
00553     Uint32 length;          
00554     Uint16 delay;           
00556     /* Trigger */
00557     Uint16 button;          
00558     Uint16 interval;        
00560     /* Condition */
00561     Uint16 right_sat[3];    
00562     Uint16 left_sat[3];     
00563     Sint16 right_coeff[3];  
00564     Sint16 left_coeff[3];   
00565     Uint16 deadband[3];     
00566     Sint16 center[3];       
00567 } SDL_HapticCondition;
00583 typedef struct SDL_HapticRamp
00584 {
00585     /* Header */
00586     Uint16 type;            
00587     SDL_HapticDirection direction;  
00589     /* Replay */
00590     Uint32 length;          
00591     Uint16 delay;           
00593     /* Trigger */
00594     Uint16 button;          
00595     Uint16 interval;        
00597     /* Ramp */
00598     Sint16 start;           
00599     Sint16 end;             
00601     /* Envelope */
00602     Uint16 attack_length;   
00603     Uint16 attack_level;    
00604     Uint16 fade_length;     
00605     Uint16 fade_level;      
00606 } SDL_HapticRamp;
00622 typedef struct SDL_HapticCustom
00623 {
00624     /* Header */
00625     Uint16 type;            
00626     SDL_HapticDirection direction;  
00628     /* Replay */
00629     Uint32 length;          
00630     Uint16 delay;           
00632     /* Trigger */
00633     Uint16 button;          
00634     Uint16 interval;        
00636     /* Custom */
00637     Uint8 channels;         
00638     Uint16 period;          
00639     Uint16 samples;         
00640     Uint16 *data;           
00642     /* Envelope */
00643     Uint16 attack_length;   
00644     Uint16 attack_level;    
00645     Uint16 fade_length;     
00646     Uint16 fade_level;      
00647 } SDL_HapticCustom;
00719 typedef union SDL_HapticEffect
00720 {
00721     /* Common for all force feedback effects */
00722     Uint16 type;                    
00723     SDL_HapticConstant constant;    
00724     SDL_HapticPeriodic periodic;    
00725     SDL_HapticCondition condition;  
00726     SDL_HapticRamp ramp;            
00727     SDL_HapticCustom custom;        
00728 } SDL_HapticEffect;
00729 
00730 
00731 /* Function prototypes */
00739 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
00740 
00753 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
00754 
00777 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
00778 
00790 extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
00791 
00803 extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
00804 
00814 extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
00815 
00826 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
00827 
00839 extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
00840 
00858 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick *
00859                                                                joystick);
00860 
00868 extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
00869 
00886 extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
00887 
00903 extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
00904 
00924 extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
00925 
00926 
00934 extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
00935 
00949 extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic,
00950                                                       SDL_HapticEffect *
00951                                                       effect);
00952 
00966 extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic,
00967                                                 SDL_HapticEffect * effect);
00968 
00988 extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic,
00989                                                    int effect,
00990                                                    SDL_HapticEffect * data);
00991 
01012 extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic,
01013                                                 int effect,
01014                                                 Uint32 iterations);
01015 
01028 extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic,
01029                                                  int effect);
01030 
01043 extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic,
01044                                                      int effect);
01045 
01061 extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic * haptic,
01062                                                       int effect);
01063 
01082 extern DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
01083 
01098 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic,
01099                                                     int autocenter);
01100 
01117 extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic);
01118 
01131 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
01132 
01141 extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
01142 
01143 
01144 /* Ends C function definitions when using C++ */
01145 #ifdef __cplusplus
01146 /* *INDENT-OFF* */
01147 }
01148 /* *INDENT-ON* */
01149 #endif
01150 #include "close_code.h"
01151 
01152 #endif /* _SDL_haptic_h */
01153 
01154 /* vi: set ts=4 sw=4 expandtab: */
/Users/hercules/trunk/SDL/include/SDL_haptic.h
