include/SDL_haptic.h
author Edgar Simo <bobbens@gmail.com>
Tue, 01 Jul 2008 09:22:22 +0000
branchgsoc2008_force_feedback
changeset 2480 b883974445fc
parent 2478 4fd783e0f34b
child 2481 5d0ea4576f20
permissions -rw-r--r--
Some more error reporting.
Added periodic effect.
Confirmed it works.
     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 typedef struct SDL_HapticConstant {
    61    /* Header */
    62    Uint16 type;
    63    Uint16 direction;
    64 
    65    /* Replay */
    66    Uint16 length;
    67    Uint16 delay;
    68 
    69    /* Trigger */
    70    Uint16 button;
    71    Uint16 interval;
    72 
    73    /* Constant */
    74    Sint16 level;
    75 
    76    /* Envelope */
    77    Uint16 attack_length;
    78    Uint16 attack_level;
    79    Uint16 fade_length;
    80    Uint16 fade_level;
    81 } SDL_HapticConstant;
    82 typedef struct SDL_HapticPeriodic {
    83    /* Header */
    84    Uint16 type;
    85    Uint16 direction;
    86 
    87    /* Replay */
    88    Uint16 length;
    89    Uint16 delay;
    90 
    91    /* Trigger */
    92    Uint16 button;
    93    Uint16 interval;
    94 
    95    /* Periodic */
    96    Uint16 waveform;
    97    Uint16 period;
    98    Sint16 magnitude;
    99    Sint16 offset;
   100    Uint16 phase;
   101 
   102    /* Envelope */
   103    Uint16 attack_length;
   104    Uint16 attack_level;
   105    Uint16 fade_length;
   106    Uint16 fade_level;
   107 } SDL_HapticPeriodic;
   108 
   109 typedef union SDL_HapticEffect {
   110    /* Common for all force feedback effects */
   111    Uint16 type; /* Effect type */
   112    SDL_HapticConstant constant; /* Constant effect */
   113    SDL_HapticPeriodic periodic; /* Periodic effect */
   114 } SDL_HapticEffect;
   115 
   116 
   117 /* Function prototypes */
   118 /*
   119  * Count the number of joysticks attached to the system
   120  */
   121 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
   122 
   123 /*
   124  * Get the implementation dependent name of a Haptic device.
   125  * This can be called before any joysticks are opened.
   126  * If no name can be found, this function returns NULL.
   127  */
   128 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
   129 
   130 /*
   131  * Opens a Haptic device for usage - the index passed as an
   132  * argument refers to the N'th Haptic device on this system.
   133  *
   134  * This function returns a Haptic device identifier, or Null
   135  * if an error occurred.
   136  */
   137 extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
   138 
   139 /* 
   140  * Closes a Haptic device previously opened with SDL_HapticOpen.
   141  */
   142 extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
   143 
   144 /*
   145  * Returns the number of effects a haptic device can store.
   146  */
   147 extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
   148 
   149 /*
   150  * Returns the supported effects.  Individual effects can be queried by
   151  * bitwise operators.
   152  *
   153  * Example:  (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT)
   154  */
   155 extern DECLSPEC unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic);
   156 
   157 /*
   158  * Creates a new haptic effect on the device.
   159  */
   160 extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   161 
   162 /*
   163  * Runs the haptic effect on it's assosciated haptic device.
   164  */
   165 extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
   166 
   167 /*
   168  * Destroys a haptic effect on the device.
   169  */
   170 extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
   171 
   172 
   173 /* Ends C function definitions when using C++ */
   174 #ifdef __cplusplus
   175 /* *INDENT-OFF* */
   176 }
   177 /* *INDENT-ON* */
   178 #endif
   179 #include "close_code.h"
   180 
   181 #endif /* _SDL_haptic_h */
   182 
   183 /* vi: set ts=4 sw=4 expandtab: */
   184 
   185