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

annotate include/SDL_haptic.h @ 2483:9d52368ebcf5 gsoc2008_force_feedback

Setting effects memory to 0. Added SDL_HapticSetGain().

author	Edgar Simo <bobbens@gmail.com>
date	Tue, 01 Jul 2008 14:09:53 +0000
parents	b51ad78812d5
children	666472fd4cb0

rev	line source
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	1 /*
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	3 Copyright (C) 2008 Edgar Simo
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	4
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	9
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	13 Lesser General Public License for more details.
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	14
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	16 License along with this library; if not, write to the Free Software
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	18
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	19 Sam Lantinga
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	20 slouken@libsdl.org
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	21 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	22
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	23 /**
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	24 * \file SDL_haptic.h
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	25 *
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	26 * Include file for SDL haptic subsystem
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	27 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	28
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	29 #ifndef _SDL_haptic_h
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	30 #define _SDL_haptic_h
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	31
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	32 #include "SDL_stdinc.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	33 #include "SDL_error.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	34
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	35 #include "begin_code.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	36 /* Set up for C function definitions, even when using C++ */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	37 #ifdef __cplusplus
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	38 /* INDENT-OFF */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	39 extern "C" {
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	40 /* INDENT-ON */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	41 #endif
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	42
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	43 /* The haptic structure used to identify an SDL haptic */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	44 struct _SDL_Haptic;
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	45 typedef struct _SDL_Haptic SDL_Haptic;
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	46
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	47
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	48 /* Different effects that can be generated */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	49 #define SDL_HAPTIC_CONSTANT (1<<0)
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	50 #define SDL_HAPTIC_PERIODIC (1<<1)
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	51 #define SDL_HAPTIC_RAMP (1<<2)
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	52 #define SDL_HAPTIC_SPRING (1<<3)
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	53 #define SDL_HAPTIC_FRICTION (1<<4)
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	54 #define SDL_HAPTIC_DAMPER (1<<5)
2482 b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	55 #define SDL_HAPTIC_INERTIA (1<<6)
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	56 #define SDL_HAPTIC_GAIN (1<<7)
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	57 #define SDL_HAPTIC_AUTOCENTER (1<<8)
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	58
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	59 typedef enum SDL_waveform {
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	60 SDL_WAVEFORM_SINE,
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	61 SDL_WAVEFORM_SQUARE,
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	62 SDL_WAVEFORM_TRIANGLE,
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	63 SDL_WAVEFORM_SAWTOOTHUP,
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	64 SDL_WAVEFORM_SAWTOOTHDOWN
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	65 } SDL_waveform;
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	66
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	67
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	68 /*
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	69 * All values max at 32767 (0x7fff). Signed values also can be negative.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	70 * Time values unless specified otherwise are in milliseconds.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	71 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	72 * Common parts:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	73 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	74 * Replay:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	75 * Uint16 length; Duration of effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	76 * Uint16 delay; Delay before starting effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	77 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	78 * Trigger:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	79 * Uint16 button; Button that triggers effect.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	80 * Uint16 interval; How soon before effect can be triggered again.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	81 *
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	82 * Envelope:
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	83 * Uint16 attack_length; Duration of the attack.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	84 * Uint16 attack_level; Level at the start of the attack.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	85 * Uint16 fade_length; Duration of the fade out.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	86 * Uint16 fade_level; Level at the end of the fade.
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	87 */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	88 typedef struct SDL_HapticConstant {
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	89 /* Header */
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	90 Uint16 type; /* SDL_HAPTIC_CONSTANT */
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	91 Uint16 direction;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	92
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	93 /* Replay */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	94 Uint16 length;
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	95 Uint16 delay;
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	96
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	97 /* Trigger */
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	98 Uint16 button;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	99 Uint16 interval;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	100
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	101 /* Constant */
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	102 Sint16 level; /* Strength of the constant effect. */
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	103
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	104 /* Envelope */
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	105 Uint16 attack_length;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	106 Uint16 attack_level;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	107 Uint16 fade_length;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	108 Uint16 fade_level;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	109 } SDL_HapticConstant;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	110 typedef struct SDL_HapticPeriodic {
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	111 /* Header */
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	112 Uint16 type; /* SDL_HAPTIC_PERIODIC */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	113 Uint16 direction;
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	114
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	115 /* Replay */
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	116 Uint16 length;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	117 Uint16 delay;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	118
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	119 /* Trigger */
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	120 Uint16 button;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	121 Uint16 interval;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	122
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	123 /* Periodic */
2481 5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	124 SDL_waveform waveform; /* Type of effect */
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	125 Uint16 period; /* Period of the wave */
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	126 Sint16 magnitude; /* Peak value */
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	127 Sint16 offset; /* Mean value of the wave */
5d0ea4576f20 More comments. Edgar Simo <bobbens@gmail.com> parents: 2480 diff changeset	128 Uint16 phase; /* Horizontal shift */
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	129
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	130 /* Envelope */
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	131 Uint16 attack_length;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	132 Uint16 attack_level;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	133 Uint16 fade_length;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	134 Uint16 fade_level;
b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	135 } SDL_HapticPeriodic;
2482 b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	136 typedef struct SDL_HapticCondition {
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	137 /* Header */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	138 Uint16 type; /* SDL_HAPTIC_{SPRING,DAMPER,INERTIA,FRICTION} */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	139 Uint16 direction;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	140
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	141 /* Replay */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	142 Uint16 length;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	143 Uint16 delay;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	144
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	145 /* Trigger */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	146 Uint16 button;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	147 Uint16 interval;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	148
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	149 /* Condition */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	150 Uint16 right_sat; /* Level when joystick is to the right. */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	151 Uint16 left_sat; /* Level when joystick is to the left */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	152 Sint16 right_coeff; /* How fast to increase the force towards the right */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	153 Sint16 left_coeff; /* How fast to increase the force towards the left */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	154 Uint16 deadband; /* Size of the dead zone */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	155 Sint16 center; /* Position of the dead zone */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	156
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	157 } SDL_HapticCondition;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	158 typedef struct SDL_HapticRamp {
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	159 /* Header */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	160 Uint16 type; /* SDL_HAPTIC_RAMP */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	161 Uint16 direction;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	162
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	163 /* Replay */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	164 Uint16 length;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	165 Uint16 delay;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	166
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	167 /* Trigger */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	168 Uint16 button;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	169 Uint16 interval;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	170
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	171 /* Ramp */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	172 Sint16 start;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	173 Sint16 end;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	174
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	175 /* Envelope */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	176 Uint16 attack_length;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	177 Uint16 attack_level;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	178 Uint16 fade_length;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	179 Uint16 fade_level;
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	180
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	181 } SDL_HapticRamp;
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	182
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	183 typedef union SDL_HapticEffect {
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	184 /* Common for all force feedback effects */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	185 Uint16 type; /* Effect type */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	186 SDL_HapticConstant constant; /* Constant effect */
2480 b883974445fc Some more error reporting. Edgar Simo <bobbens@gmail.com> parents: 2478 diff changeset	187 SDL_HapticPeriodic periodic; /* Periodic effect */
2482 b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	188 SDL_HapticCondition condition; /* Condition effect */
b51ad78812d5 Removed the linux only SDL_HAPTIC_RUMBLE (use PERIODIC instead). Edgar Simo <bobbens@gmail.com> parents: 2481 diff changeset	189 SDL_HapticRamp ramp; /* Ramp effect */
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	190 } SDL_HapticEffect;
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	191
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	192
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	193 /* Function prototypes */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	194 /*
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	195 * Count the number of joysticks attached to the system
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	196 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	197 extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	198
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	199 /*
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	200 * Get the implementation dependent name of a Haptic device.
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	201 * This can be called before any joysticks are opened.
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	202 * If no name can be found, this function returns NULL.
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	203 */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	204 extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	205
2476 242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	206 /*
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	207 * Opens a Haptic device for usage - the index passed as an
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	208 * argument refers to the N'th Haptic device on this system.
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	209 *
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	210 * This function returns a Haptic device identifier, or Null
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	211 * if an error occurred.
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	212 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	213 extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	214
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	215 /*
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	216 * Closes a Haptic device previously opened with SDL_HapticOpen.
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	217 */
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	218 extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
242d8a668ebb * Implemented opening and closing of haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2472 diff changeset	219
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	220 /*
2478 4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	221 * Returns the number of effects a haptic device can store.
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	222 */
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	223 extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	224
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	225 /*
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	226 * Returns the supported effects. Individual effects can be queried by
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	227 * bitwise operators.
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	228 *
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	229 * Example: (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT)
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	230 */
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	231 extern DECLSPEC unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic);
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	232
4fd783e0f34b Added query functions for haptic devices. Edgar Simo <bobbens@gmail.com> parents: 2477 diff changeset	233 /*
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	234 * Creates a new haptic effect on the device.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	235 *
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	236 * Returns the id of the effect on success, -1 on failure.
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	237 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	238 extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	239
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	240 /*
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	241 * Runs the haptic effect on it's assosciated haptic device.
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	242 *
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	243 * Returns 0 on success or -1 on failure.
2477 97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	244 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	245 extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	246
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	247 /*
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	248 * Destroys a haptic effect on the device.
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	249 */
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	250 extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
97f75ea43a93 Starting to add infrastructure to handle haptic effects. Edgar Simo <bobbens@gmail.com> parents: 2476 diff changeset	251
2483 9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	252 /*
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	253 * Sets the global gain of the device. Gain should be between 0 and 100.
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	254 *
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	255 * Returns 0 on success or -1 on failure.
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	256 */
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	257 extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
9d52368ebcf5 Setting effects memory to 0. Edgar Simo <bobbens@gmail.com> parents: 2482 diff changeset	258
2472 3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	259
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	260 /* Ends C function definitions when using C++ */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	261 #ifdef __cplusplus
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	262 /* INDENT-OFF */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	263 }
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	264 /* INDENT-ON */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	265 #endif
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	266 #include "close_code.h"
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	267
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	268 #endif /* _SDL_haptic_h */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	269
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	270 /* vi: set ts=4 sw=4 expandtab: */
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	271
3f73c88c9abb First commit of the SDL_haptic subsystem. Edgar Simo <bobbens@gmail.com> parents: diff changeset	272

Mercurial > sdl-ios-xcode

annotate include/SDL_haptic.h @ 2483:9d52368ebcf5 gsoc2008_force_feedback