Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDKImageRefTypes.h
Go to the documentation of this file.
1// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
2// Generated from SchemasV3/CoreSchemas/schemas/ImageRefTypes.yaml
6
7#pragma once
8#ifndef SCANBOTSDK_IMAGEREFTYPES_H
9#define SCANBOTSDK_IMAGEREFTYPES_H
10
11
12#include <ScanbotSDKTypes.h>
14#include <stdbool.h>
15#include <stddef.h>
16#include <stdint.h>
17#include <string.h>
19#include <ScanbotSDKErrorCode.h>
20#include <ScanbotSDKDefs.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26
51
61
78
88
95
103
124
145
166
167
188
198
215
225
242
252
259
274 scanbotsdk_rect_t crop_rect,
275 bool live_source,
276 scanbotsdk_canvas_color_t canvas_color,
278
289 bool live_source,
291
292
300
321
342
367
368
375
400 scanbotsdk_rect_t crop_rect,
401 bool live_source,
403 scanbotsdk_canvas_color_t canvas_color,
404 scanbotsdk_image_rotation_t orientation,
406
417 bool live_source,
419
420
428
449
470
503
528
553
554
561
581 scanbotsdk_rect_t crop_rect,
582 scanbotsdk_color_conversion_t color_conversion,
583 scanbotsdk_canvas_color_t canvas_color,
586
597
598
606
627
652
677
702
703
710
730 scanbotsdk_rect_t crop_rect,
731 scanbotsdk_color_conversion_t color_conversion,
732 scanbotsdk_canvas_color_t canvas_color,
735
746
747
755
776
801
826
851
852
859
879 int quality,
880 bool optimize,
882
893
894
902
933
960
961
968
991 int quality,
992 bool optimize,
995
1006
1007
1015
1046
1073
1098
1099
1132
1142
1149
1163 scanbotsdk_u8string_ref_t file_path,
1164 scanbotsdk_image_source_t** result);
1165
1166
1174
1195
1216
1217
1224
1240 int bitmap_memory_consumption,
1241 int hibernation_memory_consumption,
1243
1254
1255
1263
1288
1313
1314
1321
1338 scanbotsdk_image_profile_t* image_info,
1339 scanbotsdk_image_source_t* image_source,
1341
1342
1350
1371
1392
1413
1414
1421
1437 scanbotsdk_image_ref_profile_t** image_ref_profiles,
1438 size_t image_ref_profiles_size,
1439 int64_t total_memory_consumption,
1441
1454 scanbotsdk_image_ref_profile_t** image_ref_profiles,
1455 size_t image_ref_profiles_size,
1457
1458
1466
1497
1522
1523
1530
1552 int64_t total_memory_consumption_diff,
1554 size_t removed_size,
1556 size_t added_size,
1557 scanbotsdk_u8string_ref_t* modified,
1558 size_t modified_size,
1560
1580 size_t removed_size,
1582 size_t added_size,
1583 scanbotsdk_u8string_ref_t* modified,
1584 size_t modified_size,
1586
1587
1595
1620
1651
1682
1713
1714
1715#ifdef __cplusplus
1716} /* extern "C" */
1717#endif
1718
1719#endif /* SCANBOTSDK_IMAGEREFTYPES_H */
ScanbotSDK Error Code C API.
scanbotsdk_error_code_t
The error codes returned by most of the Scanbot SDK functions.
Definition ScanbotSDKErrorCode.h:26
The Scanbot SDK C API primitive types.
Represents a rectangle with integer coordinates.
Definition ScanbotSDKTypes.h:51
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_width(scanbotsdk_image_info_t *self, int width)
Sets value of width field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_get_hibernation_memory_consumption(scanbotsdk_image_profile_t *self, int *hibernation_memory_consumption)
Returns value of hibernation_memory_consumption field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_set_hibernation_memory_consumption(scanbotsdk_image_profile_t *self, int hibernation_memory_consumption)
Sets value of hibernation_memory_consumption field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_removed(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *removed, size_t size)
Returns value of removed field of the given object. The returned pointers do NOT own the underlying o...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_free(scanbotsdk_save_image_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_save_image_options_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_height(scanbotsdk_image_info_t *self, int height)
Sets value of height field of the given object.
scanbotsdk_color_conversion_t
scanbotsdk_color_conversion_t enum
Definition ScanbotSDKImageRefTypes.h:32
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_modified(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *modified, size_t size)
Returns value of modified field of the given object. The returned pointers do NOT own the underlying ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_create(int bitmap_memory_consumption, int hibernation_memory_consumption, scanbotsdk_image_profile_t **result)
Creates a new instance of scanbotsdk_image_profile with given params and stores it in the location sp...
scanbotsdk_encoding_format_t
scanbotsdk_encoding_format_t enum
Definition ScanbotSDKImageRefTypes.h:231
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_free(scanbotsdk_basic_image_load_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_basic_image_load_options_t....
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)
Sets value of color_conversion field of the given object.
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)
Returns value of orientation field of the given 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)
Returns value of crop_rect field of the given object.
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)
Returns value of load_mode field of the given object.
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)
Returns value of image_source field of the given object. The returned pointers do NOT own the underly...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_create_with_defaults(scanbotsdk_u8string_ref_t *removed, size_t removed_size, scanbotsdk_u8string_ref_t *added, size_t added_size, scanbotsdk_u8string_ref_t *modified, size_t modified_size, scanbotsdk_image_ref_pool_snapshots_diff_t **result)
Creates a new instance of scanbotsdk_image_ref_pool_snapshots_diff_t with given required params and s...
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)
Sets value of crop_rect field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_canvas_color(scanbotsdk_raw_image_load_options_t *self, scanbotsdk_canvas_color_t canvas_color)
Sets value of canvas_color field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_set_live_source(scanbotsdk_basic_image_load_options_t *self, bool live_source)
Sets value of live_source field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_load_mode_t_to_string(scanbotsdk_path_load_mode_t value, const char **result)
Returns the string representation of the given scanbotsdk_path_load_mode_t value.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_create(int quality, bool optimize, scanbotsdk_save_image_options_t **result)
Creates a new instance of scanbotsdk_save_image_options with given params and stores it in the locati...
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)
Returns value of color_conversion field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_free(scanbotsdk_encode_image_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_encode_image_options_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_set_format(scanbotsdk_encode_image_options_t *self, scanbotsdk_encoding_format_t format)
Sets value of format field of the given object.
struct scanbotsdk_image_profile_t scanbotsdk_image_profile_t
scanbotsdk_image_profile_t class
Definition ScanbotSDKImageRefTypes.h:1223
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_create(scanbotsdk_rect_t crop_rect, bool live_source, scanbotsdk_canvas_color_t canvas_color, scanbotsdk_basic_image_load_options_t **result)
Creates a new instance of scanbotsdk_basic_image_load_options with given params and stores it in the ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_set_quality(scanbotsdk_save_image_options_t *self, int quality)
Sets value of quality field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_create_with_defaults(scanbotsdk_buffer_image_load_options_t **result)
Creates a new instance of scanbotsdk_buffer_image_load_options_t with given required params and store...
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)
Creates a new instance of scanbotsdk_image_ref_pool_snapshot with given params and stores it in the l...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_free(scanbotsdk_image_ref_pool_snapshots_diff_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_ref_pool_snapshots_diff_t....
scanbotsdk_image_origin_t
scanbotsdk_image_origin_t enum
Definition ScanbotSDKImageTypes.h:63
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)
Returns value of image_ref_profiles field of the given object. The returned pointers do NOT own the u...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_get_optimize(scanbotsdk_save_image_options_t *self, bool *optimize)
Returns value of optimize field of the given 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)
Returns value of crop_rect field of the given object.
scanbotsdk_canvas_color_t
scanbotsdk_canvas_color_t enum
Definition ScanbotSDKImageRefTypes.h:67
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)
Sets value of crop_rect field of the given object.
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)
Returns size of added array.
struct scanbotsdk_raw_image_load_options_t scanbotsdk_raw_image_load_options_t
scanbotsdk_raw_image_load_options_t class
Definition ScanbotSDKImageRefTypes.h:374
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_get_live_source(scanbotsdk_basic_image_load_options_t *self, bool *live_source)
Returns value of live_source field of the given object.
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)
Returns value of total_memory_consumption field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_set_file_path(scanbotsdk_image_source_t *self, scanbotsdk_u8string_ref_t file_path)
Sets value of file_path field of the given object.
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)
Sets value of crop_rect field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_modified(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *modified, size_t modified_size)
Sets value of modified field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encoding_format_t_to_string(scanbotsdk_encoding_format_t value, const char **result)
Returns the string representation of the given scanbotsdk_encoding_format_t value.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshot_free(scanbotsdk_image_ref_pool_snapshot_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_ref_pool_snapshot_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)
Creates a new instance of scanbotsdk_image_ref_profile with given params and stores it in the locatio...
struct scanbotsdk_image_info_t scanbotsdk_image_info_t
scanbotsdk_image_info_t class
Definition ScanbotSDKImageRefTypes.h:94
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_free(scanbotsdk_raw_image_load_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_raw_image_load_options_t....
struct scanbotsdk_save_image_options_t scanbotsdk_save_image_options_t
scanbotsdk_save_image_options_t class
Definition ScanbotSDKImageRefTypes.h:858
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)
Returns value of total_memory_consumption_diff field of the given object.
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)
Sets value of image_info field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_get_quality(scanbotsdk_encode_image_options_t *self, int *quality)
Returns value of quality field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_create_with_defaults(scanbotsdk_image_profile_t **result)
Creates a new instance of scanbotsdk_image_profile_t with given required params and stores it in the ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_create_with_defaults(bool live_source, scanbotsdk_basic_image_load_options_t **result)
Creates a new instance of scanbotsdk_basic_image_load_options_t with given required params and stores...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_live_source(scanbotsdk_raw_image_load_options_t *self, bool *live_source)
Returns value of live_source field of the given object.
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)
Sets value of load_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_set_type(scanbotsdk_image_source_t *self, scanbotsdk_image_source_type_t type)
Sets value of type field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_free(scanbotsdk_image_source_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_source_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_conversion_t_to_string(scanbotsdk_color_conversion_t value, const char **result)
Returns the string representation of the given scanbotsdk_color_conversion_t value.
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)
Sets value of crop_rect field of the given object.
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)
Returns size of removed array.
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)
Returns value of image_info field of the given object. The returned pointers do NOT own the underlyin...
struct scanbotsdk_image_ref_pool_snapshots_diff_t scanbotsdk_image_ref_pool_snapshots_diff_t
scanbotsdk_image_ref_pool_snapshots_diff_t class
Definition ScanbotSDKImageRefTypes.h:1529
struct scanbotsdk_encode_image_options_t scanbotsdk_encode_image_options_t
scanbotsdk_encode_image_options_t class
Definition ScanbotSDKImageRefTypes.h:967
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_create(scanbotsdk_rect_t crop_rect, scanbotsdk_color_conversion_t color_conversion, scanbotsdk_canvas_color_t canvas_color, scanbotsdk_path_load_mode_t load_mode, scanbotsdk_path_image_load_options_t **result)
Creates a new instance of scanbotsdk_path_image_load_options with given params and stores it in the l...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_get_canvas_color(scanbotsdk_basic_image_load_options_t *self, scanbotsdk_canvas_color_t *canvas_color)
Returns value of canvas_color field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_create(int quality, bool optimize, scanbotsdk_encoding_format_t format, scanbotsdk_encode_image_options_t **result)
Creates a new instance of scanbotsdk_encode_image_options with given params and stores it in the loca...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_set_optimize(scanbotsdk_encode_image_options_t *self, bool optimize)
Sets value of optimize field of the given object.
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)
Sets value of ref_info field of the given object.
struct scanbotsdk_buffer_image_load_options_t scanbotsdk_buffer_image_load_options_t
scanbotsdk_buffer_image_load_options_t class
Definition ScanbotSDKImageRefTypes.h:709
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_removed(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *removed, size_t removed_size)
Sets value of removed field of the given object.
struct scanbotsdk_image_ref_pool_snapshot_t scanbotsdk_image_ref_pool_snapshot_t
scanbotsdk_image_ref_pool_snapshot_t class
Definition ScanbotSDKImageRefTypes.h:1420
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)
Returns size of image_ref_profiles array.
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)
Sets value of origin field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_get_optimize(scanbotsdk_encode_image_options_t *self, bool *optimize)
Returns value of optimize field of the given object.
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)
Returns size of modified array.
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)
Creates a new instance of scanbotsdk_image_ref_pool_snapshot_t with given required params and stores ...
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)
Returns value of load_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_set_canvas_color(scanbotsdk_path_image_load_options_t *self, scanbotsdk_canvas_color_t canvas_color)
Sets value of canvas_color field of the given object.
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)
Returns value of origin field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_set_max_byte_size(scanbotsdk_image_info_t *self, int max_byte_size)
Sets value of max_byte_size field of the given 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)
Returns value of crop_rect field of the given 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)
Returns value of ref_info field of the given object. The returned pointers do NOT own the underlying ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_get_bitmap_memory_consumption(scanbotsdk_image_profile_t *self, int *bitmap_memory_consumption)
Returns value of bitmap_memory_consumption field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_get_quality(scanbotsdk_save_image_options_t *self, int *quality)
Returns value of quality field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_get_canvas_color(scanbotsdk_path_image_load_options_t *self, scanbotsdk_canvas_color_t *canvas_color)
Returns value of canvas_color field of the given object.
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)
Sets value of image_source field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_create_with_defaults(bool live_source, scanbotsdk_raw_image_load_options_t **result)
Creates a new instance of scanbotsdk_raw_image_load_options_t with given required params and stores i...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_set_live_source(scanbotsdk_raw_image_load_options_t *self, bool live_source)
Sets value of live_source field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_basic_image_load_options_set_canvas_color(scanbotsdk_basic_image_load_options_t *self, scanbotsdk_canvas_color_t canvas_color)
Sets value of canvas_color field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_profile_free(scanbotsdk_image_ref_profile_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_ref_profile_t. If null is passed,...
struct scanbotsdk_image_ref_profile_t scanbotsdk_image_ref_profile_t
scanbotsdk_image_ref_profile_t class
Definition ScanbotSDKImageRefTypes.h:1320
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_get_added(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *added, size_t size)
Returns value of added field of the given object. The returned pointers do NOT own the underlying obj...
scanbotsdk_buffer_load_mode_t
scanbotsdk_buffer_load_mode_t enum
Definition ScanbotSDKImageRefTypes.h:204
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)
Sets value of total_memory_consumption_diff field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_get_format(scanbotsdk_encode_image_options_t *self, scanbotsdk_encoding_format_t *format)
Returns value of format field of the given object.
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)
Sets value of orientation field of the given object.
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)
Sets value of load_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_width(scanbotsdk_image_info_t *self, int *width)
Returns value of width field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_create(scanbotsdk_rect_t crop_rect, scanbotsdk_color_conversion_t color_conversion, scanbotsdk_canvas_color_t canvas_color, scanbotsdk_buffer_load_mode_t load_mode, scanbotsdk_buffer_image_load_options_t **result)
Creates a new instance of scanbotsdk_buffer_image_load_options with given params and stores it in the...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_create_with_defaults(scanbotsdk_encode_image_options_t **result)
Creates a new instance of scanbotsdk_encode_image_options_t with given required params and stores it ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_free(scanbotsdk_image_profile_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_profile_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_load_mode_t_to_string(scanbotsdk_buffer_load_mode_t value, const char **result)
Returns the string representation of the given scanbotsdk_buffer_load_mode_t value.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_set_canvas_color(scanbotsdk_buffer_image_load_options_t *self, scanbotsdk_canvas_color_t canvas_color)
Sets value of canvas_color field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_set_added(scanbotsdk_image_ref_pool_snapshots_diff_t *self, scanbotsdk_u8string_ref_t *added, size_t added_size)
Sets value of added field of the given object.
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)
Returns value of color_conversion field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_get_type(scanbotsdk_image_source_t *self, scanbotsdk_image_source_type_t *type)
Returns value of type field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_free(scanbotsdk_buffer_image_load_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_buffer_image_load_options_t....
SBSDK_API scanbotsdk_error_code_t scanbotsdk_raw_image_load_options_get_canvas_color(scanbotsdk_raw_image_load_options_t *self, scanbotsdk_canvas_color_t *canvas_color)
Returns value of canvas_color field of the given object.
struct scanbotsdk_basic_image_load_options_t scanbotsdk_basic_image_load_options_t
scanbotsdk_basic_image_load_options_t class
Definition ScanbotSDKImageRefTypes.h:258
SBSDK_API scanbotsdk_error_code_t scanbotsdk_buffer_image_load_options_get_canvas_color(scanbotsdk_buffer_image_load_options_t *self, scanbotsdk_canvas_color_t *canvas_color)
Returns value of canvas_color field of the given object.
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)
Sets value of color_conversion field of the given object.
struct scanbotsdk_path_image_load_options_t scanbotsdk_path_image_load_options_t
scanbotsdk_path_image_load_options_t class
Definition ScanbotSDKImageRefTypes.h:560
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_free(scanbotsdk_path_image_load_options_t *object)
Frees the memory allocated for the instance of scanbotsdk_path_image_load_options_t....
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)
Sets value of total_memory_consumption field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_max_byte_size(scanbotsdk_image_info_t *self, int *max_byte_size)
Returns value of max_byte_size field of the given 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)
Returns value of crop_rect field of the given object.
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)
Sets value of image_ref_profiles field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_get_height(scanbotsdk_image_info_t *self, int *height)
Returns value of height field of the given object.
struct scanbotsdk_image_source_t scanbotsdk_image_source_t
scanbotsdk_image_source_t class
Definition ScanbotSDKImageRefTypes.h:1148
SBSDK_API scanbotsdk_error_code_t scanbotsdk_canvas_color_t_to_string(scanbotsdk_canvas_color_t value, const char **result)
Returns the string representation of the given scanbotsdk_canvas_color_t value.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_ref_pool_snapshots_diff_create(int64_t total_memory_consumption_diff, scanbotsdk_u8string_ref_t *removed, size_t removed_size, scanbotsdk_u8string_ref_t *added, size_t added_size, scanbotsdk_u8string_ref_t *modified, size_t modified_size, scanbotsdk_image_ref_pool_snapshots_diff_t **result)
Creates a new instance of scanbotsdk_image_ref_pool_snapshots_diff with given params and stores it in...
scanbotsdk_image_rotation_t
scanbotsdk_image_rotation_t enum
Definition ScanbotSDKImageTypes.h:28
SBSDK_API scanbotsdk_error_code_t scanbotsdk_encode_image_options_set_quality(scanbotsdk_encode_image_options_t *self, int quality)
Sets value of quality field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_get_file_path(scanbotsdk_image_source_t *self, scanbotsdk_u8string_ref_t *file_path)
Returns value of file_path field of the given object. The returned pointers do NOT own the underlying...
scanbotsdk_image_source_type_t
scanbotsdk_image_source_type_t enum
Definition ScanbotSDKImageRefTypes.h:1105
SBSDK_API scanbotsdk_error_code_t scanbotsdk_path_image_load_options_create_with_defaults(scanbotsdk_path_image_load_options_t **result)
Creates a new instance of scanbotsdk_path_image_load_options_t with given required params and stores ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_set_optimize(scanbotsdk_save_image_options_t *self, bool optimize)
Sets value of optimize field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_info_free(scanbotsdk_image_info_t *object)
Frees the memory allocated for the instance of scanbotsdk_image_info_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_type_t_to_string(scanbotsdk_image_source_type_t value, const char **result)
Returns the string representation of the given scanbotsdk_image_source_type_t value.
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_canvas_color_t canvas_color, scanbotsdk_image_rotation_t orientation, scanbotsdk_raw_image_load_options_t **result)
Creates a new instance of scanbotsdk_raw_image_load_options with given params and stores it in the lo...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_save_image_options_create_with_defaults(scanbotsdk_save_image_options_t **result)
Creates a new instance of scanbotsdk_save_image_options_t with given required params and stores it in...
scanbotsdk_path_load_mode_t
scanbotsdk_path_load_mode_t enum
Definition ScanbotSDKImageRefTypes.h:173
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_source_create(scanbotsdk_image_source_type_t type, scanbotsdk_u8string_ref_t file_path, scanbotsdk_image_source_t **result)
Creates a new instance of scanbotsdk_image_source with given params and stores it in the location spe...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_image_profile_set_bitmap_memory_consumption(scanbotsdk_image_profile_t *self, int bitmap_memory_consumption)
Sets value of bitmap_memory_consumption field of the given object.
@ SCANBOTSDK_COLOR_CONVERSION_UNCHANGED
Definition ScanbotSDKImageRefTypes.h:48
@ SCANBOTSDK_COLOR_CONVERSION_ANY_COLOR
Definition ScanbotSDKImageRefTypes.h:44
@ SCANBOTSDK_COLOR_CONVERSION_COLOR
Definition ScanbotSDKImageRefTypes.h:40
@ SCANBOTSDK_COLOR_CONVERSION_GRAY
Definition ScanbotSDKImageRefTypes.h:36
@ SCANBOTSDK_ENCODING_FORMAT_PNG
Definition ScanbotSDKImageRefTypes.h:239
@ SCANBOTSDK_ENCODING_FORMAT_JPEG
Definition ScanbotSDKImageRefTypes.h:235
@ SCANBOTSDK_CANVAS_COLOR_WHITE
Definition ScanbotSDKImageRefTypes.h:71
@ SCANBOTSDK_CANVAS_COLOR_BLACK
Definition ScanbotSDKImageRefTypes.h:75
@ SCANBOTSDK_BUFFER_LOAD_MODE_EAGER
Definition ScanbotSDKImageRefTypes.h:208
@ SCANBOTSDK_BUFFER_LOAD_MODE_LAZY
Definition ScanbotSDKImageRefTypes.h:212
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_CAMERA
Definition ScanbotSDKImageRefTypes.h:1117
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_PLATFORM_IMAGE
Definition ScanbotSDKImageRefTypes.h:1113
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_API
Definition ScanbotSDKImageRefTypes.h:1109
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_OTHER
Definition ScanbotSDKImageRefTypes.h:1129
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_FILE
Definition ScanbotSDKImageRefTypes.h:1121
@ SCANBOTSDK_IMAGE_SOURCE_TYPE_BUFFER
Definition ScanbotSDKImageRefTypes.h:1125
@ SCANBOTSDK_PATH_LOAD_MODE_LAZY_WITH_COPY
Definition ScanbotSDKImageRefTypes.h:185
@ SCANBOTSDK_PATH_LOAD_MODE_LAZY
Definition ScanbotSDKImageRefTypes.h:181
@ SCANBOTSDK_PATH_LOAD_MODE_EAGER
Definition ScanbotSDKImageRefTypes.h:177
struct scanbotsdk_ref_counted_object_profile_t scanbotsdk_ref_counted_object_profile_t
scanbotsdk_ref_counted_object_profile_t class
Definition ScanbotSDKObjectPoolTypes.h:29
Represents a non-owning view of a UTF-8 encoded string.
Definition ScanbotSDKTypes.h:112