CCAux  2.20.0.0
CCAux API reference
Backlight.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 2023 CrossControl AB
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; with
8  * version 2.1 of the License.
9  */
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 {
32 #endif
33 
34 typedef void *BACKLIGHTHANDLE;
35 
55 EXTERN_C
56 CCAUXDLL_API
58 CCAUXDLL_CALLING_CONV
60 
71 EXTERN_C
72 CCAUXDLL_API
73 void CCAUXDLL_CALLING_CONV Backlight_release(BACKLIGHTHANDLE);
74 
88 EXTERN_C
89 CCAUXDLL_API
90 eErr CCAUXDLL_CALLING_CONV Backlight_getIntensity(BACKLIGHTHANDLE, uint8_t *intensity);
91 
105 EXTERN_C
106 CCAUXDLL_API
107 eErr CCAUXDLL_CALLING_CONV Backlight_setIntensity(BACKLIGHTHANDLE, uint8_t intensity);
108 
123 EXTERN_C
124 CCAUXDLL_API
125 eErr CCAUXDLL_CALLING_CONV Backlight_getStatus(BACKLIGHTHANDLE, uint8_t *status);
126 
140 EXTERN_C
141 CCAUXDLL_API
142 eErr CCAUXDLL_CALLING_CONV Backlight_getHWStatus(BACKLIGHTHANDLE, bool *status);
143 
152 EXTERN_C
153 CCAUXDLL_API
155 
163 EXTERN_C
164 CCAUXDLL_API
166 
176 EXTERN_C
177 CCAUXDLL_API
179 
189 EXTERN_C
190 CCAUXDLL_API
191 eErr CCAUXDLL_CALLING_CONV Backlight_setAutomaticBLParams(BACKLIGHTHANDLE, bool bSoftTransitions);
192 
203 EXTERN_C
204 CCAUXDLL_API
205 eErr CCAUXDLL_CALLING_CONV Backlight_getAutomaticBLParams(BACKLIGHTHANDLE, bool *bSoftTransitions, float64_t *k);
206 
219 EXTERN_C
220 CCAUXDLL_API
221 eErr CCAUXDLL_CALLING_CONV Backlight_setAutomaticBLFilter(BACKLIGHTHANDLE, uint32_t averageWndSize,
222  uint32_t rejectWndSize, uint32_t rejectDeltaInLux,
224 
237 EXTERN_C
238 CCAUXDLL_API
239 eErr CCAUXDLL_CALLING_CONV Backlight_getAutomaticBLFilter(BACKLIGHTHANDLE, uint32_t *averageWndSize,
240  uint32_t *rejectWndSize, uint32_t *rejectDeltaInLux,
242 
255 EXTERN_C
256 CCAUXDLL_API
257 eErr CCAUXDLL_CALLING_CONV Backlight_getLedDimming(BACKLIGHTHANDLE, CCStatus *status);
258 
271 EXTERN_C
272 CCAUXDLL_API
273 eErr CCAUXDLL_CALLING_CONV Backlight_setLedDimming(BACKLIGHTHANDLE, CCStatus status);
274 
284 EXTERN_C
285 CCAUXDLL_API
287 
297 EXTERN_C
298 CCAUXDLL_API
299 eErr CCAUXDLL_CALLING_CONV Backlight_getActive(BACKLIGHTHANDLE, ComponentLocation *location);
300 
302 #ifdef __cplusplus
303 } /* namespace CrossControl */
304 #endif
305 
306 #endif /* CC_BACKLIGHT_H_ */
unsigned int uint32_t
Definition: CCAuxTypes.h:39
unsigned char uint8_t
Definition: CCAuxTypes.h:37
double float64_t
Definition: CCAuxTypes.h:16
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_startAutomaticBL(BACKLIGHTHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getAutomaticBLStatus(BACKLIGHTHANDLE, uint8_t *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getIntensity(BACKLIGHTHANDLE, uint8_t *intensity)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getStatus(BACKLIGHTHANDLE, uint8_t *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getAutomaticBLFilter(BACKLIGHTHANDLE, uint32_t *averageWndSize, uint32_t *rejectWndSize, uint32_t *rejectDeltaInLux, LightSensorSamplingMode *mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_setAutomaticBLFilter(BACKLIGHTHANDLE, uint32_t averageWndSize, uint32_t rejectWndSize, uint32_t rejectDeltaInLux, LightSensorSamplingMode mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_setActive(BACKLIGHTHANDLE, ComponentLocation location)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getAutomaticBLParams(BACKLIGHTHANDLE, bool *bSoftTransitions, float64_t *k)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getHWStatus(BACKLIGHTHANDLE, bool *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_stopAutomaticBL(BACKLIGHTHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_setLedDimming(BACKLIGHTHANDLE, CCStatus status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_setAutomaticBLParams(BACKLIGHTHANDLE, bool bSoftTransitions)
EXTERN_C CCAUXDLL_API BACKLIGHTHANDLE CCAUXDLL_CALLING_CONV GetBacklight(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getLedDimming(BACKLIGHTHANDLE, CCStatus *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_setIntensity(BACKLIGHTHANDLE, uint8_t intensity)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Backlight_getActive(BACKLIGHTHANDLE, ComponentLocation *location)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Backlight_release(BACKLIGHTHANDLE)
Definition: About.h:30
void * BACKLIGHTHANDLE
Definition: Backlight.h:34
LightSensorSamplingMode
Definition: CCAuxTypes.h:142
CCStatus
Definition: CCAuxTypes.h:153
ComponentLocation
Definition: CCAuxTypes.h:569
eErr
Definition: CCAuxTypes.h:162