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

annotate include/SDL_haptic.h @ 2497:0893fbf73b3d gsoc2008_force_feedback

Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Added doxygen to SDL_Haptic.h.

author	Edgar Simo <bobbens@gmail.com>
date	Sun, 06 Jul 2008 16:53:32 +0000
parents	66c02abeef0e
children	ab567bd667bf

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
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	23 /** \file SDL_haptic.h */
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	24 /**
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	25 * \mainpage SDL_haptic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	26 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	27 * The SDL Haptic subsystem allows you to control haptic (force feedback)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	28 * devices.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	29 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	30 * The basic usage is as follows:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	31 * - Initialize the Subsystem (SDL_INIT_HAPTIC).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	32 * - Open a Haptic Device.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	33 * - SDL_HapticOpen(...) to open from index.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	34 * - SDL_HapticOpenFromJoystick(...) to open from an existing joystick.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	35 * - Create an effect (SDL_HapticEffect).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	36 * - Upload the effect with SDL_HapticNewEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	37 * - Run the effect with SDL_HapticRunEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	38 * - (optional) Free the effect with SDL_HapticDestroyEffect(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	39 * - Close the haptic device with SDL_HapticClose(...).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	40 *
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 * Example:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	43 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	44 * \code
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	45 * int test_haptic( SDL_Joystick * joystick ) {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	46 * SDL_Haptic *haptic;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	47 * SDL_HapticEffect effect;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	48 * int effect_id;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	49 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	50 * // Open the device
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	51 * haptic = SDL_HapticOpenFromJoystick( joystick );
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	52 * 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	53 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	54 * // See if it can do sine waves
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	55 * if ((SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_SINE)==0) {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	56 * SDL_HapticClose(haptic); // No sine effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	57 * return -1;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	58 * }
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	59 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	60 * // Create the effect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	61 * 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	62 * effect.type = SDL_HAPTIC_SINE;
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 */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	102 #endif /* __cpluspuls */
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 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	105 * \struct SDL_Haptic
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.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	140 *
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
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	245 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	246 * \struct SDL_HapticConstant
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	247 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	248 * \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	249 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	250 * 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	251 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	252 * \sa SDL_HAPTIC_CONSTANT
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	253 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	254 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	255 typedef struct SDL_HapticConstant {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	256 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	257 Uint16 type; /*< SDL_HAPTIC_CONSTANT /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	258 Uint16 direction;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	259
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	260 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	261 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	262 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	263
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	264 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	265 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	266 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	267
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	268 /* Constant */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	269 Sint16 level; /*< Strength of the constant effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	270
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	271 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	272 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	273 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	274 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	275 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	276 } SDL_HapticConstant;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	277 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	278 * \struct SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	279 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	280 * \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	281 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	282 * The struct handles the following effects:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	283 * - SDL_HAPTIC_SINE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	284 * - SDL_HAPTIC_SQUARE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	285 * - SDL_HAPTIC_TRIANGLE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	286 * - SDL_HAPTIC_SAWTOOTHUP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	287 * - SDL_HAPTIC_SAWTOOTHDOWN
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	288 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	289 * \sa SDL_HAPTIC_SINE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	290 * \sa SDL_HAPTIC_SQUARE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	291 * \sa SDL_HAPTIC_TRIANGLE
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	292 * \sa SDL_HAPTIC_SAWTOOTHUP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	293 * \sa SDL_HAPTIC_SAWTOOTHDOWN
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	294 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	295 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	296 typedef struct SDL_HapticPeriodic {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	297 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	298 Uint16 type; /* SDL_HAPTIC_{SINE,SQUARE,TRIANGLE,SAWTOOTHUP,SAWTOOTHDOWN} */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	299 Uint16 direction;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	300
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	301 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	302 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	303 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	304
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	305 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	306 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	307 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	308
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	309 /* Periodic */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	310 Uint16 period; /*< Period of the wave. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	311 Sint16 magnitude; /*< Peak value. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	312 Sint16 offset; /*< Mean value of the wave. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	313 Uint16 phase; /*< Horizontal shift. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	314
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	315 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	316 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	317 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	318 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	319 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	320 } SDL_HapticPeriodic;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	321 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	322 * \struct SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	323 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	324 * \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	325 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	326 * The struct handles the following effects:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	327 * - SDL_HAPTIC_SPRING
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	328 * - SDL_HAPTIC_DAMPER
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	329 * - SDL_HAPTIC_INERTIA
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	330 * - SDL_HAPTIC_FRICTION
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	331 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	332 * \sa SDL_HAPTIC_SPRING
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	333 * \sa SDL_HAPTIC_DAMPER
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	334 * \sa SDL_HAPTIC_INERTIA
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	335 * \sa SDL_HAPTIC_FRICTION
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	336 * \sa SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	337 */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	338 typedef struct SDL_HapticCondition {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	339 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	340 Uint16 type; /*< SDL_HAPTIC_{SPRING,DAMPER,INERTIA,FRICTION} /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	341 Uint16 direction;
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 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	344 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	345 Uint16 delay; /*< Delay before starting the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	346
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	347 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	348 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	349 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	350
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	351 /* Condition */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	352 Uint16 right_sat; /*< Level when joystick is to the right. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	353 Uint16 left_sat; /*< Level when joystick is to the left. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	354 Sint16 right_coeff; /*< How fast to increase the force towards the right. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	355 Sint16 left_coeff; /*< How fast to increase the force towards the left. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	356 Uint16 deadband; /*< Size of the dead zone. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	357 Sint16 center; /*< Position of the dead zone. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	358 } SDL_HapticCondition;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	359 /**
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	360 * \struct SDL_HapticRamp
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 * \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	363 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	364 * 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	365 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	366 * \sa SDL_HAPTIC_RAMP
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	367 * \sa SDL_HapticEffect
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 typedef struct SDL_HapticRamp {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	370 /* Header */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	371 Uint16 type; /*< SDL_HAPTIC_RAMP /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	372 Uint16 direction;
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	373
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	374 /* Replay */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	375 Uint16 length; /*< Duration of the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	376 Uint16 delay; /*< Delay before starting the effect. /
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 /* Trigger */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	379 Uint16 button; /*< Button that triggers the effect. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	380 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	381
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	382 /* Ramp */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	383 Sint16 start; /*< Beginning strength level. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	384 Sint16 end; /*< Ending strength level. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	385
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	386 /* Envelope */
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	387 Uint16 attack_length; /*< Duration of the attack. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	388 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	389 Uint16 fade_length; /*< Duration of the fade. /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	390 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	391 } SDL_HapticRamp;
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	392 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	393 * \union SDL_HapticEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	394 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	395 * \brief The generic template for any haptic effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	396 *
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	397 * All values max at 32767 (0x7fff). Signed values also can be negative.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	398 * Time values unless specified otherwise are in milliseconds.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	399 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	400 * Common parts:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	401 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	402 * Replay:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	403 * Uint16 length; Duration of effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	404 * Uint16 delay; Delay before starting effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	405 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	406 * Trigger:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	407 * Uint16 button; Button that triggers effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	408 * Uint16 interval; How soon before effect can be triggered again.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	409 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	410 * Envelope:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	411 * Uint16 attack_length; Duration of the attack.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	412 * Uint16 attack_level; Level at the start of the attack.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	413 * Uint16 fade_length; Duration of the fade out.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	414 * Uint16 fade_level; Level at the end of the fade.
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	415 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	416 * \sa SDL_HapticConstant
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	417 * \sa SDL_HapticPeriodic
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	418 * \sa SDL_HapticCondition
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	419 * \sa SDL_HaptiRamp
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	420 */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	421 typedef union SDL_HapticEffect {
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	422 /* Common for all force feedback effects */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	423 Uint16 type; /*< Effect type /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	424 SDL_HapticConstant constant; /*< Constant effect /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	425 SDL_HapticPeriodic periodic; /*< Periodic effect /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	426 SDL_HapticCondition condition; /*< Condition effect /
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	427 SDL_HapticRamp ramp; /*< Ramp effect /
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	428 } SDL_HapticEffect;
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	429
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	430
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	431 /* Function prototypes */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	432 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	433 * \fn int SDL_NumHaptics(void)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	434 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	435 * \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	436 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	437 * \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	438 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	439 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	440
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	441 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	442 * \fn const char * SDL_HapticName(int device_index)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	443 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	444 * \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	445 * 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	446 * 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	447 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	448 * \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	449 * \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	450 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	451 * \sa SDL_NumHaptics
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	452 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	453 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	454
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	455 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	456 * \fn SDL_Haptic * SDL_HapticOpen(int device_Index)
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 * \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	459 * 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	460 *
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	461 * This function returns a Haptic device identifier, or Null
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	462 * if an error occurred.
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	463 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	464 * \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	465 * \return Device identifier or NULL on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	466 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	467 * \sa SDL_HapticOpenFromJoystick
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	468 * \sa SDL_HapticClose
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	469 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	470 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	471
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	472 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	473 * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joysticke)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	474 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	475 * \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	476 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	477 * \param joystick Joystick to test for haptic capabilities.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	478 * \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	479 * or -1 if an error ocurred.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	480 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	481 * \sa SDL_HapticOpenFromJoystick
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	482 */
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	483 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	484
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	485 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	486 * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	487 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	488 * \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	489 * 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	490 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	491 * \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	492 * \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	493 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	494 * \sa SDL_HapticOpen
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	495 * \sa SDL_HapticClose
2489 96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	496 */
96adc8025331 Exposed some of the joystick stuff to the haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: 2488 diff changeset	497 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	498
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	499 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	500 * \fn void SDL_HapticClose(SDL_Haptic * haptic)
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 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	503 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	504 * \param haptic Haptic device to close.
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	505 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	506 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	507
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	508 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	509 * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	510 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	511 * \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	512 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	513 * \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	514 * \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	515 * -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	516 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	517 * \sa SDL_HapticQuery
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	518 */
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	519 extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	520
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	521 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	522 * \fn unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	523 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	524 * \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	525 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	526 * Example:
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	527 * \code
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	528 * if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	529 * printf("We have constant haptic effect!");
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 * \endcode
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	532 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	533 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	534 * \param haptic The haptic device to query.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	535 * \return Haptic features in bitwise manner (OR'd).
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	536 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	537 * \sa SDL_HapticNumEffects
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	538 * \sa SDL_HapticEffectSupported
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	539 */
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	540 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	541
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	542 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	543 * \fn int SDL_HapticEffectSupported
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	544 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	545 * \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	546 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	547 * \param haptic Haptic device to check on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	548 * \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	549 * \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	550 * -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	551 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	552 * \sa SDL_HapticQuery
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	553 * \sa SDL_HapticNewEffect
2486 24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	554 */
24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	555 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	556
24dd8b8669fa Added SDL_HAPTIC_CUSTOM (not supported on linux). Edgar Simo <bobbens@gmail.com> parents: 2485 diff changeset	557 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	558 * \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	559 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	560 * \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	561 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	562 * \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	563 * \param effect Properties of the effect to create.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	564 * \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	565 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	566 * \sa SDL_HapticUpdateEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	567 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	568 * \sa SDL_HapticDestroyEffect
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	569 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	570 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	571
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	572 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	573 * \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	574 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	575 * \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	576 * dynamically changing direction may be strange. Specifically the effect
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	577 * 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	578 * the type either when running UpdateEffect.
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	579 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	580 * \param haptic Haptic device that has the effect.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	581 * \param effect Effect to update.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	582 * \param data New effect properties to use.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	583 * \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	584 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	585 * \sa SDL_HapticNewEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	586 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	587 * \sa SDL_HapticDestroyEffect
2488 8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	588 */
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	589 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	590
8e2bdbccf7ff Added SDL_HapticUpdateEffect(). Edgar Simo <bobbens@gmail.com> parents: 2487 diff changeset	591 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	592 * \fn int SDL_HapticRunEffects(SDL_Haptic * haptic, int effect)
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	593 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	594 * \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	595 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	596 * \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	597 * \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	598 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	599 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	600 * \sa SDL_HapticStopEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	601 * \sa SDL_HapticDestroyEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	602 * \sa SDL_HapticGetEffectStatus
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	603 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	604 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	605
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	606 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	607 * \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	608 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	609 * \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	610 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	611 * \param haptic Haptic device to stop the effect on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	612 * \praam effect Identifier of the effect to stop.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	613 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	614 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	615 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	616 * \sa SDL_HapticDestroyEffect
2485 67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	617 */
67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	618 extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	619
67978eea6d10 Added SDL_HapticStopEffect(). Edgar Simo <bobbens@gmail.com> parents: 2484 diff changeset	620 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	621 * \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	622 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	623 * \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	624 * 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	625 * closed.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	626 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	627 * \param haptic Device to destroy the effect on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	628 * \param effect Identifier of the effect to destroy.
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 * \sa SDL_HapticNewEffect
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	631 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	632 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	633
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	634 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	635 * \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	636 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	637 * \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	638 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	639 * Device must support the SDL_HAPTIC_STATUS feature.
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	640 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	641 * \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	642 * \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	643 * \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	644 * or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	645 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	646 * \sa SDL_HapticRunEffect
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	647 * \sa SDL_HapticStopEffect
2495 66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	648 */
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	649 extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	650
66c02abeef0e Added SDL_HapticGetEffectStatus(). Edgar Simo <bobbens@gmail.com> parents: 2489 diff changeset	651 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	652 * \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	653 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	654 * \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	655 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	656 * Device must support the SDL_HAPTIC_GAIN feature.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	657 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	658 * \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	659 * \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	660 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	661 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	662 * \sa SDL_HapticQuery
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	663 */
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	664 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	665
2484 666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	666 /*
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	667 * \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	668 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	669 * \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	670 * 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	671 *
2497 0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	672 * Device must support the SDL_HAPTIC_AUTOCENTER feature.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	673 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	674 * \param haptic Haptic device to set autocentering on.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	675 * \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	676 * \return 0 on success or -1 on error.
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	677 *
0893fbf73b3d Renamed SDL_HapticQueryEffects to SDL_HapticQuery. Edgar Simo <bobbens@gmail.com> parents: 2495 diff changeset	678 * \sa SDL_HapticQuery
2484 666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	679 */
666472fd4cb0 HapticSetGain checks to see if device supports it. Edgar Simo <bobbens@gmail.com> parents: 2483 diff changeset	680 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	681
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	682
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	683 /* Ends C function definitions when using C++ */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	684 #ifdef __cplusplus
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	685 /* INDENT-OFF */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	686 }
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	687 /* INDENT-ON */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	688 #endif
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	689 #include "close_code.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	690
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	691 #endif /* _SDL_haptic_h */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	692
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	693 /* vi: set ts=4 sw=4 expandtab: */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	694
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	695

Mercurial > sdl-ios-xcode

annotate include/SDL_haptic.h @ 2497:0893fbf73b3d gsoc2008_force_feedback