Function libeyelink_sys::el_bitmap_save_and_backdrop

pub unsafe extern "C" fn el_bitmap_save_and_backdrop(
    hbm: *mut EYEBITMAP, 
    xs: INT16, 
    ys: INT16, 
    width: INT16, 
    height: INT16, 
    fname: *mut c_char, 
    path: *mut c_char, 
    sv_options: INT16, 
    xd: INT16, 
    yd: INT16, 
    xferoptions: UINT16
) -> c_int

@ingroup bitmap_save This function saves the entire bitmap as a .BMP, .JPG, .PNG, or .TIF file, and transfers the image to tracker as backdrop for gaze cursors.

@param hbm Bitmap to save or transfer or both. @param xs X position. @param ys Y position. @param width Width. @param height Height. @param fname File name to save as. The extension decides the format of the file. @param path The directory to which the file will be written. @param sv_options If the file exists, it replaces the file unless SV_NOREPLACE is specified. @param xd X positon. @param yd Y positon. @param xferoptions Transfer options set with bitwise OR of the following constants, determines how bitmap is processed: \arg \c BX_AVERAGE Averaging combined pixels \arg \c BX_DARKEN Choosing darkest and keep thin dark lines. \arg \c BX_LIGHTEN Choosing darkest and keep thin white lines and control how bitmap size is reduced to fit tracker display. \arg \c BX_MAXCONTRAST Maximizes contrast for clearest image. \arg \c BX_NODITHER Disables the dithering of the image. \arg \c BX_GREYSCALE Converts the image to grayscale (grayscale works best for EyeLink I, text, etc.).

\sa el_bitmap_to_backdrop(), el_bitmap_save(), sdl_bitmap_to_backdrop(), sdl_bitmap_save(),sdl_bitmap_save_and_backdrop, gdi_bitmap_to_backdrop(), gdi_bitmap_save(),gdi_bitmap_save_and_backdrop, bitmap_save(), and bitmap_to_backdrop() for more information.

@remark This function relies on the writeImageHook set by call to set_write_image_hook() to write the images in different formats. By default, if eyelink_core_graphics library is used, gd library is used to write the images and if eyelink_gdi_graphics is used FreeImage library is used to write the images. If neither one of them is used, call to this function does not write the images unless, set_write_image_hook() is used to set the writeImageHook.

@remark This function should not be called when timing is critical, as this might take very long to return.