Browse Source

Sync SDL wiki -> header

SDL Wiki Bot 2 years ago
parent
commit
36e7670143
2 changed files with 9 additions and 5 deletions
  1. 4 2
      include/SDL_gamecontroller.h
  2. 5 3
      include/SDL_sensor.h

+ 4 - 2
include/SDL_gamecontroller.h

@@ -896,14 +896,16 @@ extern DECLSPEC float SDLCALL SDL_GameControllerGetSensorDataRate(SDL_GameContro
 extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorData(SDL_GameController *gamecontroller, SDL_SensorType type, float *data, int num_values);
 
 /**
- * Get the current state of a game controller sensor with the timestamp of the last update.
+ * Get the current state of a game controller sensor with the timestamp of the
+ * last update.
  *
  * The number of values and interpretation of the data is sensor dependent.
  * See SDL_sensor.h for the details for each type of sensor.
  *
  * \param gamecontroller The controller to query
  * \param type The type of sensor to query
- * \param timestamp A pointer filled with the timestamp in microseconds of the current sensor reading if available, or 0 if not
+ * \param timestamp A pointer filled with the timestamp in microseconds of the
+ *                  current sensor reading if available, or 0 if not
  * \param data A pointer filled with the current sensor state
  * \param num_values The number of values to write to data
  * \return 0 or -1 if an error occurred.

+ 5 - 3
include/SDL_sensor.h

@@ -270,17 +270,19 @@ extern DECLSPEC SDL_SensorID SDLCALL SDL_SensorGetInstanceID(SDL_Sensor *sensor)
 extern DECLSPEC int SDLCALL SDL_SensorGetData(SDL_Sensor *sensor, float *data, int num_values);
 
 /**
- * Get the current state of an opened sensor with the timestamp of the last update.
+ * Get the current state of an opened sensor with the timestamp of the last
+ * update.
  *
  * The number of values and interpretation of the data is sensor dependent.
  *
  * \param sensor The SDL_Sensor object to query
- * \param timestamp A pointer filled with the timestamp in microseconds of the current sensor reading if available, or 0 if not
+ * \param timestamp A pointer filled with the timestamp in microseconds of the
+ *                  current sensor reading if available, or 0 if not
  * \param data A pointer filled with the current sensor state
  * \param num_values The number of values to write to data
  * \returns 0 or -1 if an error occurred.
  *
- * \since This function is available since SDL 2.0.9.
+ * \since This function is available since SDL 2.26.0.
  */
 extern DECLSPEC int SDLCALL SDL_SensorGetDataWithTimestamp(SDL_Sensor *sensor, Uint64 *timestamp, float *data, int num_values);