tobii_research_calibration.h

Go to the documentation of this file.

#ifndef TOBII_RESEARCH_CALIBRATION_H_
#define TOBII_RESEARCH_CALIBRATION_H_

#include "tobii_research.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    TOBII_RESEARCH_CALIBRATION_FAILURE = 0,
    TOBII_RESEARCH_CALIBRATION_SUCCESS = 1,
    TOBII_RESEARCH_CALIBRATION_SUCCESS_LEFT_EYE = 2,
    TOBII_RESEARCH_CALIBRATION_SUCCESS_RIGHT_EYE = 3
} TobiiResearchCalibrationStatus;

typedef enum TobiiResearchSelectedEye {
    TOBII_RESEARCH_SELECTED_EYE_LEFT,

    TOBII_RESEARCH_SELECTED_EYE_RIGHT,

    TOBII_RESEARCH_SELECTED_EYE_BOTH
} TobiiResearchSelectedEye;

typedef enum {
    TOBII_RESEARCH_CALIBRATION_EYE_VALIDITY_INVALID_AND_NOT_USED = -1,

    TOBII_RESEARCH_CALIBRATION_EYE_VALIDITY_VALID_BUT_NOT_USED = 0,

    TOBII_RESEARCH_CALIBRATION_EYE_VALIDITY_VALID_AND_USED = 1,

    TOBII_RESEARCH_CALIBRATION_EYE_VALIDITY_UNKNOWN
} TobiiResearchCalibrationEyeValidity;

typedef struct {
    TobiiResearchNormalizedPoint2D position_on_display_area;
    TobiiResearchCalibrationEyeValidity validity;
} TobiiResearchCalibrationEyeData;

typedef struct {
    TobiiResearchCalibrationEyeData left_eye;
    TobiiResearchCalibrationEyeData right_eye;
} TobiiResearchCalibrationSample;

typedef struct {
    TobiiResearchNormalizedPoint2D position_on_display_area;
    TobiiResearchCalibrationSample* calibration_samples;
    size_t calibration_sample_count;
} TobiiResearchCalibrationPoint;

typedef struct {
    TobiiResearchCalibrationPoint* calibration_points;
    size_t calibration_point_count;
    TobiiResearchCalibrationStatus status;
} TobiiResearchCalibrationResult;


typedef struct {
    TobiiResearchCalibrationStatus status;
} TobiiResearchHMDCalibrationResult;

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
                       tobii_research_screen_based_calibration_enter_calibration_mode(
                               TobiiResearchEyeTracker* eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
                        tobii_research_screen_based_calibration_leave_calibration_mode(
                                TobiiResearchEyeTracker* eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_screen_based_calibration_collect_data(
        TobiiResearchEyeTracker* eyetracker,
        float x,
        float y);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_screen_based_calibration_discard_data(
        TobiiResearchEyeTracker* eyetracker,
        float x,
        float y);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_screen_based_calibration_compute_and_apply(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchCalibrationResult** result);

TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_screen_based_calibration_result(
        TobiiResearchCalibrationResult* result);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
    tobii_research_screen_based_monocular_calibration_collect_data(TobiiResearchEyeTracker* eyetracker,
                float x, float y, TobiiResearchSelectedEye eye_to_calibrate, TobiiResearchSelectedEye* collected_eyes);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
    tobii_research_screen_based_monocular_calibration_discard_data(TobiiResearchEyeTracker* eyetracker,
                float x, float y, TobiiResearchSelectedEye eye_to_calibrate);
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
    tobii_research_screen_based_monocular_calibration_compute_and_apply(TobiiResearchEyeTracker* eyetracker,
        TobiiResearchCalibrationResult** result);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
                       tobii_research_hmd_based_calibration_enter_calibration_mode(
                               TobiiResearchEyeTracker* eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL
                        tobii_research_hmd_based_calibration_leave_calibration_mode(
                                TobiiResearchEyeTracker* eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_hmd_based_calibration_collect_data(
    TobiiResearchEyeTracker* eyetracker, float x, float y, float z);


TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_hmd_based_calibration_compute_and_apply(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchHMDCalibrationResult* result);

#ifdef __cplusplus
}
#endif
#endif /* TOBII_RESEARCH_CALIBRATION_H_ */