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

annotate include/SDL_haptic.h @ 2951:268073d5a40d

Don't check in personal files

author	Sam Lantinga <slouken@libsdl.org>
date	Fri, 02 Jan 2009 01:32:51 +0000
parents	0906692aa6a4
children	d3baf5ac4e37

rev	line source
2713 0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 /*
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2 SDL - Simple DirectMedia Layer
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 Copyright (C) 2008 Edgar Simo
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 This library is free software; you can redistribute it and/or
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 License as published by the Free Software Foundation; either
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 Lesser General Public License for more details.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16 License along with this library; if not, write to the Free Software
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	18
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19 Sam Lantinga
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 slouken@libsdl.org
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 * \file SDL_haptic.h
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	26 * \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	27 * devices.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	28 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	29 * The basic usage is as follows:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	30 * - Initialize the Subsystem (SDL_INIT_HAPTIC).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	31 * - Open a Haptic Device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	32 * - SDL_HapticOpen(...) to open from index.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	33 * - SDL_HapticOpenFromJoystick(...) to open from an existing joystick.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	34 * - Create an effect (SDL_HapticEffect).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	35 * - Upload the effect with SDL_HapticNewEffect(...).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36 * - Run the effect with SDL_HapticRunEffect(...).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 * - (optional) Free the effect with SDL_HapticDestroyEffect(...).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 * - Close the haptic device with SDL_HapticClose(...).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	40 * Example:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43 * int test_haptic( SDL_Joystick * joystick ) {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 * SDL_Haptic *haptic;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 * SDL_HapticEffect effect;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46 * int effect_id;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	48 * // Open the device
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	49 * haptic = SDL_HapticOpenFromJoystick( joystick );
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	50 * if (haptic == NULL) return -1; // Most likely joystick isn't haptic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	51 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	52 * // See if it can do sine waves
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	53 * if ((SDL_HapticQuery(haptic) & SDL_HAPTIC_SINE)==0) {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	54 * SDL_HapticClose(haptic); // No sine effect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	55 * return -1;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	56 * }
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	57 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58 * // Create the effect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	59 * memset( &effect, 0, sizeof(SDL_HapticEffect) ); // 0 is safe default
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	60 * effect.type = SDL_HAPTIC_SINE;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	61 * effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 * effect.periodic.direction.dir[0] = 18000; // Force comes from south
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63 * effect.periodic.period = 1000; // 1000 ms
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	64 * effect.periodic.magnitude = 20000; // 20000/32767 strength
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65 * effect.periodic.length = 5000; // 5 seconds long
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 * effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	67 * effect.periodic.fade_length = 1000; // Takes 1 second to fade away
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	69 * // Upload the effect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	70 * effect_id = SDL_HapticNewEffect( haptic, &effect );
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	72 * // Test the effect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 * SDL_HapticRunEffect( haptic, effect_id, 1 );
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	74 * SDL_Delay( 5000); // Wait for the effect to finish
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	75 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	76 * // We destroy the effect, although closing the device also does this
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77 * SDL_HapticDestroyEffect( haptic, effect_id );
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 * // Close the device
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 * SDL_HapticClose(haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82 * return 0; // Success
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 * }
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 * \author Edgar Simo Serra
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89 #ifndef _SDL_haptic_h
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	90 #define _SDL_haptic_h
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	91
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	92 #include "SDL_stdinc.h"
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93 #include "SDL_error.h"
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	94 #include "SDL_joystick.h"
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96 #include "begin_code.h"
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97 /* Set up for C function definitions, even when using C++ */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98 #ifdef __cplusplus
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 /* INDENT-OFF */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 extern "C" {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 /* INDENT-ON */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102 #endif /* __cplusplus */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105 * \typedef SDL_Haptic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 * \brief The haptic structure used to identify an SDL haptic.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 * \sa SDL_HapticOpen
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110 * \sa SDL_HapticOpenFromJoystick
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111 * \sa SDL_HapticClose
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	112 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 struct _SDL_Haptic;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114 typedef struct _SDL_Haptic SDL_Haptic;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	117 /*
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	118 * Different haptic features a device can have.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 * \def SDL_HAPTIC_CONSTANT
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 * \brief Constant haptic effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 #define SDL_HAPTIC_CONSTANT (1<<0) /* Constant effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 * \def SDL_HAPTIC_SINE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	130 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	131 * \brief Periodic haptic effect that simulates sine waves.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	132 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	133 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	134 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	135 #define SDL_HAPTIC_SINE (1<<1) /* Sine wave effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	136 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 * \def SDL_HAPTIC_SQUARE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	138 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	139 * \brief Periodic haptic effect that simulates square waves.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	140 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	141 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	142 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	143 #define SDL_HAPTIC_SQUARE (1<<2) /* Square wave effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	144 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	145 * \def SDL_HAPTIC_TRIANGLE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	146 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	147 * \brief Periodic haptic effect that simulates triangular waves.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	148 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	149 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	150 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	151 #define SDL_HAPTIC_TRIANGLE (1<<3) /* Triangle wave effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	152 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	153 * \def SDL_HAPTIC_SAWTOOTHUP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	154 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	155 * \brief Periodic haptic effect that simulates saw tooth up waves.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	156 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	159 #define SDL_HAPTIC_SAWTOOTHUP (1<<4) /* Sawtoothup wave effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	161 * \def SDL_HAPTIC_SAWTOOTHDOWN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	162 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	163 * \brief Periodic haptic effect that simulates saw tooth down waves.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	164 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	165 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	166 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	167 #define SDL_HAPTIC_SAWTOOTHDOWN (1<<5) /* Sawtoothdown wave effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	168 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	169 * \def SDL_HAPTIC_RAMP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	170 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	171 * \brief Ramp haptic effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	172 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	173 * \sa SDL_HapticRamp
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	174 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	175 #define SDL_HAPTIC_RAMP (1<<6) /* Ramp effect supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	176 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	177 * \def SDL_HAPTIC_SPRING
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	178 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	179 * \brief Condition haptic effect that simulates a spring. Effect is based on the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	180 * axes position.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	181 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	182 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	183 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	184 #define SDL_HAPTIC_SPRING (1<<7) /* Spring effect supported - uses axes position */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	185 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	186 * \def SDL_HAPTIC_DAMPER
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	187 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	188 * \brief Condition haptic effect that simulates dampening. Effect is based on the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	189 * axes velocity.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	190 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	191 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	192 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	193 #define SDL_HAPTIC_DAMPER (1<<8) /* Damper effect supported - uses axes velocity */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	194 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	195 * \def SDL_HAPTIC_INERTIA
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	196 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	197 * \brief Condition haptic effect that simulates inertia. Effect is based on the axes
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	198 * acceleration.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	199 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	200 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	201 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	202 #define SDL_HAPTIC_INERTIA (1<<9) /* Inertia effect supported - uses axes acceleration */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	203 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	204 * \def SDL_HAPTIC_FRICTION
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	205 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	206 * \brief Condition haptic effect that simulates friction. Effect is based on the axes
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	207 * movement.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	208 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	209 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	210 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	211 #define SDL_HAPTIC_FRICTION (1<<10) /* Friction effect supported - uses axes movement */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	212 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	213 * \def SDL_HAPTIC_CUSTOM
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	214 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	215 * \brief User defined custom haptic effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	216 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	217 #define SDL_HAPTIC_CUSTOM (1<<11) /* Custom effect is supported */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	218 /* These last two are features the device has, not effects */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	219 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	220 * \def SDL_HAPTIC_GAIN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	221 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	222 * \brief Device supports setting the global gain.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	223 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	224 * \sa SDL_HapticSetGain
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	225 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	226 #define SDL_HAPTIC_GAIN (1<<12) /* Device can set global gain */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	227 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	228 * \def SDL_HAPTIC_AUTOCENTER
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	229 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	230 * \brief Device supports setting autocenter.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	231 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	232 * \sa SDL_HapticSetAutocenter
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	233 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	234 #define SDL_HAPTIC_AUTOCENTER (1<<13) /* Device can set autocenter */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	235 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	236 * \def SDL_HAPTIC_STATUS
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	237 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	238 * \brief Device can be queried for effect status.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	239 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	240 * \sa SDL_HapticGetEffectStatus
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	241 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	242 #define SDL_HAPTIC_STATUS (1<<14) /* Device can be queried for effect status */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	243 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	244 * \def SDL_HAPTIC_PAUSE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	245 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	246 * \brief Device can be paused.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	247 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	248 * \sa SDL_HapticPause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	249 * \sa SDL_HapticUnpause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	250 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	251 #define SDL_HAPTIC_PAUSE (1<<15) /* Device can be paused. */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	252
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	253
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	254 /*
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	255 * Direction encodings
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	256 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	257 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	258 * \def SDL_HAPTIC_POLAR
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	259 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	260 * \brief Uses polar coordinates for the direction.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	261 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	262 * \sa SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	263 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	264 #define SDL_HAPTIC_POLAR 0
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	265 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	266 * \def SDL_HAPTIC_CARTESIAN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	267 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	268 * \brief Uses cartesian coordinates for the direction.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	269 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	270 * \sa SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	271 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	272 #define SDL_HAPTIC_CARTESIAN 1
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	273 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	274 * \def SDL_HAPTIC_SPHERICAL
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	275 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	276 * \brief Uses spherical coordinates for the direction.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	277 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	278 * \sa SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	279 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	280 #define SDL_HAPTIC_SPHERICAL 2
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	281
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	282
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	283 /*
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	284 * Misc defines.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	285 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	286 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	287 * \def SDL_HAPTIC_INFINITY
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	288 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	289 * \brief Used to play a device an infinite number of times.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	290 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	291 * \sa SDL_HapticRunEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	292 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	293 #define SDL_HAPTIC_INFINITY 4294967295U
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	294
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	295
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	296 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	297 * \struct SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	298 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	299 * \brief Structure that represents a haptic direction.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	300 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	301 * Directions can be specified by:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	302 * - SDL_HAPTIC_POLAR : Specified by polar coordinates.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	303 * - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	304 * - SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	305 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	306 * Cardinal directions of the haptic device are relative to the positioning
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	307 * of the device. North is considered to be away from the user.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	308 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	309 * The following diagram represents the cardinal directions:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	310 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	311 * .--.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	312 * \|__\| .-------.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	313 * \|=.\| \|.-----.\|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	314 * \|--\| \|\| \|\|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	315 * \| \| \|'-----'\|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	316 * \|__\|~')_____('
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	317 * [ COMPUTER ]
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	318 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	319 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	320 * North (0,-1)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	321 * ^
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	322 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	323 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	324 * (1,0) West <----[ HAPTIC ]----> East (-1,0)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	325 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	326 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	327 * v
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	328 * South (0,1)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	329 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	330 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	331 * [ USER ]
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	332 * \\|\|\|/
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	333 * (o o)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	334 * ---ooO-(_)-Ooo---
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	335 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	336 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	337 * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	338 * degree starting north and turning clockwise. SDL_HAPTIC_POLAR only uses
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	339 * the first dir parameter. The cardinal directions would be:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	340 * - North: 0 (0 degrees)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	341 * - East: 9000 (90 degrees)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	342 * - South: 18000 (180 degrees)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	343 * - West: 27000 (270 degrees)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	344 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	345 * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by three positions
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	346 * (X axis, Y axis and Z axis (with 3 axes)). SDL_HAPTIC_CARTESIAN uses
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	347 * the first three dir parameters. The cardinal directions would be:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	348 * - North: 0,-1, 0
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	349 * - East: -1, 0, 0
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	350 * - South: 0, 1, 0
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	351 * - West: 1, 0, 0
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	352 * The Z axis represents the height of the effect if supported, otherwise
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	353 * it's unused. In cartesian encoding (1,2) would be the same as (2,4), you
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	354 * can use any multiple you want, only the direction matters.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	355 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	356 * If type is SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	357 * The first two dir parameters are used. The dir parameters are as follows
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	358 * (all values are in hundredths of degrees):
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	359 * 1) Degrees from (1, 0) rotated towards (0, 1).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	360 * 2) Degrees towards (0, 0, 1) (device needs at least 3 axes).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	361 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	362 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	363 * Example of force coming from the south with all encodings (force coming
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	364 * from the south means the user will have to pull the stick to counteract):
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	365 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	366 * SDL_HapticDirection direction;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	367 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	368 * // Cartesian directions
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	369 * direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	370 * direction.dir[0] = 0; // X position
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	371 * direction.dir[1] = 1; // Y position
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	372 * // Assuming the device has 2 axes, we don't need to specify third parameter.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	373 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	374 * // Polar directions
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	375 * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	376 * direction.dir[0] = 18000; // Polar only uses first parameter
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	377 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	378 * // Spherical coordinates
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	379 * direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	380 * direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	381 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	382 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	383 * \sa SDL_HAPTIC_POLAR
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	384 * \sa SDL_HAPTIC_CARTESIAN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	385 * \sa SDL_HAPTIC_SPHERICAL
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	386 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	387 * \sa SDL_HapticNumAxes
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	388 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	389 typedef struct SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	390 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	391 Uint8 type; /*< The type of encoding. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	392 Uint16 dir[3]; /*< The encoded direction. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	393 } SDL_HapticDirection;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	394
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	395
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	396 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	397 * \struct SDL_HapticConstant
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	398 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	399 * \brief A structure containing a template for a Constant effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	400 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	401 * The struct is exclusive to the SDL_HAPTIC_CONSTANT effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	402 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	403 * A constant effect applies a constant force in the specified direction
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	404 * to the joystick.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	405 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	406 * \sa SDL_HAPTIC_CONSTANT
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	407 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	408 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	409 typedef struct SDL_HapticConstant
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	410 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	411 /* Header */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	412 Uint16 type; /*< SDL_HAPTIC_CONSTANT /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	413 SDL_HapticDirection direction; /*< Direction of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	414
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	415 /* Replay */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	416 Uint32 length; /*< Duration of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	417 Uint16 delay; /*< Delay before starting the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	418
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	419 /* Trigger */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	420 Uint16 button; /*< Button that triggers the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	421 Uint16 interval; /*< How soon it can be triggered again after button. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	422
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	423 /* Constant */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	424 Sint16 level; /*< Strength of the constant effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	425
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	426 /* Envelope */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	427 Uint16 attack_length; /*< Duration of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	428 Uint16 attack_level; /*< Level at the start of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	429 Uint16 fade_length; /*< Duration of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	430 Uint16 fade_level; /*< Level at the end of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	431 } SDL_HapticConstant;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	432 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	433 * \struct SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	434 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	435 * \brief A structure containing a template for a Periodic effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	436 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	437 * The struct handles the following effects:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	438 * - SDL_HAPTIC_SINE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	439 * - SDL_HAPTIC_SQUARE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	440 * - SDL_HAPTIC_TRIANGLE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	441 * - SDL_HAPTIC_SAWTOOTHUP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	442 * - SDL_HAPTIC_SAWTOOTHDOWN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	443 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	444 * A periodic effect consists in a wave-shaped effect that repeats itself
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	445 * over time. The type determines the shape of the wave and the parameters
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	446 * determine the dimensions of the wave.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	447 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	448 * Phase is given by hundredth of a cyle meaning that giving the phase a value
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	449 * of 9000 will displace it 25% of it's period. Here are sample values:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	450 * - 0: No phase displacement.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	451 * - 9000: Displaced 25% of it's period.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	452 * - 18000: Displaced 50% of it's period.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	453 * - 27000: Displaced 75% of it's period.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	454 * - 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	455 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	456 * Examples:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	457 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	458 * SDL_HAPTIC_SINE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	459 * __ __ __ __
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	460 * / \ / \ / \ /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	461 * / \__/ \__/ \__/
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	462 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	463 * SDL_HAPTIC_SQUARE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	464 * __ __ __ __ __
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	465 * \| \| \| \| \| \| \| \| \| \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	466 * \| \|__\| \|__\| \|__\| \|__\| \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	467 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	468 * SDL_HAPTIC_TRIANGLE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	469 * /\ /\ /\ /\ /\
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	470 * / \ / \ / \ / \ /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	471 * / \/ \/ \/ \/
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	472 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	473 * SDL_HAPTIC_SAWTOOTHUP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	474 * /\| /\| /\| /\| /\| /\| /\|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	475 * / \| / \| / \| / \| / \| / \| / \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	476 * / \|/ \|/ \|/ \|/ \|/ \|/ \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	477 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	478 * SDL_HAPTIC_SAWTOOTHDOWN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	479 * \ \|\ \|\ \|\ \|\ \|\ \|\ \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	480 * \ \| \ \| \ \| \ \| \ \| \ \| \ \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	481 * \\| \\| \\| \\| \\| \\| \\|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	482 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	483 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	484 * \sa SDL_HAPTIC_SINE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	485 * \sa SDL_HAPTIC_SQUARE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	486 * \sa SDL_HAPTIC_TRIANGLE
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	487 * \sa SDL_HAPTIC_SAWTOOTHUP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	488 * \sa SDL_HAPTIC_SAWTOOTHDOWN
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	489 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	490 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	491 typedef struct SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	492 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	493 /* Header */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	494 Uint16 type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	495 SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	496 SDL_HAPTIC_SAWTOOTHDOWN */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	497 SDL_HapticDirection direction; /*< Direction of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	498
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	499 /* Replay */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	500 Uint32 length; /*< Duration of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	501 Uint16 delay; /*< Delay before starting the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	502
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	503 /* Trigger */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	504 Uint16 button; /*< Button that triggers the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	505 Uint16 interval; /*< How soon it can be triggered again after button. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	506
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	507 /* Periodic */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	508 Uint16 period; /*< Period of the wave. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	509 Sint16 magnitude; /*< Peak value. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	510 Sint16 offset; /*< Mean value of the wave. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	511 Uint16 phase; /*< Horizontal shift given by hundredth of a cycle. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	512
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	513 /* Envelope */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	514 Uint16 attack_length; /*< Duration of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	515 Uint16 attack_level; /*< Level at the start of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	516 Uint16 fade_length; /*< Duration of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	517 Uint16 fade_level; /*< Level at the end of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	518 } SDL_HapticPeriodic;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	519 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	520 * \struct SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	521 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	522 * \brief A structure containing a template for a Condition effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	523 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	524 * The struct handles the following effects:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	525 * - SDL_HAPTIC_SPRING: Effect based on axes position.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	526 * - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	527 * - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	528 * - SDL_HAPTIC_FRICTION: Effect based on axes movement.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	529 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	530 * Direction is handled by condition internals instead of a direction member.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	531 * The condition effect specific members have three parameters. The first
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	532 * refers to the X axis, the second refers to the Y axis and the third
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	533 * refers to the Z axis. The right terms refer to the positive side of the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	534 * axis and the left terms refer to the negative side of the axis. Please
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	535 * refer to the SDL_HapticDirection diagram for which side is positive and
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	536 * which is negative.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	537 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	538 * \sa SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	539 * \sa SDL_HAPTIC_SPRING
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	540 * \sa SDL_HAPTIC_DAMPER
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	541 * \sa SDL_HAPTIC_INERTIA
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	542 * \sa SDL_HAPTIC_FRICTION
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	543 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	544 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	545 typedef struct SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	546 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	547 /* Header */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	548 Uint16 type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	549 SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	550 SDL_HapticDirection direction; /*< Direction of the effect - Not used ATM. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	551
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	552 /* Replay */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	553 Uint32 length; /*< Duration of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	554 Uint16 delay; /*< Delay before starting the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	555
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	556 /* Trigger */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	557 Uint16 button; /*< Button that triggers the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	558 Uint16 interval; /*< How soon it can be triggered again after button. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	559
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	560 /* Condition */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	561 Uint16 right_sat[3]; /*< Level when joystick is to the positive side. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	562 Uint16 left_sat[3]; /*< Level when joystick is to the negative side. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	563 Sint16 right_coeff[3]; /*< How fast to increase the force towards the positive side. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	564 Sint16 left_coeff[3]; /*< How fast to increase the force towards the negative side. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	565 Uint16 deadband[3]; /*< Size of the dead zone. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	566 Sint16 center[3]; /*< Position of the dead zone. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	567 } SDL_HapticCondition;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	568 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	569 * \struct SDL_HapticRamp
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	570 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	571 * \brief A structure containing a template for a Ramp effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	572 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	573 * This struct is exclusively for the SDL_HAPTIC_RAMP effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	574 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	575 * The ramp effect starts at start strength and ends at end strength.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	576 * It augments in linear fashion. If you use attack and fade with a ramp
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	577 * they effects get added to the ramp effect making the effect become
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	578 * quadratic instead of linear.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	579 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	580 * \sa SDL_HAPTIC_RAMP
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	581 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	582 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	583 typedef struct SDL_HapticRamp
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	584 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	585 /* Header */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	586 Uint16 type; /*< SDL_HAPTIC_RAMP /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	587 SDL_HapticDirection direction; /*< Direction of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	588
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	589 /* Replay */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	590 Uint32 length; /*< Duration of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	591 Uint16 delay; /*< Delay before starting the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	592
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	593 /* Trigger */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	594 Uint16 button; /*< Button that triggers the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	595 Uint16 interval; /*< How soon it can be triggered again after button. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	596
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	597 /* Ramp */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	598 Sint16 start; /*< Beginning strength level. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	599 Sint16 end; /*< Ending strength level. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	600
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	601 /* Envelope */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	602 Uint16 attack_length; /*< Duration of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	603 Uint16 attack_level; /*< Level at the start of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	604 Uint16 fade_length; /*< Duration of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	605 Uint16 fade_level; /*< Level at the end of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	606 } SDL_HapticRamp;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	607 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	608 * \struct SDL_HapticCustom
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	609 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	610 * \brief A structure containing a template for the SDL_HAPTIC_CUSTOM effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	611 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	612 * A custom force feedback effect is much like a periodic effect, where the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	613 * application can define it's exact shape. You will have to allocate the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	614 * data yourself. Data should consist of channels * samples Uint16 samples.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	615 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	616 * If channels is one, the effect is rotated using the defined direction.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	617 * Otherwise it uses the samples in data for the different axes.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	618 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	619 * \sa SDL_HAPTIC_CUSTOM
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	620 * \sa SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	621 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	622 typedef struct SDL_HapticCustom
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	623 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	624 /* Header */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	625 Uint16 type; /*< SDL_HAPTIC_CUSTOM /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	626 SDL_HapticDirection direction; /*< Direction of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	627
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	628 /* Replay */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	629 Uint32 length; /*< Duration of the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	630 Uint16 delay; /*< Delay before starting the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	631
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	632 /* Trigger */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	633 Uint16 button; /*< Button that triggers the effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	634 Uint16 interval; /*< How soon it can be triggered again after button. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	635
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	636 /* Custom */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	637 Uint8 channels; /*< Axes to use, minimum of one. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	638 Uint16 period; /*< Sample periods. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	639 Uint16 samples; /*< Amount of samples. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	640 Uint16 data; /< Should contain channelssamples items. */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	641
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	642 /* Envelope */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	643 Uint16 attack_length; /*< Duration of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	644 Uint16 attack_level; /*< Level at the start of the attack. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	645 Uint16 fade_length; /*< Duration of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	646 Uint16 fade_level; /*< Level at the end of the fade. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	647 } SDL_HapticCustom;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	648 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	649 * \union SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	650 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	651 * \brief The generic template for any haptic effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	652 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	653 * All values max at 32767 (0x7FFF). Signed values also can be negative.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	654 * Time values unless specified otherwise are in milliseconds.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	655 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	656 * You can also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	657 * Neither delay, interval, attack_length nor fade_length support
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	658 * SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	659 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	660 * Additionally, the SDL_HAPTIC_RAMP effect does not support a duration of
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	661 * SDL_HAPTIC_INFINITY.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	662 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	663 * Button triggers may not be supported on all devices, it is advised to not
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	664 * use them if possible. Buttons start at index 1 instead of index 0 like
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	665 * they joystick.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	666 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	667 * If both attack_length and fade_level are 0, the envelope is not used,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	668 * otherwise both values are used.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	669 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	670 * Common parts:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	671 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	672 * // Replay - All effects have this
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	673 * Uint32 length; // Duration of effect (ms).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	674 * Uint16 delay; // Delay before starting effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	675 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	676 * // Trigger - All effects have this
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	677 * Uint16 button; // Button that triggers effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	678 * Uint16 interval; // How soon before effect can be triggered again.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	679 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	680 * // Envelope - All effects except condition effects have this
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	681 * Uint16 attack_length; // Duration of the attack (ms).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	682 * Uint16 attack_level; // Level at the start of the attack.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	683 * Uint16 fade_length; // Duration of the fade out (ms).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	684 * Uint16 fade_level; // Level at the end of the fade.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	685 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	686 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	687 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	688 * Here we have an example of a constant effect evolution in time:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	689 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	690 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	691 * Strength
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	692 * ^
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	693 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	694 * \| effect level --> _________________
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	695 * \| / \
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	696 * \| / \
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	697 * \| / \
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	698 * \| / \
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	699 * \| attack_level --> \| \
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	700 * \| \| \| <--- fade_level
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	701 * \|
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	702 * +--------------------------------------------------> Time
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	703 * [--] [---]
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	704 * attack_length fade_length
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	705 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	706 * [------------------][-----------------------]
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	707 * delay length
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	708 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	709 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	710 * Note either the attack_level or the fade_level may be above the actual
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	711 * effect level.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	712 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	713 * \sa SDL_HapticConstant
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	714 * \sa SDL_HapticPeriodic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	715 * \sa SDL_HapticCondition
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	716 * \sa SDL_HapticRamp
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	717 * \sa SDL_HapticCustom
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	718 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	719 typedef union SDL_HapticEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	720 {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	721 /* Common for all force feedback effects */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	722 Uint16 type; /*< Effect type. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	723 SDL_HapticConstant constant; /*< Constant effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	724 SDL_HapticPeriodic periodic; /*< Periodic effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	725 SDL_HapticCondition condition; /*< Condition effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	726 SDL_HapticRamp ramp; /*< Ramp effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	727 SDL_HapticCustom custom; /*< Custom effect. /
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	728 } SDL_HapticEffect;
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	729
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	730
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	731 /* Function prototypes */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	732 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	733 * \fn int SDL_NumHaptics(void)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	734 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	735 * \brief Count the number of joysticks attached to the system.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	736 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	737 * \return Number of haptic devices detected on the system.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	738 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	739 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	740
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	741 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	742 * \fn const char * SDL_HapticName(int device_index)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	743 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	744 * \brief Get the implementation dependent name of a Haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	745 * This can be called before any joysticks are opened.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	746 * If no name can be found, this function returns NULL.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	747 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	748 * \param device_index Index of the device to get it's name.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	749 * \return Name of the device or NULL on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	750 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	751 * \sa SDL_NumHaptics
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	752 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	753 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	754
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	755 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	756 * \fn SDL_Haptic * SDL_HapticOpen(int device_index)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	757 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	758 * \brief Opens a Haptic device for usage - the index passed as an
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	759 * argument refers to the N'th Haptic device on this system.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	760 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	761 * When opening a haptic device, it's gain will be set to maximum and
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	762 * autocenter will be disabled. To modify these values use
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	763 * SDL_HapticSetGain and SDL_HapticSetAutocenter
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	764 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	765 * \param device_index Index of the device to open.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	766 * \return Device identifier or NULL on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	767 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	768 * \sa SDL_HapticIndex
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	769 * \sa SDL_HapticOpenFromMouse
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	770 * \sa SDL_HapticOpenFromJoystick
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	771 * \sa SDL_HapticClose
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	772 * \sa SDL_HapticSetGain
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	773 * \sa SDL_HapticSetAutocenter
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	774 * \sa SDL_HapticPause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	775 * \sa SDL_HapticStopAll
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	776 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	777 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	778
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	779 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	780 * \fn int SDL_HapticOpened(int device_index)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	781 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	782 * \brief Checks if the haptic device at index has been opened.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	783 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	784 * \param device_index Index to check to see if it has been opened.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	785 * \return 1 if it has been opened or 0 if it hasn't.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	786 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	787 * \sa SDL_HapticOpen
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	788 * \sa SDL_HapticIndex
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	789 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	790 extern DECLSPEC int SDLCALL SDL_HapticOpened(int device_index);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	791
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	792 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	793 * \fn int SDL_HapticIndex(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	794 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	795 * \brief Gets the index of a haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	796 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	797 * \param haptic Haptic device to get the index of.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	798 * \return The index of the haptic device or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	799 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	800 * \sa SDL_HapticOpen
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	801 * \sa SDL_HapticOpened
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	802 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	803 extern DECLSPEC int SDLCALL SDL_HapticIndex(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	804
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	805 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	806 * \fn int SDL_MouseIsHaptic(void)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	807 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	808 * \brief Gets whether or not the current mouse has haptic capabilities.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	809 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	810 * \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	811 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	812 * \sa SDL_HapticOpenFromMouse
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	813 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	814 extern DECLSPEC int SDLCALL SDL_MouseIsHaptic(void);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	815
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	816 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	817 * \fn SDL_Haptic * SDL_HapticOpenFromMouse(void)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	818 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	819 * \brief Tries to open a haptic device from the current mouse.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	820 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	821 * \return The haptic device identifier or NULL on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	822 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	823 * \sa SDL_MouseIsHaptic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	824 * \sa SDL_HapticOpen
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	825 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	826 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpenFromMouse(void);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	827
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	828 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	829 * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	830 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	831 * \brief Checks to see if a joystick has haptic features.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	832 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	833 * \param joystick Joystick to test for haptic capabilities.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	834 * \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	835 * or -1 if an error ocurred.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	836 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	837 * \sa SDL_HapticOpenFromJoystick
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	838 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	839 extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	840
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	841 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	842 * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	843 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	844 * \brief Opens a Haptic device for usage from a Joystick device. Still has
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	845 * to be closed seperately to the joystick.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	846 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	847 * When opening from a joystick you should first close the haptic device before
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	848 * closing the joystick device. If not, on some implementations the haptic
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	849 * device will also get unallocated and you'll be unable to use force feedback
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	850 * on that device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	851 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	852 * \param joystick Joystick to create a haptic device from.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	853 * \return A valid haptic device identifier on success or NULL on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	854 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	855 * \sa SDL_HapticOpen
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	856 * \sa SDL_HapticClose
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	857 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	858 extern DECLSPEC SDL_Haptic SDLCALL SDL_HapticOpenFromJoystick(SDL_Joystick
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	859 joystick);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	860
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	861 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	862 * \fn void SDL_HapticClose(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	863 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	864 * \brief Closes a Haptic device previously opened with SDL_HapticOpen.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	865 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	866 * \param haptic Haptic device to close.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	867 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	868 extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	869
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	870 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	871 * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	872 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	873 * \brief Returns the number of effects a haptic device can store.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	874 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	875 * On some platforms this isn't fully supported, and therefore is an
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	876 * aproximation. Always check to see if your created effect was actually
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	877 * created and do not rely solely on HapticNumEffects.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	878 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	879 * \param haptic The haptic device to query effect max.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	880 * \return The number of effects the haptic device can store or
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	881 * -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	882 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	883 * \sa SDL_HapticNumEffectsPlaying
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	884 * \sa SDL_HapticQuery
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	885 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	886 extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	887
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	888 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	889 * \fn int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	890 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	891 * \brief Returns the number of effects a haptic device can play at the same time.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	892 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	893 * This is not supported on all platforms, but will always return a value. Added
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	894 * here for the sake of completness.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	895 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	896 * \param haptic The haptic device to query maximum playing effect.s
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	897 * \return The number of effects the haptic device can play at the same time
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	898 * or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	899 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	900 * \sa SDL_HapticNumEffects
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	901 * \sa SDL_HapticQuery
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	902 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	903 extern DECLSPEC int SDLCALL SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	904
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	905 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	906 * \fn unsigned int SDL_HapticQuery(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	907 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	908 * \brief Gets the haptic devices supported features in bitwise matter.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	909 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	910 * Example:
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	911 * \code
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	912 * if (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT) {
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	913 * printf("We have constant haptic effect!");
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	914 * }
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	915 * \endcode
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	916 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	917 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	918 * \param haptic The haptic device to query.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	919 * \return Haptic features in bitwise manner (OR'd).
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	920 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	921 * \sa SDL_HapticNumEffects
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	922 * \sa SDL_HapticEffectSupported
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	923 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	924 extern DECLSPEC unsigned int SDLCALL SDL_HapticQuery(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	925
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	926
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	927 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	928 * \fn int SDL_HapticNumAxes(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	929 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	930 * \brief Gets the number of haptic axes the device has.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	931 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	932 * \sa SDL_HapticDirection
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	933 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	934 extern DECLSPEC int SDLCALL SDL_HapticNumAxes(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	935
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	936 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	937 * \fn int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	938 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	939 * \brief Checks to see if effect is supported by haptic.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	940 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	941 * \param haptic Haptic device to check on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	942 * \param effect Effect to check to see if it is supported.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	943 * \return SDL_TRUE if effect is supported, SDL_FALSE if it isn't or
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	944 * -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	945 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	946 * \sa SDL_HapticQuery
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	947 * \sa SDL_HapticNewEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	948 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	949 extern DECLSPEC int SDLCALL SDL_HapticEffectSupported(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	950 SDL_HapticEffect *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	951 effect);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	952
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	953 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	954 * \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	955 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	956 * \brief Creates a new haptic effect on the device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	957 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	958 * \param haptic Haptic device to create the effect on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	959 * \param effect Properties of the effect to create.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	960 * \return The id of the effect on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	961 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	962 * \sa SDL_HapticUpdateEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	963 * \sa SDL_HapticRunEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	964 * \sa SDL_HapticDestroyEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	965 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	966 extern DECLSPEC int SDLCALL SDL_HapticNewEffect(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	967 SDL_HapticEffect * effect);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	968
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	969 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	970 * \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	971 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	972 * \brief Updates the properties of an effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	973 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	974 * Can be used dynamically, although behaviour when dynamically changing
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	975 * direction may be strange. Specifically the effect may reupload itself
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	976 * and start playing from the start. You cannot change the type either when
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	977 * running UpdateEffect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	978 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	979 * \param haptic Haptic device that has the effect.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	980 * \param effect Effect to update.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	981 * \param data New effect properties to use.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	982 * \return The id of the effect on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	983 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	984 * \sa SDL_HapticNewEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	985 * \sa SDL_HapticRunEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	986 * \sa SDL_HapticDestroyEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	987 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	988 extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	989 int effect,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	990 SDL_HapticEffect * data);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	991
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	992 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	993 * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	994 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	995 * \brief Runs the haptic effect on it's assosciated haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	996 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	997 * If iterations are SDL_HAPTIC_INFINITY, it'll run the effect over and over
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	998 * repeating the envelope (attack and fade) every time. If you only want the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	999 * effect to last forever, set SDL_HAPTIC_INFINITY in the effect's length
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1000 * parameter.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1001 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1002 * \param haptic Haptic device to run the effect on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1003 * \param effect Identifier of the haptic effect to run.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1004 * \param iterations Number of iterations to run the effect. Use
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1005 * SDL_HAPTIC_INFINITY for infinity.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1006 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1007 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1008 * \sa SDL_HapticStopEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1009 * \sa SDL_HapticDestroyEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1010 * \sa SDL_HapticGetEffectStatus
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1011 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1012 extern DECLSPEC int SDLCALL SDL_HapticRunEffect(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1013 int effect,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1014 Uint32 iterations);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1015
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1016 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1017 * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1018 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1019 * \brief Stops the haptic effect on it's assosciated haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1020 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1021 * \param haptic Haptic device to stop the effect on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1022 * \param effect Identifier of the effect to stop.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1023 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1024 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1025 * \sa SDL_HapticRunEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1026 * \sa SDL_HapticDestroyEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1027 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1028 extern DECLSPEC int SDLCALL SDL_HapticStopEffect(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1029 int effect);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1030
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1031 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1032 * \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1033 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1034 * \brief Destroys a haptic effect on the device. This will stop the effect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1035 * if it's running. Effects are automatically destroyed when the device is
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1036 * closed.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1037 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1038 * \param haptic Device to destroy the effect on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1039 * \param effect Identifier of the effect to destroy.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1040 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1041 * \sa SDL_HapticNewEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1042 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1043 extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1044 int effect);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1045
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1046 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1047 * \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1048 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1049 * \brief Gets the status of the current effect on the haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1050 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1051 * Device must support the SDL_HAPTIC_STATUS feature.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1052 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1053 * \param haptic Haptic device to query the effect status on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1054 * \param effect Identifier of the effect to query it's status.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1055 * \return 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1056 * or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1057 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1058 * \sa SDL_HapticRunEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1059 * \sa SDL_HapticStopEffect
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1060 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1061 extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1062 int effect);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1063
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1064 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1065 * \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1066 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1067 * \brief Sets the global gain of the device. Gain should be between 0 and 100.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1068 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1069 * Device must support the SDL_HAPTIC_GAIN feature.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1070 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1071 * The user may specify the maxmimum gain by setting the environment variable
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1072 * SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1073 * SDL_HapticSetGain will scale linearly using SDL_HAPTIC_GAIN_MAX as the
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1074 * maximum.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1075 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1076 * \param haptic Haptic device to set the gain on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1077 * \param gain Value to set the gain to, should be between 0 and 100.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1078 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1079 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1080 * \sa SDL_HapticQuery
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1081 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1082 extern DECLSPEC int SDLCALL SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1083
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1084 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1085 * \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1086 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1087 * \brief Sets the global autocenter of the device. Autocenter should be between
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1088 * 0 and 100. Setting it to 0 will disable autocentering.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1089 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1090 * Device must support the SDL_HAPTIC_AUTOCENTER feature.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1091 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1092 * \param haptic Haptic device to set autocentering on.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1093 * \param autocenter Value to set autocenter to, 0 disables autocentering.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1094 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1095 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1096 * \sa SDL_HapticQuery
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1097 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1098 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic,
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1099 int autocenter);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1100
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1101 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1102 * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1103 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1104 * \brief Pauses a haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1105 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1106 * Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1107 * to resume playback.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1108 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1109 * Do not modify the effects nor add new ones while the device is paused.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1110 * That can cause all sorts of weird errors.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1111 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1112 * \param haptic Haptic device to pause.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1113 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1114 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1115 * \sa SDL_HapticUnpause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1116 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1117 extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1118
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1119 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1120 * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1121 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1122 * \brief Unpauses a haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1123 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1124 * Call to unpause after SDL_HapticPause.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1125 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1126 * \param haptic Haptic device to pause.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1127 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1128 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1129 * \sa SDL_HapticPause
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1130 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1131 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1132
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1133 /**
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1134 * \fn extern DECSLPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic)
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1135 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1136 * \brief Stops all the currently playing effects on a haptic device.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1137 *
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1138 * \param haptic Haptic device to stop.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1139 * \return 0 on success or -1 on error.
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1140 */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1141 extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1142
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1143
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1144 /* Ends C function definitions when using C++ */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1145 #ifdef __cplusplus
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1146 /* INDENT-OFF */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1147 }
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1148 /* INDENT-ON */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1149 #endif
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1150 #include "close_code.h"
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1151
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1152 #endif /* _SDL_haptic_h */
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1153
0906692aa6a4 Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1154 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_haptic.h @ 2951:268073d5a40d