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

annotate include/SDL_haptic.h @ 5230:5d01d426f2ea

It's now possible to disable the fast atomic operations, at a huge performance penalty.

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 07 Feb 2011 22:57:33 -0800
parents	ad4141d88412
children

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

Mercurial > sdl-ios-xcode

annotate include/SDL_haptic.h @ 5230:5d01d426f2ea