include/SDL_haptic.h
changeset 10956 d9b0b7d337b9
parent 10737 3406a0f8b041
child 11811 5d94cb6b24d3
     1.1 --- a/include/SDL_haptic.h	Sat Apr 01 00:46:42 2017 -0400
     1.2 +++ b/include/SDL_haptic.h	Sun Apr 02 21:32:49 2017 +0200
     1.3 @@ -22,12 +22,12 @@
     1.4  /**
     1.5   *  \file SDL_haptic.h
     1.6   *
     1.7 - *  \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
     1.8 + *  \brief The SDL haptic subsystem allows you to control haptic (force feedback)
     1.9   *         devices.
    1.10   *
    1.11   *  The basic usage is as follows:
    1.12 - *   - Initialize the Subsystem (::SDL_INIT_HAPTIC).
    1.13 - *   - Open a Haptic Device.
    1.14 + *   - Initialize the subsystem (::SDL_INIT_HAPTIC).
    1.15 + *   - Open a haptic device.
    1.16   *    - SDL_HapticOpen() to open from index.
    1.17   *    - SDL_HapticOpenFromJoystick() to open from an existing joystick.
    1.18   *   - Create an effect (::SDL_HapticEffect).
    1.19 @@ -282,7 +282,7 @@
    1.20  /**
    1.21   *  \brief Device can be queried for effect status.
    1.22   *
    1.23 - *  Device can be queried for effect status.
    1.24 + *  Device supports querying effect status.
    1.25   *
    1.26   *  \sa SDL_HapticGetEffectStatus
    1.27   */
    1.28 @@ -291,6 +291,8 @@
    1.29  /**
    1.30   *  \brief Device can be paused.
    1.31   *
    1.32 + *  Devices supports being paused.
    1.33 + *
    1.34   *  \sa SDL_HapticPause
    1.35   *  \sa SDL_HapticUnpause
    1.36   */
    1.37 @@ -444,7 +446,7 @@
    1.38  /**
    1.39   *  \brief A structure containing a template for a Constant effect.
    1.40   *
    1.41 - *  The struct is exclusive to the ::SDL_HAPTIC_CONSTANT effect.
    1.42 + *  This struct is exclusively for the ::SDL_HAPTIC_CONSTANT effect.
    1.43   *
    1.44   *  A constant effect applies a constant force in the specified direction
    1.45   *  to the joystick.
    1.46 @@ -676,6 +678,8 @@
    1.47  /**
    1.48   *  \brief A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
    1.49   *
    1.50 + *  This struct is exclusively for the ::SDL_HAPTIC_CUSTOM effect.
    1.51 + *
    1.52   *  A custom force feedback effect is much like a periodic effect, where the
    1.53   *  application can define its exact shape.  You will have to allocate the
    1.54   *  data yourself.  Data should consist of channels * samples Uint16 samples.
    1.55 @@ -804,7 +808,7 @@
    1.56  extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
    1.57  
    1.58  /**
    1.59 - *  \brief Get the implementation dependent name of a Haptic device.
    1.60 + *  \brief Get the implementation dependent name of a haptic device.
    1.61   *
    1.62   *  This can be called before any joysticks are opened.
    1.63   *  If no name can be found, this function returns NULL.
    1.64 @@ -817,9 +821,9 @@
    1.65  extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
    1.66  
    1.67  /**
    1.68 - *  \brief Opens a Haptic device for usage.
    1.69 + *  \brief Opens a haptic device for use.
    1.70   *
    1.71 - *  The index passed as an argument refers to the N'th Haptic device on this
    1.72 + *  The index passed as an argument refers to the N'th haptic device on this
    1.73   *  system.
    1.74   *
    1.75   *  When opening a haptic device, its gain will be set to maximum and
    1.76 @@ -885,15 +889,15 @@
    1.77   *  \brief Checks to see if a joystick has haptic features.
    1.78   *
    1.79   *  \param joystick Joystick to test for haptic capabilities.
    1.80 - *  \return 1 if the joystick is haptic, 0 if it isn't
    1.81 - *          or -1 if an error ocurred.
    1.82 + *  \return SDL_TRUE if the joystick is haptic, SDL_FALSE if it isn't
    1.83 + *          or -1 if an error occurred.
    1.84   *
    1.85   *  \sa SDL_HapticOpenFromJoystick
    1.86   */
    1.87  extern DECLSPEC int SDLCALL SDL_JoystickIsHaptic(SDL_Joystick * joystick);
    1.88  
    1.89  /**
    1.90 - *  \brief Opens a Haptic device for usage from a Joystick device.
    1.91 + *  \brief Opens a haptic device for use from a joystick device.
    1.92   *
    1.93   *  You must still close the haptic device separately.  It will not be closed
    1.94   *  with the joystick.
    1.95 @@ -913,7 +917,7 @@
    1.96                                                                 joystick);
    1.97  
    1.98  /**
    1.99 - *  \brief Closes a Haptic device previously opened with SDL_HapticOpen().
   1.100 + *  \brief Closes a haptic device previously opened with SDL_HapticOpen().
   1.101   *
   1.102   *  \param haptic Haptic device to close.
   1.103   */
   1.104 @@ -957,7 +961,7 @@
   1.105   *  Example:
   1.106   *  \code
   1.107   *  if (SDL_HapticQuery(haptic) & SDL_HAPTIC_CONSTANT) {
   1.108 - *      printf("We have constant haptic effect!");
   1.109 + *      printf("We have constant haptic effect!\n");
   1.110   *  }
   1.111   *  \endcode
   1.112   *
   1.113 @@ -996,7 +1000,7 @@
   1.114   *
   1.115   *  \param haptic Haptic device to create the effect on.
   1.116   *  \param effect Properties of the effect to create.
   1.117 - *  \return The id of the effect on success or -1 on error.
   1.118 + *  \return The identifier of the effect on success or -1 on error.
   1.119   *
   1.120   *  \sa SDL_HapticUpdateEffect
   1.121   *  \sa SDL_HapticRunEffect
   1.122 @@ -1008,13 +1012,13 @@
   1.123  /**
   1.124   *  \brief Updates the properties of an effect.
   1.125   *
   1.126 - *  Can be used dynamically, although behaviour when dynamically changing
   1.127 + *  Can be used dynamically, although behavior when dynamically changing
   1.128   *  direction may be strange.  Specifically the effect may reupload itself
   1.129   *  and start playing from the start.  You cannot change the type either when
   1.130   *  running SDL_HapticUpdateEffect().
   1.131   *
   1.132   *  \param haptic Haptic device that has the effect.
   1.133 - *  \param effect Effect to update.
   1.134 + *  \param effect Identifier of the effect to update.
   1.135   *  \param data New effect properties to use.
   1.136   *  \return 0 on success or -1 on error.
   1.137   *