|
FG Camera Library
1.5.0.0 (2023-09-08)
|
|
|
FG Camera Library
1.5.0.0 (2023-09-08)
|
|
Header file for this libraray.
For a description on how to use this library take a look at First Steps.
Data Structures | |
| struct | FG_IMAGE |
| This structure stores information associated with image buffers More... | |
| struct | FG_VERSION |
| struct for the library version "libFGCamera.so.major.minor.patchlevel.buildnumber" More... | |
Macros | |
| #define | FG_VERSION_BUILDNUMBER 0 |
| Library version build number. | |
| #define | FG_VERSION_MAJOR 1 |
| Library version major number. | |
| #define | FG_VERSION_MINOR 5 |
| Library version minor number. | |
| #define | FG_VERSION_NUMBER (FG_VERSION_BUILDNUMBER + 100 * (FG_VERSION_PATCHLEVEL + 100 * (FG_VERSION_MINOR + 100 * FG_VERSION_MAJOR))) |
| Library version number More... | |
| #define | FG_VERSION_PATCHLEVEL 0 |
| Library version patch number. | |
Functions | |
| UINT32 DLL_FG_API | FG_alloc_image (FG_IMAGE *img) |
| Allocates a new image buffer for storing sensor frames. More... | |
| UINT32 DLL_FG_API | FG_append_image (FG_IMAGE *img) |
| Puts an image buffer into the aquisition queue. More... | |
| UINT32 DLL_FG_API | FG_free_image (FG_IMAGE *img) |
| Releases an image buffer. More... | |
| UINT32 DLL_FG_API | FG_get_aoi (UINT32 *x1, UINT32 *y1, UINT32 *x2, UINT32 *y2, enum eFG_PIXEL_TYPE *pixel_type) |
| Returns the area of interest and the output format. More... | |
| UINT32 DLL_FG_API | FG_get_black (UINT32 *black) |
| Returns the normalized black level. More... | |
| UINT32 DLL_FG_API | FG_get_camera_type (enum eFG_CAMERA_TYPE *camera_type) |
| Returns the installed camera type. More... | |
| UINT32 DLL_FG_API | FG_get_gain (UINT32 *gain) |
| Returns the normalized gain value. More... | |
| UINT32 DLL_FG_API | FG_get_gain_rgb (UINT32 *gain_red, UINT32 *gain_green, UINT32 *gain_blue) |
| Returns the normalized color gain values for supported hardware. More... | |
| UINT32 DLL_FG_API | FG_get_image (FG_IMAGE *img, UINT32 TimeOut_ms) |
| Returns captured images to the user. More... | |
| UINT32 DLL_FG_API | FG_get_image_size (UINT32 *width, UINT32 *height, UINT32 *bytes) |
| Returns the size of the image buffers. More... | |
| UINT32 DLL_FG_API | FG_get_last_error (char *error_sting, UINT32 max_string_size) |
| Returns an error description for the last failed library call. More... | |
| UINT32 DLL_FG_API | FG_get_pixel_order (enum eFG_PIXEL_ORDER *pixel_order) |
| Returns the order of pixel components within image buffers. More... | |
| UINT32 DLL_FG_API | FG_get_scan_param (UINT32 *scan_x, UINT32 *scan_y, UINT32 *scan_width, UINT32 *scan_height, UINT32 *image_height, enum eFG_PIXEL_TYPE *pixel_type) |
| Returns the area of interest and the output format. More... | |
| UINT32 DLL_FG_API | FG_get_shutter_time (UINT32 *shutter_time_us) |
| Returns the exposure time in µs. More... | |
| UINT32 DLL_FG_API | FG_get_special_option (const char *option, INT64 *result) |
| Returns a special camera property value. More... | |
| UINT32 DLL_FG_API | FG_get_timestamp (FG_IMAGE *img, UINT64 *pTimestamp) |
| Returns the image completion timestamp of a captured image. More... | |
| UINT32 DLL_FG_API | FG_get_trigger_mode (enum eFG_TRIGGER_MODE *trigger_mode) |
| Returns the configured trigger mode. More... | |
| UINT32 DLL_FG_API | FG_get_version (FG_VERSION *lib_version) |
| Returns the library version. More... | |
| UINT32 DLL_FG_API | FG_install_camera (enum eFG_CAMERA_TYPE camera_type) |
| Opens and initializes the camera. More... | |
| UINT32 DLL_FG_API | FG_save_image (FG_IMAGE *img, const char *filename) |
| Saves the given image into an BMP file. More... | |
| UINT32 DLL_FG_API | FG_set_aoi (UINT32 x1, UINT32 y1, UINT32 x2, UINT32 y2, enum eFG_PIXEL_TYPE pixel_type) |
| Sets the area of interest and the output format. More... | |
| UINT32 DLL_FG_API | FG_set_black (UINT32 black) |
| Sets the black level using a normalized value. More... | |
| UINT32 DLL_FG_API | FG_set_gain (UINT32 gain) |
| Sets the gain using a normalized value. More... | |
| UINT32 DLL_FG_API | FG_set_gain_rgb (UINT32 gain_red, UINT32 gain_green, UINT32 gain_blue) |
| Sets the color component gain values for supported hardware. More... | |
| UINT32 DLL_FG_API | FG_set_scan_param (UINT32 scan_x, UINT32 scan_y, UINT32 scan_width, UINT32 scan_height, UINT32 image_height, enum eFG_PIXEL_TYPE pixel_type) |
| Sets the area of interest and output format. More... | |
| UINT32 DLL_FG_API | FG_set_shutter_time (UINT32 shutter_time_us) |
| Sets the exposure time in µs. More... | |
| UINT32 DLL_FG_API | FG_set_special_option (const char *option, INT64 arg) |
| Configures a special camera property. More... | |
| UINT32 DLL_FG_API | FG_set_trigger_mode (enum eFG_TRIGGER_MODE trigger_mode) |
| Sets the trigger mode. More... | |
| UINT32 DLL_FG_API | FG_stop_image (void) |
| Forces the camera to stop grabbing and using any buffers. More... | |
| UINT32 DLL_FG_API | FG_trigger_image (void) |
| Triggers the next image in software triggered mode. More... | |
| UINT32 DLL_FG_API | FG_uninstall_camera (void) |
| Closes the camera. More... | |
| #define FG_VERSION_NUMBER (FG_VERSION_BUILDNUMBER + 100 * (FG_VERSION_PATCHLEVEL + 100 * (FG_VERSION_MINOR + 100 * FG_VERSION_MAJOR))) |
Library version number
The library version has the following structure: <major>.<minor>.<patchlevel>.<buildnumber>
For example, the library version 1.2.8.0 produces a value of 1020800 after evaluation of the VIB_VERSION expression by the compiler.
| enum eFG_CAMERA_TYPE |
The following camera models are supported by this library.
| enum eFG_ERROR_CODE |
The result code for all library functions.
| Enumerator | |
|---|---|
| FG_ERROR_CODE_NoError | The function was successful. |
| FG_ERROR_CODE_Unknown | Unknown error. |
| FG_ERROR_CODE_InvalidArgument | The function arguments are invalid. |
| FG_ERROR_CODE_InvalidCameraChannel | The selected camera channel is invalid. |
| FG_ERROR_CODE_GrabTimeOut | Only valid for FG_get_image(): acquisition timeout. |
| FG_ERROR_CODE_BrokenImage | Only valid for FG_get_image(): the returned image contents are invalid. |
| FG_ERROR_CODE_ExtraErrorInformation | Other errors, use FG_get_last_error() to obtain the error message. |
| enum eFG_PIXEL_ORDER |
Order of pixel components in memory (see FG_get_pixel_order()).
| enum eFG_PIXEL_TYPE |
Specifies the format to use for captured images (see FG_get_aoi() / FG_set_aoi()).
Support for the different pixel types depend on the used sensor, see also:
| enum eFG_TRIGGER_MODE |
Trigger mode definitions, see FG_set_trigger_mode() for a description.
| Enumerator | |
|---|---|
| FG_TRIGGER_MODE_SOFTWARE | Software triggered mode. |
| FG_TRIGGER_MODE_HARDWARE | Hardware triggered mode. |
| FG_TRIGGER_MODE_FREERUN | Free-run triggered mode. |
1.8.18