C Language Compatible Types

C-compatible types for interoperability with C codebases. More...

Classes
struct	peak_common_interval
	Represents an integer interval with inclusive minimum and maximum bounds. More...
struct	peak_common_interval_u
	Represents an unsigned integer interval with inclusive minimum and maximum bounds. More...
struct	peak_common_interval_f
	Represents a floating-point interval with inclusive minimum and maximum bounds. More...
struct	peak_common_size
	Represents a 2D size with unsigned integer dimensions. More...
struct	peak_common_size_f
	Represents a 2D size with floating-point dimensions. More...
struct	peak_common_point
	Represents a 2D point with signed integer coordinates. More...
struct	peak_common_point_u
	Represents a 2D point with unsigned integer coordinates. More...
struct	peak_common_point_f
	Represents a 2D point with floating-point coordinates. More...
struct	peak_common_rectangle
	Represents a rectangle defined by a position and unsigned integer size. More...
struct	peak_common_rectangle_u
	Represents a rectangle defined by an unsigned integer position and unsigned integer size. More...
struct	peak_common_rectangle_f
	Represents a rectangle defined by a floating-point position and size. More...
struct	peak_common_version
	Represents a version number. More...

Typedefs
typedef peak_common_point_f	peak_common_vector
	Represents a 2D vector using floating-point precision.

Enumerations
enum	peak_common_pixel_format {   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8 = 0x01080008 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10 = 0x0110000C ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12 = 0x01100010 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8 = 0x01080009 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10 = 0x0110000D ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12 = 0x01100011 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8 = 0x0108000A ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10 = 0x0110000E ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12 = 0x01100012 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8 = 0x0108000B ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10 = 0x0110000F ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12 = 0x01100013 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_8 = 0x01080001 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_10 = 0x01100003 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_12 = 0x01100005 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_16 = 0x01100007 ,   PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8 = 0x010800C6 ,   PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16 = 0x011000C7 ,   PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8 = 0x010800B1 ,   PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16 = 0x011000B8 ,   PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F = 0x012000BF ,   PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F = 0x026000C0 ,   PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS = 0x420C0001 ,   PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS = 0x420C0002 ,   PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY = 0x0210001F ,   PEAK_COMMON_PIXEL_FORMAT_RGB_8 = 0x02180014 ,   PEAK_COMMON_PIXEL_FORMAT_RGB_10 = 0x02300018 ,   PEAK_COMMON_PIXEL_FORMAT_RGB_12 = 0x0230001A ,   PEAK_COMMON_PIXEL_FORMAT_BGR_8 = 0x02180015 ,   PEAK_COMMON_PIXEL_FORMAT_BGR_10 = 0x02300019 ,   PEAK_COMMON_PIXEL_FORMAT_BGR_12 = 0x0230001B ,   PEAK_COMMON_PIXEL_FORMAT_RGBA_8 = 0x02200016 ,   PEAK_COMMON_PIXEL_FORMAT_RGBA_10 = 0x0240005F ,   PEAK_COMMON_PIXEL_FORMAT_RGBA_12 = 0x02400061 ,   PEAK_COMMON_PIXEL_FORMAT_BGRA_8 = 0x02200017 ,   PEAK_COMMON_PIXEL_FORMAT_BGRA_10 = 0x0240004C ,   PEAK_COMMON_PIXEL_FORMAT_BGRA_12 = 0x0240004E ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED = 0x010A0052 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED = 0x010C0053 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED = 0x010A0054 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED = 0x010C0055 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED = 0x010A0056 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED = 0x010C0057 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED = 0x010A0058 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED = 0x010C0059 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED = 0x010A0046 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED = 0x010C0047 ,   PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32 = 0x0220001D ,   PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32 = 0x0220001E ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS = 0x40000001 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS = 0x40000002 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS = 0x40000003 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS = 0x40000004 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS = 0x40000011 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS = 0x40000012 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS = 0x40000013 ,   PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS = 0x40000014 ,   PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS = 0x4000000f ,   PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS = 0x4000001f }
	Enum listing all supported pixel formats and their internal IDs. More...

Detailed Description

C-compatible types for interoperability with C codebases.

This group contains a selection of type definitions and structures designed for use in pure C environments. While the majority of the library is written in C++ and leverages modern C++ features, these types provide limited interoperability for scenarios where integration with C code is required.

Only a subset of types are exposed in this group, focused on facilitating basic data exchange and interoperability. Full functionality of the library is not available in C.

Since

ids_peak_common 1.0

Typedef Documentation

peak_common_vector

typedef peak_common_point_f peak_common_vector

Represents a 2D vector using floating-point precision.

Since

ids_peak_common 1.0

Enumeration Type Documentation

peak_common_pixel_format

enum peak_common_pixel_format

Enum listing all supported pixel formats and their internal IDs.

Each enumerator represents a specific pixel layout and bit depth, used for interpreting raw image data correctly.

Since

ids_peak_common 1.0

Enumerator
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12
PEAK_COMMON_PIXEL_FORMAT_MONO_8
PEAK_COMMON_PIXEL_FORMAT_MONO_10
PEAK_COMMON_PIXEL_FORMAT_MONO_12
PEAK_COMMON_PIXEL_FORMAT_MONO_16
PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8
PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16
PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8
PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16
PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F
PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F
PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS
PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS
PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY
PEAK_COMMON_PIXEL_FORMAT_RGB_8
PEAK_COMMON_PIXEL_FORMAT_RGB_10
PEAK_COMMON_PIXEL_FORMAT_RGB_12
PEAK_COMMON_PIXEL_FORMAT_BGR_8
PEAK_COMMON_PIXEL_FORMAT_BGR_10
PEAK_COMMON_PIXEL_FORMAT_BGR_12
PEAK_COMMON_PIXEL_FORMAT_RGBA_8
PEAK_COMMON_PIXEL_FORMAT_RGBA_10
PEAK_COMMON_PIXEL_FORMAT_RGBA_12
PEAK_COMMON_PIXEL_FORMAT_BGRA_8
PEAK_COMMON_PIXEL_FORMAT_BGRA_10
PEAK_COMMON_PIXEL_FORMAT_BGRA_12
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED
PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED
PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED
PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32
PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.
PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS	Attention This pixel format is preliminary, and its name and value may change in a future product version.