eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-28 07:29:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

include: A ton of little documentation tweaks, fixes, and improvements.

Browse source 
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon 2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
No known key found for this signature in database
GPG key ID: FA148B892AB48044
45 changed files with 1565 additions and 833 deletions
Download patch file Download diff file Expand all files Collapse all files

20
include/SDL3/SDL_sensor.h
View file

@ -79,7 +79,7 @@ typedef enum
} SDL_SensorType;
/**
* Accelerometer sensor
* Accelerometer sensor.
*
* The accelerometer returns the current acceleration in SI meters per
* second squared. This measurement includes the force of gravity, so
@ -91,9 +91,10 @@ typedef enum
* values[2]: Acceleration on the z axis
*
* For phones and tablets held in natural orientation and game controllers held in front of you, the axes are defined as follows:
* -X ... +X : left ... right
* -Y ... +Y : bottom ... top
* -Z ... +Z : farther ... closer
*
* - -X ... +X : left ... right
* - -Y ... +Y : bottom ... top
* - -Z ... +Z : farther ... closer
*
* The axis data is not changed when the device is rotated.
*
@ -102,7 +103,7 @@ typedef enum
#define SDL_STANDARD_GRAVITY 9.80665f
/**
* Gyroscope sensor
* Gyroscope sensor.
*
* The gyroscope returns the current rate of rotation in radians per second.
* The rotation is positive in the counter-clockwise direction. That is,
@ -115,9 +116,10 @@ typedef enum
* values[2]: Angular speed around the z axis (roll)
*
* For phones and tablets held in natural orientation and game controllers held in front of you, the axes are defined as follows:
* -X ... +X : left ... right
* -Y ... +Y : bottom ... top
* -Z ... +Z : farther ... closer
*
* - -X ... +X : left ... right
* - -Y ... +Y : bottom ... top
* - -Z ... +Z : farther ... closer
*
* The axis data is not changed when the device is rotated.
*
@ -205,7 +207,7 @@ extern DECLSPEC SDL_Sensor *SDLCALL SDL_GetSensorFromInstanceID(SDL_SensorID ins
extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSensorProperties(SDL_Sensor *sensor);
/**
* Get the implementation dependent name of a sensor
* Get the implementation dependent name of a sensor.
*
* \param sensor The SDL_Sensor object
* \returns the sensor name, or NULL if `sensor` is NULL.