CCAux  2.7.2.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Backlight.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Backlight.h
6 *
7 * Version 2.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Backlight settings
13 *
14 * Use the function GetBacklight() to get a handle to pass on to the other functions.
15 * Use the method Backlight_release(BACKLIGHTHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include backlight_example.cpp
19 *
20 ************************************************/
21 
22 #ifndef CC_BACKLIGHT_H_
23 #define CC_BACKLIGHT_H_
24 
25 #include "CCAuxErrors.h"
26 #include "CCAuxTypes.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* BACKLIGHTHANDLE;
34 
48  EXTERN_C
49  CCAUXDLL_API
50  BACKLIGHTHANDLE
51  CCAUXDLL_CALLING_CONV
52  GetBacklight(void);
53 
64  EXTERN_C
65  CCAUXDLL_API
66  void
67  CCAUXDLL_CALLING_CONV
68  Backlight_release(BACKLIGHTHANDLE);
69 
83  EXTERN_C
84  CCAUXDLL_API
85  eErr
86  CCAUXDLL_CALLING_CONV
87  Backlight_getIntensity (BACKLIGHTHANDLE, unsigned char* intensity);
88 
102  EXTERN_C
103  CCAUXDLL_API
104  eErr
105  CCAUXDLL_CALLING_CONV
106  Backlight_setIntensity(BACKLIGHTHANDLE, unsigned char intensity);
107 
121  EXTERN_C
122  CCAUXDLL_API
123  eErr
124  CCAUXDLL_CALLING_CONV
125  Backlight_getStatus(BACKLIGHTHANDLE, unsigned char* status);
126 
140  EXTERN_C
141  CCAUXDLL_API
142  eErr
143  CCAUXDLL_CALLING_CONV
144  Backlight_getHWStatus(BACKLIGHTHANDLE, bool* status);
145 
154  EXTERN_C
155  CCAUXDLL_API
156  eErr
157  CCAUXDLL_CALLING_CONV
158  Backlight_startAutomaticBL(BACKLIGHTHANDLE);
159 
167  EXTERN_C
168  CCAUXDLL_API
169  eErr
170  CCAUXDLL_CALLING_CONV
171  Backlight_stopAutomaticBL(BACKLIGHTHANDLE);
172 
182  EXTERN_C
183  CCAUXDLL_API
184  eErr
185  CCAUXDLL_CALLING_CONV
186  Backlight_getAutomaticBLStatus(BACKLIGHTHANDLE, unsigned char* status);
187 
197  EXTERN_C
198  CCAUXDLL_API
199  eErr
200  CCAUXDLL_CALLING_CONV
201  Backlight_setAutomaticBLParams(BACKLIGHTHANDLE, bool bSoftTransitions);
202 
213  EXTERN_C
214  CCAUXDLL_API
215  eErr
216  CCAUXDLL_CALLING_CONV
217  Backlight_getAutomaticBLParams(BACKLIGHTHANDLE, bool* bSoftTransitions, double* k);
218 
231  EXTERN_C
232  CCAUXDLL_API
233  eErr
234  CCAUXDLL_CALLING_CONV
235  Backlight_setAutomaticBLFilter(
236  BACKLIGHTHANDLE,
237  unsigned long averageWndSize,
238  unsigned long rejectWndSize,
239  unsigned long rejectDeltaInLux,
240  LightSensorSamplingMode mode);
241 
254  EXTERN_C
255  CCAUXDLL_API
256  eErr
257  CCAUXDLL_CALLING_CONV
258  Backlight_getAutomaticBLFilter(
259  BACKLIGHTHANDLE,
260  unsigned long* averageWndSize,
261  unsigned long* rejectWndSize,
262  unsigned long* rejectDeltaInLux,
263  LightSensorSamplingMode* mode);
264 
277  EXTERN_C
278  CCAUXDLL_API
279  eErr
280  CCAUXDLL_CALLING_CONV
281  Backlight_getLedDimming(BACKLIGHTHANDLE, CCStatus* status);
282 
295  EXTERN_C
296  CCAUXDLL_API
297  eErr
298  CCAUXDLL_CALLING_CONV
299  Backlight_setLedDimming(BACKLIGHTHANDLE, CCStatus status);
300 
301 #ifdef __cplusplus
302 } /* namespace CrossControl */
303 #endif
304 
305 #endif /* CC_BACKLIGHT_H_ */
306 
307 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1