SDL  2.0
SDL_sensor.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"
+ 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)
 

Detailed Description

Include file for SDL sensor event handling

Definition in file SDL_sensor.h.

Macro Definition Documentation

◆ SDL_STANDARD_GRAVITY

#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.

See also
SDL_GetDisplayOrientation()

Definition at line 99 of file SDL_sensor.h.

Typedef Documentation

◆ 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.

Enumeration Type Documentation

◆ SDL_SensorType

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.

70 {
71  SDL_SENSOR_INVALID = -1, /**< Returned for an invalid sensor */
72  SDL_SENSOR_UNKNOWN, /**< Unknown sensor type */
73  SDL_SENSOR_ACCEL, /**< Accelerometer */
74  SDL_SENSOR_GYRO /**< Gyroscope */
SDL_SensorType
Definition: SDL_sensor.h:70
@ SDL_SENSOR_INVALID
Definition: SDL_sensor.h:71
@ SDL_SENSOR_GYRO
Definition: SDL_sensor.h:74
@ SDL_SENSOR_UNKNOWN
Definition: SDL_sensor.h:72
@ SDL_SENSOR_ACCEL
Definition: SDL_sensor.h:73

Function Documentation

◆ SDL_LockSensors()

void SDL_LockSensors ( void  )

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.

See also
SDL_GetDisplayOrientation() Locking for multi-threaded access to the sensor hidapi API

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().

◆ SDL_NumSensors()

int SDL_NumSensors ( void  )

Count the number of sensors attached to the system right now.

Definition at line 99 of file SDL_sensor.c.

100 {
101  int i, total_sensors = 0;
102  SDL_LockSensors();
103  for (i = 0; i < SDL_arraysize(SDL_sensor_drivers); ++i) {
104  total_sensors += SDL_sensor_drivers[i]->GetCount();
105  }
107  return total_sensors;
108 }
void SDL_UnlockSensors(void)
Definition: SDL_sensor.c:62
static SDL_SensorDriver * SDL_sensor_drivers[]
Definition: SDL_sensor.c:34
void SDL_LockSensors(void)
Definition: SDL_sensor.c:54
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:121
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
int(* GetCount)(void)
Definition: SDL_syssensor.h:60

References SDL_SensorDriver::GetCount, i, SDL_arraysize, SDL_LockSensors(), SDL_sensor_drivers, and SDL_UnlockSensors().

◆ SDL_SensorClose()

void SDL_SensorClose ( SDL_Sensor *  sensor)

Close a sensor previously opened with SDL_SensorOpen()

Definition at line 392 of file SDL_sensor.c.

393 {
394  SDL_Sensor *sensorlist;
395  SDL_Sensor *sensorlistprev;
396 
397  if (!SDL_PrivateSensorValid(sensor)) {
398  return;
399  }
400 
401  SDL_LockSensors();
402 
403  /* First decrement ref count */
404  if (--sensor->ref_count > 0) {
406  return;
407  }
408 
409  if (SDL_updating_sensor) {
411  return;
412  }
413 
414  sensor->driver->Close(sensor);
415  sensor->hwdata = NULL;
416 
417  sensorlist = SDL_sensors;
418  sensorlistprev = NULL;
419  while (sensorlist) {
420  if (sensor == sensorlist) {
421  if (sensorlistprev) {
422  /* unlink this entry */
423  sensorlistprev->next = sensorlist->next;
424  } else {
425  SDL_sensors = sensor->next;
426  }
427  break;
428  }
429  sensorlistprev = sensorlist;
430  sensorlist = sensorlist->next;
431  }
432 
433  SDL_free(sensor->name);
434 
435  /* Free the data associated with this sensor */
436  SDL_free(sensor);
437 
439 }
#define SDL_free
static SDL_Sensor * SDL_sensors
Definition: SDL_sensor.c:48
static SDL_bool SDL_updating_sensor
Definition: SDL_sensor.c:49
static int SDL_PrivateSensorValid(SDL_Sensor *sensor)
Definition: SDL_sensor.c:307
#define NULL
Definition: begin_code.h:163

References NULL, SDL_free, SDL_LockSensors(), SDL_PrivateSensorValid(), SDL_sensors, SDL_UnlockSensors(), and SDL_updating_sensor.

Referenced by SDL_SensorQuit(), and SDL_SensorUpdate().

◆ SDL_SensorFromInstanceID()

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.

290 {
291  SDL_Sensor *sensor;
292 
293  SDL_LockSensors();
294  for (sensor = SDL_sensors; sensor; sensor = sensor->next) {
295  if (sensor->instance_id == instance_id) {
296  break;
297  }
298  }
300  return sensor;
301 }

References SDL_LockSensors(), SDL_sensors, and SDL_UnlockSensors().

◆ SDL_SensorGetData()

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.

Parameters
sensorThe sensor to query
dataA pointer filled with the current sensor state
num_valuesThe number of values to write to data
Returns
0 or -1 if an error occurred.

Definition at line 377 of file SDL_sensor.c.

378 {
379  if (!SDL_PrivateSensorValid(sensor)) {
380  return -1;
381  }
382 
383  num_values = SDL_min(num_values, SDL_arraysize(sensor->data));
384  SDL_memcpy(data, sensor->data, num_values*sizeof(*data));
385  return 0;
386 }
#define SDL_memcpy
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
#define SDL_min(x, y)
Definition: SDL_stdinc.h:412

References SDL_arraysize, SDL_memcpy, SDL_min, and SDL_PrivateSensorValid().

◆ SDL_SensorGetDeviceInstanceID()

SDL_SensorID SDL_SensorGetDeviceInstanceID ( int  device_index)

Get the instance ID of a sensor.

This can be called before any sensors are opened.

Returns
The sensor instance ID, or -1 if device_index is out of range.

Definition at line 195 of file SDL_sensor.c.

196 {
197  SDL_SensorDriver *driver;
198  SDL_SensorID instance_id = -1;
199 
200  SDL_LockSensors();
201  if (SDL_GetDriverAndSensorIndex(device_index, &driver, &device_index)) {
202  instance_id = driver->GetDeviceInstanceID(device_index);
203  }
205 
206  return instance_id;
207 }
static SDL_bool SDL_GetDriverAndSensorIndex(int device_index, SDL_SensorDriver **driver, int *driver_index)
Definition: SDL_sensor.c:124
Sint32 SDL_SensorID
Definition: SDL_sensor.h:60
SDL_SensorID(* GetDeviceInstanceID)(int device_index)
Definition: SDL_syssensor.h:75

References SDL_SensorDriver::GetDeviceInstanceID, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().

◆ SDL_SensorGetDeviceName()

const char* SDL_SensorGetDeviceName ( int  device_index)

Get the implementation dependent name of a sensor.

This can be called before any sensors are opened.

Returns
The sensor name, or NULL if device_index is out of range.

Definition at line 149 of file SDL_sensor.c.

150 {
151  SDL_SensorDriver *driver;
152  const char *name = NULL;
153 
154  SDL_LockSensors();
155  if (SDL_GetDriverAndSensorIndex(device_index, &driver, &device_index)) {
156  name = driver->GetDeviceName(device_index);
157  }
159 
160  /* FIXME: Really we should reference count this name so it doesn't go away after unlock */
161  return name;
162 }
GLuint const GLchar * name
const char *(* GetDeviceName)(int device_index)
Definition: SDL_syssensor.h:66

References SDL_SensorDriver::GetDeviceName, NULL, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().

◆ SDL_SensorGetDeviceNonPortableType()

int SDL_SensorGetDeviceNonPortableType ( int  device_index)

Get the platform dependent type of a sensor.

This can be called before any sensors are opened.

Returns
The sensor platform dependent type, or -1 if device_index is out of range.

Definition at line 180 of file SDL_sensor.c.

181 {
182  SDL_SensorDriver *driver;
183  int type = -1;
184 
185  SDL_LockSensors();
186  if (SDL_GetDriverAndSensorIndex(device_index, &driver, &device_index)) {
187  type = driver->GetDeviceNonPortableType(device_index);
188  }
190 
191  return type;
192 }
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1571
int(* GetDeviceNonPortableType)(int device_index)
Definition: SDL_syssensor.h:72

References SDL_SensorDriver::GetDeviceNonPortableType, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), and SDL_UnlockSensors().

◆ SDL_SensorGetDeviceType()

SDL_SensorType SDL_SensorGetDeviceType ( int  device_index)

Get the type of a sensor.

This can be called before any sensors are opened.

Returns
The sensor type, or SDL_SENSOR_INVALID if device_index is out of range.

Definition at line 165 of file SDL_sensor.c.

166 {
167  SDL_SensorDriver *driver;
169 
170  SDL_LockSensors();
171  if (SDL_GetDriverAndSensorIndex(device_index, &driver, &device_index)) {
172  type = driver->GetDeviceType(device_index);
173  }
175 
176  return type;
177 }
SDL_SensorType(* GetDeviceType)(int device_index)
Definition: SDL_syssensor.h:69

References SDL_SensorDriver::GetDeviceType, SDL_GetDriverAndSensorIndex(), SDL_LockSensors(), SDL_SENSOR_INVALID, and SDL_UnlockSensors().

◆ SDL_SensorGetInstanceID()

SDL_SensorID SDL_SensorGetInstanceID ( SDL_Sensor *  sensor)

Get the instance ID of a sensor.

This can be called before any sensors are opened.

Returns
The sensor instance ID, or -1 if the sensor is NULL.

Definition at line 364 of file SDL_sensor.c.

365 {
366  if (!SDL_PrivateSensorValid(sensor)) {
367  return -1;
368  }
369 
370  return sensor->instance_id;
371 }

References SDL_PrivateSensorValid().

◆ SDL_SensorGetName()

const char* SDL_SensorGetName ( SDL_Sensor *  sensor)

Get the implementation dependent name of a sensor.

Returns
The sensor name, or NULL if the sensor is NULL.

Definition at line 325 of file SDL_sensor.c.

326 {
327  if (!SDL_PrivateSensorValid(sensor)) {
328  return NULL;
329  }
330 
331  return sensor->name;
332 }

References NULL, and SDL_PrivateSensorValid().

◆ SDL_SensorGetNonPortableType()

int SDL_SensorGetNonPortableType ( SDL_Sensor *  sensor)

Get the platform dependent type of a sensor.

This can be called before any sensors are opened.

Returns
The sensor platform dependent type, or -1 if the sensor is NULL.

Definition at line 351 of file SDL_sensor.c.

352 {
353  if (!SDL_PrivateSensorValid(sensor)) {
354  return -1;
355  }
356 
357  return sensor->non_portable_type;
358 }

References SDL_PrivateSensorValid().

◆ SDL_SensorGetType()

SDL_SensorType SDL_SensorGetType ( SDL_Sensor *  sensor)

Get the type of a sensor.

This can be called before any sensors are opened.

Returns
The sensor type, or SDL_SENSOR_INVALID if the sensor is NULL.

Definition at line 338 of file SDL_sensor.c.

339 {
340  if (!SDL_PrivateSensorValid(sensor)) {
341  return SDL_SENSOR_INVALID;
342  }
343 
344  return sensor->type;
345 }

References SDL_PrivateSensorValid(), and SDL_SENSOR_INVALID.

◆ SDL_SensorOpen()

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.

Returns
A sensor identifier, or NULL if an error occurred.

Definition at line 217 of file SDL_sensor.c.

218 {
219  SDL_SensorDriver *driver;
220  SDL_SensorID instance_id;
221  SDL_Sensor *sensor;
222  SDL_Sensor *sensorlist;
223  const char *sensorname = NULL;
224 
225  SDL_LockSensors();
226 
227  if (!SDL_GetDriverAndSensorIndex(device_index, &driver, &device_index)) {
229  return NULL;
230  }
231 
232  sensorlist = SDL_sensors;
233  /* If the sensor is already open, return it
234  * it is important that we have a single sensor * for each instance id
235  */
236  instance_id = driver->GetDeviceInstanceID(device_index);
237  while (sensorlist) {
238  if (instance_id == sensorlist->instance_id) {
239  sensor = sensorlist;
240  ++sensor->ref_count;
242  return sensor;
243  }
244  sensorlist = sensorlist->next;
245  }
246 
247  /* Create and initialize the sensor */
248  sensor = (SDL_Sensor *) SDL_calloc(sizeof(*sensor), 1);
249  if (sensor == NULL) {
250  SDL_OutOfMemory();
252  return NULL;
253  }
254  sensor->driver = driver;
255  sensor->instance_id = instance_id;
256  sensor->type = driver->GetDeviceType(device_index);
257  sensor->non_portable_type = driver->GetDeviceNonPortableType(device_index);
258 
259  if (driver->Open(sensor, device_index) < 0) {
260  SDL_free(sensor);
262  return NULL;
263  }
264 
265  sensorname = driver->GetDeviceName(device_index);
266  if (sensorname) {
267  sensor->name = SDL_strdup(sensorname);
268  } else {
269  sensor->name = NULL;
270  }
271 
272  /* Add sensor to list */
273  ++sensor->ref_count;
274  /* Link the sensor in the list */
275  sensor->next = SDL_sensors;
276  SDL_sensors = sensor;
277 
279 
280  driver->Update(sensor);
281 
282  return sensor;
283 }
#define SDL_strdup
#define SDL_calloc
#define SDL_OutOfMemory()
Definition: SDL_error.h:88
void(* Update)(SDL_Sensor *sensor)
Definition: SDL_syssensor.h:88
int(* Open)(SDL_Sensor *sensor, int device_index)
Definition: SDL_syssensor.h:81

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.

◆ SDL_SensorUpdate()

void SDL_SensorUpdate ( void  )

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.

◆ SDL_UnlockSensors()