SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.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_GetSensorInstanceName (SDL_SensorID instance_id) |
SDL_SensorType | SDL_GetSensorInstanceType (SDL_SensorID instance_id) |
int | SDL_GetSensorInstanceNonPortableType (SDL_SensorID instance_id) |
SDL_Sensor * | SDL_OpenSensor (SDL_SensorID instance_id) |
SDL_Sensor * | SDL_GetSensorFromInstanceID (SDL_SensorID instance_id) |
const char * | SDL_GetSensorName (SDL_Sensor *sensor) |
SDL_SensorType | SDL_GetSensorType (SDL_Sensor *sensor) |
int | SDL_GetSensorNonPortableType (SDL_Sensor *sensor) |
SDL_SensorID | SDL_GetSensorInstanceID (SDL_Sensor *sensor) |
int | SDL_GetSensorData (SDL_Sensor *sensor, float *data, int num_values) |
void | SDL_CloseSensor (SDL_Sensor *sensor) |
void | SDL_UpdateSensors (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 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.
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 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 phone is rotated.
Definition at line 103 of file SDL_sensor.h.
typedef struct SDL_Sensor SDL_Sensor |
Definition at line 52 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 ID value starts at 1 and increments from there. The value 0 is an invalid ID.
Definition at line 60 of file SDL_sensor.h.
enum SDL_SensorType |
Definition at line 69 of file SDL_sensor.h.
void SDL_CloseSensor | ( | SDL_Sensor * | sensor | ) |
Close a sensor previously opened with SDL_OpenSensor().
sensor | The SDL_Sensor object to close |
int SDL_GetSensorData | ( | 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 SDL_Sensor object to query |
data | A pointer filled with the current sensor state |
num_values | The number of values to write to data |
SDL_Sensor * SDL_GetSensorFromInstanceID | ( | SDL_SensorID | instance_id | ) |
Return the SDL_Sensor associated with an instance ID.
instance_id | the sensor instance ID |
SDL_SensorID SDL_GetSensorInstanceID | ( | SDL_Sensor * | sensor | ) |
Get the instance ID of a sensor.
sensor | The SDL_Sensor object to inspect |
sensor
is NULL.const char * SDL_GetSensorInstanceName | ( | SDL_SensorID | instance_id | ) |
Get the implementation dependent name of a sensor.
instance_id | the sensor instance ID |
instance_id
is not validint SDL_GetSensorInstanceNonPortableType | ( | SDL_SensorID | instance_id | ) |
Get the platform dependent type of a sensor.
instance_id | the sensor instance ID |
instance_id
is not validSDL_SensorType SDL_GetSensorInstanceType | ( | SDL_SensorID | instance_id | ) |
Get the type of a sensor.
instance_id | the sensor instance ID |
SDL_SENSOR_INVALID
if instance_id
is not validconst char * SDL_GetSensorName | ( | SDL_Sensor * | sensor | ) |
Get the implementation dependent name of a sensor
sensor | The SDL_Sensor object |
sensor
is NULL.int SDL_GetSensorNonPortableType | ( | SDL_Sensor * | sensor | ) |
Get the platform dependent type of a sensor.
sensor | The SDL_Sensor object to inspect |
sensor
is NULL.SDL_SensorID * SDL_GetSensors | ( | int * | count | ) |
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 held in portrait mode 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 phone or controller is rotated.
count | a pointer filled in with the number of sensors returned |
SDL_SensorType SDL_GetSensorType | ( | SDL_Sensor * | sensor | ) |
Get the type of a sensor.
sensor | The SDL_Sensor object to inspect |
SDL_SENSOR_INVALID
if sensor
is NULL.SDL_Sensor * SDL_OpenSensor | ( | SDL_SensorID | instance_id | ) |
Open a sensor for use.
instance_id | the sensor instance ID |