Ubuntu Platform API  2.2.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
light.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_LIGHT_EVENT_H_
20 #define UBUNTU_APPLICATION_SENSORS_LIGHT_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 void UASLightEvent;
35 
42  UBUNTU_DLL_PUBLIC uint64_t
44  UASLightEvent* event);
45 
54  UASLightEvent* event,
55  float* value);
56 
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif /* UBUNTU_APPLICATION_SENSORS_LIGHT_EVENT_H_ */
UBUNTU_DLL_PUBLIC UStatus uas_light_event_get_light(UASLightEvent *event, float *value)
Query the value measured by the ambient light sensor.
UbuntuStatus
Indicates the status of an operation.
Definition: status.h:26
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
void UASLightEvent
Opaque type describing an ambient light sensor reading.
Definition: light.h:34
UBUNTU_DLL_PUBLIC uint64_t uas_light_event_get_timestamp(UASLightEvent *event)
Query the timestamp of the sensor reading.