SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Macros | |
#define | SDL_STANDARD_GRAVITY 9.80665f |
Typedefs | |
typedef struct SDL_Sensor | SDL_Sensor |
typedef Uint32 | SDL_SensorID |
Enumerations | |
enum | SDL_SensorType { SDL_SENSOR_INVALID = -1 , SDL_SENSOR_UNKNOWN , SDL_SENSOR_ACCEL , SDL_SENSOR_GYRO , SDL_SENSOR_ACCEL_L , SDL_SENSOR_GYRO_L , SDL_SENSOR_ACCEL_R , SDL_SENSOR_GYRO_R } |
Functions | |
SDL_SensorID * | SDL_GetSensors (int *count) |
const char * | SDL_GetSensorNameForID (SDL_SensorID instance_id) |
SDL_SensorType | SDL_GetSensorTypeForID (SDL_SensorID instance_id) |
int | SDL_GetSensorNonPortableTypeForID (SDL_SensorID instance_id) |
SDL_Sensor * | SDL_OpenSensor (SDL_SensorID instance_id) |
SDL_Sensor * | SDL_GetSensorFromID (SDL_SensorID instance_id) |
SDL_PropertiesID | SDL_GetSensorProperties (SDL_Sensor *sensor) |
const char * | SDL_GetSensorName (SDL_Sensor *sensor) |
SDL_SensorType | SDL_GetSensorType (SDL_Sensor *sensor) |
int | SDL_GetSensorNonPortableType (SDL_Sensor *sensor) |
SDL_SensorID | SDL_GetSensorID (SDL_Sensor *sensor) |
bool | SDL_GetSensorData (SDL_Sensor *sensor, float *data, int num_values) |
void | SDL_CloseSensor (SDL_Sensor *sensor) |
void | SDL_UpdateSensors (void) |
#define SDL_STANDARD_GRAVITY 9.80665f |
A constant to represent standard gravity for accelerometer sensors.
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 away from the center of the earth, which is a positive Y value.
Definition at line 69 of file SDL_sensor.h.
typedef struct SDL_Sensor SDL_Sensor |
SDL sensor management.
In order to use these functions, SDL_Init() must have been called with the SDL_INIT_SENSOR flag. This causes SDL to scan the system for sensors, and load appropriate drivers.
Definition at line 47 of file SDL_sensor.h.
typedef Uint32 SDL_SensorID |
This is a unique ID for a sensor for the time it is connected to the system, and is never reused for the lifetime of the application.
The value 0 is an invalid ID.
Definition at line 57 of file SDL_sensor.h.
enum SDL_SensorType |
The different sensors defined by SDL.
Additional sensors may be available, using platform dependent semantics.
Here 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 away from the center of the earth, which is a positive Y value.
values[0]
: Acceleration on the x axisvalues[1]
: Acceleration on the y axisvalues[2]
: Acceleration on the z axisFor phones and tablets held in natural orientation and game controllers held in front of you, the axes are defined as follows:
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:
The gyroscope axis data is not changed when the device is rotated.
Definition at line 125 of file SDL_sensor.h.
|
extern |
Close a sensor previously opened with SDL_OpenSensor().
sensor | the SDL_Sensor object to close. |
|
extern |
Get the current state of an opened sensor.
The number of values and interpretation of the data is sensor dependent.
sensor | the SDL_Sensor object to query. |
data | a pointer filled with the current sensor state. |
num_values | the number of values to write to data. |
|
extern |
Return the SDL_Sensor associated with an instance ID.
instance_id | the sensor instance ID. |
|
extern |
Get the instance ID of a sensor.
sensor | the SDL_Sensor object to inspect. |
|
extern |
Get the implementation dependent name of a sensor.
sensor | the SDL_Sensor object. |
|
extern |
Get the implementation dependent name of a sensor.
This can be called before any sensors are opened.
instance_id | the sensor instance ID. |
instance_id
is not valid.
|
extern |
Get the platform dependent type of a sensor.
sensor | the SDL_Sensor object to inspect. |
sensor
is NULL.
|
extern |
Get the platform dependent type of a sensor.
This can be called before any sensors are opened.
instance_id | the sensor instance ID. |
instance_id
is not valid.
|
extern |
Get the properties associated with a sensor.
sensor | the SDL_Sensor object. |
|
extern |
Get a list of currently connected sensors.
count | a pointer filled in with the number of sensors returned, may be NULL. |
|
extern |
Get the type of a sensor.
sensor | the SDL_Sensor object to inspect. |
SDL_SENSOR_INVALID
if sensor
is NULL.
|
extern |
Get the type of a sensor.
This can be called before any sensors are opened.
instance_id | the sensor instance ID. |
SDL_SENSOR_INVALID
if instance_id
is not valid.
|
extern |
Open a sensor for use.
instance_id | the sensor instance ID. |
|
extern |
Update the current state of the open sensors.
This is called automatically by the event loop if sensor events are enabled.
This needs to be called from the thread that initialized the sensor subsystem.