Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

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 {
28  SC_IMAGE_LAYOUT_UNKNOWN = 0x0000,
35  SC_IMAGE_LAYOUT_GRAY_8U = 0x0001,
42  SC_IMAGE_LAYOUT_RGB_8U = 0x0002,
49  SC_IMAGE_LAYOUT_RGBA_8U = 0x0004,
50 
59  SC_IMAGE_LAYOUT_YPCBCR_8U = 0x0008,
60 
69  SC_IMAGE_LAYOUT_YPCRCB_8U = 0x0010,
70 
80  SC_IMAGE_LAYOUT_YUYV_8U = 0x0020,
81 
91  SC_IMAGE_LAYOUT_UYVY_8U = 0x0040,
92 
102  SC_IMAGE_LAYOUT_I420_8U = 0x0080
103 } ScImageLayout;
104 
105 
131 typedef struct ScOpaqueImageDescription ScImageDescription;
134 
146 SC_EXPORT ScImageDescription * sc_image_description_new();
147 
156 SC_EXPORT void
157 sc_image_description_retain(ScImageDescription *description);
158 
169 SC_EXPORT void
170 sc_image_description_release(ScImageDescription *description);
171 
188 SC_EXPORT ScImageLayout
189 sc_image_description_get_layout(const ScImageDescription *description);
190 
202 SC_EXPORT void
203 sc_image_description_set_layout(ScImageDescription *description,
204  ScImageLayout layout);
205 
206 
217 SC_EXPORT uint32_t
218 sc_image_description_get_width(const ScImageDescription *description);
219 
230 SC_EXPORT void
231 sc_image_description_set_width(ScImageDescription *description,
232  uint32_t width);
233 
244 SC_EXPORT uint32_t
245 sc_image_description_get_height(const ScImageDescription *description);
246 
256 SC_EXPORT void
257 sc_image_description_set_height(ScImageDescription *description,
258  uint32_t height);
259 
260 
271 SC_EXPORT uint32_t
272 sc_image_description_get_first_plane_offset(const ScImageDescription *description);
273 
274 
284 SC_EXPORT void
285 sc_image_description_set_first_plane_offset(ScImageDescription *description,
286  uint32_t offset);
287 
298 SC_EXPORT uint32_t
299 sc_image_description_get_first_plane_row_bytes(const ScImageDescription *description);
300 
310 SC_EXPORT void
311 sc_image_description_set_first_plane_row_bytes(ScImageDescription *description,
312  uint32_t row_bytes);
313 
314 
325 SC_EXPORT uint32_t
326 sc_image_description_get_second_plane_row_bytes(const ScImageDescription *description);
327 
337 SC_EXPORT void
338 sc_image_description_set_second_plane_row_bytes(ScImageDescription *description,
339  uint32_t row_bytes);
340 
341 
352 SC_EXPORT uint32_t
353 sc_image_description_get_second_plane_offset(const ScImageDescription *description);
354 
364 SC_EXPORT void
365 sc_image_description_set_second_plane_offset(ScImageDescription *description,
366  uint32_t offset);
367 
378 SC_EXPORT uint32_t
379 sc_image_description_get_memory_size(const ScImageDescription *description);
380 
391 SC_EXPORT void
392 sc_image_description_set_memory_size(ScImageDescription *description,
393  uint32_t memory_size);
394 
395 
396 #if defined(__cplusplus)
397 }
398 #endif
399 
400 
401 #endif // SC_IMAGE_DESCRIPTION_H_
402 
403 
SC_IMAGE_LAYOUT_UNKNOWN
Image layout is unknown.
Definition: ScImageDescription.h:28
ScImageDescription::sc_image_description_set_height
void sc_image_description_set_height(ScImageDescription *description, uint32_t height)
Set height of image.
ScImageDescription::sc_image_description_set_width
void sc_image_description_set_width(ScImageDescription *description, uint32_t width)
Set width of image.
ScImageDescription::sc_image_description_get_second_plane_offset
uint32_t sc_image_description_get_second_plane_offset(const ScImageDescription *description)
Get the start offset of the second data plane.
SC_IMAGE_LAYOUT_RGB_8U
RGB image with 8bit per color channel.
Definition: ScImageDescription.h:42
ScImageDescription::sc_image_description_get_first_plane_row_bytes
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.
ScImageDescription::sc_image_description_get_width
uint32_t sc_image_description_get_width(const ScImageDescription *description)
Get width of image.
SC_IMAGE_LAYOUT_UYVY_8U
8-bit UYVY 4:2:2 image format.
Definition: ScImageDescription.h:91
ScImageDescription::sc_image_description_get_first_plane_offset
uint32_t sc_image_description_get_first_plane_offset(const ScImageDescription *description)
Get 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_set_second_plane_row_bytes
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.
ScImageDescription::sc_image_description_set_first_plane_row_bytes
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_get_memory_size
uint32_t sc_image_description_get_memory_size(const ScImageDescription *description)
Get the total memory size of the frame data.
ScImageDescription::sc_image_description_set_first_plane_offset
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_GRAY_8U
Single-channel 8-bit gray scale image.
Definition: ScImageDescription.h:35
ScImageLayout
ScImageLayout
Specifies the format of the pixel data.
Definition: ScImageDescription.h:24
ScImageDescription
Describes dimensions as well as internal memory layout of an image buffer.
ScImageDescription::sc_image_description_get_layout
ScImageLayout sc_image_description_get_layout(const ScImageDescription *description)
Get the image layout.
SC_IMAGE_LAYOUT_YPCBCR_8U
YpCbCr 4:2:0 image format.
Definition: ScImageDescription.h:59
ScConfig.h
Common definitions used throughout the ScanditSDK API.
SC_IMAGE_LAYOUT_YPCRCB_8U
YpCrCb 4:2:0 image format.
Definition: ScImageDescription.h:69
ScImageDescription::sc_image_description_get_height
uint32_t sc_image_description_get_height(const ScImageDescription *description)
Get height of image.
ScImageDescription::sc_image_description_set_memory_size
void sc_image_description_set_memory_size(ScImageDescription *description, uint32_t memory_size)
Set the total memory size of the frame data.
ScImageDescription::sc_image_description_retain
void sc_image_description_retain(ScImageDescription *description)
Increase reference count of image description by one.
SC_IMAGE_LAYOUT_I420_8U
I420 format with separate Y, U and V planes.
Definition: ScImageDescription.h:102
ScImageDescription::sc_image_description_release
void sc_image_description_release(ScImageDescription *description)
Decrease reference count of image description by one.
SC_IMAGE_LAYOUT_YUYV_8U
8-bit YUYV 4:2:2 image format.
Definition: ScImageDescription.h:80
ScImageDescription::sc_image_description_set_layout
void sc_image_description_set_layout(ScImageDescription *description, ScImageLayout layout)
Set the image layout.
ScImageDescription::sc_image_description_set_second_plane_offset
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
ScImageDescription * sc_image_description_new()
Create a new image description.
ScImageDescription::sc_image_description_get_second_plane_row_bytes
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.
Copyright (C) 2017 Scandit AG