Backlight.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  Backlight.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description: 
 *  Backlight settings 
 *
 *  Use the function GetBacklight() to get a handle to pass on to the other functions. 
 *  Use the method Backlight_release(BACKLIGHTHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include backlight_example.cpp
 *
 ************************************************/

#ifndef CC_BACKLIGHT_H_
#define CC_BACKLIGHT_H_

#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* BACKLIGHTHANDLE;

  EXTERN_C
    CCAUXDLL_API
    BACKLIGHTHANDLE
    CCAUXDLL_CALLING_CONV
    GetBacklight(void);

  EXTERN_C
    CCAUXDLL_API
    void
    CCAUXDLL_CALLING_CONV
    Backlight_release(BACKLIGHTHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_getIntensity (BACKLIGHTHANDLE, uint8_t* intensity);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_setIntensity(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_getHWStatus(BACKLIGHTHANDLE, bool* status);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_startAutomaticBL(BACKLIGHTHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_stopAutomaticBL(BACKLIGHTHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_getAutomaticBLStatus(BACKLIGHTHANDLE, uint8_t* status);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_setAutomaticBLParams(BACKLIGHTHANDLE, bool bSoftTransitions);

  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_setAutomaticBLFilter(
    BACKLIGHTHANDLE, 
    uint32_t averageWndSize,
    uint32_t rejectWndSize,
    uint32_t rejectDeltaInLux,
    LightSensorSamplingMode mode);

  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_getLedDimming(BACKLIGHTHANDLE, CCStatus* status);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Backlight_setLedDimming(BACKLIGHTHANDLE, CCStatus status);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_BACKLIGHT_H_ */