ScImageDescription.h
Go to the documentation of this file.
1 
10 #ifndef SC_IMAGE_DESCRIPTION_H_
11 #define SC_IMAGE_DESCRIPTION_H_
12 
13 #include <Scandit/ScConfig.h>
14 
15 #if defined(__cplusplus)
16 extern "C" {
17 #endif
18 
24 typedef enum {
50 
58 
68 
78 
89 
100 
120 
130 } ScImageLayout;
131 
157 typedef struct ScOpaqueImageDescription ScImageDescription;
160 
172 SC_EXPORT
174 
183 SC_EXPORT
185 
196 SC_EXPORT
198 
215 SC_EXPORT
217 
229 SC_EXPORT
231 
242 SC_EXPORT
243 uint32_t sc_image_description_get_width(ScImageDescription const *description);
244 
255 SC_EXPORT
256 void sc_image_description_set_width(ScImageDescription *description, uint32_t width);
257 
268 SC_EXPORT
269 uint32_t sc_image_description_get_height(ScImageDescription const *description);
270 
280 SC_EXPORT
281 void sc_image_description_set_height(ScImageDescription *description, uint32_t height);
282 
293 SC_EXPORT
295 
305 SC_EXPORT
306 void sc_image_description_set_first_plane_offset(ScImageDescription *description, uint32_t offset);
307 
318 SC_EXPORT
320 
330 SC_EXPORT
332  uint32_t row_bytes);
333 
344 SC_EXPORT
346 
356 SC_EXPORT
358  uint32_t row_bytes);
359 
370 SC_EXPORT
372 
382 SC_EXPORT
383 void sc_image_description_set_second_plane_offset(ScImageDescription *description, uint32_t offset);
384 
395 SC_EXPORT
396 uint32_t sc_image_description_get_memory_size(ScImageDescription const *description);
397 
408 SC_EXPORT
409 void sc_image_description_set_memory_size(ScImageDescription *description, uint32_t memory_size);
410 
411 #if defined(__cplusplus)
412 }
413 #endif
414 
415 #endif // SC_IMAGE_DESCRIPTION_H_
Image layout is unknown.
Definition: ScImageDescription.h:28
void sc_image_description_set_height(ScImageDescription *description, uint32_t height)
Set height of image.
uint32_t sc_image_description_get_width(ScImageDescription const *description)
Get width of image.
void sc_image_description_set_width(ScImageDescription *description, uint32_t width)
Set width of image.
RGB image with 8 bits per color channel.
Definition: ScImageDescription.h:42
uint32_t sc_image_description_get_height(ScImageDescription const *description)
Get height of image.
8-bit UYVY 4:2:2 image format.
Definition: ScImageDescription.h:99
RGBA image with 8 bits per color channel.
Definition: ScImageDescription.h:49
void sc_image_description_set_second_plane_row_bytes(ScImageDescription *description, uint32_t row_bytes)
Set the number of bytes per row for the second data plane.
BGR image with 8 bits per color channel.
Definition: ScImageDescription.h:119
void sc_image_description_set_first_plane_row_bytes(ScImageDescription *description, uint32_t row_bytes)
Set the number of bytes per row for first data plane.
ScImageDescription * sc_image_description_new(void)
Create a new image description.
void sc_image_description_set_first_plane_offset(ScImageDescription *description, uint32_t offset)
Set the start offset of the first data plane.
uint32_t sc_image_description_get_second_plane_offset(ScImageDescription const *description)
Get the start offset of the second data plane.
ARGB image with 8 bits per color channel.
Definition: ScImageDescription.h:57
Single-channel 8-bit gray scale image.
Definition: ScImageDescription.h:35
ScImageLayout
Specifies the format of the pixel data.
Definition: ScImageDescription.h:24
Describes dimensions as well as internal memory layout of an image buffer.
uint32_t sc_image_description_get_memory_size(ScImageDescription const *description)
Get the total memory size of the frame data.
uint32_t sc_image_description_get_first_plane_offset(ScImageDescription const *description)
Get start offset of the first data plane.
uint32_t sc_image_description_get_second_plane_row_bytes(ScImageDescription const *description)
Get the number of bytes per row for the second data plane.
YpCbCr 4:2:0 image format.
Definition: ScImageDescription.h:67
Common definitions used throughout the ScanditSDK API.
YpCrCb 4:2:2 image format.
Definition: ScImageDescription.h:129
YpCrCb 4:2:0 image format.
Definition: ScImageDescription.h:77
uint32_t sc_image_description_get_first_plane_row_bytes(ScImageDescription const *description)
Get the number of bytes per row for the first data plane.
void sc_image_description_set_memory_size(ScImageDescription *description, uint32_t memory_size)
Set the total memory size of the frame data.
void sc_image_description_retain(ScImageDescription *description)
Increase reference count of image description by one.
I420 format with separate Y, U and V planes.
Definition: ScImageDescription.h:110
void sc_image_description_release(ScImageDescription *description)
Decrease reference count of image description by one.
8-bit YUYV 4:2:2 image format.
Definition: ScImageDescription.h:88
void sc_image_description_set_layout(ScImageDescription *description, ScImageLayout layout)
Set the image layout.
ScImageLayout sc_image_description_get_layout(ScImageDescription const *description)
Get the image layout.
void sc_image_description_set_second_plane_offset(ScImageDescription *description, uint32_t offset)
Set the start offset of the second data plane.