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 
60 
70 
81 
92 
103 } ScImageLayout;
104 
105 
131 typedef struct ScOpaqueImageDescription ScImageDescription;
134 
147 
156 SC_EXPORT void
158 
169 SC_EXPORT void
171 
188 SC_EXPORT ScImageLayout
190 
202 SC_EXPORT void
204  ScImageLayout layout);
205 
206 
217 SC_EXPORT uint32_t
219 
230 SC_EXPORT void
232  uint32_t width);
233 
244 SC_EXPORT uint32_t
246 
256 SC_EXPORT void
258  uint32_t height);
259 
260 
271 SC_EXPORT uint32_t
273 
274 
284 SC_EXPORT void
286  uint32_t offset);
287 
298 SC_EXPORT uint32_t
300 
310 SC_EXPORT void
312  uint32_t row_bytes);
313 
314 
325 SC_EXPORT uint32_t
327 
337 SC_EXPORT void
339  uint32_t row_bytes);
340 
341 
352 SC_EXPORT uint32_t
354 
364 SC_EXPORT void
366  uint32_t offset);
367 
378 SC_EXPORT uint32_t
380 
391 SC_EXPORT void
393  uint32_t memory_size);
394 
395 
396 #if defined(__cplusplus)
397 }
398 #endif
399 
400 
401 #endif // SC_IMAGE_DESCRIPTION_H_
402 
403 
Image layout is unknown.
Definition: ScImageDescription.h:28
void sc_image_description_set_height(ScImageDescription *description, uint32_t height)
Set height of image.
void sc_image_description_set_width(ScImageDescription *description, uint32_t width)
Set width of image.
uint32_t sc_image_description_get_second_plane_offset(const ScImageDescription *description)
Get the start offset of the second data plane.
RGB image with 8bit per color channel.
Definition: ScImageDescription.h:42
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_width(const ScImageDescription *description)
Get width of image.
8-bit UYVY 4:2:2 image format.
Definition: ScImageDescription.h:91
uint32_t sc_image_description_get_first_plane_offset(const ScImageDescription *description)
Get start offset of the first data plane.
RGBA image with 8bit 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.
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.
uint32_t sc_image_description_get_memory_size(const ScImageDescription *description)
Get the total memory size of the frame data.
void sc_image_description_set_first_plane_offset(ScImageDescription *description, uint32_t offset)
Set the start offset of the first data plane.
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.
ScImageLayout sc_image_description_get_layout(const ScImageDescription *description)
Get the image layout.
YpCbCr 4:2:0 image format.
Definition: ScImageDescription.h:59
Common definitions used throughout the ScanditSDK API.
YpCrCb 4:2:0 image format.
Definition: ScImageDescription.h:69
uint32_t sc_image_description_get_height(const ScImageDescription *description)
Get height of image.
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:102
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:80
void sc_image_description_set_layout(ScImageDescription *description, ScImageLayout layout)
Set 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.
ScImageDescription * sc_image_description_new()
Create a new image description.
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.