tobii_research_eyetracker.h

Go to the documentation of this file.

#ifndef TOBII_RESEARCH_EYETRACKER_H_
#define TOBII_RESEARCH_EYETRACKER_H_

#include "tobii_research.h"

typedef enum {
    TOBII_RESEARCH_CAPABILITIES_NONE,

    TOBII_RESEARCH_CAPABILITIES_CAN_SET_DISPLAY_AREA = 1 << 0,

    TOBII_RESEARCH_CAPABILITIES_HAS_EXTERNAL_SIGNAL = 1 << 1,

    TOBII_RESEARCH_CAPABILITIES_HAS_EYE_IMAGES = 1 << 2,

    TOBII_RESEARCH_CAPABILITIES_HAS_GAZE_DATA  = 1 << 3,

    TOBII_RESEARCH_CAPABILITIES_HAS_HMD_GAZE_DATA = 1 << 4,

    TOBII_RESEARCH_CAPABILITIES_CAN_DO_SCREEN_BASED_CALIBRATION  = 1 << 5,

    TOBII_RESEARCH_CAPABILITIES_CAN_DO_HMD_BASED_CALIBRATION  = 1 << 6,

    TOBII_RESEARCH_CAPABILITIES_HAS_HMD_LENS_CONFIG  = 1 << 7,
} TobiiResearchCapabilities;

typedef struct {
    TobiiResearchPoint3D back_lower_left;

    TobiiResearchPoint3D back_lower_right;

    TobiiResearchPoint3D back_upper_left;

    TobiiResearchPoint3D back_upper_right;

    TobiiResearchPoint3D front_lower_left;

    TobiiResearchPoint3D front_lower_right;

    TobiiResearchPoint3D front_upper_left;

    TobiiResearchPoint3D front_upper_right;
} TobiiResearchTrackBox;

typedef enum TobiiResearchLicenseValidationResult {
    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_OK,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_TAMPERED,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_INVALID_APPLICATION_SIGNATURE,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_NONSIGNED_APPLICATION,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_EXPIRED,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_PREMATURE,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_INVALID_PROCESS_NAME,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_INVALID_SERIAL_NUMBER,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_INVALID_MODEL,

    TOBII_RESEARCH_LICENSE_VALIDATION_RESULT_UNKNOWN
} TobiiResearchLicenseValidationResult;

typedef struct {
    TobiiResearchPoint3D bottom_left;

    TobiiResearchPoint3D bottom_right;

    float height;

    TobiiResearchPoint3D top_left;

    TobiiResearchPoint3D top_right;

    float width;
} TobiiResearchDisplayArea;

typedef struct {
    void* data;
    size_t size;
} TobiiResearchCalibrationData;

typedef struct {
    float* frequencies;
    size_t frequency_count;
} TobiiResearchGazeOutputFrequencies;

typedef struct {
    char** modes;
    size_t mode_count;
} TobiiResearchEyeTrackingModes;

typedef struct {
    TobiiResearchPoint3D left;
    TobiiResearchPoint3D right;
} TobiiResearchHMDLensConfiguration;

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_address(
        TobiiResearchEyeTracker* eyetracker, char** address);
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_serial_number(
        TobiiResearchEyeTracker* eyetracker, char** serial_number);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_device_name(
        TobiiResearchEyeTracker* eyetracker, char** device_name);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_model(
        TobiiResearchEyeTracker* eyetracker, char** model);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_firmware_version(
        TobiiResearchEyeTracker* eyetracker, char** fw_version);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_capabilities(
        TobiiResearchEyeTracker* eyetracker, TobiiResearchCapabilities* capabilities);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_retrieve_calibration_data(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchCalibrationData** data);

TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_calibration_data(
        TobiiResearchCalibrationData* data);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_apply_calibration_data(
        TobiiResearchEyeTracker* eyetracker,
        const TobiiResearchCalibrationData* data);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_all_gaze_output_frequencies(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchGazeOutputFrequencies** frequencies);

TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_gaze_output_frequencies(
        TobiiResearchGazeOutputFrequencies* frequencies);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_gaze_output_frequency(
        TobiiResearchEyeTracker* eyetracker,
        float* gaze_output_frequency);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_set_gaze_output_frequency(
        TobiiResearchEyeTracker* eyetracker,
        float gaze_output_frequency);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_all_eye_tracking_modes(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchEyeTrackingModes** modes);


TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_eye_tracking_modes(
        TobiiResearchEyeTrackingModes* modes);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_eye_tracking_mode(
        TobiiResearchEyeTracker* eyetracker,
        char** eye_tracking_mode);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_set_eye_tracking_mode(
        TobiiResearchEyeTracker* eyetracker,
        const char* eye_tracking_mode);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_track_box(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchTrackBox* track_box);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_apply_licenses(
        TobiiResearchEyeTracker* eyetracker,
        const void** license_key,
        size_t* license_keys_size,
        TobiiResearchLicenseValidationResult* validation_results,
        size_t number_of_licenses);


TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_clear_applied_licenses(
        TobiiResearchEyeTracker* eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_display_area(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchDisplayArea* display_area);


TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_set_device_name(
        TobiiResearchEyeTracker* eyetracker,
        const char* device_name);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_hmd_lens_configuration(
        TobiiResearchEyeTracker* eyetracker,
        TobiiResearchHMDLensConfiguration* lens_configuration);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_set_hmd_lens_configuration(
        TobiiResearchEyeTracker* eyetracker,
        const TobiiResearchHMDLensConfiguration* lens_configuration);

#endif /* TOBII_RESEARCH_EYETRACKER_H_ */