ScanbotSDKDocumentCleanup.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_document_cleanup_t	scanbotsdk_document_cleanup_t
	scanbotsdk_document_cleanup_t class

Functions
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 specified by the last argument.
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, the function does nothing.
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_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 unchanged. The number of available undo operations is limited by maxUndoRedoStackSize. When the operation limit is exceeded, the oldest operations cannot be undone.
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, returns the current image unchanged. Performing a new cleanup operation after undo will clear the redo history.
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 return false.
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 operation has been performed and not yet fully undone.
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 operation has been performed and not yet overwritten by a new cleanup.