Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Orphan documentation in SDL_sensor.h? #9468

Closed
icculus opened this issue Apr 7, 2024 · 2 comments
Closed

Orphan documentation in SDL_sensor.h? #9468

icculus opened this issue Apr 7, 2024 · 2 comments
Assignees
Milestone

Comments

@icculus
Copy link
Collaborator

icculus commented Apr 7, 2024

This is in SDL_sensor.h, with nothing associated with it.

/**
 * 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,
 * an observer looking from a positive location on one of the axes would
 * see positive rotation on that axis when it appeared to be rotating
 * counter-clockwise.
 *
 * values[0]: Angular speed around the x axis (pitch)
 * values[1]: Angular speed around the y axis (yaw)
 * 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
 *
 * The axis data is not changed when the device is rotated.
 *
 * \sa SDL_GetCurrentDisplayOrientation()
 */

Did this have something that was removed? Is this just notes on what to expect from SDL_GetSensorData?

@icculus icculus added this to the 3.2.0 milestone Apr 7, 2024
@slouken
Copy link
Collaborator

slouken commented Apr 15, 2024

Both this and the "Accelerometer sensor" blocks are standalone documentation for SDL_SENSOR_ACCEL* and SDL_SENSOR_GYRO*. I'm guessing your script associated the accelerometer documentation with SDL_STANDARD_GRAVITY.

These should probably be moved into the SDL_SensorType block.

@icculus icculus self-assigned this Apr 15, 2024
@icculus
Copy link
Collaborator Author

icculus commented Apr 16, 2024

Okay, this has been updated: https://wiki.libsdl.org/SDL3/SDL_SensorType

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants