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