Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDKDocumentEnhancerTypes.h
Go to the documentation of this file.
1// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
2// Generated from SchemasV3/CoreSchemas/schemas/DocumentEnhancerTypes.yaml
6
7#pragma once
8#ifndef SCANBOTSDK_DOCUMENTENHANCERTYPES_H
9#define SCANBOTSDK_DOCUMENTENHANCERTYPES_H
10
11
12#include <ScanbotSDKImage.h>
14#include <stdbool.h>
15#include <stddef.h>
16#include <stdint.h>
17#include <string.h>
18#include <ScanbotSDKErrorCode.h>
19#include <ScanbotSDKDefs.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25
42
52
59
80 scanbotsdk_aspect_ratio_t** aspect_ratios,
81 size_t aspect_ratios_size,
83
94
95
103
128
167
168
175
183
193
194
195#ifdef __cplusplus
196} /* extern "C" */
197#endif
198
199#endif /* SCANBOTSDK_DOCUMENTENHANCERTYPES_H */
ScanbotSDK Error Code C API.
scanbotsdk_error_code_t
The error codes returned by most of the Scanbot SDK functions.
Definition ScanbotSDKErrorCode.h:25
ScanbotSDK Image Ref C API.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_mode_t_to_string(scanbotsdk_document_straightening_mode_t value, const char **result)
Returns the string representation of the given scanbotsdk_document_straightening_mode_t value.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_result_free(scanbotsdk_document_straightening_result_t *object)
Frees the memory allocated for the instance of scanbotsdk_document_straightening_result_t....
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_set_aspect_ratios(scanbotsdk_document_straightening_parameters_t *self, scanbotsdk_aspect_ratio_t **aspect_ratios, size_t aspect_ratios_size)
Sets value of aspect_ratios field of the given object.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_result_get_straightened_image(scanbotsdk_document_straightening_result_t *self, scanbotsdk_image_t **straightened_image)
Returns value of straightened_image field of the given object. The returned pointers do NOT own the u...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_get_aspect_ratios_size(scanbotsdk_document_straightening_parameters_t *self, size_t *size)
Returns size of aspect_ratios array.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_free(scanbotsdk_document_straightening_parameters_t *object)
Frees the memory allocated for the instance of scanbotsdk_document_straightening_parameters_t....
struct scanbotsdk_document_straightening_result_t scanbotsdk_document_straightening_result_t
scanbotsdk_document_straightening_result_t class
Definition ScanbotSDKDocumentEnhancerTypes.h:174
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_get_aspect_ratios(scanbotsdk_document_straightening_parameters_t *self, scanbotsdk_aspect_ratio_t **aspect_ratios, size_t size)
Returns value of aspect_ratios field of the given object. The returned pointers do NOT own the underl...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_get_straightening_mode(scanbotsdk_document_straightening_parameters_t *self, scanbotsdk_document_straightening_mode_t *straightening_mode)
Returns value of straightening_mode field of the given object.
scanbotsdk_document_straightening_mode_t
scanbotsdk_document_straightening_mode_t enum
Definition ScanbotSDKDocumentEnhancerTypes.h:31
struct scanbotsdk_document_straightening_parameters_t scanbotsdk_document_straightening_parameters_t
scanbotsdk_document_straightening_parameters_t class
Definition ScanbotSDKDocumentEnhancerTypes.h:58
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_create(scanbotsdk_document_straightening_mode_t straightening_mode, scanbotsdk_aspect_ratio_t **aspect_ratios, size_t aspect_ratios_size, scanbotsdk_document_straightening_parameters_t **result)
Creates a new instance of scanbotsdk_document_straightening_parameters with given params and stores i...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_create_with_defaults(scanbotsdk_document_straightening_parameters_t **result)
Creates a new instance of scanbotsdk_document_straightening_parameters_t with given required params a...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_straightening_parameters_set_straightening_mode(scanbotsdk_document_straightening_parameters_t *self, scanbotsdk_document_straightening_mode_t straightening_mode)
Sets value of straightening_mode field of the given object.
@ SCANBOTSDK_DOCUMENT_STRAIGHTENING_MODE_NONE
Definition ScanbotSDKDocumentEnhancerTypes.h:34
@ SCANBOTSDK_DOCUMENT_STRAIGHTENING_MODE_STRAIGHTEN
Definition ScanbotSDKDocumentEnhancerTypes.h:39
struct scanbotsdk_aspect_ratio_t scanbotsdk_aspect_ratio_t
scanbotsdk_aspect_ratio_t class
Definition ScanbotSDKGeometry.h:133
struct scanbotsdk_image_t scanbotsdk_image_t
Represents an instance of the opaque image.
Definition ScanbotSDKImage.h:31