#include <ubuntu/status.h>
#include <ubuntu/visibility.h>
#include <ubuntu/application/sensors/event/gyroscope.h>
Go to the source code of this file.
Typedefs | |
typedef void | UASensorsGyroscope |
Opaque type that models the gyroscope. More... | |
typedef void(* | on_gyroscope_event_cb) (UASGyroscopeEvent *event, void *context) |
Callback type used by applications to subscribe to orientation events. More... | |
Functions | |
UBUNTU_DLL_PUBLIC UASensorsGyroscope * | ua_sensors_gyroscope_new () |
Create a new object for accessing the gyroscopic sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_enable (UASensorsGyroscope *sensor) |
Enables the supplied gyroscopic sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_disable (UASensorsGyroscope *sensor) |
Disables the supplied gyroscopic sensor. More... | |
UBUNTU_DLL_PUBLIC uint32_t | ua_sensors_gyroscope_get_min_delay (UASensorsGyroscope *sensor) |
Queries the minimum delay between two readings for the supplied sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_get_min_value (UASensorsGyroscope *sensor, float *value) |
Queries the minimum value that can be reported by the sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_get_max_value (UASensorsGyroscope *sensor, float *value) |
Queries the maximum value that can be reported by the sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_get_resolution (UASensorsGyroscope *sensor, float *value) |
Queries the numeric resolution supported by the sensor. More... | |
UBUNTU_DLL_PUBLIC void | ua_sensors_gyroscope_set_reading_cb (UASensorsGyroscope *sensor, on_gyroscope_event_cb cb, void *ctx) |
Set the callback to be invoked whenever a new sensor reading is available. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_gyroscope_set_event_rate (UASensorsGyroscope *sensor, uint32_t rate) |
Set the sensor event delivery rate in nanoseconds.. More... | |
typedef void(* on_gyroscope_event_cb) (UASGyroscopeEvent *event, void *context) |
Callback type used by applications to subscribe to orientation events.
Definition at line 41 of file gyroscope.h.
typedef void UASensorsGyroscope |
Opaque type that models the gyroscope.
Definition at line 35 of file gyroscope.h.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_disable | ( | UASensorsGyroscope * | sensor | ) |
Disables the supplied gyroscopic sensor.
[in] | sensor | The sensor instance to be disabled. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_enable | ( | UASensorsGyroscope * | sensor | ) |
Enables the supplied gyroscopic sensor.
[in] | sensor | The sensor instance to be enabled. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_get_max_value | ( | UASensorsGyroscope * | sensor, |
float * | value | ||
) |
Queries the maximum value that can be reported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC uint32_t ua_sensors_gyroscope_get_min_delay | ( | UASensorsGyroscope * | sensor | ) |
Queries the minimum delay between two readings for the supplied sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_get_min_value | ( | UASensorsGyroscope * | sensor, |
float * | value | ||
) |
Queries the minimum value that can be reported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_get_resolution | ( | UASensorsGyroscope * | sensor, |
float * | value | ||
) |
Queries the numeric resolution supported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UASensorsGyroscope* ua_sensors_gyroscope_new | ( | ) |
Create a new object for accessing the gyroscopic sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_gyroscope_set_event_rate | ( | UASensorsGyroscope * | sensor, |
uint32_t | rate | ||
) |
Set the sensor event delivery rate in nanoseconds..
[in] | sensor | The sensor instance to be modified. |
[in] | rate | The new event delivery rate. |
UBUNTU_DLL_PUBLIC void ua_sensors_gyroscope_set_reading_cb | ( | UASensorsGyroscope * | sensor, |
on_gyroscope_event_cb | cb, | ||
void * | ctx | ||
) |
Set the callback to be invoked whenever a new sensor reading is available.
[in] | sensor | The sensor instance to associate the callback with. |
[in] | cb | The callback to be invoked. |
[in] | ctx | The context supplied to the callback invocation. |