|
SDL
2.0
|
Include dependency graph for SDL_sensor.h:
This graph shows which files directly or indirectly include this file: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 | |
| void | SDL_LockSensors (void) |
| void | SDL_UnlockSensors (void) |
| 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 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 99 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_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) b int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext SDL_RWops int return return void return int int return double return SDL_bool return int int return SDL_AudioDeviceID const void Uint32 return SDL_AudioDeviceID int float float float return SDL_JoystickID return int SDL_Rect return SDL_Window float return SDL_Window return SDL_Renderer SDL_bool return SDL_AudioDeviceID void Uint32 return Uint32 int int int Uint32 return const char SDL_bool return int return SDL_Joystick return SDL_Joystick return SDL_GameController return return int return int return int return SDL_RWops size_t int return SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation return const char return SDL_Window VkInstance VkSurfaceKHR return SDL_malloc_func SDL_calloc_func SDL_realloc_func SDL_free_func return SDL_AudioStream const void int return SDL_AudioStream SDL_AudioStream float return float return float return float return float return float int return float float return return SDL_Renderer return double return int return double return const wchar_t return SDL_Joystick Uint16 Uint16 Uint32 return int return int return int return SDL_Sensor return SDL_Sensor return SDL_Sensor float int return int return SDL_ThreadFunction const char const size_t void return SDL_Joystick return SDL_Renderer return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FRect int return SDL_Renderer const SDL_FRect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_FRect const double const SDL_FPoint const SDL_RendererFlip return return void SDL_RWops Sint64 int return SDL_RWops void size_t size_t return SDL_RWops return SDL_Window return SDL_Texture const SDL_Rect SDL_Surface return char const char char return const wchar_t const wchar_t size_t return SDL_GameController return SDL_GameController int SDL_Joystick int SDL_Texture SDL_ScaleMode return int return int return SDL_Joystick int Sint16 return SDL_Joystick int Uint8 return SDL_MetalView return double return return const char return SDL_GameController return SDL_Joystick return SDL_GameController Uint16 Uint16 Uint32 return SDL_GameController SDL_GameControllerAxis return SDL_GameController return SDL_GameController int int Uint8 float float float return SDL_GameController return SDL_GameController SDL_SensorType return SDL_GameController 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.
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.
If you are using the sensor API or handling events from multiple threads you should use these locking functions to protect access to the sensors.
In particular, you are guaranteed that the sensor list won't change, so the API functions that take a sensor index will be valid, and sensor events will not be delivered.
Definition at line 819 of file SDL_dynapi_procs.h.
References SDL_LockMutex, and SDL_sensor_lock.
Referenced by SDL_NumSensors(), SDL_SensorClose(), SDL_SensorFromInstanceID(), SDL_SensorGetDeviceInstanceID(), SDL_SensorGetDeviceName(), SDL_SensorGetDeviceNonPortableType(), SDL_SensorGetDeviceType(), SDL_SensorOpen(), SDL_SensorQuit(), and SDL_SensorUpdate().
Count the number of sensors attached to the system right now.
Definition at line 99 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 392 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 289 of file SDL_sensor.c.
References SDL_LockSensors(), SDL_sensors, and SDL_UnlockSensors().
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 377 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 195 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 149 of file SDL_sensor.c.
References SDL_SensorDriver::GetDeviceName, NULL, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().
Get the platform dependent type of a sensor.
This can be called before any sensors are opened.
Definition at line 180 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 165 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 364 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 325 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 351 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 338 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 217 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 738 of file SDL_dynapi_procs.h.
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.
Definition at line 62 of file SDL_sensor.c.
References SDL_sensor_lock, and SDL_UnlockMutex.
Referenced by SDL_NumSensors(), SDL_SensorClose(), SDL_SensorFromInstanceID(), SDL_SensorGetDeviceInstanceID(), SDL_SensorGetDeviceName(), SDL_SensorGetDeviceNonPortableType(), SDL_SensorGetDeviceType(), SDL_SensorOpen(), SDL_SensorQuit(), and SDL_SensorUpdate().