SDL
2.0
|
Go to the source code of this file.
Macros | |
#define | SDL_STANDARD_GRAVITY 9.80665f |
Typedefs | |
typedef Sint32 | SDL_SensorID |
Enumerations | |
enum | SDL_SensorType { SDL_SENSOR_INVALID = -1, SDL_SENSOR_UNKNOWN, SDL_SENSOR_ACCEL, SDL_SENSOR_GYRO } |
Functions | |
int | SDL_NumSensors (void) |
Count the number of sensors attached to the system right now. More... | |
const char * | SDL_SensorGetDeviceName (int device_index) |
Get the implementation dependent name of a sensor. More... | |
SDL_SensorType | SDL_SensorGetDeviceType (int device_index) |
Get the type of a sensor. More... | |
int | SDL_SensorGetDeviceNonPortableType (int device_index) |
Get the platform dependent type of a sensor. More... | |
SDL_SensorID | SDL_SensorGetDeviceInstanceID (int device_index) |
Get the instance ID of a sensor. More... | |
SDL_Sensor * | SDL_SensorOpen (int device_index) |
Open a sensor for use. More... | |
SDL_Sensor * | SDL_SensorFromInstanceID (SDL_SensorID instance_id) |
const char * | SDL_SensorGetName (SDL_Sensor *sensor) |
Get the implementation dependent name of a sensor. More... | |
SDL_SensorType | SDL_SensorGetType (SDL_Sensor *sensor) |
Get the type of a sensor. More... | |
int | SDL_SensorGetNonPortableType (SDL_Sensor *sensor) |
Get the platform dependent type of a sensor. More... | |
SDL_SensorID | SDL_SensorGetInstanceID (SDL_Sensor *sensor) |
Get the instance ID of a sensor. More... | |
int | SDL_SensorGetData (SDL_Sensor *sensor, float *data, int num_values) |
void | SDL_SensorClose (SDL_Sensor *sensor) |
void | SDL_SensorUpdate (void) |
Include file for SDL sensor event handling
Definition in file SDL_sensor.h.
#define SDL_STANDARD_GRAVITY 9.80665f |
Accelerometer sensor
The accelerometer returns the current acceleration in SI meters per second squared. This includes gravity, so a device at rest will have an acceleration of SDL_STANDARD_GRAVITY straight down.
values[0]: Acceleration on the x axis values[1]: Acceleration on the y axis values[2]: Acceleration on the z axis
For phones held in portrait mode, 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 phone is rotated.
Definition at line 97 of file SDL_sensor.h.
typedef Sint32 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 ID value starts at 0 and increments from there. The value -1 is an invalid ID.
Definition at line 60 of file SDL_sensor.h.
enum SDL_SensorType |
Enumerator | |
---|---|
SDL_SENSOR_INVALID | Returned for an invalid sensor |
SDL_SENSOR_UNKNOWN | Unknown sensor type |
SDL_SENSOR_ACCEL | Accelerometer |
SDL_SENSOR_GYRO | Gyroscope |
Definition at line 69 of file SDL_sensor.h.
int SDL_NumSensors | ( | void | ) |
Count the number of sensors attached to the system right now.
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 values[1]: Angular speed around the y axis values[2]: Angular speed around the z axis
For phones held in portrait mode, 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 phone is rotated.
Definition at line 97 of file SDL_sensor.c.
References SDL_SensorDriver::GetCount, i, SDL_arraysize, SDL_LockSensors(), SDL_sensor_drivers, and SDL_UnlockSensors().
void SDL_SensorClose | ( | SDL_Sensor * | sensor | ) |
Close a sensor previously opened with SDL_SensorOpen()
Definition at line 390 of file SDL_sensor.c.
References NULL, SDL_free, SDL_LockSensors(), SDL_PrivateSensorValid(), SDL_sensors, SDL_UnlockSensors(), and SDL_updating_sensor.
Referenced by SDL_SensorQuit(), and SDL_SensorUpdate().
SDL_Sensor* SDL_SensorFromInstanceID | ( | SDL_SensorID | instance_id | ) |
Return the SDL_Sensor associated with an instance id.
Definition at line 287 of file SDL_sensor.c.
References SDL_LockSensors(), SDL_sensors, and SDL_UnlockSensors().
int SDL_SensorGetData | ( | SDL_Sensor * | sensor, |
float * | data, | ||
int | num_values | ||
) |
Get the current state of an opened sensor.
The number of values and interpretation of the data is sensor dependent.
sensor | The sensor to query |
data | A pointer filled with the current sensor state |
num_values | The number of values to write to data |
Definition at line 375 of file SDL_sensor.c.
References SDL_arraysize, SDL_memcpy, SDL_min, and SDL_PrivateSensorValid().
SDL_SensorID SDL_SensorGetDeviceInstanceID | ( | int | device_index | ) |
Get the instance ID of a sensor.
This can be called before any sensors are opened.
Definition at line 193 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceInstanceID, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().
const char* SDL_SensorGetDeviceName | ( | int | device_index | ) |
Get the implementation dependent name of a sensor.
This can be called before any sensors are opened.
Definition at line 147 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceName, NULL, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().
int SDL_SensorGetDeviceNonPortableType | ( | int | device_index | ) |
Get the platform dependent type of a sensor.
This can be called before any sensors are opened.
Definition at line 178 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceNonPortableType, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().
SDL_SensorType SDL_SensorGetDeviceType | ( | int | device_index | ) |
Get the type of a sensor.
This can be called before any sensors are opened.
Definition at line 163 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceType, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), SDL_SENSOR_INVALID, and SDL_UnlockSensors().
SDL_SensorID SDL_SensorGetInstanceID | ( | SDL_Sensor * | sensor | ) |
Get the instance ID of a sensor.
This can be called before any sensors are opened.
Definition at line 362 of file SDL_sensor.c.
References SDL_PrivateSensorValid().
const char* SDL_SensorGetName | ( | SDL_Sensor * | sensor | ) |
Get the implementation dependent name of a sensor.
Definition at line 323 of file SDL_sensor.c.
References NULL, and SDL_PrivateSensorValid().
int SDL_SensorGetNonPortableType | ( | SDL_Sensor * | sensor | ) |
Get the platform dependent type of a sensor.
This can be called before any sensors are opened.
Definition at line 349 of file SDL_sensor.c.
References SDL_PrivateSensorValid().
SDL_SensorType SDL_SensorGetType | ( | SDL_Sensor * | sensor | ) |
Get the type of a sensor.
This can be called before any sensors are opened.
Definition at line 336 of file SDL_sensor.c.
References SDL_PrivateSensorValid(), and SDL_SENSOR_INVALID.
SDL_Sensor* SDL_SensorOpen | ( | int | device_index | ) |
Open a sensor for use.
The index passed as an argument refers to the N'th sensor on the system.
Definition at line 215 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceInstanceID, SDL_SensorDriver::GetDeviceName, SDL_SensorDriver::GetDeviceNonPortableType, SDL_SensorDriver::GetDeviceType, NULL, SDL_SensorDriver::Open, SDL_calloc, SDL_free, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), SDL_OutOfMemory, SDL_sensors, SDL_strdup, SDL_UnlockSensors(), and SDL_SensorDriver::Update.
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.
Definition at line 503 of file SDL_sensor.c.
References SDL_SensorDriver::Detect, i, SDL_arraysize, SDL_FALSE, SDL_INIT_SENSOR, SDL_LockSensors(), SDL_sensor_drivers, SDL_SensorClose(), SDL_sensors, SDL_TRUE, SDL_UnlockSensors(), SDL_updating_sensor, and SDL_WasInit.