SR Research Support Site
Data Structures | Macros | Typedefs | Enumerations | Functions
core_expt.h File Reference

Declarations of eyelink_core functions and types. More...

Data Structures

struct  DISPLAYINFO
 
struct  EYECOLOR
 Represents an RGB color. More...
 
struct  EYEPALETTE
 Represents a palette index. More...
 
struct  EYEPIXELFORMAT
 Represents pixel format of an image or surface. More...
 
struct  EYEBITMAP
 Represents a bitmap image. More...
 
struct  KeyInput
 Keyboard input event structure. More...
 
struct  MouseMotionEvent
 Mouse motion event structure (For future) More...
 
struct  MouseButtonEvent
 Mouse button event structure (For future) More...
 
union  InputEvent
 Union of all input types. More...
 
struct  HOOKFCNS
 Structure used set and get callback functions. More...
 
struct  HOOKFCNS2
 Structure used set and get callback functions. More...
 
struct  _CrossHairInfo
 Structure to hold cross hair information. More...
 

Macros

#define CURS_UP   0x4800
 
#define CURS_DOWN   0x5000
 
#define CURS_LEFT   0x4B00
 
#define CURS_RIGHT   0x4D00
 
#define ESC_KEY   0x001B
 
#define ENTER_KEY   0x000D
 
#define PAGE_UP   0x4900
 
#define PAGE_DOWN   0x5100
 
#define JUNK_KEY   1
 
#define TERMINATE_KEY   0x7FFF
 
#define DISPLAYINFODEF
 This structure holds information on the display. More...
 
#define DONE_TRIAL   0
 
#define TRIAL_OK   0
 
#define REPEAT_TRIAL   1
 
#define SKIP_TRIAL   2
 
#define ABORT_EXPT   3
 
#define TRIAL_ERROR   -1
 
#define BX_AVERAGE   0
 
#define BX_DARKEN   1
 
#define BX_LIGHTEN   2
 
#define BX_MAXCONTRAST   4
 
#define BX_NODITHER   8
 
#define BX_GRAYSCALE   16
 
#define BX_TXFILE   32
 
#define BX_DOTRANSFER   256
 
#define SV_NOREPLACE   1
 
#define SV_MAKEPATH   2
 
#define BAD_FILENAME   -2222
 
#define BAD_ARGUMENT   -2223
 
#define KEYINPUT_EVENT   0x1
 
#define MOUSE_INPUT_EVENT   0x4
 
#define MOUSE_MOTION_INPUT_EVENT   0x5
 
#define MOUSE_BUTTON_INPUT_EVENT   0x6
 
#define ELKMOD_NONE   0x0000
 
#define ELKMOD_LSHIFT   0x0001
 
#define ELKMOD_RSHIFT   0x0002
 
#define ELKMOD_LCTRL   0x0040
 
#define ELKMOD_RCTRL   0x0080
 
#define ELKMOD_LALT   0x0100
 
#define ELKMOD_RALT   0x0200
 
#define ELKMOD_LMETA   0x0400
 
#define ELKMOD_RMETA   0x0800
 
#define ELKMOD_NUM   0x1000
 
#define ELKMOD_CAPS   0x2000
 
#define ELKMOD_MODE   0x4000
 
#define ELKEY_DOWN   1
 
#define ELKEY_UP   0
 
#define FIVE_SAMPLE_MODEL   1
 
#define NINE_SAMPLE_MODEL   2
 
#define SEVENTEEN_SAMPLE_MODEL   3
 
#define EL1000_TRACKER_MODEL   4
 
#define CR_HAIR_COLOR   1
 
#define PUPIL_HAIR_COLOR   2
 
#define PUPIL_BOX_COLOR   3
 
#define SEARCH_LIMIT_BOX_COLOR   4
 
#define MOUSE_CURSOR_COLOR   5
 

Typedefs

typedef enum _EL_CAL_BEEP EL_CAL_BEEP
 Enum used for calibration beeps.
 
typedef struct _CrossHairInfo CrossHairInfo
 

Enumerations

enum  IMAGETYPE {
  JPEG, PNG, GIF, BMP,
  XPM
}
 
enum  _EL_CAL_BEEP {
  EL_DC_DONE_ERR_BEEP =-2, EL_CAL_DONE_ERR_BEEP =-1, EL_CAL_DONE_GOOD_BEEP =0, EL_CAL_TARG_BEEP =1,
  EL_DC_DONE_GOOD_BEEP =2, EL_DC_TARG_BEEP =3
}
 Enum used for calibration beeps. More...
 

Functions

INT16 open_eyelink_connection (INT16 mode)
 
void close_eyelink_connection (void)
 
INT16 set_eyelink_address (char *addr)
 
INT16 set_eyelink_tcp_only (INT16 arg)
 
INT32 set_application_priority (INT32 priority)
 
INT16 message_pump (void)
 
INT16 key_message_pump (void)
 
void pump_delay (UINT32 delay)
 
void flush_getkey_queue (void)
 
UINT16 read_getkey_queue (void)
 
UINT16 echo_key (void)
 
UINT16 getkey (void)
 
UINT32 getkey_with_mod (UINT16 *unicode)
 
INT16 eyecmd_printf (const char *fmt,...)
 
INT16 eyemsg_printf (const char *fmt,...)
 
INT16 eyemsg_printf_ex (UINT32 exectime, const char *fmt,...)
 
INT16 start_recording (INT16 file_samples, INT16 file_events, INT16 link_samples, INT16 link_events)
 
INT16 check_recording (void)
 
void stop_recording (void)
 
void set_offline_mode (void)
 
INT16 check_record_exit (void)
 
void exit_calibration (void)
 
INT16 do_tracker_setup (void)
 
INT16 do_drift_correct (INT16 x, INT16 y, INT16 draw, INT16 allow_setup)
 
INT16 do_drift_correctf (float x, float y, INT16 draw, INT16 allow_setup)
 
INT16 target_mode_display (void)
 
INT16 image_mode_display (void)
 
void alert_printf (char *fmt,...)
 
INT32 receive_data_file (const char *src, const char *dest, INT16 dest_is_path)
 
INT32 receive_data_file_feedback (const char *src, const char *dest, INT16 dest_is_path, void(*progress)(unsigned int size, unsigned int received))
 
INT32 receive_data_file_feedback_v2 (char *src, char *dest, INT16 dest_is_path, void(*progress)(unsigned int size, unsigned int received))
 
INT32 send_data_file_feedback (char *src, char *dest, INT16 dest_is_path, void(*progress)(unsigned int size, unsigned int received))
 
INT32 send_data_file_mem (char *src, char *fname, int file_size, void(*progress)(unsigned int size, unsigned int received))
 
INT32 send_data_file (char *src, char *dest, INT16 dest_is_path)
 
INT16 open_data_file (char *name)
 
INT16 close_data_file (void)
 
INT16 escape_pressed (void)
 
INT16 break_pressed (void)
 
void terminal_break (INT16 assert)
 
INT16 application_terminated (void)
 
void begin_realtime_mode (UINT32 delay)
 
void end_realtime_mode (void)
 
void set_high_priority (void)
 
void set_normal_priority (void)
 
INT32 in_realtime_mode (void)
 
void eyelink_enable_extended_realtime (void)
 
char * eyelink_get_error (int id, char *function_name)
 
void splice_fname (const char *fname, const char *path, char *ffname)
 
int check_filename_characters (const char *name)
 
int file_exists (const char *path)
 
int create_path (const char *path, INT16 create, INT16 is_dir)
 
int el_bitmap_save_and_backdrop (EYEBITMAP *hbm, INT16 xs, INT16 ys, INT16 width, INT16 height, const char *fname, const char *path, INT16 sv_options, INT16 xd, INT16 yd, UINT16 xferoptions)
 
int el_bitmap_to_backdrop (EYEBITMAP *hbm, INT16 xs, INT16 ys, INT16 width, INT16 height, INT16 xd, INT16 yd, UINT16 xferoptions)
 
int el_bitmap_save (EYEBITMAP *hbm, INT16 xs, INT16 ys, INT16 width, INT16 height, char *fname, char *path, INT16 sv_options)
 
void setup_graphic_hook_functions (HOOKFCNS *hooks)
 
HOOKFCNSget_all_hook_functions (void)
 
INT16 setup_graphic_hook_functions_V2 (HOOKFCNS2 *hooks)
 
HOOKFCNSget_all_hook_functions_V2 (void)
 
int set_write_image_hook (int(*hookfn)(char *outfilename, int format, EYEBITMAP *bitmap), int options)
 
int eyelink_peep_input_event (InputEvent *event, int mask)
 
int eyelink_get_input_event (InputEvent *event, int mask)
 
int eyelink_peep_last_input_event (InputEvent *event, int mask)
 
void eyelink_flush_input_event (void)
 
INT32 eyelink_initialize_mapping (float left, float top, float right, float bottom)
 
INT32 eyelink_href_to_gaze (float *xp, float *yp, FSAMPLE *sample)
 
INT32 eyelink_gaze_to_href (float *xp, float *yp, FSAMPLE *sample)
 
float eyelink_href_angle (float x1, float y1, float x2, float y2)
 
void eyelink_href_resolution (float x, float y, float *xres, float *yres)
 
int get_image_xhair_data (INT16 x[4], INT16 y[4], INT16 *xhairs_on)
 
int eyelink_get_extra_raw_values (FSAMPLE *s, FSAMPLE_RAW *rv)
 
int eyelink_get_extra_raw_values_v2 (FSAMPLE *s, int eye, FSAMPLE_RAW *rv)
 
int eyelink_calculate_velocity_x_y (int slen, float xvel[2], float yvel[2], FSAMPLE *vel_sample)
 
int eyelink_calculate_velocity (int slen, float vel[2], FSAMPLE *vel_sample)
 
int eyelink_calculate_overallvelocity_and_acceleration (int slen, float vel[2], float acc[2], FSAMPLE *vel_sample)
 
INT16 timemsg_printf (UINT32 t, char *fmt,...)
 
int open_message_file (char *fname)
 
void close_message_file (void)
 
INT32 eyelink_draw_cross_hair (CrossHairInfo *chi)
 
void eyelink_dll_version (char FARTYPE *c)
 
void eyelink_set_special_keys (int terminate_key_mask, int terminate_key, int break_key_mask, int break_key, int case_sensitive)
 

Detailed Description

Declarations of eyelink_core functions and types.

This file will also reference the other EyeLink header files.

Macro Definition Documentation

#define DISPLAYINFODEF

This structure holds information on the display.

This structure holds information on the display Call get_display_information() to fill this with data Check mode before running experiment!

Function Documentation

void eyelink_dll_version ( char FARTYPE *  c)

Returns the eyelink_core library version number.

Parameters
[out]cfills in the version number of the eyelink_core library.

Copyright ©2002-2021, SR Research Ltd.