ScanbotSDKDocumentCleanupTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/DocumentCleanupTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_DOCUMENTCLEANUPTYPES_H
#define SCANBOTSDK_DOCUMENTCLEANUPTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_document_cleanup_status_t {

    SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_OK = 0,

    SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_OK_BUT_REDUCED_QUALITY = 1,

    SCANBOTSDK_DOCUMENT_CLEANUP_STATUS_ERROR_MASK_TOO_LARGE = 2,
 
} scanbotsdk_document_cleanup_status_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_status_t_to_string(scanbotsdk_document_cleanup_status_t value, const char** result);

typedef struct scanbotsdk_document_cleanup_result_t scanbotsdk_document_cleanup_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_result_free(scanbotsdk_document_cleanup_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_result_get_status(scanbotsdk_document_cleanup_result_t* self, scanbotsdk_document_cleanup_status_t* status);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_result_get_image(scanbotsdk_document_cleanup_result_t* self, scanbotsdk_image_t** image);
 

typedef struct scanbotsdk_document_cleanup_configuration_t scanbotsdk_document_cleanup_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_create(
    bool keep_text,
    int max_undo_redo_stack_size,
    int max_cleanup_resolution,
    int max_mask_bounding_box_area,
    scanbotsdk_document_cleanup_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_create_with_defaults(
    scanbotsdk_document_cleanup_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_free(scanbotsdk_document_cleanup_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_get_keep_text(scanbotsdk_document_cleanup_configuration_t* self, bool* keep_text);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_set_keep_text(scanbotsdk_document_cleanup_configuration_t* self, bool keep_text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_get_max_undo_redo_stack_size(scanbotsdk_document_cleanup_configuration_t* self, int* max_undo_redo_stack_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_set_max_undo_redo_stack_size(scanbotsdk_document_cleanup_configuration_t* self, int max_undo_redo_stack_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_get_max_cleanup_resolution(scanbotsdk_document_cleanup_configuration_t* self, int* max_cleanup_resolution);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_set_max_cleanup_resolution(scanbotsdk_document_cleanup_configuration_t* self, int max_cleanup_resolution);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_get_max_mask_bounding_box_area(scanbotsdk_document_cleanup_configuration_t* self, int* max_mask_bounding_box_area);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_cleanup_configuration_set_max_mask_bounding_box_area(scanbotsdk_document_cleanup_configuration_t* self, int max_mask_bounding_box_area);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTCLEANUPTYPES_H */