TouchScreenCalib.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Touch Screen Calibration interface
 *  Note that the VC platform uses a different touch screen solution which is not supported by this API.
 *
 *  Use the function GetTouchScreenCalib() to get a handle to pass on to the other functions.
 *  Use the method TouchScreenCalib_release(TOUCHSCREENCALIBHANDLE) to return the handle.
 *
 ************************************************/
 
#ifndef CC_TOUCHSCRCALIB_H
#define CC_TOUCHSCRCALIB_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *TOUCHSCREENCALIBHANDLE;
 
typedef enum
{
    MODE_UNKNOWN         = 0, 
    MODE_NORMAL          = 1, 
    MODE_CALIBRATION_5P  = 2, 
    MODE_CALIBRATION_9P  = 3, 
    MODE_CALIBRATION_13P = 4  
} CalibrationModeSettings;
 
typedef enum
{
    CONFIG_CALIBRATION_WITH         = 0, 
    CONFIG_CALIBRATION_MEASUREMENTS = 1, 
    CONFIG_5P_CALIBRATION_POINT_BORDER =
        2, 
    CONFIG_13P_CALIBRATION_POINT_BORDER =
        3, 
    CONFIG_13P_CALIBRATION_TRANSITION_MIN =
        4, 
    CONFIG_13P_CALIBRATION_TRANSITION_MAX =
        5 
} CalibrationConfigParam;
 
EXTERN_C
CCAUXDLL_API
TOUCHSCREENCALIBHANDLE
CCAUXDLL_CALLING_CONV
GetTouchScreenCalib(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV TouchScreenCalib_release(TOUCHSCREENCALIBHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_setMode(TOUCHSCREENCALIBHANDLE, CalibrationModeSettings mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_getMode(TOUCHSCREENCALIBHANDLE, CalibrationModeSettings *mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_setCalibrationPoint(TOUCHSCREENCALIBHANDLE, uint8_t pointNr);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_checkCalibrationPointFinished(TOUCHSCREENCALIBHANDLE, bool *finished,
                                                                          uint8_t pointNr);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_getConfigParam(TOUCHSCREENCALIBHANDLE, CalibrationConfigParam param,
                                                           uint16_t *value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_setConfigParam(TOUCHSCREENCALIBHANDLE, CalibrationConfigParam param,
                                                           uint16_t value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreenCalib_autoSensorCalib(TOUCHSCREENCALIBHANDLE);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_TOUCHSCRCALIB_H */