ScImageDescription.h

Go to the documentation of this file.

 
#ifndef SC_IMAGE_DESCRIPTION_H_
#define SC_IMAGE_DESCRIPTION_H_
 
#include <stddef.h>
 
#include <Scandit/ScConfig.h>
 
SC_EXTERN_C_BEGIN
 
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 const *description);
 
SC_EXPORT
void sc_image_description_release(ScImageDescription const *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_planes_count(ScImageDescription const *description);
 
SC_EXPORT
ptrdiff_t sc_image_description_get_plane_offset(ScImageDescription const *description,
                                                uint32_t plane_index);
 
SC_EXPORT
void sc_image_description_set_plane_offset(ScImageDescription *description,
                                           uint32_t plane_index,
                                           ptrdiff_t offset);
 
SC_EXPORT
uint32_t sc_image_description_get_plane_row_bytes(ScImageDescription const *description,
                                                  uint32_t plane_index);
 
SC_EXPORT
void sc_image_description_set_plane_row_bytes(ScImageDescription *description,
                                              uint32_t plane_index,
                                              uint32_t row_bytes);
 
SC_EXTERN_C_END
 
#endif // SC_IMAGE_DESCRIPTION_H_