ScImageDescription.h

Go to the documentation of this file.

#ifndef SC_IMAGE_DESCRIPTION_H_
#define SC_IMAGE_DESCRIPTION_H_

#include <Scandit/ScConfig.h>

#if defined(__cplusplus)
extern "C" {
#endif

typedef enum {
    SC_IMAGE_LAYOUT_UNKNOWN = 0x0000,
    SC_IMAGE_LAYOUT_GRAY_8U = 0x0001,
    SC_IMAGE_LAYOUT_RGB_8U = 0x0002,
    SC_IMAGE_LAYOUT_RGBA_8U = 0x0004,

    SC_IMAGE_LAYOUT_ARGB_8U = 0x0100,

    SC_IMAGE_LAYOUT_YPCBCR_8U = 0x0008,

    SC_IMAGE_LAYOUT_YPCRCB_8U = 0x0010,

    SC_IMAGE_LAYOUT_YUYV_8U = 0x0020,

    SC_IMAGE_LAYOUT_UYVY_8U = 0x0040,

    SC_IMAGE_LAYOUT_I420_8U = 0x0080,
    SC_IMAGE_LAYOUT_BGR_8U = 0x0200,

    SC_IMAGE_LAYOUT_NV16_8U = 0x0800,
} ScImageLayout;

typedef struct ScOpaqueImageDescription ScImageDescription;

SC_EXPORT
ScImageDescription *sc_image_description_new(void);

SC_EXPORT
void sc_image_description_retain(ScImageDescription *description);

SC_EXPORT
void sc_image_description_release(ScImageDescription *description);

SC_EXPORT
ScImageLayout sc_image_description_get_layout(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_layout(ScImageDescription *description, ScImageLayout layout);

SC_EXPORT
uint32_t sc_image_description_get_width(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_width(ScImageDescription *description, uint32_t width);

SC_EXPORT
uint32_t sc_image_description_get_height(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_height(ScImageDescription *description, uint32_t height);

SC_EXPORT
uint32_t sc_image_description_get_first_plane_offset(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_first_plane_offset(ScImageDescription *description, uint32_t offset);

SC_EXPORT
uint32_t sc_image_description_get_first_plane_row_bytes(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_first_plane_row_bytes(ScImageDescription *description,
                                                    uint32_t row_bytes);

SC_EXPORT
uint32_t sc_image_description_get_second_plane_row_bytes(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_second_plane_row_bytes(ScImageDescription *description,
                                                     uint32_t row_bytes);

SC_EXPORT
uint32_t sc_image_description_get_second_plane_offset(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_second_plane_offset(ScImageDescription *description, uint32_t offset);

SC_EXPORT
uint32_t sc_image_description_get_memory_size(ScImageDescription const *description);

SC_EXPORT
void sc_image_description_set_memory_size(ScImageDescription *description, uint32_t memory_size);

#if defined(__cplusplus)
}
#endif

#endif // SC_IMAGE_DESCRIPTION_H_