Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
proximity.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_SENSORS_PROXIMITY_EVENT_H_
20 #define UBUNTU_APPLICATION_SENSORS_PROXIMITY_EVENT_H_
21 
22 #include <ubuntu/visibility.h>
23 
24 #include <stdint.h>
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
34  typedef enum {
38 
40 
45  typedef void UASProximityEvent;
46 
53  UBUNTU_DLL_PUBLIC uint64_t
55  UASProximityEvent* event);
56 
65  UASProximityEvent* event);
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif /* UBUNTU_APPLICATION_SENSORS_PROXIMITY_EVENT_H_ */
uas_proximity_event_get_distance
UBUNTU_DLL_PUBLIC UASProximityDistance uas_proximity_event_get_distance(UASProximityEvent *event)
Query the discrete distance as reported by the proximity sensor.
visibility.h
UASProximityDistance
UbuntuApplicationSensorsProximityDistance UASProximityDistance
Definition: proximity.h:39
U_PROXIMITY_FAR
@ U_PROXIMITY_FAR
Definition: proximity.h:36
U_PROXIMITY_NEAR
@ U_PROXIMITY_NEAR
Definition: proximity.h:35
UBUNTU_DLL_PUBLIC
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
UASProximityEvent
void UASProximityEvent
Opaque type describing an accelerometer reading.
Definition: proximity.h:45
uas_proximity_event_get_timestamp
UBUNTU_DLL_PUBLIC uint64_t uas_proximity_event_get_timestamp(UASProximityEvent *event)
Query the timestamp of the sensor reading.
UbuntuApplicationSensorsProximityDistance
UbuntuApplicationSensorsProximityDistance
Useful constants when inspecting readings from the proximity sensor.
Definition: proximity.h:34