CCAux  2.8.3.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.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Backlight settings
14  *
15  * Use the function GetBacklight() to get a handle to pass on to the other functions.
16  * Use the method Backlight_release(BACKLIGHTHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include backlight_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_BACKLIGHT_H_
24 #define CC_BACKLIGHT_H_
25 
26 #include "CCAuxErrors.h"
27 #include "CCAuxTypes.h"
28 #include "CCPlatform.h"
29 
30 #ifdef __cplusplus
31 namespace CrossControl {
32 #endif
33 
34  typedef void* BACKLIGHTHANDLE;
35 
49  EXTERN_C
50  CCAUXDLL_API
51  BACKLIGHTHANDLE
52  CCAUXDLL_CALLING_CONV
53  GetBacklight(void);
54 
65  EXTERN_C
66  CCAUXDLL_API
67  void
68  CCAUXDLL_CALLING_CONV
69  Backlight_release(BACKLIGHTHANDLE);
70 
84  EXTERN_C
85  CCAUXDLL_API
86  eErr
87  CCAUXDLL_CALLING_CONV
88  Backlight_getIntensity (BACKLIGHTHANDLE, unsigned char* intensity);
89 
103  EXTERN_C
104  CCAUXDLL_API
105  eErr
106  CCAUXDLL_CALLING_CONV
107  Backlight_setIntensity(BACKLIGHTHANDLE, unsigned char intensity);
108 
122  EXTERN_C
123  CCAUXDLL_API
124  eErr
125  CCAUXDLL_CALLING_CONV
126  Backlight_getStatus(BACKLIGHTHANDLE, unsigned char* status);
127 
141  EXTERN_C
142  CCAUXDLL_API
143  eErr
144  CCAUXDLL_CALLING_CONV
145  Backlight_getHWStatus(BACKLIGHTHANDLE, bool* status);
146 
155  EXTERN_C
156  CCAUXDLL_API
157  eErr
158  CCAUXDLL_CALLING_CONV
159  Backlight_startAutomaticBL(BACKLIGHTHANDLE);
160 
168  EXTERN_C
169  CCAUXDLL_API
170  eErr
171  CCAUXDLL_CALLING_CONV
172  Backlight_stopAutomaticBL(BACKLIGHTHANDLE);
173 
183  EXTERN_C
184  CCAUXDLL_API
185  eErr
186  CCAUXDLL_CALLING_CONV
187  Backlight_getAutomaticBLStatus(BACKLIGHTHANDLE, unsigned char* status);
188 
198  EXTERN_C
199  CCAUXDLL_API
200  eErr
201  CCAUXDLL_CALLING_CONV
202  Backlight_setAutomaticBLParams(BACKLIGHTHANDLE, bool bSoftTransitions);
203 
214  EXTERN_C
215  CCAUXDLL_API
216  eErr
217  CCAUXDLL_CALLING_CONV
218  Backlight_getAutomaticBLParams(BACKLIGHTHANDLE, bool* bSoftTransitions, double* k);
219 
232  EXTERN_C
233  CCAUXDLL_API
234  eErr
235  CCAUXDLL_CALLING_CONV
236  Backlight_setAutomaticBLFilter(
237  BACKLIGHTHANDLE,
238  unsigned long averageWndSize,
239  unsigned long rejectWndSize,
240  unsigned long rejectDeltaInLux,
241  LightSensorSamplingMode mode);
242 
255  EXTERN_C
256  CCAUXDLL_API
257  eErr
258  CCAUXDLL_CALLING_CONV
259  Backlight_getAutomaticBLFilter(
260  BACKLIGHTHANDLE,
261  unsigned long* averageWndSize,
262  unsigned long* rejectWndSize,
263  unsigned long* rejectDeltaInLux,
264  LightSensorSamplingMode* mode);
265 
278  EXTERN_C
279  CCAUXDLL_API
280  eErr
281  CCAUXDLL_CALLING_CONV
282  Backlight_getLedDimming(BACKLIGHTHANDLE, CCStatus* status);
283 
296  EXTERN_C
297  CCAUXDLL_API
298  eErr
299  CCAUXDLL_CALLING_CONV
300  Backlight_setLedDimming(BACKLIGHTHANDLE, CCStatus status);
301 
302 #ifdef __cplusplus
303 } /* namespace CrossControl */
304 #endif
305 
306 #endif /* CC_BACKLIGHT_H_ */
307 
308 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1