Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDKDocumentCleanup.h
Go to the documentation of this file.
1// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
2// Generated from SchemasV3/CoreSchemas/schemas/DocumentCleanup.yaml
6
7#pragma once
8#ifndef SCANBOTSDK_DOCUMENTCLEANUP_H
9#define SCANBOTSDK_DOCUMENTCLEANUP_H
10
11
12#include <ScanbotSDKImage.h>
14#include <stdbool.h>
15#include <stddef.h>
16#include <stdint.h>
17#include <ScanbotSDKErrorCode.h>
18#include <ScanbotSDKDefs.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
24
33
47 scanbotsdk_image_t* image,
50);
51
60);
61
77);
78
94 scanbotsdk_image_t** result
95);
96
111 scanbotsdk_image_t** result
112);
113
127 scanbotsdk_image_t** result
128);
129
143 bool* result
144);
145
159 bool* result
160);
161
162
163#ifdef __cplusplus
164} /* extern "C" */
165#endif
166
167#endif /* SCANBOTSDK_DOCUMENTCLEANUP_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
ScanbotSDK Image Ref C API.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_can_undo(scanbotsdk_document_cleanup_t *self, bool *result)
Returns whether an undo operation is currently available. This is true when at least one cleanup oper...
struct scanbotsdk_document_cleanup_configuration_t scanbotsdk_document_cleanup_configuration_t
scanbotsdk_document_cleanup_configuration_t class
Definition ScanbotSDKDocumentCleanupTypes.h:105
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_reset(scanbotsdk_document_cleanup_t *self, scanbotsdk_image_t **result)
Restores the original image, and clears the undo/redo history. After reset, both canUndo and canRedo ...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_undo(scanbotsdk_document_cleanup_t *self, scanbotsdk_image_t **result)
Reverts the last cleanup operation. If no operations are available to undo, returns the current image...
struct scanbotsdk_document_cleanup_result_t scanbotsdk_document_cleanup_result_t
scanbotsdk_document_cleanup_result_t class
Definition ScanbotSDKDocumentCleanupTypes.h:67
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_create(scanbotsdk_image_t *image, scanbotsdk_document_cleanup_configuration_t *configuration, scanbotsdk_document_cleanup_t **result)
Creates a new instance of scanbotsdk_document_cleanup with given params and stores it in the location...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_run(scanbotsdk_document_cleanup_t *self, scanbotsdk_image_t *mask, scanbotsdk_document_cleanup_result_t **result)
cleans the masked areas up.
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_free(scanbotsdk_document_cleanup_t *self)
Frees the memory allocated for the instance of scanbotsdk_document_cleanup_t. If null is passed,...
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_redo(scanbotsdk_document_cleanup_t *self, scanbotsdk_image_t **result)
Re-applies the last undone cleanup operation. If no operations are available to redo,...
struct scanbotsdk_document_cleanup_t scanbotsdk_document_cleanup_t
scanbotsdk_document_cleanup_t class
Definition ScanbotSDKDocumentCleanup.h:32
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_can_redo(scanbotsdk_document_cleanup_t *self, bool *result)
Returns whether a redo operation is currently available. This is true when at least one undo operatio...
struct scanbotsdk_image_t scanbotsdk_image_t
Represents an instance of the opaque image.
Definition ScanbotSDKImage.h:31