ScanbotSDKImageRefTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/ImageRefTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_IMAGEREFTYPES_H
#define SCANBOTSDK_IMAGEREFTYPES_H
 
 
#include <ScanbotSDKTypes.h>
#include <image/ScanbotSDKImageTypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <utils/ScanbotSDKObjectPoolTypes.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_color_conversion_t {

    SCANBOTSDK_COLOR_CONVERSION_GRAY = 0,

    SCANBOTSDK_COLOR_CONVERSION_COLOR = 1,

    SCANBOTSDK_COLOR_CONVERSION_ANY_COLOR = 2,

    SCANBOTSDK_COLOR_CONVERSION_UNCHANGED = 3,
 
} scanbotsdk_color_conversion_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_conversion_t_to_string(scanbotsdk_color_conversion_t value, const char** result);

typedef struct scanbotsdk_image_info_t scanbotsdk_image_info_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_free(scanbotsdk_image_info_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_height(scanbotsdk_image_info_t* self, int* height);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_height(scanbotsdk_image_info_t* self, int height);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_width(scanbotsdk_image_info_t* self, int* width);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_width(scanbotsdk_image_info_t* self, int width);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_max_byte_size(scanbotsdk_image_info_t* self, int* max_byte_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_max_byte_size(scanbotsdk_image_info_t* self, int max_byte_size);
 

typedef enum scanbotsdk_path_load_mode_t {

    SCANBOTSDK_PATH_LOAD_MODE_EAGER = 0,

    SCANBOTSDK_PATH_LOAD_MODE_LAZY = 1,

    SCANBOTSDK_PATH_LOAD_MODE_LAZY_WITH_COPY = 2,
 
} scanbotsdk_path_load_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_load_mode_t_to_string(scanbotsdk_path_load_mode_t value, const char** result);

typedef enum scanbotsdk_buffer_load_mode_t {

    SCANBOTSDK_BUFFER_LOAD_MODE_EAGER = 0,

    SCANBOTSDK_BUFFER_LOAD_MODE_LAZY = 1,
 
} scanbotsdk_buffer_load_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_load_mode_t_to_string(scanbotsdk_buffer_load_mode_t value, const char** result);

typedef enum scanbotsdk_encoding_format_t {

    SCANBOTSDK_ENCODING_FORMAT_JPEG = 0,

    SCANBOTSDK_ENCODING_FORMAT_PNG = 1,
 
} scanbotsdk_encoding_format_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encoding_format_t_to_string(scanbotsdk_encoding_format_t value, const char** result);

typedef struct scanbotsdk_basic_image_load_options_t scanbotsdk_basic_image_load_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_create(
    scanbotsdk_rect_t crop_rect,
    bool live_source,
    scanbotsdk_basic_image_load_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_create_with_defaults(
    bool live_source,
    scanbotsdk_basic_image_load_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_free(scanbotsdk_basic_image_load_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_get_crop_rect(scanbotsdk_basic_image_load_options_t* self, scanbotsdk_rect_t* crop_rect);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_set_crop_rect(scanbotsdk_basic_image_load_options_t* self, scanbotsdk_rect_t crop_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_get_live_source(scanbotsdk_basic_image_load_options_t* self, bool* live_source);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_set_live_source(scanbotsdk_basic_image_load_options_t* self, bool live_source);
 

typedef struct scanbotsdk_raw_image_load_options_t scanbotsdk_raw_image_load_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_create(
    scanbotsdk_rect_t crop_rect,
    bool live_source,
    scanbotsdk_image_origin_t origin,
    scanbotsdk_image_rotation_t orientation,
    scanbotsdk_raw_image_load_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_create_with_defaults(
    bool live_source,
    scanbotsdk_raw_image_load_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_free(scanbotsdk_raw_image_load_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_crop_rect(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_rect_t* crop_rect);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_crop_rect(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_rect_t crop_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_live_source(scanbotsdk_raw_image_load_options_t* self, bool* live_source);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_live_source(scanbotsdk_raw_image_load_options_t* self, bool live_source);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_origin(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_image_origin_t* origin);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_origin(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_image_origin_t origin);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_orientation(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_image_rotation_t* orientation);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_orientation(scanbotsdk_raw_image_load_options_t* self, scanbotsdk_image_rotation_t orientation);
 

typedef struct scanbotsdk_path_image_load_options_t scanbotsdk_path_image_load_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_create(
    scanbotsdk_rect_t crop_rect,
    scanbotsdk_color_conversion_t color_conversion,
    scanbotsdk_path_load_mode_t load_mode,
    scanbotsdk_path_image_load_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_create_with_defaults(
    scanbotsdk_path_image_load_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_free(scanbotsdk_path_image_load_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_get_crop_rect(scanbotsdk_path_image_load_options_t* self, scanbotsdk_rect_t* crop_rect);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_set_crop_rect(scanbotsdk_path_image_load_options_t* self, scanbotsdk_rect_t crop_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_get_color_conversion(scanbotsdk_path_image_load_options_t* self, scanbotsdk_color_conversion_t* color_conversion);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_set_color_conversion(scanbotsdk_path_image_load_options_t* self, scanbotsdk_color_conversion_t color_conversion);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_get_load_mode(scanbotsdk_path_image_load_options_t* self, scanbotsdk_path_load_mode_t* load_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_set_load_mode(scanbotsdk_path_image_load_options_t* self, scanbotsdk_path_load_mode_t load_mode);
 

typedef struct scanbotsdk_buffer_image_load_options_t scanbotsdk_buffer_image_load_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_create(
    scanbotsdk_rect_t crop_rect,
    scanbotsdk_color_conversion_t color_conversion,
    scanbotsdk_buffer_load_mode_t load_mode,
    scanbotsdk_buffer_image_load_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_create_with_defaults(
    scanbotsdk_buffer_image_load_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_free(scanbotsdk_buffer_image_load_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_get_crop_rect(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_rect_t* crop_rect);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_set_crop_rect(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_rect_t crop_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_get_color_conversion(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_color_conversion_t* color_conversion);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_set_color_conversion(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_color_conversion_t color_conversion);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_get_load_mode(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_buffer_load_mode_t* load_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_set_load_mode(scanbotsdk_buffer_image_load_options_t* self, scanbotsdk_buffer_load_mode_t load_mode);
 

typedef struct scanbotsdk_save_image_options_t scanbotsdk_save_image_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_create(
    int quality,
    scanbotsdk_save_image_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_create_with_defaults(
    scanbotsdk_save_image_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_free(scanbotsdk_save_image_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_get_quality(scanbotsdk_save_image_options_t* self, int* quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_set_quality(scanbotsdk_save_image_options_t* self, int quality);
 

typedef struct scanbotsdk_encode_image_options_t scanbotsdk_encode_image_options_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_create(
    int quality,
    scanbotsdk_encoding_format_t format,
    scanbotsdk_encode_image_options_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_create_with_defaults(
    scanbotsdk_encode_image_options_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_free(scanbotsdk_encode_image_options_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_get_quality(scanbotsdk_encode_image_options_t* self, int* quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_set_quality(scanbotsdk_encode_image_options_t* self, int quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_get_format(scanbotsdk_encode_image_options_t* self, scanbotsdk_encoding_format_t* format);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_set_format(scanbotsdk_encode_image_options_t* self, scanbotsdk_encoding_format_t format);
 

typedef enum scanbotsdk_image_source_type_t {

    SCANBOTSDK_IMAGE_SOURCE_TYPE_API = 0,

    SCANBOTSDK_IMAGE_SOURCE_TYPE_PLATFORM_IMAGE = 1,

    SCANBOTSDK_IMAGE_SOURCE_TYPE_CAMERA = 2,

    SCANBOTSDK_IMAGE_SOURCE_TYPE_FILE = 3,

    SCANBOTSDK_IMAGE_SOURCE_TYPE_BUFFER = 4,

    SCANBOTSDK_IMAGE_SOURCE_TYPE_OTHER = 5,
 
} scanbotsdk_image_source_type_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_type_t_to_string(scanbotsdk_image_source_type_t value, const char** result);

typedef struct scanbotsdk_image_source_t scanbotsdk_image_source_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_create(
    scanbotsdk_image_source_type_t type,
    const char* file_path,
    scanbotsdk_image_source_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_free(scanbotsdk_image_source_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_get_type(scanbotsdk_image_source_t* self, scanbotsdk_image_source_type_t* type);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_set_type(scanbotsdk_image_source_t* self, scanbotsdk_image_source_type_t type);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_get_file_path(scanbotsdk_image_source_t* self, const char** file_path);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_set_file_path(scanbotsdk_image_source_t* self, const char* file_path);
 

typedef struct scanbotsdk_image_profile_t scanbotsdk_image_profile_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_create(
    int bitmap_memory_consumption,
    int hibernation_memory_consumption,
    scanbotsdk_image_profile_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_create_with_defaults(
    scanbotsdk_image_profile_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_free(scanbotsdk_image_profile_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_get_bitmap_memory_consumption(scanbotsdk_image_profile_t* self, int* bitmap_memory_consumption);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_set_bitmap_memory_consumption(scanbotsdk_image_profile_t* self, int bitmap_memory_consumption);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_get_hibernation_memory_consumption(scanbotsdk_image_profile_t* self, int* hibernation_memory_consumption);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_set_hibernation_memory_consumption(scanbotsdk_image_profile_t* self, int hibernation_memory_consumption);
 

typedef struct scanbotsdk_image_ref_profile_t scanbotsdk_image_ref_profile_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_create(
    scanbotsdk_ref_counted_object_profile_t* ref_info,
    scanbotsdk_image_profile_t* image_info,
    scanbotsdk_image_source_t* image_source,
    scanbotsdk_image_ref_profile_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_free(scanbotsdk_image_ref_profile_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_get_ref_info(scanbotsdk_image_ref_profile_t* self, scanbotsdk_ref_counted_object_profile_t** ref_info);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_set_ref_info(scanbotsdk_image_ref_profile_t* self, scanbotsdk_ref_counted_object_profile_t* ref_info);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_get_image_info(scanbotsdk_image_ref_profile_t* self, scanbotsdk_image_profile_t** image_info);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_set_image_info(scanbotsdk_image_ref_profile_t* self, scanbotsdk_image_profile_t* image_info);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_get_image_source(scanbotsdk_image_ref_profile_t* self, scanbotsdk_image_source_t** image_source);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_set_image_source(scanbotsdk_image_ref_profile_t* self, scanbotsdk_image_source_t* image_source);
 

typedef struct scanbotsdk_image_ref_pool_snapshot_t scanbotsdk_image_ref_pool_snapshot_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_create(
    scanbotsdk_image_ref_profile_t** image_ref_profiles,
    size_t image_ref_profiles_size,
    int64_t total_memory_consumption,
    scanbotsdk_image_ref_pool_snapshot_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_create_with_defaults(
    scanbotsdk_image_ref_profile_t** image_ref_profiles,
    size_t image_ref_profiles_size,
    scanbotsdk_image_ref_pool_snapshot_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_free(scanbotsdk_image_ref_pool_snapshot_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_get_image_ref_profiles(scanbotsdk_image_ref_pool_snapshot_t* self, scanbotsdk_image_ref_profile_t** image_ref_profiles, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_get_image_ref_profiles_size(scanbotsdk_image_ref_pool_snapshot_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_set_image_ref_profiles(scanbotsdk_image_ref_pool_snapshot_t* self, scanbotsdk_image_ref_profile_t** image_ref_profiles, size_t image_ref_profiles_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_get_total_memory_consumption(scanbotsdk_image_ref_pool_snapshot_t* self, int64_t* total_memory_consumption);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_set_total_memory_consumption(scanbotsdk_image_ref_pool_snapshot_t* self, int64_t total_memory_consumption);
 

typedef struct scanbotsdk_image_ref_pool_snapshots_diff_t scanbotsdk_image_ref_pool_snapshots_diff_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_create(
    int64_t total_memory_consumption_diff,
    const char** removed,
    size_t removed_size,
    const char** added,
    size_t added_size,
    const char** modified,
    size_t modified_size,
    scanbotsdk_image_ref_pool_snapshots_diff_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_create_with_defaults(
    const char** removed,
    size_t removed_size,
    const char** added,
    size_t added_size,
    const char** modified,
    size_t modified_size,
    scanbotsdk_image_ref_pool_snapshots_diff_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_free(scanbotsdk_image_ref_pool_snapshots_diff_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_total_memory_consumption_diff(scanbotsdk_image_ref_pool_snapshots_diff_t* self, int64_t* total_memory_consumption_diff);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_total_memory_consumption_diff(scanbotsdk_image_ref_pool_snapshots_diff_t* self, int64_t total_memory_consumption_diff);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_removed(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** removed, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_removed_size(scanbotsdk_image_ref_pool_snapshots_diff_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_removed(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** removed, size_t removed_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_added(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** added, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_added_size(scanbotsdk_image_ref_pool_snapshots_diff_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_added(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** added, size_t added_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_modified(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** modified, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_modified_size(scanbotsdk_image_ref_pool_snapshots_diff_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_modified(scanbotsdk_image_ref_pool_snapshots_diff_t* self, const char** modified, size_t modified_size);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_IMAGEREFTYPES_H */