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 
110  SC_IMAGE_LAYOUT_I420_8U = 0x0080
111 
112 
114 
115 
141 typedef struct ScOpaqueImageDescription ScImageDescription;
144 
157 
166 SC_EXPORT void
168 
179 SC_EXPORT void
181 
198 SC_EXPORT ScImageLayout
200 
212 SC_EXPORT void
214  ScImageLayout layout);
215 
216 
227 SC_EXPORT uint32_t
229 
240 SC_EXPORT void
242  uint32_t width);
243 
254 SC_EXPORT uint32_t
256 
266 SC_EXPORT void
268  uint32_t height);
269 
270 
281 SC_EXPORT uint32_t
283 
284 
294 SC_EXPORT void
296  uint32_t offset);
297 
308 SC_EXPORT uint32_t
310 
320 SC_EXPORT void
322  uint32_t row_bytes);
323 
324 
335 SC_EXPORT uint32_t
337 
347 SC_EXPORT void
349  uint32_t row_bytes);
350 
351 
362 SC_EXPORT uint32_t
364 
374 SC_EXPORT void
376  uint32_t offset);
377 
388 SC_EXPORT uint32_t
390 
401 SC_EXPORT void
403  uint32_t memory_size);
404 
405 
406 #if defined(__cplusplus)
407 }
408 #endif
409 
410 
411 #endif // SC_IMAGE_DESCRIPTION_H_
412 
413 
void sc_image_description_set_second_plane_offset(ScImageDescription *description, uint32_t offset)
Set the start offset of the second data plane.
@ SC_IMAGE_LAYOUT_YUYV_8U
8-bit YUYV 4:2:2 image format.
Definition: ScImageDescription.h:88
@ SC_IMAGE_LAYOUT_RGB_8U
RGB image with 8bit per color channel.
Definition: ScImageDescription.h:42
uint32_t sc_image_description_get_second_plane_offset(const ScImageDescription *description)
Get the start offset of the second data plane.
void sc_image_description_set_layout(ScImageDescription *description, ScImageLayout layout)
Set the image layout.
uint32_t sc_image_description_get_second_plane_row_bytes(const ScImageDescription *description)
Get the number of bytes per row for the second data plane.
ScImageLayout sc_image_description_get_layout(const ScImageDescription *description)
Get the image layout.
uint32_t sc_image_description_get_first_plane_offset(const ScImageDescription *description)
Get start offset of the first data plane.
@ SC_IMAGE_LAYOUT_UNKNOWN
Image layout is unknown.
Definition: ScImageDescription.h:28
uint32_t sc_image_description_get_memory_size(const ScImageDescription *description)
Get the total memory size of the frame data.
@ SC_IMAGE_LAYOUT_ARGB_8U
ARGB image with 8bit per color channel.
Definition: ScImageDescription.h:57
void sc_image_description_set_height(ScImageDescription *description, uint32_t height)
Set height of image.
Common definitions used throughout the ScanditSDK API.
@ SC_IMAGE_LAYOUT_YPCRCB_8U
YpCrCb 4:2:0 image format.
Definition: ScImageDescription.h:77
void sc_image_description_set_width(ScImageDescription *description, uint32_t width)
Set width of image.
void sc_image_description_set_first_plane_offset(ScImageDescription *description, uint32_t offset)
Set the start offset of the first data plane.
@ SC_IMAGE_LAYOUT_RGBA_8U
RGBA image with 8bit per color channel.
Definition: ScImageDescription.h:49
ScImageDescription * sc_image_description_new(void)
Create a new image description.
@ SC_IMAGE_LAYOUT_I420_8U
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.
ScImageLayout
Specifies the format of the pixel data.
Definition: ScImageDescription.h:24
Describes dimensions as well as internal memory layout of an image buffer.
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.
@ SC_IMAGE_LAYOUT_UYVY_8U
8-bit UYVY 4:2:2 image format.
Definition: ScImageDescription.h:99
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.
void sc_image_description_set_memory_size(ScImageDescription *description, uint32_t memory_size)
Set the total memory size of the frame data.
@ SC_IMAGE_LAYOUT_GRAY_8U
Single-channel 8-bit gray scale image.
Definition: ScImageDescription.h:35
@ SC_IMAGE_LAYOUT_YPCBCR_8U
YpCbCr 4:2:0 image format.
Definition: ScImageDescription.h:67
uint32_t sc_image_description_get_width(const ScImageDescription *description)
Get width of image.
void sc_image_description_retain(ScImageDescription *description)
Increase reference count of image description by one.
uint32_t sc_image_description_get_first_plane_row_bytes(const ScImageDescription *description)
Get the number of bytes per row for the first data plane.
uint32_t sc_image_description_get_height(const ScImageDescription *description)
Get height of image.