ScCommon.h

Go to the documentation of this file.

 
#ifndef SC_COMMON_H_
#define SC_COMMON_H_
 
 
#include <Scandit/ScConfig.h>
#include <Scandit/ScImageDescription.h>
 
#if defined(__cplusplus)
extern "C" {
#endif
 
 
typedef struct {
    int32_t x;
    int32_t y;
} ScPoint;
 
 
inline ScPoint sc_point_make(int x, int y) {
    ScPoint point;
    point.x = x;
    point.y = y;
    return point;
}
 
 
typedef struct  {
    ScPoint top_left;
    ScPoint top_right;
    ScPoint bottom_right;
    ScPoint bottom_left;
} ScQuadrilateral;
 
 
SC_EXPORT ScQuadrilateral
sc_quadrilateral_make(ScPoint tl, ScPoint tr, ScPoint br, ScPoint bl);
 
typedef struct {
    float x;
    float y;
} ScPointF;
 
inline ScPointF sc_point_f_make(float x, float y) {
    ScPointF point;
    point.x = x;
    point.y = y;
    return point;
}
 
typedef struct {
    uint32_t width;  
    uint32_t height; 
} ScSize;
 
typedef struct {
    float width;  
    float height; 
} ScSizeF;
 
typedef struct  {
    ScPointF position;
    ScSizeF size;
} ScRectangleF;
 
SC_EXPORT ScRectangleF
sc_rectangle_f_make(float position_x, float position_y, float width, float height);
 
SC_EXPORT ScPointF
sc_rectangle_f_get_center(ScRectangleF rectangle);
 
typedef enum  {
    SC_CAMERA_FOCUS_MODE_UNKNOWN  = 0, 
    SC_CAMERA_FOCUS_MODE_FIXED    = 1, 
    SC_CAMERA_FOCUS_MODE_AUTO     = 2, 
    SC_CAMERA_FOCUS_MODE_MANUAL   = 4  
} ScCameraFocusMode;
 
SC_EXPORT void sc_free(void *pointer);
 
typedef struct {
    const char       *message;
 
    uint32_t       code;
} ScError;
 
typedef enum {
    SC_NO_ERROR                 = 0,
    SC_ERROR_UNKNOWN            = 1,
    SC_ERROR_NOT_IMPLEMENTED    = 2,
    SC_ERROR_INVALID_INPUT      = 3,
    SC_ERROR_INTERNAL_ERROR     = 4
} ScErrorType;
 
 
SC_EXPORT void sc_error_free(ScError *error);
 
 
typedef enum {
    SC_INFORMATION_KEY_SOFTWARE_LICENSES = 0,
    SC_INFORMATION_KEY_SDK_VERSION = 1,
    SC_INFORMATION_KEY_SDK_BUILD = 2,
} ScInformationKey;
 
SC_EXPORT const char* sc_get_information_string(ScInformationKey key);
 
typedef struct {
    ScImageDescription* description;
    uint8_t* data;
} ScImageBuffer;
 
SC_EXPORT void
sc_image_buffer_free(ScImageBuffer* image);
 
 
#if defined(__cplusplus)
}
#endif
 
#endif // SC_COMMON_H_