ScanbotSDKDocumentEnhancerTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef enum scanbotsdk_document_straightening_mode_t	scanbotsdk_document_straightening_mode_t
	scanbotsdk_document_straightening_mode_t enum
typedef struct scanbotsdk_document_straightening_parameters_t	scanbotsdk_document_straightening_parameters_t
	scanbotsdk_document_straightening_parameters_t class
typedef struct scanbotsdk_document_straightening_result_t	scanbotsdk_document_straightening_result_t
	scanbotsdk_document_straightening_result_t class

Enumerations
enum	scanbotsdk_document_straightening_mode_t {   SCANBOTSDK_DOCUMENT_STRAIGHTENING_MODE_NONE = 0 ,   SCANBOTSDK_DOCUMENT_STRAIGHTENING_MODE_STRAIGHTEN = 1 }
	scanbotsdk_document_straightening_mode_t enum More...

Functions
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_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 it in the location specified by the last argument.
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 and stores it in the location specified by the last argument.
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. If null is passed, the function does nothing.
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.
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.
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 underlying object, caller must not free them.
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_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_free (scanbotsdk_document_straightening_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_straightening_result_t. If null is passed, the function does nothing.
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 underlying object, caller must not free them.