sdl-ios-xcode: include/SDL_haptic.h annotate

annotate include/SDL_haptic.h @ 2512:ef147ee4896c gsoc2008_force_feedback

Improved some ioctl handling. Implemented SDL_MouseIsHaptic and SDL_HapticOpenFromMouse. More code comments.

author	Edgar Simo <bobbens@gmail.com>
date	Thu, 10 Jul 2008 08:38:08 +0000
parents	f12ae0bae468
children	030fc4375e63

rev	line source
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 /**
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	24 * \file SDL_haptic.h
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	25 *
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	26 * \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	27 * devices.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	28 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	29 * The basic usage is as follows:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	30 * - Initialize the Subsystem (SDL_INIT_HAPTIC).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	31 * - Open a Haptic Device.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	32 * - SDL_HapticOpen(...) to open from index.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	33 * - SDL_HapticOpenFromJoystick(...) to open from an existing joystick.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	34 * - Create an effect (SDL_HapticEffect).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	35 * - Upload the effect with SDL_HapticNewEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	36 * - Run the effect with SDL_HapticRunEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	37 * - (optional) Free the effect with SDL_HapticDestroyEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	38 * - Close the haptic device with SDL_HapticClose(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	39 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	40 * Example:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	41 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	42 * \code
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	43 * int test_haptic( SDL_Joystick * joystick ) {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	44 * SDL_Haptic *haptic;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	45 * SDL_HapticEffect effect;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	46 * int effect_id;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	47 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	48 * // Open the device
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	49 * haptic = SDL_HapticOpenFromJoystick( joystick );
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	50 * if (haptic == NULL) return -1; // Most likely joystick isn't haptic
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	51 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	52 * // See if it can do sine waves
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	53 * if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	54 * SDL_HapticClose(haptic); // No sine effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	55 * return -1;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	56 * }
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	57 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	58 * // Create the effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	59 * memset( &effect, 0, sizeof(SDL_HapticEffect) ); // 0 is safe default
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	60 * effect.type = SDL_HAPTIC_SINE;
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	61 * effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
2501 ff12f79dfc8d Fixed mistake in example. Edgar Simo <bobbens@gmail.com> parents: 2500 diff changeset	62 * effect.periodic.direction.dir[0] = 18000; // Force comes from south
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	63 * effect.periodic.period = 1000; // 1000 ms
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	64 * effect.periodic.magnitude = 20000; // 20000/32767 strength
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	65 * effect.periodic.length = 5000; // 5 seconds long
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	66 * effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	67 * effect.periodic.fade_length = 1000; // Takes 1 second to fade away
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	68 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	69 * // Upload the effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	70 * effect_id = SDL_HapticNewEffect( haptic, &effect );
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	71 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	72 * // Test the effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	73 * SDL_HapticRunEffect( haptic, effect_id );
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	74 * SDL_Delay( 5000); // Wait for the effect to finish
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	75 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	76 * // We destroy the effect, although closing the device also does this
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	77 * SDL_HapticDestroyEffect( haptic, effect_id );
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	78 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	79 * // Close the device
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	80 * SDL_HapticClose(haptic);
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	81 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	82 * return 0; // Success
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	83 * }
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	84 * \endcode
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	85 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	86 * \author Edgar Simo Serra
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	87 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	88
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	89 #ifndef _SDL_haptic_h
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	90 #define _SDL_haptic_h
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	91
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	92 #include "SDL_stdinc.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	93 #include "SDL_error.h"
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	94 #include "SDL_joystick.h"
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	95
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	96 #include "begin_code.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	97 /* Set up for C function definitions, even when using C++ */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	98 #ifdef __cplusplus
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	99 /* INDENT-OFF */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	100 extern "C" {
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	101 /* INDENT-ON */
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	102 #endif /* __cplusplus */
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	103
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	104 /**
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	105 * \typedef SDL_Haptic
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	106 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	107 * \brief The haptic structure used to identify an SDL haptic.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	108 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	109 * \sa SDL_HapticOpen
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	110 * \sa SDL_HapticOpenFromJoystick
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	111 * \sa SDL_HapticClose
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	112 */
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	113 struct _SDL_Haptic;
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	114 typedef struct _SDL_Haptic SDL_Haptic;
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	115
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	116
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	117 /*
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	118 * Different haptic features a device can have.
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	119 */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	120 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	121 * \def SDL_HAPTIC_CONSTANT
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	122 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	123 * \brief Constant haptic effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	124 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	125 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	126 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	127 #define SDL_HAPTIC_CONSTANT (1<<0) /* Constant effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	128 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	129 * \def SDL_HAPTIC_SINE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	130 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	131 * \brief Periodic haptic effect that simulates sine waves.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	132 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	133 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	134 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	135 #define SDL_HAPTIC_SINE (1<<1) /* Sine wave effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	136 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	137 * \def SDL_HAPTIC_SQUARE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	138 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	139 * \brief Periodic haptic effect that simulates square waves.
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	140 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	141 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	142 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	143 #define SDL_HAPTIC_SQUARE (1<<2) /* Square wave effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	144 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	145 * \def SDL_HAPTIC_TRIANGLE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	146 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	147 * \brief Periodic haptic effect that simulates triangular waves.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	148 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	149 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	150 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	151 #define SDL_HAPTIC_TRIANGLE (1<<3) /* Triangle wave effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	152 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	153 * \def SDL_HAPTIC_SAWTOOTHUP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	154 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	155 * \brief Periodic haptic effect that simulates saw tooth up waves.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	156 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	157 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	158 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	159 #define SDL_HAPTIC_SAWTOOTHUP (1<<4) /* Sawtoothup wave effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	160 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	161 * \def SDL_HAPTIC_SAWTOOTHDOWN
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	162 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	163 * \brief Periodic haptic effect that simulates saw tooth down waves.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	164 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	165 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	166 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	167 #define SDL_HAPTIC_SAWTOOTHDOWN (1<<5) /* Sawtoothdown wave effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	168 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	169 * \def SDL_HAPTIC_RAMP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	170 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	171 * \brief Ramp haptic effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	172 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	173 * \sa SDL_HapticRamp
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	174 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	175 #define SDL_HAPTIC_RAMP (1<<6) /* Ramp effect supported */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	176 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	177 * \def SDL_HAPTIC_SPRING
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	178 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	179 * \brief Condition haptic effect that simulates a spring. Effect is based on the
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	180 * axes position.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	181 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	182 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	183 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	184 #define SDL_HAPTIC_SPRING (1<<7) /* Spring effect supported - uses axes position */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	185 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	186 * \def SDL_HAPTIC_DAMPER
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	187 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	188 * \brief Condition haptic effect that simulates dampening. Effect is based on the
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	189 * axes velocity.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	190 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	191 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	192 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	193 #define SDL_HAPTIC_DAMPER (1<<8) /* Damper effect supported - uses axes velocity */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	194 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	195 * \def SDL_HAPTIC_INERTIA
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	196 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	197 * \brief Condition haptic effect that simulates inertia. Effect is based on the axes
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	198 * acceleration.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	199 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	200 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	201 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	202 #define SDL_HAPTIC_INERTIA (1<<9) /* Inertia effect supported - uses axes acceleration */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	203 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	204 * \def SDL_HAPTIC_FRICTION
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	205 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	206 * \brief Condition haptic effect that simulates friction. Effect is based on the axes
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	207 * movement.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	208 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	209 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	210 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	211 #define SDL_HAPTIC_FRICTION (1<<10) /* Friction effect supported - uses axes movement */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	212 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	213 * \def SDL_HAPTIC_CUSTOM
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	214 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	215 * \brief User defined custom haptic effect. TODO.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	216 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	217 #define SDL_HAPTIC_CUSTOM (1<<11) /* Custom effect is supported */
2487 4c8e25ef2d97 Merged seperate waveforms into types to be more compatible. Edgar Simo <bobbens@gmail.com> parents: 2486 diff changeset	218 /* These last two are features the device has, not effects */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	219 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	220 * \def SDL_HAPTIC_GAIN
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	221 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	222 * \brief Device supports setting the global gain.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	223 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	224 * \sa SDL_HapticSetGain
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	225 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	226 #define SDL_HAPTIC_GAIN (1<<12) /* Device can set global gain */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	227 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	228 * \def SDL_HAPTIC_AUTOCENTER
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	229 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	230 * \brief Device supports setting autocenter.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	231 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	232 * \sa SDL_HapticSetAutocenter
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	233 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	234 #define SDL_HAPTIC_AUTOCENTER (1<<13) /* Device can set autocenter */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	235 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	236 * \def SDL_HAPTIC_STATUS
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	237 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	238 * \brief Device can be queried for effect status.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	239 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	240 * \sa SDL_HapticGetEffectStatus
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	241 */
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	242 #define SDL_HAPTIC_STATUS (1<<14) /* Device can be queried for effect status */
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	243
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	244
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	245 /*
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	246 * Direction encodings
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	247 */
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	248 /**
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	249 * \def SDL_HAPTIC_POLAR
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	250 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	251 * \brief Uses polar coordinates for the direction.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	252 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	253 * \sa SDL_HapticDirection
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	254 */
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	255 #define SDL_HAPTIC_POLAR 0
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	256 /**
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	257 * \def SDL_HAPTIC_CARTESIAN
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	258 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	259 * \brief Uses cartesian coordinates for the direction.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	260 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	261 * \sa SDL_HapticDirection
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	262 */
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	263 #define SDL_HAPTIC_CARTESIAN 1
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	264
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	265
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	266 /**
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	267 * \struct SDL_HapticDirection
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	268 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	269 * \brief Structure that represents a haptic direction.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	270 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	271 * Directions can be specified by:
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	272 * - SDL_HAPTIC_POLAR : Specified by polar coordinates.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	273 * - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	274 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	275 * Cardinal directions of the haptic device are relative to the positioning
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	276 * of the device. North is considered to be away from the user.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	277 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	278 * The following diagram represents the cardinal directions:
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	279 * \code
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	280 * .--.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	281 * \|__\| .-------.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	282 * \|=.\| \|.-----.\|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	283 * \|--\| \|\| \|\|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	284 * \| \| \|'-----'\|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	285 * \|__\|~')_____('
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	286 * [ COMPUTER ]
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	287 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	288 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	289 * North (-1)
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	290 * ^
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	291 * \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	292 * \|
2502 5356ca0c36a3 Fixed linux directions being inverted. Edgar Simo <bobbens@gmail.com> parents: 2501 diff changeset	293 * (1) West <----[ HAPTIC ]----> East (-1)
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	294 * \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	295 * \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	296 * v
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	297 * South (1)
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	298 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	299 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	300 * [ USER ]
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	301 * \\|\|\|/
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	302 * (o o)
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	303 * ---ooO-(_)-Ooo---
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	304 * \endcode
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	305 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	306 * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	307 * degree starting north and turning clockwise. The cardinal directions would be:
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	308 * - North: 0 (0 degrees)
2511 f12ae0bae468 Fixed bugs in documentation. Edgar Simo <bobbens@gmail.com> parents: 2507 diff changeset	309 * - East: 9000 (90 degrees)
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	310 * - South: 18000 (180 degrees)
2511 f12ae0bae468 Fixed bugs in documentation. Edgar Simo <bobbens@gmail.com> parents: 2507 diff changeset	311 * - West: 27000 (270 degrees)
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	312 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	313 * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by position.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	314 * The cardinal directions would be:
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	315 * - North: 0,-1
2511 f12ae0bae468 Fixed bugs in documentation. Edgar Simo <bobbens@gmail.com> parents: 2507 diff changeset	316 * - East: -1, 0
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	317 * - South: 0, 1
2511 f12ae0bae468 Fixed bugs in documentation. Edgar Simo <bobbens@gmail.com> parents: 2507 diff changeset	318 * - West: 1, 0
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	319 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	320 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	321 * Example:
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	322 * \code
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	323 * SDL_HapticDirection direction;
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	324 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	325 * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
2511 f12ae0bae468 Fixed bugs in documentation. Edgar Simo <bobbens@gmail.com> parents: 2507 diff changeset	326 * direction.dir = 18000; // Force comes from the south meaning the user will
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	327 * // have to pull the stick to counteract.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	328 * \endcode
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	329 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	330 * \sa SDL_HAPTIC_POLAR
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	331 * \sa SDL_HAPTIC_CARTESIAN
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	332 * \sa SDL_HapticEffect
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	333 */
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	334 typedef struct SDL_HapticDirection {
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	335 Uint8 type; /*< The type of encoding. /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	336 Uint16 dir[2]; /*< The encoded direction. /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	337 } SDL_HapticDirection;
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	338
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	339
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	340 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	341 * \struct SDL_HapticConstant
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	342 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	343 * \brief A structure containing a template for a Constant effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	344 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	345 * The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	346 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	347 * A constant effect applies a constant force in the specified direction
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	348 * to the joystick.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	349 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	350 * \sa SDL_HAPTIC_CONSTANT
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	351 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	352 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	353 typedef struct SDL_HapticConstant {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	354 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	355 Uint16 type; /*< SDL_HAPTIC_CONSTANT /
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	356 SDL_HapticDirection direction; /*< Direction of the effect. /
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	357
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	358 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	359 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	360 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	361
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	362 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	363 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	364 Uint16 interval; /*< How soon it can be triggered again after button. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	365
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	366 /* Constant */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	367 Sint16 level; /*< Strength of the constant effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	368
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	369 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	370 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	371 Uint16 attack_level; /*< Level at the start of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	372 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	373 Uint16 fade_level; /*< Level at the end of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	374 } SDL_HapticConstant;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	375 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	376 * \struct SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	377 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	378 * \brief A structure containing a template for a Periodic effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	379 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	380 * The struct handles the following effects:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	381 * - SDL_HAPTIC_SINE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	382 * - SDL_HAPTIC_SQUARE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	383 * - SDL_HAPTIC_TRIANGLE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	384 * - SDL_HAPTIC_SAWTOOTHUP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	385 * - SDL_HAPTIC_SAWTOOTHDOWN
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	386 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	387 * A periodic effect consists in a wave-shaped effect that repeats itself
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	388 * over time. The type determines the shape of the wave and the parameters
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	389 * determine the dimensions of the wave.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	390 *
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	391 * Examples:
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	392 * \code
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	393 * SDL_HAPTIC_SINE
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	394 * __ __ __ __
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	395 * / \ / \ / \ /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	396 * / \__/ \__/ \__/
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	397 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	398 * SDL_HAPTIC_SQUARE
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	399 * __ __ __ __ __
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	400 * \| \| \| \| \| \| \| \| \| \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	401 * \| \|__\| \|__\| \|__\| \|__\| \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	402 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	403 * SDL_HAPTIC_TRIANGLE
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	404 * /\ /\ /\ /\ /\
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	405 * / \ / \ / \ / \ /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	406 * / \/ \/ \/ \/
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	407 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	408 * SDL_HAPTIC_SAWTOOTHUP
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	409 * /\| /\| /\| /\| /\| /\| /\|
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	410 * / \| / \| / \| / \| / \| / \| / \|
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	411 * / \|/ \|/ \|/ \|/ \|/ \|/ \|
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	412 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	413 * SDL_HAPTIC_SAWTOOTHDOWN
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	414 * \ \|\ \|\ \|\ \|\ \|\ \|\ \|
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	415 * \ \| \ \| \ \| \ \| \ \| \ \| \ \|
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	416 * \\| \\| \\| \\| \\| \\| \\|
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	417 * \endcode
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	418 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	419 * \sa SDL_HAPTIC_SINE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	420 * \sa SDL_HAPTIC_SQUARE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	421 * \sa SDL_HAPTIC_TRIANGLE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	422 * \sa SDL_HAPTIC_SAWTOOTHUP
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	423 * \sa SDL_HAPTIC_SAWTOOTHDOWN
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	424 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	425 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	426 typedef struct SDL_HapticPeriodic {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	427 /* Header */
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	428 Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	429 SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	430 SDL_HAPTIC_SAWTOOTHDOWN */
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	431 SDL_HapticDirection direction; /*< Direction of the effect. /
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	432
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	433 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	434 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	435 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	436
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	437 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	438 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	439 Uint16 interval; /*< How soon it can be triggered again after button. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	440
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	441 /* Periodic */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	442 Uint16 period; /*< Period of the wave. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	443 Sint16 magnitude; /*< Peak value. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	444 Sint16 offset; /*< Mean value of the wave. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	445 Uint16 phase; /*< Horizontal shift. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	446
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	447 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	448 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	449 Uint16 attack_level; /*< Level at the start of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	450 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	451 Uint16 fade_level; /*< Level at the end of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	452 } SDL_HapticPeriodic;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	453 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	454 * \struct SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	455 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	456 * \brief A structure containing a template for a Condition effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	457 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	458 * The struct handles the following effects:
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	459 * - SDL_HAPTIC_SPRING: Effect based on axes position.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	460 * - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	461 * - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	462 * - SDL_HAPTIC_FRICTION: Effect based on axes movement.
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	463 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	464 * Direction is handled by condition internals instead of a direction member.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	465 * The condition effect specific members have two parameters. The first
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	466 * refers to the X axis, the second refers to the Y axis. The right terms
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	467 * refer to the positive side of the axis and the left terms refer to the
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	468 * negative side of the axis. Please refer to the SDL_HapticDirection
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	469 * diagram for which side is positive and which is negative.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	470 *
2500 5251d0510b7e Implemented polar coordinates in linux. Edgar Simo <bobbens@gmail.com> parents: 2499 diff changeset	471 * \sa SDL_HapticDirection
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	472 * \sa SDL_HAPTIC_SPRING
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	473 * \sa SDL_HAPTIC_DAMPER
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	474 * \sa SDL_HAPTIC_INERTIA
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	475 * \sa SDL_HAPTIC_FRICTION
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	476 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	477 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	478 typedef struct SDL_HapticCondition {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	479 /* Header */
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	480 Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	481 SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	482
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	483 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	484 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	485 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	486
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	487 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	488 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	489 Uint16 interval; /*< How soon it can be triggered again after button. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	490
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	491 /* Condition */
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	492 Uint16 right_sat[2]; /*< Level when joystick is to the positive side. /
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	493 Uint16 left_sat[2]; /*< Level when joystick is to the negative side. /
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	494 Sint16 right_coeff[2]; /*< How fast to increase the force towards the positive side. /
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	495 Sint16 left_coeff[2]; /*< How fast to increase the force towards the negative side. /
2500 5251d0510b7e Implemented polar coordinates in linux. Edgar Simo <bobbens@gmail.com> parents: 2499 diff changeset	496 Uint16 deadband[2]; /*< Size of the dead zone. /
5251d0510b7e Implemented polar coordinates in linux. Edgar Simo <bobbens@gmail.com> parents: 2499 diff changeset	497 Sint16 center[2]; /*< Position of the dead zone. /
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	498 } SDL_HapticCondition;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	499 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	500 * \struct SDL_HapticRamp
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	501 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	502 * \brief A structure containing a template for a Ramp effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	503 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	504 * This struct is exclusively for the SDL_HAPTIC_RAMP effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	505 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	506 * The ramp effect starts at start strength and ends at end strength.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	507 * It augments in linear fashion. If you use attack and fade with a ramp
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	508 * they effects get added to the ramp effect making the effect become
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	509 * quadratic instead of linear.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	510 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	511 * \sa SDL_HAPTIC_RAMP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	512 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	513 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	514 typedef struct SDL_HapticRamp {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	515 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	516 Uint16 type; /*< SDL_HAPTIC_RAMP /
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	517 SDL_HapticDirection direction; /*< Direction of the effect. /
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	518
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	519 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	520 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	521 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	522
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	523 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	524 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	525 Uint16 interval; /*< How soon it can be triggered again after button. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	526
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	527 /* Ramp */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	528 Sint16 start; /*< Beginning strength level. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	529 Sint16 end; /*< Ending strength level. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	530
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	531 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	532 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	533 Uint16 attack_level; /*< Level at the start of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	534 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	535 Uint16 fade_level; /*< Level at the end of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	536 } SDL_HapticRamp;
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	537 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	538 * \union SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	539 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	540 * \brief The generic template for any haptic effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	541 *
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	542 * All values max at 32767 (0x7FFF). Signed values also can be negative.
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	543 * Time values unless specified otherwise are in milliseconds.
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	544 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	545 * Common parts:
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	546 * \code
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	547 * // Replay - All effects have this
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	548 * Uint16 length; // Duration of effect (ms).
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	549 * Uint16 delay; // Delay before starting effect.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	550 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	551 * // Trigger - All effects have this
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	552 * Uint16 button; // Button that triggers effect.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	553 * Uint16 interval; // How soon before effect can be triggered again.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	554 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	555 * // Envelope - All effects except condition effects have this
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	556 * Uint16 attack_length; // Duration of the attack (ms).
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	557 * Uint16 attack_level; // Level at the start of the attack.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	558 * Uint16 fade_length; // Duration of the fade out (ms).
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	559 * Uint16 fade_level; // Level at the end of the fade.
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	560 * \endcode
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	561 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	562 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	563 * Here we have an example of a constant effect evolution in time:
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	564 *
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	565 * \code
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	566 * Strength
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	567 * ^
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	568 * \|
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	569 * \| effect level --> _________________
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	570 * \| / \
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	571 * \| / \
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	572 * \| / \
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	573 * \| / \
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	574 * \| attack_level --> \| \
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	575 * \| \| \| <--- fade_level
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	576 * \|
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	577 * +--------------------------------------------------> Time
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	578 * [--] [---]
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	579 * attack_length fade_length
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	580 *
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	581 * [------------------][-----------------------]
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	582 * delay length
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	583 * \endcode
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	584 *
2504 e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	585 * Note either the attack_level or the fade_level may be above the actual
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	586 * effect level.
e68c99a19a2f Fixed more mistakes in documentation. Edgar Simo <bobbens@gmail.com> parents: 2502 diff changeset	587 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	588 * \sa SDL_HapticConstant
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	589 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	590 * \sa SDL_HapticCondition
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	591 * \sa SDL_HapticRamp
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	592 */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	593 typedef union SDL_HapticEffect {
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	594 /* Common for all force feedback effects */
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	595 Uint16 type; /*< Effect type. /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	596 SDL_HapticConstant constant; /*< Constant effect. /
cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	597 SDL_HapticPeriodic periodic; /*< Periodic effect. /
2500 5251d0510b7e Implemented polar coordinates in linux. Edgar Simo <bobbens@gmail.com> parents: 2499 diff changeset	598 SDL_HapticCondition condition; /*< Condition effect. /
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	599 SDL_HapticRamp ramp; /*< Ramp effect. /
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	600 } SDL_HapticEffect;
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	601
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	602
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	603 /* Function prototypes */
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	604 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	605 * \fn int SDL_NumHaptics(void)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	606 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	607 * \brief Count the number of joysticks attached to the system.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	608 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	609 * \return Number of haptic devices detected on the system.
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	610 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	611 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	612
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	613 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	614 * \fn const char * SDL_HapticName(int device_index)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	615 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	616 * \brief Get the implementation dependent name of a Haptic device.
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	617 * This can be called before any joysticks are opened.
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	618 * If no name can be found, this function returns NULL.
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	619 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	620 * \param device_index Index of the device to get it's name.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	621 * \return Name of the device or NULL on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	622 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	623 * \sa SDL_NumHaptics
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	624 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	625 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	626
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	627 /**
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	628 * \fn SDL_Haptic * SDL_HapticOpen(int device_index)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	629 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	630 * \brief Opens a Haptic device for usage - the index passed as an
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	631 * argument refers to the N'th Haptic device on this system.
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	632 *
2507 8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	633 * When opening a haptic device, it's gain will be set to maximum and
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	634 * autocenter will be disabled. To modify these values use
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	635 * SDL_HapticSetGain and SDL_HapticSetAutocenter
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	636 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	637 * \param device_index Index of the device to open.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	638 * \return Device identifier or NULL on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	639 *
2505 abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	640 * \sa SDL_HapticIndex
2512 ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	641 * \sa SDL_HapticOpenFromMouse
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	642 * \sa SDL_HapticOpenFromJoystick
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	643 * \sa SDL_HapticClose
2507 8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	644 * \sa SDL_HapticSetGain
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	645 * \sa SDL_HapticSetAutocenter
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	646 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	647 extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	648
2506 ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	649 /**
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	650 * \fn int SDL_HapticOpened(int device_index)
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	651 *
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	652 * \brief Checks if the haptic device at index has been opened.
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	653 *
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	654 * \param device_index Index to check to see if it has been opened.
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	655 * \return 1 if it has been opened or 0 if it hasn't.
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	656 *
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	657 * \sa SDL_HapticOpen
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	658 * \sa SDL_HapticIndex
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	659 */
ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	660 extern DECLSPEC int SDL_HapticOpened(int device_index);
2505 abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	661
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	662 /**
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	663 * \fn int SDL_HapticIndex(SDL_Haptic * haptic)
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	664 *
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	665 * \brief Gets the index of a haptic device.
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	666 *
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	667 * \param haptic Haptic device to get the index of.
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	668 * \return The index of the haptic device or -1 on error.
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	669 *
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	670 * \sa SDL_HapticOpen
2506 ba8e99fe92c1 Added SDL_HapticOpened(). Edgar Simo <bobbens@gmail.com> parents: 2505 diff changeset	671 * \sa SDL_HapticOpened
2505 abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	672 */
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	673 extern DECLSPEC int SDL_HapticIndex(SDL_Haptic * haptic);
abfcba0f3bd1 Added SDL_HapticIndex. Edgar Simo <bobbens@gmail.com> parents: 2504 diff changeset	674
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	675 /**
2512 ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	676 * \fn int SDL_MouseIsHaptic(void)
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	677 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	678 * \brief Gets whether or not the current mouse has haptic capabilities.
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	679 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	680 * \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	681 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	682 * \sa SDL_HapticOpenFromMouse
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	683 */
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	684 extern DECLSPEC SDL_MouseIsHaptic(void);
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	685
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	686 /**
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	687 * \fn SDL_Haptic * SDL_HapticOpenFromMouse(void)
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	688 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	689 * \brief Tries to open a haptic device from the current mouse.
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	690 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	691 * \return The haptic device identifier or NULL on error.
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	692 *
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	693 * \sa SDL_MouseIsHaptic
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	694 * \sa SDL_HapticOpen
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	695 */
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	696 extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromMouse(void);
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	697
ef147ee4896c Improved some ioctl handling. Edgar Simo <bobbens@gmail.com> parents: 2511 diff changeset	698 /**
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	699 * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	700 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	701 * \brief Checks to see if a joystick has haptic features.
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	702 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	703 * \param joystick Joystick to test for haptic capabilities.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	704 * \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	705 * or -1 if an error ocurred.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	706 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	707 * \sa SDL_HapticOpenFromJoystick
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	708 */
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	709 extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	710
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	711 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	712 * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	713 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	714 * \brief Opens a Haptic device for usage from a Joystick device. Still has
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	715 * to be closed seperately to the joystick.
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	716 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	717 * \param joystick Joystick to create a haptic device from.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	718 * \return A valid haptic device identifier on success or NULL on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	719 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	720 * \sa SDL_HapticOpen
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	721 * \sa SDL_HapticClose
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	722 */
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	723 extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	724
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	725 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	726 * \fn void SDL_HapticClose(SDL_Haptic * haptic)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	727 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	728 * \brief Closes a Haptic device previously opened with SDL_HapticOpen.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	729 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	730 * \param haptic Haptic device to close.
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	731 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	732 extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	733
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	734 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	735 * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	736 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	737 * \brief Returns the number of effects a haptic device can store.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	738 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	739 * \param haptic The haptic device to query effect max.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	740 * \return The number of effects the haptic device can store or
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	741 * -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	742 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	743 * \sa SDL_HapticQuery
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	744 */
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	745 extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	746
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	747 /**
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	748 * \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	749 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	750 * \brief Gets the haptic devices supported features in bitwise matter.
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	751 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	752 * Example:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	753 * \code
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	754 * if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	755 * printf("We have constant haptic effect!");
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	756 * }
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	757 * \endcode
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	758 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	759 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	760 * \param haptic The haptic device to query.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	761 * \return Haptic features in bitwise manner (OR'd).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	762 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	763 * \sa SDL_HapticNumEffects
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	764 * \sa SDL_HapticEffectSupported
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	765 */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	766 extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	767
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	768 /**
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	769 * \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	770 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	771 * \brief Checks to see if effect is supported by haptic.
2486 24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	772 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	773 * \param haptic Haptic device to check on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	774 * \param effect Effect to check to see if it is supported.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	775 * \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	776 * -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	777 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	778 * \sa SDL_HapticQuery
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	779 * \sa SDL_HapticNewEffect
2486 24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	780 */
24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	781 extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	782
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	783 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	784 * \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	785 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	786 * \brief Creates a new haptic effect on the device.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	787 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	788 * \param haptic Haptic device to create the effect on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	789 * \param effect Properties of the effect to create.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	790 * \return The id of the effect on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	791 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	792 * \sa SDL_HapticUpdateEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	793 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	794 * \sa SDL_HapticDestroyEffect
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	795 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	796 extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	797
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	798 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	799 * \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	800 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	801 * \brief Updates an effect. Can be used dynamically, although behaviour when
2488 8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	802 * dynamically changing direction may be strange. Specifically the effect
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	803 * may reupload itself and start playing from the start. You cannot change
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	804 * the type either when running UpdateEffect.
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	805 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	806 * \param haptic Haptic device that has the effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	807 * \param effect Effect to update.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	808 * \param data New effect properties to use.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	809 * \return The id of the effect on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	810 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	811 * \sa SDL_HapticNewEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	812 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	813 * \sa SDL_HapticDestroyEffect
2488 8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	814 */
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	815 extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	816
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	817 /**
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	818 * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect)
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	819 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	820 * \brief Runs the haptic effect on it's assosciated haptic device.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	821 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	822 * \param haptic Haptic device to run the effect on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	823 * \param effect Identifier of the haptic effect to run.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	824 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	825 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	826 * \sa SDL_HapticStopEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	827 * \sa SDL_HapticDestroyEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	828 * \sa SDL_HapticGetEffectStatus
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	829 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	830 extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	831
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	832 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	833 * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	834 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	835 * \brief Stops the haptic effect on it's assosciated haptic device.
2485 67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	836 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	837 * \param haptic Haptic device to stop the effect on.
2499 cc2b270608b2 Created SDL_HapticDirection. Edgar Simo <bobbens@gmail.com> parents: 2498 diff changeset	838 * \param effect Identifier of the effect to stop.
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	839 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	840 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	841 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	842 * \sa SDL_HapticDestroyEffect
2485 67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	843 */
67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	844 extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	845
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	846 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	847 * \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	848 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	849 * \brief Destroys a haptic effect on the device. This will stop the effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	850 * if it's running. Effects are automatically destroyed when the device is
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	851 * closed.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	852 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	853 * \param haptic Device to destroy the effect on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	854 * \param effect Identifier of the effect to destroy.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	855 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	856 * \sa SDL_HapticNewEffect
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	857 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	858 extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	859
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	860 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	861 * \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	862 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	863 * \brief Gets the status of the current effect on the haptic device.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	864 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	865 * Device must support the SDL_HAPTIC_STATUS feature.
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	866 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	867 * \param haptic Haptic device to query the effect status on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	868 * \param effect Identifier of the effect to query it's status.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	869 * \return 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	870 * or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	871 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	872 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	873 * \sa SDL_HapticStopEffect
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	874 */
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	875 extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	876
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	877 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	878 * \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	879 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	880 * \brief Sets the global gain of the device. Gain should be between 0 and 100.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	881 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	882 * Device must support the SDL_HAPTIC_GAIN feature.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	883 *
2507 8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	884 * The user may specify the maxmimum gain by setting the environment variable
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	885 * SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	886 * SDL_HapticSetGain will scale linearly using SDL_HAPTIC_GAIN_MAX as the
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	887 * maximum.
8ef1d0f4d0c1 Gain is set to max on haptic device open. Edgar Simo <bobbens@gmail.com> parents: 2506 diff changeset	888 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	889 * \param haptic Haptic device to set the gain on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	890 * \param gain Value to set the gain to, should be between 0 and 100.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	891 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	892 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	893 * \sa SDL_HapticQuery
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	894 */
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	895 extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	896
2498 ab567bd667bf Fixed various mistakes in the doxygen. Edgar Simo <bobbens@gmail.com> parents: 2497 diff changeset	897 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	898 * \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	899 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	900 * \brief Sets the global autocenter of the device. Autocenter should be between
2484 666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	901 * 0 and 100. Setting it to 0 will disable autocentering.
666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	902 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	903 * Device must support the SDL_HAPTIC_AUTOCENTER feature.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	904 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	905 * \param haptic Haptic device to set autocentering on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	906 * \param autocenter Value to set autocenter to, 0 disables autocentering.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	907 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	908 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	909 * \sa SDL_HapticQuery
2484 666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	910 */
666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	911 extern DECLSPEC int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	912
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	913
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	914 /* Ends C function definitions when using C++ */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	915 #ifdef __cplusplus
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	916 /* INDENT-OFF */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	917 }
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	918 /* INDENT-ON */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	919 #endif
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	920 #include "close_code.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	921
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	922 #endif /* _SDL_haptic_h */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	923
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	924 /* vi: set ts=4 sw=4 expandtab: */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	925
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	926

Mercurial > sdl-ios-xcode

annotate include/SDL_haptic.h @ 2512:ef147ee4896c gsoc2008_force_feedback