Skip to content

Commit

Permalink
Sync SDL3 header -> wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Apr 16, 2024
1 parent daa9aab commit b901866
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 18 deletions.
18 changes: 1 addition & 17 deletions SDL3/SDL_STANDARD_GRAVITY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###### (This is the documentation for SDL3, which is under heavy development and the API is changing! [SDL2](https://wiki.libsdl.org/SDL2/) is the current stable version!)
# SDL_STANDARD_GRAVITY

Accelerometer sensor.
A constant to represent standard gravity for accelerometer sensors.

## Header File

Expand All @@ -20,26 +20,10 @@ squared. This measurement includes the force of gravity, so a device at
rest will have an value of [SDL_STANDARD_GRAVITY](SDL_STANDARD_GRAVITY)
away from the center of the earth, which is a positive Y value.

values[0]: Acceleration on the x axis values[1]: Acceleration on the y axis
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

The axis data is not changed when the device is rotated.

## Version

This macro is available since SDL 3.0.0.

## See Also

* [SDL_GetCurrentDisplayOrientation](SDL_GetCurrentDisplayOrientation)

----
[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro)

51 changes: 50 additions & 1 deletion SDL3/SDL_SensorType.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
###### (This is the documentation for SDL3, which is under heavy development and the API is changing! [SDL2](https://wiki.libsdl.org/SDL2/) is the current stable version!)
# SDL_SensorType

The different sensors defined by SDL
The different sensors defined by SDL.

## Header File

Expand Down Expand Up @@ -30,6 +30,55 @@ Additional sensors may be available, using platform dependent semantics.
Hare are the additional Android sensors:
https://developer.android.com/reference/android/hardware/SensorEvent.html#values

Accelerometer sensor notes:

The accelerometer returns the current acceleration in SI meters per second
squared. This measurement includes the force of gravity, so a device at
rest will have an value of [SDL_STANDARD_GRAVITY](SDL_STANDARD_GRAVITY)
away from the center of the earth, which is a positive Y value.

- `values[0]`: Acceleration on the x axis
- `values[1]`: Acceleration on the y axis
- `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

The accelerometer axis data is not changed when the device is rotated.

Gyroscope sensor notes:

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 gyroscope axis data is not changed when the device is rotated.

## Version

This enum is available since SDL 3.0.0.

## See Also

* [SDL_GetCurrentDisplayOrientation](SDL_GetCurrentDisplayOrientation)

----
[CategoryAPI](CategoryAPI), [CategoryAPIEnum](CategoryAPIEnum)

0 comments on commit b901866

Please sign in to comment.