peak_common_pixel_format.hpp File Reference

Enum holding the possible pixel format names. More...

#include <peak_common/exceptions/peak_common_exceptions.hpp>
#include <peak_common/types/geometry/peak_common_size.hpp>
#include <peak_common/types/peak_common_channel.hpp>
#include <peak_common_c/detail/peak_common_defines.h>
#include <peak_common_c/types/peak_common_pixel_format.h>
#include <unordered_map>
#include <algorithm>
#include <array>
#include <cstdint>
#include <ostream>
#include <string>
#include <vector>
#include <peak_common/types/detail/peak_common_pixel_format.ipp>

Go to the source code of this file.

Classes
class	peak::common::PixelFormatInfo
	Provides information and utility functions for pixel formats. More...

Namespaces
namespace	peak
	The "peak" namespace directly contains convenience functionality like the DeviceManager as well as the global Library::Initialize() / Library::Close() functions, which must be called before/after usage of the library.
namespace	peak::common
	Root namespace for common types and interfaces shared across multiple libraries.
namespace	peak::common::detail
	Namespace for internal implementation details and low-level types.

Enumerations
enum class	peak::common::PixelFormat : uint64_t {   peak::common::PixelFormat::BayerGR8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8 ,   peak::common::PixelFormat::BayerGR10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10 ,   peak::common::PixelFormat::BayerGR12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12 ,   peak::common::PixelFormat::BayerRG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8 ,   peak::common::PixelFormat::BayerRG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10 ,   peak::common::PixelFormat::BayerRG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12 ,   peak::common::PixelFormat::BayerGB8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8 ,   peak::common::PixelFormat::BayerGB10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10 ,   peak::common::PixelFormat::BayerGB12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12 ,   peak::common::PixelFormat::BayerBG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8 ,   peak::common::PixelFormat::BayerBG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10 ,   peak::common::PixelFormat::BayerBG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12 ,   peak::common::PixelFormat::Mono8 = PEAK_COMMON_PIXEL_FORMAT_MONO_8 ,   peak::common::PixelFormat::Mono10 = PEAK_COMMON_PIXEL_FORMAT_MONO_10 ,   peak::common::PixelFormat::Mono12 = PEAK_COMMON_PIXEL_FORMAT_MONO_12 ,   peak::common::PixelFormat::Mono16 = PEAK_COMMON_PIXEL_FORMAT_MONO_16 ,   peak::common::PixelFormat::Confidence8 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8 ,   peak::common::PixelFormat::Confidence16 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16 ,   peak::common::PixelFormat::Coord3D_C8 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8 ,   peak::common::PixelFormat::Coord3D_C16 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16 ,   peak::common::PixelFormat::Coord3D_C32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F ,   peak::common::PixelFormat::Coord3D_ABC32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F ,   peak::common::PixelFormat::YUV420_8_YY_UV_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS ,   peak::common::PixelFormat::YUV420_8_YY_VU_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS ,   peak::common::PixelFormat::YUV422_8_UYVY = PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY ,   peak::common::PixelFormat::RGB8 = PEAK_COMMON_PIXEL_FORMAT_RGB_8 ,   peak::common::PixelFormat::RGB10 = PEAK_COMMON_PIXEL_FORMAT_RGB_10 ,   peak::common::PixelFormat::RGB12 = PEAK_COMMON_PIXEL_FORMAT_RGB_12 ,   peak::common::PixelFormat::BGR8 = PEAK_COMMON_PIXEL_FORMAT_BGR_8 ,   peak::common::PixelFormat::BGR10 = PEAK_COMMON_PIXEL_FORMAT_BGR_10 ,   peak::common::PixelFormat::BGR12 = PEAK_COMMON_PIXEL_FORMAT_BGR_12 ,   peak::common::PixelFormat::RGBa8 = PEAK_COMMON_PIXEL_FORMAT_RGBA_8 ,   peak::common::PixelFormat::RGBa10 = PEAK_COMMON_PIXEL_FORMAT_RGBA_10 ,   peak::common::PixelFormat::RGBa12 = PEAK_COMMON_PIXEL_FORMAT_RGBA_12 ,   peak::common::PixelFormat::BGRa8 = PEAK_COMMON_PIXEL_FORMAT_BGRA_8 ,   peak::common::PixelFormat::BGRa10 = PEAK_COMMON_PIXEL_FORMAT_BGRA_10 ,   peak::common::PixelFormat::BGRa12 = PEAK_COMMON_PIXEL_FORMAT_BGRA_12 ,   peak::common::PixelFormat::BayerBG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED ,   peak::common::PixelFormat::BayerBG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED ,   peak::common::PixelFormat::BayerGB10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED ,   peak::common::PixelFormat::BayerGB12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED ,   peak::common::PixelFormat::BayerGR10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED ,   peak::common::PixelFormat::BayerGR12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED ,   peak::common::PixelFormat::BayerRG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED ,   peak::common::PixelFormat::BayerRG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED ,   peak::common::PixelFormat::Mono10p = PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED ,   peak::common::PixelFormat::Mono12p = PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED ,   peak::common::PixelFormat::RGB10p32 = PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32 ,   peak::common::PixelFormat::BGR10p32 = PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32 ,   peak::common::PixelFormat::BayerRG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerGB10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerGR10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerBG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerRG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerGB12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerGR12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerBG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS ,   peak::common::PixelFormat::Mono10g40IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS ,   peak::common::PixelFormat::Mono12g24IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS ,   peak::common::PixelFormat::Mono32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_32F_IDS) ,   peak::common::PixelFormat::RGB32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_RGB_32F_IDS) ,   peak::common::PixelFormat::Mono10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono8_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10g40IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12g24IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_AB) ,   peak::common::PixelFormat::BayerRG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_AB) ,   peak::common::PixelFormat::BayerBG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_AB) ,   peak::common::PixelFormat::BayerGR10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_AB) ,   peak::common::PixelFormat::BayerGB10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_AB) ,   peak::common::PixelFormat::Mono12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_AB) ,   peak::common::PixelFormat::BayerRG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_AB) ,   peak::common::PixelFormat::BayerBG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_AB) ,   peak::common::PixelFormat::BayerGR12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_AB) ,   peak::common::PixelFormat::BayerGB12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_AB) ,   peak::common::PixelFormat::Mono8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_AB) ,   peak::common::PixelFormat::BayerRG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_AB) ,   peak::common::PixelFormat::BayerBG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_AB) ,   peak::common::PixelFormat::BayerGR8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_AB) ,   peak::common::PixelFormat::BayerGB8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_AB) ,   peak::common::PixelFormat::Mono8_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_ABCD) ,   peak::common::PixelFormat::Mono10_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_ABCD) ,   peak::common::PixelFormat::Mono12_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_ABCD) }
	Enum listing all supported pixel formats and their internal IDs. More...

Functions
constexpr uint64_t	peak::common::detail::CPixelFormatCast (peak_common_pixel_format pixelFormat) noexcept
constexpr PixelFormat	peak::common::detail::CPixelFormatToCppPixelFormat (peak_common_pixel_format pixelFormat) noexcept
constexpr peak_common_pixel_format	peak::common::detail::CppPixelFormatToCPixelFormat (PixelFormat pixelFormat) noexcept

Detailed Description

Enum holding the possible pixel format names.

Author

IDS Imaging Development Systems GmbH

Date

2025-05-09

Since

ids_peak_common 1.0

Copyright (c) 2025 - 2026, IDS Imaging Development Systems GmbH. All rights reserved.