src/haptic/SDL_syshaptic.h
author Edgar Simo <bobbens@gmail.com>
Wed, 06 Aug 2008 09:55:29 +0000
branchgsoc2008_force_feedback
changeset 2624 c6476e26a783
parent 2524 1a55848ce198
child 2645 269ba4f28d0e
permissions -rw-r--r--
Fixd outstanding typo.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     1
/*
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     2
    SDL - Simple DirectMedia Layer
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     3
    Copyright (C) 2008 Edgar Simo
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     4
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     5
    This library is free software; you can redistribute it and/or
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     6
    modify it under the terms of the GNU Lesser General Public
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     7
    License as published by the Free Software Foundation; either
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     8
    version 2.1 of the License, or (at your option) any later version.
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
     9
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    10
    This library is distributed in the hope that it will be useful,
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    13
    Lesser General Public License for more details.
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    14
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    15
    You should have received a copy of the GNU Lesser General Public
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    16
    License along with this library; if not, write to the Free Software
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    18
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    19
    Sam Lantinga
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    20
    slouken@libsdl.org
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    21
*/
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    22
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    23
#include "SDL_config.h"
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    24
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    25
#include "SDL_haptic.h"
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    26
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    27
2512
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    28
/*
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    29
 * Number of haptic devices on the system.
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    30
 */
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    31
extern Uint8 SDL_numhaptics;
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    32
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    33
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    34
struct haptic_effect
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    35
{
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    36
   SDL_HapticEffect effect; /* The current event */
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    37
   struct haptic_hweffect *hweffect; /* The hardware behind the event */
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    38
};
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    39
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    40
/*
2517
37c13c12c878 Broke API by introducing iterations to SDL_HapticRunEffects().
Edgar Simo <bobbens@gmail.com>
parents: 2515
diff changeset
    41
 * The real SDL_Haptic struct.
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    42
 */
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    43
struct _SDL_Haptic
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    44
{  
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    45
   Uint8 index; /* Stores index it is attached to */
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    46
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    47
   struct haptic_effect *effects; /* Allocated effects */
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    48
   int neffects; /* Maximum amount of effects */
2515
030fc4375e63 Added SDL_HapticNumEffectsPlaying().
Edgar Simo <bobbens@gmail.com>
parents: 2512
diff changeset
    49
   int nplaying; /* Maximum amount of effects to play at the same time */
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    50
   unsigned int supported; /* Supported effects */
2523
366d84fdf8d1 Haptic subsystem handles haptic axes now.
Edgar Simo <bobbens@gmail.com>
parents: 2519
diff changeset
    51
   int naxes; /* Number of axes on the device. */
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    52
2477
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    53
   struct haptic_hwdata *hwdata; /* Driver dependent */
97f75ea43a93 Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents: 2475
diff changeset
    54
   int ref_count; /* Count for multiple opens */
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    55
};
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    56
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    57
/* 
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    58
 * Scans the system for haptic devices.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    59
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    60
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    61
 */
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
    62
extern int SDL_SYS_HapticInit(void);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    63
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    64
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    65
 * Gets the device dependent name of the haptic device
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    66
 */
2475
4b874e3a3a2c Some code cleanup.
Edgar Simo <bobbens@gmail.com>
parents: 2472
diff changeset
    67
extern const char * SDL_SYS_HapticName(int index);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    68
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    69
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    70
 * Opens the haptic device for usage.  The haptic device should have
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    71
 * the index value set previously.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    72
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    73
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    74
 */
2475
4b874e3a3a2c Some code cleanup.
Edgar Simo <bobbens@gmail.com>
parents: 2472
diff changeset
    75
extern int SDL_SYS_HapticOpen(SDL_Haptic * haptic);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    76
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    77
/*
2512
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    78
 * Returns the index of the haptic core pointer or -1 if none is found.
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    79
 */
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    80
int SDL_SYS_HapticMouse(void);
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    81
ef147ee4896c Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents: 2495
diff changeset
    82
/*
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    83
 * Checks to see if the joystick has haptic capabilities.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    84
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    85
 * Returns >0 if haptic capabilities are detected, 0 if haptic
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    86
 * capabilities aren't detected and -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    87
 */
2624
c6476e26a783 Fixd outstanding typo.
Edgar Simo <bobbens@gmail.com>
parents: 2524
diff changeset
    88
extern int SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    89
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    90
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    91
 * Opens the haptic device for usage using the same device as
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    92
 * the joystick.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    93
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    94
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    95
 */
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    96
extern int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic,
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    97
                                          SDL_Joystick * joystick);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    98
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
    99
 * Checks to see if haptic device and joystick device are the same.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   100
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   101
 * Returns 1 if they are the same, 0 if they aren't.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   102
 */
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   103
extern int SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic,
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   104
                                      SDL_Joystick * joystick);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   105
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   106
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   107
 * Closes a haptic device after usage.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   108
 */
2475
4b874e3a3a2c Some code cleanup.
Edgar Simo <bobbens@gmail.com>
parents: 2472
diff changeset
   109
extern void SDL_SYS_HapticClose(SDL_Haptic * haptic);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   110
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   111
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   112
 * Performs a cleanup on the haptic subsystem.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   113
 */
2475
4b874e3a3a2c Some code cleanup.
Edgar Simo <bobbens@gmail.com>
parents: 2472
diff changeset
   114
extern void SDL_SYS_HapticQuit(void);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   115
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   116
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   117
 * Creates a new haptic effect on the haptic device using base
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   118
 * as a template for the effect.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   119
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   120
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   121
 */
2479
b9eb2cfe16cd Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents: 2477
diff changeset
   122
extern int SDL_SYS_HapticNewEffect(SDL_Haptic * haptic,
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   123
                                 struct haptic_effect * effect,
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   124
                                 SDL_HapticEffect * base);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   125
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   126
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   127
 * Updates the haptic effect on the haptic device using data
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   128
 * as a template.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   129
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   130
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   131
 */
2488
8e2bdbccf7ff Added SDL_HapticUpdateEffect().
Edgar Simo <bobbens@gmail.com>
parents: 2485
diff changeset
   132
extern int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   133
                                      struct haptic_effect * effect,
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   134
                                      SDL_HapticEffect * data);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   135
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   136
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   137
 * Runs the effect on the haptic device.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   138
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   139
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   140
 */
2479
b9eb2cfe16cd Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents: 2477
diff changeset
   141
extern int SDL_SYS_HapticRunEffect(SDL_Haptic * haptic,
2517
37c13c12c878 Broke API by introducing iterations to SDL_HapticRunEffects().
Edgar Simo <bobbens@gmail.com>
parents: 2515
diff changeset
   142
                                   struct haptic_effect * effect,
2519
af9df9662807 More explicit with iterations and length.
Edgar Simo <bobbens@gmail.com>
parents: 2517
diff changeset
   143
                                   Uint32 iterations);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   144
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   145
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   146
 * Stops the effect on the haptic device.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   147
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   148
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   149
 */
2485
67978eea6d10 Added SDL_HapticStopEffect().
Edgar Simo <bobbens@gmail.com>
parents: 2484
diff changeset
   150
extern int SDL_SYS_HapticStopEffect(SDL_Haptic * haptic,
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   151
                                    struct haptic_effect * effect);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   152
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   153
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   154
 * Cleanups up the effect on the haptic device.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   155
 */
2479
b9eb2cfe16cd Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents: 2477
diff changeset
   156
extern void SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic,
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   157
                                        struct haptic_effect * effect);
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   158
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   159
/*
2495
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   160
 * Queries the device for the status of effect.
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   161
 *
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   162
 * Returns 0 if device is stopped, >0 if device is playing and
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   163
 * -1 on error.
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   164
 */
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   165
extern int SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic,
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   166
                                         struct haptic_effect * effect);
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   167
66c02abeef0e Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents: 2491
diff changeset
   168
/*
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   169
 * Sets the global gain of the haptic device.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   170
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   171
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   172
 */
2483
9d52368ebcf5 Setting effects memory to 0.
Edgar Simo <bobbens@gmail.com>
parents: 2480
diff changeset
   173
extern int SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain);
2491
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   174
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   175
/*
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   176
 * Sets the autocenter feature of the haptic device.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   177
 *
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   178
 * Returns 0 on success, -1 on error.
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   179
 */
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   180
extern int SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic,
10bc7aaf5114 Commented SDL_syshaptic.h.
Edgar Simo <bobbens@gmail.com>
parents: 2488
diff changeset
   181
                                       int autocenter);
2472
3f73c88c9abb First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
   182
2479
b9eb2cfe16cd Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents: 2477
diff changeset
   183