ScanbotSDKTiffTypes.h

Go to the documentation of this file.

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

typedef enum scanbotsdk_compression_mode_t {

    SCANBOTSDK_COMPRESSION_MODE_NONE = 1,

    SCANBOTSDK_COMPRESSION_MODE_CCITTRLE = 2,

    SCANBOTSDK_COMPRESSION_MODE_CCITT_T4 = 3,

    SCANBOTSDK_COMPRESSION_MODE_CCITT_T6 = 4,

    SCANBOTSDK_COMPRESSION_MODE_LZW = 5,

    SCANBOTSDK_COMPRESSION_MODE_JPEG = 7,

    SCANBOTSDK_COMPRESSION_MODE_CCITTRLEW = 32771,

    SCANBOTSDK_COMPRESSION_MODE_PACKBITS = 32773,

    SCANBOTSDK_COMPRESSION_MODE_DEFLATE = 32946,

    SCANBOTSDK_COMPRESSION_MODE_ADOBE_DEFLATE = 8,
 
} scanbotsdk_compression_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_compression_mode_t_to_string(scanbotsdk_compression_mode_t value, const char** result);

typedef struct scanbotsdk_user_field_value_t scanbotsdk_user_field_value_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_free(scanbotsdk_user_field_value_t* object);
 

typedef struct scanbotsdk_user_field_double_value_t scanbotsdk_user_field_double_value_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_create(
    double value,
    scanbotsdk_user_field_double_value_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_free(scanbotsdk_user_field_double_value_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value(scanbotsdk_user_field_value_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value(scanbotsdk_user_field_value_t* object, scanbotsdk_user_field_double_value_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value(scanbotsdk_user_field_double_value_t* object, scanbotsdk_user_field_value_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_get_value(scanbotsdk_user_field_double_value_t* self, double* value);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_set_value(scanbotsdk_user_field_double_value_t* self, double value);
 

typedef struct scanbotsdk_user_field_string_value_t scanbotsdk_user_field_string_value_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_create(
    scanbotsdk_u8string_ref_t value,
    scanbotsdk_user_field_string_value_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_free(scanbotsdk_user_field_string_value_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value(scanbotsdk_user_field_value_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value(scanbotsdk_user_field_value_t* object, scanbotsdk_user_field_string_value_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value(scanbotsdk_user_field_string_value_t* object, scanbotsdk_user_field_value_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_get_value(scanbotsdk_user_field_string_value_t* self, scanbotsdk_u8string_ref_t* value);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_set_value(scanbotsdk_user_field_string_value_t* self, scanbotsdk_u8string_ref_t value);
 

typedef struct scanbotsdk_user_field_int_value_t scanbotsdk_user_field_int_value_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_create(
    int value,
    scanbotsdk_user_field_int_value_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_free(scanbotsdk_user_field_int_value_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value(scanbotsdk_user_field_value_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value(scanbotsdk_user_field_value_t* object, scanbotsdk_user_field_int_value_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value(scanbotsdk_user_field_int_value_t* object, scanbotsdk_user_field_value_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_get_value(scanbotsdk_user_field_int_value_t* self, int* value);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_set_value(scanbotsdk_user_field_int_value_t* self, int value);
 

typedef struct scanbotsdk_user_field_t scanbotsdk_user_field_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_create(
    int tag,
    scanbotsdk_u8string_ref_t name,
    scanbotsdk_user_field_value_t* value,
    scanbotsdk_user_field_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_free(scanbotsdk_user_field_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_tag(scanbotsdk_user_field_t* self, int* tag);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_tag(scanbotsdk_user_field_t* self, int tag);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_name(scanbotsdk_user_field_t* self, scanbotsdk_u8string_ref_t* name);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_name(scanbotsdk_user_field_t* self, scanbotsdk_u8string_ref_t name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_value(scanbotsdk_user_field_t* self, scanbotsdk_user_field_value_t** value);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_value(scanbotsdk_user_field_t* self, scanbotsdk_user_field_value_t* value);
 

typedef struct scanbotsdk_tiff_generator_parameters_t scanbotsdk_tiff_generator_parameters_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_create(
    scanbotsdk_compression_mode_t compression,
    int jpeg_quality,
    int zip_compression_level,
    int dpi,
    scanbotsdk_user_field_t** user_fields,
    size_t user_fields_size,
    scanbotsdk_parametric_filter_t* binarization_filter,
    scanbotsdk_tiff_generator_parameters_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_create_with_defaults(
    scanbotsdk_tiff_generator_parameters_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_free(scanbotsdk_tiff_generator_parameters_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_compression(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_compression_mode_t* compression);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_compression(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_compression_mode_t compression);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_jpeg_quality(scanbotsdk_tiff_generator_parameters_t* self, int* jpeg_quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_jpeg_quality(scanbotsdk_tiff_generator_parameters_t* self, int jpeg_quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_zip_compression_level(scanbotsdk_tiff_generator_parameters_t* self, int* zip_compression_level);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_zip_compression_level(scanbotsdk_tiff_generator_parameters_t* self, int zip_compression_level);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_dpi(scanbotsdk_tiff_generator_parameters_t* self, int* dpi);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_dpi(scanbotsdk_tiff_generator_parameters_t* self, int dpi);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_user_fields(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_user_field_t** user_fields, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_user_fields_size(scanbotsdk_tiff_generator_parameters_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_user_fields(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_user_field_t** user_fields, size_t user_fields_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_binarization_filter(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_parametric_filter_t** binarization_filter);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_binarization_filter(scanbotsdk_tiff_generator_parameters_t* self, scanbotsdk_parametric_filter_t* binarization_filter);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_TIFFTYPES_H */