peak_ipl_backend.h File Reference

#include <peak_ipl/backend/peak_ipl_dll_defines.h>
#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Classes
struct	PEAK_IPL_POINT_2D
struct	PEAK_IPL_SIZE_2D
struct	PEAK_IPL_RECT_2D
struct	PEAK_IPL_SHARPNESS_ROI

Macros
#define	PEAK_IPL_C_API   PEAK_IPL_PUBLIC PEAK_IPL_RETURN_CODE PEAK_IPL_CALL_CONV

Typedefs
typedef int8_t	PEAK_IPL_BOOL8
typedef int32_t	PEAK_IPL_RETURN_CODE
typedef int32_t	PEAK_IPL_CONVERSION_MODE
typedef int32_t	PEAK_IPL_PIXEL_FORMAT
typedef int32_t	PEAK_IPL_ENDIANNESS
typedef int32_t	PEAK_IPL_ORIENTATION
typedef int32_t	PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY
typedef uint16_t	PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE
typedef uint16_t	PEAK_IPL_BINNINGMODE
typedef uint16_t	PEAK_IPL_VIDEO_CONTAINER
typedef uint16_t	PEAK_IPL_VIDEO_ENCODER
typedef uint16_t	PEAK_IPL_VIDEO_ENCODER_OPTION
typedef uint16_t	PEAK_IPL_VIDEO_CONTAINER_OPTION
typedef uint16_t	PEAK_IPL_SHARPNESS_ALGORITHM
typedef uint16_t	PEAK_IPL_SHARPNESS_ROI_WEIGHT
typedef struct PEAK_IPL_IMAGE_CONVERTER *	PEAK_IPL_IMAGE_CONVERTER_HANDLE
typedef struct PEAK_IPL_IMAGE_transformer *	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE
typedef struct PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR *	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE
typedef struct PEAK_IPL_BINNING *	PEAK_IPL_BINNING_HANDLE
typedef struct PEAK_IPL_DECIMATION *	PEAK_IPL_DECIMATION_HANDLE
typedef struct PEAK_IPL_COLOR_CORRECTOR *	PEAK_IPL_COLOR_CORRECTOR_HANDLE
typedef struct PEAK_IPL_GAIN *	PEAK_IPL_GAIN_HANDLE
typedef struct PEAK_IPL_GAMMA_CORRECTOR *	PEAK_IPL_GAMMA_CORRECTOR_HANDLE
typedef struct PEAK_IPL_IMAGE *	PEAK_IPL_IMAGE_HANDLE
typedef struct PEAK_IPL_HISTOGRAM *	PEAK_IPL_HISTOGRAM_HANDLE
typedef struct PEAK_IPL_PIXEL_LINE *	PEAK_IPL_PIXEL_LINE_HANDLE
typedef struct PEAK_IPL_VIDEO *	PEAK_IPL_VIDEO_HANDLE
typedef struct PEAK_IPL_SHARPNESS *	PEAK_IPL_SHARPNESS_HANDLE

Enumerations
enum	PEAK_IPL_RETURN_CODE_t {   PEAK_IPL_RETURN_CODE_SUCCESS = 0,   PEAK_IPL_RETURN_CODE_ERROR = 1,   PEAK_IPL_RETURN_CODE_INVALID_HANDLE = 2,   PEAK_IPL_RETURN_CODE_IO_ERROR = 3,   PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL = 4,   PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT = 5,   PEAK_IPL_RETURN_CODE_OUT_OF_RANGE = 6,   PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED = 7,   PEAK_IPL_RETURN_CODE_FORMAT_INTERPRETATION_ERROR = 8,   limgTypeRETURN_CODE_NOT_SUPPORTED = 9,   limgTypeRETURN_CODE_NOT_PERMITTED = 10,   limgTypeRETURN_CODE_BUSY = 11,   limgTypeRETURN_CODE_TIMEOUT = 12 }
enum	PEAK_IPL_CONVERSION_MODE_t {   PEAK_IPL_CONVERSION_MODE_FAST = 1,   PEAK_IPL_CONVERSION_MODE_HIGH_QUALITY = 2,   PEAK_IPL_CONVERSION_MODE_CLASSIC = 3 }
enum	PEAK_IPL_PIXEL_FORMAT_t {   PEAK_IPL_PIXEL_FORMAT_INVALID = 0,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_8 = 0x01080008,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10 = 0x0110000C,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12 = 0x01100010,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_8 = 0x01080009,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10 = 0x0110000D,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12 = 0x01100011,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_8 = 0x0108000A,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10 = 0x0110000E,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12 = 0x01100012,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_8 = 0x0108000B,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10 = 0x0110000F,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12 = 0x01100013,   PEAK_IPL_PIXEL_FORMAT_MONO_8 = 0x01080001,   PEAK_IPL_PIXEL_FORMAT_MONO_10 = 0x01100003,   PEAK_IPL_PIXEL_FORMAT_MONO_12 = 0x01100005,   PEAK_IPL_PIXEL_FORMAT_RGB_8 = 0x02180014,   PEAK_IPL_PIXEL_FORMAT_RGB_10 = 0x02300018,   PEAK_IPL_PIXEL_FORMAT_RGB_12 = 0x0230001A,   PEAK_IPL_PIXEL_FORMAT_BGR_8 = 0x02180015,   PEAK_IPL_PIXEL_FORMAT_BGR_10 = 0x02300019,   PEAK_IPL_PIXEL_FORMAT_BGR_12 = 0x0230001B,   PEAK_IPL_PIXEL_FORMAT_RGBA_8 = 0x02200016,   PEAK_IPL_PIXEL_FORMAT_RGBA_10 = 0x0240005F,   PEAK_IPL_PIXEL_FORMAT_RGBA_12 = 0x02400061,   PEAK_IPL_PIXEL_FORMAT_BGRA_8 = 0x02200017,   PEAK_IPL_PIXEL_FORMAT_BGRA_10 = 0x0240004C,   PEAK_IPL_PIXEL_FORMAT_BGRA_12 = 0x0240004E,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10_PACKED = 0x010A0052,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12_PACKED = 0x010C0053,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10_PACKED = 0x010A0054,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12_PACKED = 0x010C0055,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10_PACKED = 0x010A0056,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12_PACKED = 0x010C0057,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10_PACKED = 0x010A0058,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12_PACKED = 0x010C0059,   PEAK_IPL_PIXEL_FORMAT_MONO_10_PACKED = 0x010A0046,   PEAK_IPL_PIXEL_FORMAT_MONO_12_PACKED = 0x010C0047,   PEAK_IPL_PIXEL_FORMAT_RGB_10_PACKED_32 = 0x0220001D,   PEAK_IPL_PIXEL_FORMAT_BGR_10_PACKED_32 = 0x0220001E,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS = 0x40000001,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS = 0x40000002,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS = 0x40000003,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS = 0x40000004,   PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS = 0x40000011,   PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS = 0x40000012,   PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS = 0x40000013,   PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS = 0x40000014,   PEAK_IPL_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS = 0x4000000f,   PEAK_IPL_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS = 0x4000001f }
enum	PEAK_IPL_ENDIANNESS_t {   PEAK_IPL_ENDIANNESS_UNKNOWN,   PEAK_IPL_ENDIANNESS_LITTLE_ENDIAN,   PEAK_IPL_ENDIANNESS_BIG_ENDIAN }
enum	PEAK_IPL_ORIENTATION_t {   PEAK_IPL_ORIENTATION_HORIZONTAL,   PEAK_IPL_ORIENTATION_VERTICAL }
enum	PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_t {   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_INVALID,   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL1,   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL2,   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL3,   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL4,   PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL5 }
enum	PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t {   LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_90_COUNTERCLOCKWISE = 90,   LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_90_CLOCKWISE = 270,   LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_180 = 180 }
enum	PEAK_IPL_BINNINGMODE_t {   Average = 0,   Sum = 1 }
enum	PEAK_IPL_VIDEO_CONTAINER_t { PEAK_IPL_VIDEO_CONTAINER_AVI = 0 }
enum	PEAK_IPL_VIDEO_ENCODER_t {   PEAK_IPL_VIDEO_ENCODER_RAW = 0,   PEAK_IPL_VIDEO_ENCODER_MJPEG = 1 }
enum	PEAK_IPL_VIDEO_ENCODER_OPTION_t { PEAK_IPL_VIDEO_ENCODER_OPTION_QUALITY = 0 }
enum	PEAK_IPL_VIDEO_CONTAINER_OPTION_t { PEAK_IPL_VIDEO_CONTAINER_OPTION_FRAMERATE = 0 }
enum	PEAK_IPL_SHARPNESS_ALGORITHM_t {   PEAK_IPL_SHARPNESS_ALGORITHM_TENENGRAD,   PEAK_IPL_SHARPNESS_ALGORITHM_MEAN_SCORE,   PEAK_IPL_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE,   PEAK_IPL_SHARPNESS_ALGORITHM_SOBEL }
enum	PEAK_IPL_SHARPNESS_ROI_WEIGHT_t {   PEAK_IPL_SHARPNESS_ROI_WEIGHT_WEAK = 0x0021,   PEAK_IPL_SHARPNESS_ROI_WEIGHT_MEDIUM = 0x0042,   PEAK_IPL_SHARPNESS_ROI_WEIGHT_STRONG = 0x0063 }

Functions
PEAK_IPL_C_API	PEAK_IPL_Library_GetVersionMajor (uint32_t *libraryVersionMajor)
	Queries the library major version. More...
PEAK_IPL_C_API	PEAK_IPL_Library_GetVersionMinor (uint32_t *libraryVersionMinor)
	Queries the library minor version. More...
PEAK_IPL_C_API	PEAK_IPL_Library_GetVersionSubminor (uint32_t *libraryVersionSubminor)
	Queries the library subminor version. More...
PEAK_IPL_C_API	PEAK_IPL_Library_GetMaxConcurrentThreads (size_t *concurrentThreads)
	Queries the maximum number of concurrent threads used by the library. More...
PEAK_IPL_C_API	PEAK_IPL_Library_SetMaxConcurrentThreads (size_t concurrentThreads)
	Sets the maximum number of concurrent threads used by the library. More...
PEAK_IPL_C_API	PEAK_IPL_Library_GetMultiThreadingEnabled (PEAK_IPL_BOOL8 *enabled)
	Disables / Enables multithreading in the library. More...
PEAK_IPL_C_API	PEAK_IPL_Library_SetMultiThreadingEnabled (PEAK_IPL_BOOL8 enabled)
	Disables / Enables multithreading in the library. More...
PEAK_IPL_C_API	PEAK_IPL_Library_GetLastError (PEAK_IPL_RETURN_CODE *lastErrorCode, char *lastErrorDescription, size_t *lastErrorDescriptionSize)
	Queries the last error. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_Construct (PEAK_IPL_IMAGE_CONVERTER_HANDLE *imageConverterHandle)
	Creates an image converter. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_PreAllocateConversion (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_PIXEL_FORMAT inputPixelFormat, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, size_t width, size_t height, size_t imageCount)
	Pre-allocates internal buffer pools for the specified conversion. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_GetConversionMode (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_CONVERSION_MODE *conversionMode)
	Queries the given image converter's current conversion mode. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_SetConversionMode (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_CONVERSION_MODE conversionMode)
	Sets the given image converter's conversion mode. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_GetSupportedOutputPixelFormats (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_PIXEL_FORMAT inputPixelFormat, PEAK_IPL_PIXEL_FORMAT *outputPixelFormats, size_t *outputPixelFormatsSize)
	Queries the supported output pixel formats for a given input pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_Convert (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the input image converted to the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_ConvertToBuffer (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, uint8_t *outputImageBuffer, size_t outputImageBufferSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the input image converted to the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_ImageConverter_Destruct (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle)
	Destroys the image converter associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_Construct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE *adaptiveHotpixelCorrectorHandle)
	Creates an adaptive hotpixel corrector algorithm. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_SetSensitivity (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY sensitivityLevel)
	Sets the given adaptive hotpixel corrector algorithm's sensitivity. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_GetSensitivity (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY *sensitivityLevel)
	Queries the given adaptive hotpixel corrector algorithm's current sensitivity. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_SetGainFactorPercent (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, uint32_t gainFactorPercent)
	Sets the given adaptive hotpixel corrector algorithm's gain factor in percent. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_GetGainFactorPercent (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, uint32_t *gainFactorPercent)
	Queries the given adaptive hotpixel corrector algorithm's current gain factor in percent. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_Detect (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle)
	Detects hotpixels in the given image. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_GetHotpixels (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_POINT_2D *hotpixels, size_t *hotpixelsSize)
	Queries previously detected hotpixels. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_Correct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, const PEAK_IPL_POINT_2D *hotpixels, size_t hotpixelsSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Corrects the given hotpixels in the given image. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_CorrectAdaptive (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Detects and corrects hotpixels in the given image. More...
PEAK_IPL_C_API	PEAK_IPL_AdaptiveHotpixelCorrector_Destruct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle)
	Destroys the adaptive hotpixel corrector algorithm associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_Construct (PEAK_IPL_COLOR_CORRECTOR_HANDLE *colorCorrectorHandle)
	Creates a color corrector. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_SetColorCorrectionFactors (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *colorCorrectorFactors)
	Sets the factors of the color correction matrix. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_GetColorCorrectionFactors (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *colorCorrectorFactors, size_t *colorCorrectorFactorsSize)
	Returns the color corrector 3x3 matrix factors and its size. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_GetIsPixelFormatSupported (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given color corrector whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_Process (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Corrects the colors of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_ProcessInPlace (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Corrects the colors of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_Destruct (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle)
	Destroys the color corrector associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_GetSaturation (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *saturation)
	Returns the color saturation value. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_GetSaturationMin (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *saturationMin)
	Returns the minimum color saturation value. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_GetSaturationMax (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *saturationMax)
	Returns the maximum color saturation value. More...
PEAK_IPL_C_API	PEAK_IPL_ColorCorrector_SetSaturation (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float saturation)
	Sets the color saturation value. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_Construct (PEAK_IPL_BINNING_HANDLE *binningHandle)
	Creates a binning. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_SetBinningX (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningXValue)
	Sets the value of binning in horizontal direction. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_GetBinningX (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningXValue)
	Returns the value of binning in horizontal direction. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_SetBinningY (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningYValue)
	Sets the value of binning in vertical direction. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_GetBinningY (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningYValue)
	Returns the value of binning in vertical direction. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_GetBinningMin (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningMin)
	Returns the minimum binning value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_GetBinningMax (PEAK_IPL_BINNING_HANDLE binningHandle, uint8_t *binningMax)
	Returns the maximum binning value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_ExpectedOutputSize (PEAK_IPL_BINNING_HANDLE binningHandle, size_t *outputWidth, size_t *outputHeight, size_t inputWidth, size_t inputHeight, PEAK_IPL_PIXEL_FORMAT pixelFormat)
	Returns the size of a binned image given the input size and pixelformat. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_IsPixelformatSupported (PEAK_IPL_BINNING_HANDLE binningHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given binning whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_SetBinningMode (PEAK_IPL_BINNING_HANDLE binningHandle, PEAK_IPL_BINNINGMODE *mode)
	Sets the value of binning mode. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_GetBinningMode (PEAK_IPL_BINNING_HANDLE binningHandle, PEAK_IPL_BINNINGMODE *mode)
	Returns the value of binning mode. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_Process (PEAK_IPL_BINNING_HANDLE binningHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Apply the binning on the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Binning_Destruct (PEAK_IPL_BINNING_HANDLE binningHandle)
	Destroys the binning associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_Construct (PEAK_IPL_DECIMATION_HANDLE *decimationHandle)
	Creates a decimation. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_SetDecimationX (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationXValue)
	Sets the value of decimation in horizontal direction. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_GetDecimationX (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationXValue)
	Returns the value of decimation in horizontal direction. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_SetDecimationY (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationYValue)
	Sets the value of decimation in vertical direction. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_GetDecimationY (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationYValue)
	Returns the value of decimation in vertical direction. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_GetDecimationMin (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationMin)
	Returns the minimum decimation value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_GetDecimationMax (PEAK_IPL_DECIMATION_HANDLE decimationHandle, uint8_t *decimationMax)
	Returns the maximum decimation value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_ExpectedOutputSize (PEAK_IPL_DECIMATION_HANDLE decimationHandle, size_t *outputWidth, size_t *outputHeight, size_t inputWidth, size_t inputHeight, PEAK_IPL_PIXEL_FORMAT pixelFormat)
	Returns the size of a binned image given the input size and pixelformat. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_IsPixelformatSupported (PEAK_IPL_DECIMATION_HANDLE decimationHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given decimation whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_Process (PEAK_IPL_DECIMATION_HANDLE decimationHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Apply the decimation on the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Decimation_Destruct (PEAK_IPL_DECIMATION_HANDLE decimationHandle)
	Destroys the decimation associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_Construct (PEAK_IPL_GAIN_HANDLE *gainHandle)
	Creates a gain. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_SetMasterGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainValue)
	Sets the value of the master gain. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetMasterGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainValue)
	Returns the master gain value. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetMasterGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainMax)
	Returns the maximum master gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetMasterGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainMin)
	Returns the minimum master gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_SetRedGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainValue)
	Sets the value of the red gain. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetRedGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainValue)
	Returns the red gain value. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetRedGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainMax)
	Returns the maximum red gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetRedGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainMin)
	Returns the minimum red gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_SetGreenGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainValue)
	Sets the value of the green gain. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetGreenGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainValue)
	Returns the green gain value. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetGreenGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainMax)
	Returns the maximum green gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetGreenGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainMin)
	Returns the minimum green gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_SetBlueGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainValue)
	Sets the value of the blue gain. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetBlueGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainValue)
	Returns the blue gain value. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetBlueGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainMax)
	Returns the maximum blue gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetBlueGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainMin)
	Returns the minimum blue gain value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_GetIsPixelFormatSupported (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given gamma corrector whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_Process (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Apply the gain on the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_ProcessInPlace (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Apply the gain on the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Gain_Destruct (PEAK_IPL_GAIN_HANDLE gainHandle)
	Destroys the gain associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_Construct (PEAK_IPL_GAMMA_CORRECTOR_HANDLE *gammaCorrectorHandle)
	Creates a gamma corrector. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_SetGammaCorrectionValue (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue)
	Sets the value of the gamma correction. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_GetGammaCorrectionValue (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue)
	Returns the gamma corrector value. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_GetGammaCorrectionMax (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMax)
	Returns the maximum gamma corrector value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_GetGammaCorrectionMin (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMin)
	Returns the minimum gamma corrector value which can be set. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given gamma corrector whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_Process (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Corrects the gammas of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_ProcessInPlace (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Corrects the gammas of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_GammaCorrector_Destruct (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle)
	Destroys the gamma corrector associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_Image_Construct (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t width, size_t height, PEAK_IPL_IMAGE_HANDLE *imageHandle)
	Creates an image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_ConstructFromBuffer (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint8_t *buffer, uint64_t bufferSize, size_t width, size_t height, PEAK_IPL_IMAGE_HANDLE *imageHandle)
	Creates an image from a given buffer. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetWidth (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *width)
	Queries the width of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetHeight (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *height)
	Queries the height of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetPixelPointer (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t xPos, size_t yPos, uint8_t **pixelPointer)
	Queries the pointer to the given pixel position. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetByteCount (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *byteCount)
	Queries the size of the given image in number of bytes. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetPixelFormat (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat)
	Queries the pixel format of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetData (PEAK_IPL_IMAGE_HANDLE imageHandle, uint8_t **data)
	Queries the data pointer of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_Clone (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Returns a new created image containing the data of the current image as deep copy. More...
PEAK_IPL_C_API	PEAK_IPL_Image_ConvertTo (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, PEAK_IPL_CONVERSION_MODE conversionMode, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the current image converted to the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_Image_ConvertToBuffer (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, uint8_t *outputImageBuffer, size_t outputImageBufferSize, PEAK_IPL_CONVERSION_MODE conversionMode, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Stores the data of the current image converted to the given pixel format into a destination buffer and creates a new image. More...
PEAK_IPL_C_API	PEAK_IPL_Image_Destruct (PEAK_IPL_IMAGE_HANDLE imageHandle)
	Destroys the image associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_Construct (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE *imageTransformerHandle)
	Creates an image transformer. More...
PEAK_IPL_C_API	PEAK_IPL_Image_SetTimestamp (PEAK_IPL_IMAGE_HANDLE imageHandle, uint64_t timestamp_ns)
	Set the timestamp for an image in nanoseconds. More...
PEAK_IPL_C_API	PEAK_IPL_Image_GetTimestamp (PEAK_IPL_IMAGE_HANDLE imageHandle, uint64_t *timestamp_ns)
	Get the timestamp for an image in nanoseconds. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorUpDown (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the current image mirrored in up-down direction. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorLeftRight (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the current image mirrored in left-right direction. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorUpDownLeftRight (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Creates a new image containing the data of the current image mirrored in up-down and left-right direction. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorUpDownInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Mirrors the image in up-down direction in place i.e. it will change the input image itself. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorLeftRightInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Mirrors the image left-right direction in place i.e. it will change the input image itself. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_MirrorUpDownLeftRightInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Mirrors the image in up-down and left-right direction in place i.e. it will change the input image itself. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_Rotate (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle, PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t rotationAngle)
	Creates a new image containing the data of the current image rotated in direction and value of the rotation angle. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_RotateInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t rotationAngle)
	Rotates the image in in direction and value of the rotation angle in place i.e. it will change the input image itself. More...
PEAK_IPL_C_API	PEAK_IPL_ImageTransformer_Destruct (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle)
	Destroys the image transformer associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_Construct (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_HISTOGRAM_HANDLE *histogramHandle)
	Creates a histogram from image data. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_GetPixelFormat (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat)
	Queries the pixel format of the given histogram. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_GetNumChannels (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t *numChannels)
	Queries the number of the given histogram's channels. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_GetPixelSumForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *pixelSum)
	Queries the pixel sum for the channel with the given index. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_GetPixelCountForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *pixelCount)
	Queries the pixel count for the channel with the given index. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_GetBinsForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *bins, size_t *binsSize)
	Queries the bin list of the channel with the given index. More...
PEAK_IPL_C_API	PEAK_IPL_Histogram_Destruct (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle)
	Destroys the histogram associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_Construct (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_ORIENTATION orientation, size_t offset, PEAK_IPL_PIXEL_LINE_HANDLE *pixelLineHandle)
	Creates a pixel line depending on the given orientation. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_GetPixelFormat (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat)
	Queries the pixel format of the given pixel line. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_GetOrientation (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, PEAK_IPL_ORIENTATION *orientation)
	Queries the orientation of the given pixel line. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_GetOffset (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t *offset)
	Queries the offset of the given pixel line. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_GetNumChannels (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t *numChannels)
	Queries the number of the given pixel line's channels. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_GetValuesForChannel (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t channelIndex, uint32_t *values, size_t *valuesSize)
	Queries the value list for the channel with the given index. More...
PEAK_IPL_C_API	PEAK_IPL_PixelLine_Destruct (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle)
	Destroys the pixel line associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetNumChannels (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numChannels)
	Queries the number of channels of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetNumSignificantBitsPerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numSignificantBits)
	Queries the number of significant bits per pixel per channel of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetNumStorageBitsPerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numStorageBits)
	Queries the number of storage bits per pixel per channel of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetMaximumValuePerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint32_t *channelMaximumValue)
	Queries the maximum value of one pixel channel of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetNumSignificantBitsPerPixel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numSignificantBits)
	Queries the number of significant bits per pixel of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetNumStorageBitsPerPixel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numStorageBits)
	Queries the number of storage bits per pixel of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_GetEndianness (PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_ENDIANNESS *endianness)
	Queries the endianness of the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_PixelFormat_CalculateStorageSizeOfPixels (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint64_t numPixels, uint64_t *size)
	Calculates the storage size of the given number of pixels of the given pixel format in bytes. More...
PEAK_IPL_C_API	PEAK_IPL_ImageWriter_WriteAsRAW (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize)
	Writes an image as raw data binary file. More...
PEAK_IPL_C_API	PEAK_IPL_ImageWriter_WriteAsBMP (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize)
	Writes an image as BMP image file. More...
PEAK_IPL_C_API	PEAK_IPL_ImageWriter_WriteAsPNG (PEAK_IPL_IMAGE_HANDLE inputImageHandle, uint32_t quality, const char *filePath, size_t filePathSize)
	Writes an image as PNG image file. More...
PEAK_IPL_C_API	PEAK_IPL_ImageWriter_WriteAsJPG (PEAK_IPL_IMAGE_HANDLE inputImageHandle, uint32_t quality, const char *filePath, size_t filePathSize)
	Writes an image as JPEG image file. More...
PEAK_IPL_C_API	PEAK_IPL_ImageWriter_Write (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize)
	Writes an image to file and selects the format by file ending. In case the format has parameters, the default parameters are chosen. More...
PEAK_IPL_C_API	PEAK_IPL_ImageReader_Read (const char *filePath, size_t filePathSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Reads an image from a file. Image type is determined by the file ending. More...
PEAK_IPL_C_API	PEAK_IPL_ImageReaderRead_ReadAsPixelFormat (const char *filePath, size_t filePathSize, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
	Reads an image from a file. Image type is determined by the file ending. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_Open (PEAK_IPL_VIDEO_HANDLE *videoHandle, const char *filePath, PEAK_IPL_VIDEO_CONTAINER container, PEAK_IPL_VIDEO_ENCODER encoder)
	Open a video stream. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_IsOpen (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_BOOL8 *isOpen)
	Check if the video stream is open. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_Close (PEAK_IPL_VIDEO_HANDLE videoHandle)
	Close the video stream. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_Append (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
	Append an image to the video stream. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Encoder_SetOption (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_ENCODER_OPTION option, const void *value, size_t count)
	Sets an option on the encoder. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Encoder_GetOption (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_ENCODER_OPTION option, void *value, size_t count, size_t *outCount)
	Sets an option of the encoder. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Encoder_OptionRange (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_ENCODER_OPTION option, void *min, void *max, void *inc)
	Receive the range for an option of the encoder. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_GetSupportedEncodersForAContainer (PEAK_IPL_VIDEO_CONTAINER container, PEAK_IPL_VIDEO_ENCODER *encoders, size_t *size)
	Get the supported encoders for a container. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Container_SetOption (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_CONTAINER_OPTION option, const void *value, size_t count)
	Sets an option on the container. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Container_GetOption (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_ENCODER_OPTION option, void *value, size_t count, size_t *outCount)
	Gets an option of the container. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Container_OptionRange (PEAK_IPL_VIDEO_HANDLE videoHandle, PEAK_IPL_VIDEO_ENCODER_OPTION option, void *min, void *max, void *inc)
	Receive the range for an option of the container. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_GetSupportedContainersForAnEncoder (PEAK_IPL_VIDEO_ENCODER encoder, PEAK_IPL_VIDEO_CONTAINER *containers, size_t *size)
	Get the supported containers for an encoder. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Encoder_GetSupportedPixelFormats (PEAK_IPL_VIDEO_ENCODER encoder, PEAK_IPL_PIXEL_FORMAT *pixelFormatList, size_t *pixelFormatListSize)
	Get the supported pixelformats for an encoder. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_GetEncodedFrames (PEAK_IPL_VIDEO_HANDLE videoHandle, uint64_t *numFrames)
	Gets the number of encoded frames in the video stream. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_GetDroppedFrames (PEAK_IPL_VIDEO_HANDLE videoHandle, uint64_t *numFrames)
	Gets the number of dropped frames in the video stream. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_GetFileSize (PEAK_IPL_VIDEO_HANDLE videoHandle, uint64_t *fileSize)
	Gets the file size of the video. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_ResetFrameCounters (PEAK_IPL_VIDEO_HANDLE videoHandle)
	Reset compressed and dropped frame counters. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Queue_SetSize (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t size)
	Set the internal queue size of the video writer. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Queue_GetSize (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t *size)
	Get the internal queue size of the video writer. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Queue_GetRange (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t *minSize, int32_t *maxSize)
	Get the possible range of the internal queue size. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Queue_GetQueued (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t *queued)
	Get the count of the currently queued buffers. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_WaitUntilFrameDone (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t timeout_ms)
	Wait until frame processing is done. More...
PEAK_IPL_C_API	PEAK_IPL_VideoWriter_Video_WaitUntilQueueEmpty (PEAK_IPL_VIDEO_HANDLE videoHandle, int32_t timeout_ms)
	Wait until queue is empty. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_Construct (PEAK_IPL_SHARPNESS_HANDLE *handle)
	Creates a sharpness measurement. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_Destruct (PEAK_IPL_SHARPNESS_HANDLE handle)
	Destroys the sharpness measurement associated with the given handle. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_Measure (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_IMAGE_HANDLE imageHandle, double *calculated_value)
	Measures the relative sharpness of the given image. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_GetIsPixelFormatSupported (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
	Asks the given sharpness measurement whether it supports the given pixel format. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_GetSupportedPixelFormatList (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_PIXEL_FORMAT *pixelFormatList, size_t *pixelFormatListSize)
	Queries the supported pixel formats. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_SetAlgorithm (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_SHARPNESS_ALGORITHM algorithm)
	Sets the algorithm to use for measurement calculation. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_GetAlgorithm (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_SHARPNESS_ALGORITHM *algorithm)
	Returns the algorithm to use for measurement calculation. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_GetROIMinimumSize (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_SIZE_2D *min_size)
	Returns the minimum size of a ROI to use for measurement calculation. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_SetROIs (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_SHARPNESS_ROI *roiList, size_t roiListSize)
	Sets ROIs in which the sharpness is measured. More...
PEAK_IPL_C_API	PEAK_IPL_ImageSharpness_GetROIs (PEAK_IPL_SHARPNESS_HANDLE handle, PEAK_IPL_SHARPNESS_ROI *roiList, size_t *roiListSize)
	Returns the ROIs in which the sharpness is measured. More...

Detailed Description

Author

IDS Imaging Development Systems GmbH

Date

2019-05-01

Since

1.0

Copyright (c) 2019, IDS Imaging Development Systems GmbH. All rights reserved.

Macro Definition Documentation

PEAK_IPL_C_API

#define PEAK_IPL_C_API   PEAK_IPL_PUBLIC PEAK_IPL_RETURN_CODE PEAK_IPL_CALL_CONV

Typedef Documentation

PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE

typedef struct PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR* PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE

The type of adaptive hotpixel corrector handles.

PEAK_IPL_BINNING_HANDLE

typedef struct PEAK_IPL_BINNING* PEAK_IPL_BINNING_HANDLE

The type of binning handles.

PEAK_IPL_BINNINGMODE

typedef uint16_t PEAK_IPL_BINNINGMODE

PEAK_IPL_BOOL8

typedef int8_t PEAK_IPL_BOOL8

PEAK_IPL_COLOR_CORRECTOR_HANDLE

typedef struct PEAK_IPL_COLOR_CORRECTOR* PEAK_IPL_COLOR_CORRECTOR_HANDLE

The type of color corrector handles.

PEAK_IPL_CONVERSION_MODE

typedef int32_t PEAK_IPL_CONVERSION_MODE

PEAK_IPL_DECIMATION_HANDLE

typedef struct PEAK_IPL_DECIMATION* PEAK_IPL_DECIMATION_HANDLE

The type of decimation handles.

PEAK_IPL_ENDIANNESS

typedef int32_t PEAK_IPL_ENDIANNESS

PEAK_IPL_GAIN_HANDLE

typedef struct PEAK_IPL_GAIN* PEAK_IPL_GAIN_HANDLE

The type of gain corrector handles.

PEAK_IPL_GAMMA_CORRECTOR_HANDLE

typedef struct PEAK_IPL_GAMMA_CORRECTOR* PEAK_IPL_GAMMA_CORRECTOR_HANDLE

The type of gamma corrector handles.

PEAK_IPL_HISTOGRAM_HANDLE

typedef struct PEAK_IPL_HISTOGRAM* PEAK_IPL_HISTOGRAM_HANDLE

The type of histogram handles.

PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY

typedef int32_t PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY

PEAK_IPL_IMAGE_CONVERTER_HANDLE

typedef struct PEAK_IPL_IMAGE_CONVERTER* PEAK_IPL_IMAGE_CONVERTER_HANDLE

The type of image converter handles.

PEAK_IPL_IMAGE_HANDLE

typedef struct PEAK_IPL_IMAGE* PEAK_IPL_IMAGE_HANDLE

The type of image handles.

PEAK_IPL_IMAGE_TRANSFORMER_HANDLE

typedef struct PEAK_IPL_IMAGE_transformer* PEAK_IPL_IMAGE_TRANSFORMER_HANDLE

The type of image transformer handles.

PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE

typedef uint16_t PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE

PEAK_IPL_ORIENTATION

typedef int32_t PEAK_IPL_ORIENTATION

PEAK_IPL_PIXEL_FORMAT

typedef int32_t PEAK_IPL_PIXEL_FORMAT

PEAK_IPL_PIXEL_LINE_HANDLE

typedef struct PEAK_IPL_PIXEL_LINE* PEAK_IPL_PIXEL_LINE_HANDLE

The type of pixel line handles.

PEAK_IPL_RETURN_CODE

typedef int32_t PEAK_IPL_RETURN_CODE

PEAK_IPL_SHARPNESS_ALGORITHM

typedef uint16_t PEAK_IPL_SHARPNESS_ALGORITHM

PEAK_IPL_SHARPNESS_HANDLE

typedef struct PEAK_IPL_SHARPNESS* PEAK_IPL_SHARPNESS_HANDLE

PEAK_IPL_SHARPNESS_ROI_WEIGHT

typedef uint16_t PEAK_IPL_SHARPNESS_ROI_WEIGHT

PEAK_IPL_VIDEO_CONTAINER

typedef uint16_t PEAK_IPL_VIDEO_CONTAINER

PEAK_IPL_VIDEO_CONTAINER_OPTION

typedef uint16_t PEAK_IPL_VIDEO_CONTAINER_OPTION

PEAK_IPL_VIDEO_ENCODER

typedef uint16_t PEAK_IPL_VIDEO_ENCODER

PEAK_IPL_VIDEO_ENCODER_OPTION

typedef uint16_t PEAK_IPL_VIDEO_ENCODER_OPTION

PEAK_IPL_VIDEO_HANDLE

typedef struct PEAK_IPL_VIDEO* PEAK_IPL_VIDEO_HANDLE

The type of video writer handles.

Enumeration Type Documentation

PEAK_IPL_BINNINGMODE_t

enum PEAK_IPL_BINNINGMODE_t

Enumerator
Average
Sum

PEAK_IPL_CONVERSION_MODE_t

enum PEAK_IPL_CONVERSION_MODE_t

The enum holding the possible conversion modes.

Enumerator
PEAK_IPL_CONVERSION_MODE_FAST
PEAK_IPL_CONVERSION_MODE_HIGH_QUALITY
PEAK_IPL_CONVERSION_MODE_CLASSIC

PEAK_IPL_ENDIANNESS_t

enum PEAK_IPL_ENDIANNESS_t

The enum holding the possible endianness types.

Enumerator
PEAK_IPL_ENDIANNESS_UNKNOWN
PEAK_IPL_ENDIANNESS_LITTLE_ENDIAN
PEAK_IPL_ENDIANNESS_BIG_ENDIAN

PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_t

enum PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_t

Sensitivity parameter for the hotpixel correction algorithm

Enumerator
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_INVALID
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL1
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL2
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL3
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL4
PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY_LEVEL5

PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t

enum PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t

Rotation angle for the image transformer rotation algorithm

Enumerator
LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_90_COUNTERCLOCKWISE
LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_90_CLOCKWISE
LIMGTYPEIMAGE_TRANSFORMER_ROTATION_ANGLE_DEGREE_180

PEAK_IPL_ORIENTATION_t

enum PEAK_IPL_ORIENTATION_t

The enum holding the possible orientations.

Enumerator
PEAK_IPL_ORIENTATION_HORIZONTAL
PEAK_IPL_ORIENTATION_VERTICAL

PEAK_IPL_PIXEL_FORMAT_t

enum PEAK_IPL_PIXEL_FORMAT_t

The enum holding the possible pixel formats.

Enumerator
PEAK_IPL_PIXEL_FORMAT_INVALID
PEAK_IPL_PIXEL_FORMAT_BAYER_GR_8
PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10
PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12
PEAK_IPL_PIXEL_FORMAT_BAYER_RG_8
PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10
PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12
PEAK_IPL_PIXEL_FORMAT_BAYER_GB_8
PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10
PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12
PEAK_IPL_PIXEL_FORMAT_BAYER_BG_8
PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10
PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12
PEAK_IPL_PIXEL_FORMAT_MONO_8
PEAK_IPL_PIXEL_FORMAT_MONO_10
PEAK_IPL_PIXEL_FORMAT_MONO_12
PEAK_IPL_PIXEL_FORMAT_RGB_8
PEAK_IPL_PIXEL_FORMAT_RGB_10
PEAK_IPL_PIXEL_FORMAT_RGB_12
PEAK_IPL_PIXEL_FORMAT_BGR_8
PEAK_IPL_PIXEL_FORMAT_BGR_10
PEAK_IPL_PIXEL_FORMAT_BGR_12
PEAK_IPL_PIXEL_FORMAT_RGBA_8
PEAK_IPL_PIXEL_FORMAT_RGBA_10
PEAK_IPL_PIXEL_FORMAT_RGBA_12
PEAK_IPL_PIXEL_FORMAT_BGRA_8
PEAK_IPL_PIXEL_FORMAT_BGRA_10
PEAK_IPL_PIXEL_FORMAT_BGRA_12
PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10_PACKED
PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12_PACKED
PEAK_IPL_PIXEL_FORMAT_MONO_10_PACKED
PEAK_IPL_PIXEL_FORMAT_MONO_12_PACKED
PEAK_IPL_PIXEL_FORMAT_RGB_10_PACKED_32
PEAK_IPL_PIXEL_FORMAT_BGR_10_PACKED_32
PEAK_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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_IPL_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.

PEAK_IPL_RETURN_CODE_t

enum PEAK_IPL_RETURN_CODE_t

The enum holding the possible function return codes.

Enumerator
PEAK_IPL_RETURN_CODE_SUCCESS
PEAK_IPL_RETURN_CODE_ERROR
PEAK_IPL_RETURN_CODE_INVALID_HANDLE
PEAK_IPL_RETURN_CODE_IO_ERROR
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED
PEAK_IPL_RETURN_CODE_FORMAT_INTERPRETATION_ERROR
limgTypeRETURN_CODE_NOT_SUPPORTED
limgTypeRETURN_CODE_NOT_PERMITTED
limgTypeRETURN_CODE_BUSY
limgTypeRETURN_CODE_TIMEOUT

PEAK_IPL_SHARPNESS_ALGORITHM_t

enum PEAK_IPL_SHARPNESS_ALGORITHM_t

Enumerator
PEAK_IPL_SHARPNESS_ALGORITHM_TENENGRAD
PEAK_IPL_SHARPNESS_ALGORITHM_MEAN_SCORE
PEAK_IPL_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
PEAK_IPL_SHARPNESS_ALGORITHM_SOBEL

PEAK_IPL_SHARPNESS_ROI_WEIGHT_t

enum PEAK_IPL_SHARPNESS_ROI_WEIGHT_t

Enumerator
PEAK_IPL_SHARPNESS_ROI_WEIGHT_WEAK
PEAK_IPL_SHARPNESS_ROI_WEIGHT_MEDIUM
PEAK_IPL_SHARPNESS_ROI_WEIGHT_STRONG

PEAK_IPL_VIDEO_CONTAINER_OPTION_t

enum PEAK_IPL_VIDEO_CONTAINER_OPTION_t

Enumerator
PEAK_IPL_VIDEO_CONTAINER_OPTION_FRAMERATE

PEAK_IPL_VIDEO_CONTAINER_t

enum PEAK_IPL_VIDEO_CONTAINER_t

Enumerator
PEAK_IPL_VIDEO_CONTAINER_AVI

PEAK_IPL_VIDEO_ENCODER_OPTION_t

enum PEAK_IPL_VIDEO_ENCODER_OPTION_t

Enumerator
PEAK_IPL_VIDEO_ENCODER_OPTION_QUALITY

PEAK_IPL_VIDEO_ENCODER_t

enum PEAK_IPL_VIDEO_ENCODER_t

Enumerator
PEAK_IPL_VIDEO_ENCODER_RAW
PEAK_IPL_VIDEO_ENCODER_MJPEG

Function Documentation

PEAK_IPL_AdaptiveHotpixelCorrector_Construct()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Construct

(

PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE *

adaptiveHotpixelCorrectorHandle

)

Creates an adaptive hotpixel corrector algorithm.

Parameters

[out]

adaptiveHotpixelCorrectorHandle

The handle to the created adaptive hotpixel corrector algorithm.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_Correct()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Correct	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		const PEAK_IPL_POINT_2D *	hotpixels,
		size_t	hotpixelsSize,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Corrects the given hotpixels in the given image.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[in]	inputImageHandle	The handle to the input image.
[in]	hotpixels	The list of hotpixels to be corrected.
[in]	hotpixelsSize	Size of the given hotpixels list.
[out]	outputImageHandle	The handle associated with the image containing the corrected data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE At least one of adaptiveHotpixelCorrectorHandle and inputImageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with inputImageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_AdaptiveHotpixelCorrector_CorrectAdaptive()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_CorrectAdaptive	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Detects and corrects hotpixels in the given image.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[in]	inputImageHandle	The handle to the input image.
[out]	outputImageHandle	The handle associated with the image containing the corrected data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE At least one of adaptiveHotpixelCorrectorHandle and inputImageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with inputImageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_AdaptiveHotpixelCorrector_Destruct()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Destruct

(

PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE

adaptiveHotpixelCorrectorHandle

)

Destroys the adaptive hotpixel corrector algorithm associated with the given handle.

Parameters

[in]

adaptiveHotpixelCorrectorHandle

The handle to the adaptive hotpixel corrector algorithm of interest.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_Detect()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Detect	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	inputImageHandle
	)

Detects hotpixels in the given image.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[in]	inputImageHandle	The handle to the input image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE At least one of adaptiveHotpixelCorrectorHandle and inputImageHandle is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with inputImageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_AdaptiveHotpixelCorrector_GetGainFactorPercent()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetGainFactorPercent	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		uint32_t *	gainFactorPercent
	)

Queries the given adaptive hotpixel corrector algorithm's current gain factor in percent.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[out]	gainFactorPercent	The current gain factor in percent.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT gainFactorPercent is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_GetHotpixels()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetHotpixels	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_POINT_2D *	hotpixels,
		size_t *	hotpixelsSize
	)

Queries previously detected hotpixels.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[out]	hotpixels	The list of hotpixels.
[in,out]	hotpixelsSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT hotpixelsSize is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL hotpixels is valid but size is too small
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_GetSensitivity()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetSensitivity	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY *	sensitivityLevel
	)

Queries the given adaptive hotpixel corrector algorithm's current sensitivity.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[out]	sensitivityLevel	The current sensitivity level factor.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT sensitivityLevel is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_SetGainFactorPercent()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_SetGainFactorPercent	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		uint32_t	gainFactorPercent
	)

Sets the given adaptive hotpixel corrector algorithm's gain factor in percent.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[in]	gainFactorPercent	The gain factor in percent to set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_AdaptiveHotpixelCorrector_SetSensitivity()

PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_SetSensitivity	(	PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE	adaptiveHotpixelCorrectorHandle,
		PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY	sensitivityLevel
	)

Sets the given adaptive hotpixel corrector algorithm's sensitivity.

Parameters

[in]	adaptiveHotpixelCorrectorHandle	The handle to the adaptive hotpixel corrector algorithm of interest.
[in]	sensitivityLevel	The sensitivity level to set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE adaptiveHotpixelCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_Binning_Construct()

PEAK_IPL_C_API PEAK_IPL_Binning_Construct

(

PEAK_IPL_BINNING_HANDLE *

binningHandle

)

Creates a binning.

Parameters

[out]

binningHandle

The handle to the created binning.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_Destruct()

PEAK_IPL_C_API PEAK_IPL_Binning_Destruct

(

PEAK_IPL_BINNING_HANDLE

binningHandle

)

Destroys the binning associated with the given handle.

Parameters

[in]

binningHandle

The handle to the binning to destroy.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_ExpectedOutputSize()

PEAK_IPL_C_API PEAK_IPL_Binning_ExpectedOutputSize	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		size_t *	outputWidth,
		size_t *	outputHeight,
		size_t	inputWidth,
		size_t	inputHeight,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat
	)

Returns the size of a binned image given the input size and pixelformat.

Parameters

[in]	binningHandle	The handle to the binning
[out]	outputWidth	The expected width of the binned image.
[out]	outputHeight	The expected height of the binned image.
[in]	inputWidth	The width of the input image.
[in]	inputHeight	The height of the input image.
[in]	pixelFormat	The pixelFormat of the input image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputWidth or outputHeight is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.4

PEAK_IPL_Binning_GetBinningMax()

PEAK_IPL_C_API PEAK_IPL_Binning_GetBinningMax	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningMax
	)

Returns the maximum binning value which can be set.

Parameters

[in]	binningHandle	The handle to the binning
[out]	binningMax	The maximum binning value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_GetBinningMin()

PEAK_IPL_C_API PEAK_IPL_Binning_GetBinningMin	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningMin
	)

Returns the minimum binning value which can be set.

Parameters

[in]	binningHandle	The handle to the binning
[out]	binningMin	The minimum binning value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_GetBinningMode()

PEAK_IPL_C_API PEAK_IPL_Binning_GetBinningMode	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		PEAK_IPL_BINNINGMODE *	mode
	)

Returns the value of binning mode.

Parameters

[in]	binningHandle	The handle to the binning
[out]	mode	The value of binning mode.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_GetBinningX()

PEAK_IPL_C_API PEAK_IPL_Binning_GetBinningX	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningXValue
	)

Returns the value of binning in horizontal direction.

Parameters

[in]	binningHandle	The handle to the binning
[out]	binningXValue	The value of binning in horizontal direction.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningXValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_GetBinningY()

PEAK_IPL_C_API PEAK_IPL_Binning_GetBinningY	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningYValue
	)

Returns the value of binning in vertical direction.

Parameters

[in]	binningHandle	The handle to the binning
[out]	binningYValue	The value of binning in vertical direction.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.3.3

PEAK_IPL_Binning_IsPixelformatSupported()

PEAK_IPL_C_API PEAK_IPL_Binning_IsPixelformatSupported	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given binning whether it supports the given pixel format.

Parameters

[in]	binningHandle	The handle to the binning to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT isPixelFormatSupported is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.3.3

PEAK_IPL_Binning_Process()

PEAK_IPL_C_API PEAK_IPL_Binning_Process	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Apply the binning on the given image.

Parameters

[in]	binningHandle	The handle to the binning to use.
[in]	imageHandle	The handle to the image on which the binning is applied.
[out]	outputImageHandle	The handle to the image on which the binning was applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a too small image
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.3.3

PEAK_IPL_Binning_SetBinningMode()

PEAK_IPL_C_API PEAK_IPL_Binning_SetBinningMode	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		PEAK_IPL_BINNINGMODE *	mode
	)

Sets the value of binning mode.

Parameters

[in]	binningHandle	The handle to the binning.
[in]	mode	The binning mode that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.3.3

PEAK_IPL_Binning_SetBinningX()

PEAK_IPL_C_API PEAK_IPL_Binning_SetBinningX	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningXValue
	)

Sets the value of binning in horizontal direction.

Parameters

[in]	binningHandle	The handle to the binning.
[in]	binningXValue	The horizontal binning value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningXValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.3.3

PEAK_IPL_Binning_SetBinningY()

PEAK_IPL_C_API PEAK_IPL_Binning_SetBinningY	(	PEAK_IPL_BINNING_HANDLE	binningHandle,
		uint8_t *	binningYValue
	)

Sets the value of binning in vertical direction.

Parameters

[in]	binningHandle	The handle to the binning.
[in]	binningYValue	The vertical binning value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE binningHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT binningYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.3.3

PEAK_IPL_ColorCorrector_Construct()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Construct

(

PEAK_IPL_COLOR_CORRECTOR_HANDLE *

colorCorrectorHandle

)

Creates a color corrector.

Parameters

[out]

colorCorrectorHandle

The handle to the created color corrector.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_ColorCorrector_Destruct()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Destruct

(

PEAK_IPL_COLOR_CORRECTOR_HANDLE

colorCorrectorHandle

)

Destroys the color corrector associated with the given handle.

Parameters

[in]

colorCorrectorHandle

The handle to the color corrector to destroy.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_ColorCorrector_GetColorCorrectionFactors()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetColorCorrectionFactors	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float *	colorCorrectorFactors,
		size_t *	colorCorrectorFactorsSize
	)

Returns the color corrector 3x3 matrix factors and its size.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector
[out]	colorCorrectorFactors	The current color corrector factors.
[out]	colorCorrectorFactorsSize	The current color corrector factors size, default 3x3 = 9.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT colorCorrectorFactors and/or colorCorrectorFactorsSize is/are a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_ColorCorrector_GetIsPixelFormatSupported()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetIsPixelFormatSupported	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given color corrector whether it supports the given pixel format.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ColorCorrector_GetSaturation()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetSaturation	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float *	saturation
	)

Returns the color saturation value.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector.
[out]	saturation	The current color saturation value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT saturation is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.6

PEAK_IPL_ColorCorrector_GetSaturationMax()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetSaturationMax	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float *	saturationMax
	)

Returns the maximum color saturation value.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector.
[out]	saturationMax	The maximum color saturation value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT saturationMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.6

PEAK_IPL_ColorCorrector_GetSaturationMin()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetSaturationMin	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float *	saturationMin
	)

Returns the minimum color saturation value.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector.
[out]	saturationMin	The minimum color saturation value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT saturationMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.6

PEAK_IPL_ColorCorrector_Process()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Process	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Corrects the colors of the given image.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector to use.
[in]	imageHandle	The handle to the image on which the color correction matrix is applied.
[out]	outputImageHandle	The handle to the image on which the color correction matrix was applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format (e.g. packed pixel format)
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ColorCorrector_ProcessInPlace()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_ProcessInPlace	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Corrects the colors of the given image.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector to use.
[in]	imageHandle	The handle to the image on which the color correction matrix is applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format (e.g. packed pixel format)
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ColorCorrector_SetColorCorrectionFactors()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_SetColorCorrectionFactors	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float *	colorCorrectorFactors
	)

Sets the factors of the color correction matrix.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector.
[in]	colorCorrectorFactors	The color corrector factors that are set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ColorCorrector_SetSaturation()

PEAK_IPL_C_API PEAK_IPL_ColorCorrector_SetSaturation	(	PEAK_IPL_COLOR_CORRECTOR_HANDLE	colorCorrectorHandle,
		float	saturation
	)

Sets the color saturation value.

Parameters

[in]	colorCorrectorHandle	The handle to the color corrector.
[in]	saturation	The color saturation value to be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE colorCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_Decimation_Construct()

PEAK_IPL_C_API PEAK_IPL_Decimation_Construct

(

PEAK_IPL_DECIMATION_HANDLE *

decimationHandle

)

Creates a decimation.

Parameters

[out]

decimationHandle

The handle to the created decimation.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.5.0

PEAK_IPL_Decimation_Destruct()

PEAK_IPL_C_API PEAK_IPL_Decimation_Destruct

(

PEAK_IPL_DECIMATION_HANDLE

decimationHandle

)

Destroys the decimation associated with the given handle.

Parameters

[in]

decimationHandle

The handle to the decimation to destroy.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
IMG_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_ExpectedOutputSize()

PEAK_IPL_C_API PEAK_IPL_Decimation_ExpectedOutputSize	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		size_t *	outputWidth,
		size_t *	outputHeight,
		size_t	inputWidth,
		size_t	inputHeight,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat
	)

Returns the size of a binned image given the input size and pixelformat.

Parameters

[in]	decimationHandle	The handle to the decimation
[out]	outputWidth	The expected width of the binned image.
[out]	outputHeight	The expected height of the binned image.
[in]	inputWidth	The width of the input image.
[in]	inputHeight	The height of the input image.
[in]	pixelFormat	The pixelFormat of the input image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputWidth or outputHeight is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_GetDecimationMax()

PEAK_IPL_C_API PEAK_IPL_Decimation_GetDecimationMax	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationMax
	)

Returns the maximum decimation value which can be set.

Parameters

[in]	decimationHandle	The handle to the decimation
[out]	decimationMax	The maximum decimation value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_GetDecimationMin()

PEAK_IPL_C_API PEAK_IPL_Decimation_GetDecimationMin	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationMin
	)

Returns the minimum decimation value which can be set.

Parameters

[in]	decimationHandle	The handle to the decimation
[out]	decimationMin	The minimum decimation value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_GetDecimationX()

PEAK_IPL_C_API PEAK_IPL_Decimation_GetDecimationX	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationXValue
	)

Returns the value of decimation in horizontal direction.

Parameters

[in]	decimationHandle	The handle to the decimation
[out]	decimationXValue	The value of decimation in horizontal direction.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationXValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_GetDecimationY()

PEAK_IPL_C_API PEAK_IPL_Decimation_GetDecimationY	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationYValue
	)

Returns the value of decimation in vertical direction.

Parameters

[in]	decimationHandle	The handle to the decimation
[out]	decimationYValue	The value of decimation in vertical direction.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_IsPixelformatSupported()

PEAK_IPL_C_API PEAK_IPL_Decimation_IsPixelformatSupported	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given decimation whether it supports the given pixel format.

Parameters

[in]	decimationHandle	The handle to the decimation to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT isPixelFormatSupported is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_Process()

PEAK_IPL_C_API PEAK_IPL_Decimation_Process	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Apply the decimation on the given image.

Parameters

[in]	decimationHandle	The handle to the decimation to use.
[in]	imageHandle	The handle to the image on which the decimation is applied.
[out]	outputImageHandle	The handle to the image on which the decimation was applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a too small image
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_SetDecimationX()

PEAK_IPL_C_API PEAK_IPL_Decimation_SetDecimationX	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationXValue
	)

Sets the value of decimation in horizontal direction.

Parameters

[in]	decimationHandle	The handle to the decimation.
[in]	decimationXValue	The horizontal decimation value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationXValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Decimation_SetDecimationY()

PEAK_IPL_C_API PEAK_IPL_Decimation_SetDecimationY	(	PEAK_IPL_DECIMATION_HANDLE	decimationHandle,
		uint8_t *	decimationYValue
	)

Sets the value of decimation in vertical direction.

Parameters

[in]	decimationHandle	The handle to the decimation.
[in]	decimationYValue	The vertical decimation value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE decimationHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT decimationYValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5.0

PEAK_IPL_Gain_Construct()

PEAK_IPL_C_API PEAK_IPL_Gain_Construct

(

PEAK_IPL_GAIN_HANDLE *

gainHandle

)

Creates a gain.

Parameters

[out]

gainHandle

The handle to the created gain.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_Destruct()

PEAK_IPL_C_API PEAK_IPL_Gain_Destruct

(

PEAK_IPL_GAIN_HANDLE

gainHandle

)

Destroys the gain associated with the given handle.

Parameters

[in]

gainHandle

The handle to the gamma corrector to destroy.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetBlueGainMax()

PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainMax	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	blueGainMax
	)

Returns the maximum blue gain value which can be set.

Parameters

[in]	gainHandle	The handle to the gain
[out]	blueGainMax	The maximum blue gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT blueGainMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetBlueGainMin()

PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainMin	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	blueGainMin
	)

Returns the minimum blue gain value which can be set.

Parameters

[in]	gainHandle	The handle to the master gain
[out]	blueGainMin	The minimum blue gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT blueGainMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetBlueGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	blueGainValue
	)

Returns the blue gain value.

Parameters

[in]	gainHandle	The handle to the gain
[out]	blueGainValue	The current blue gain value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT blueGainValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetGreenGainMax()

PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainMax	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	greenGainMax
	)

Returns the maximum green gain value which can be set.

Parameters

[in]	gainHandle	The handle to the gain
[out]	greenGainMax	The maximum green gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT greenGainMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetGreenGainMin()

PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainMin	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	greenGainMin
	)

Returns the minimum green gain value which can be set.

Parameters

[in]	gainHandle	The handle to the master gain
[out]	greenGainMin	The minimum green gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT greenGainMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetGreenGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	greenGainValue
	)

Returns the green gain value.

Parameters

[in]	gainHandle	The handle to the gain
[out]	greenGainValue	The current green gain value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT greenGainValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetIsPixelFormatSupported()

PEAK_IPL_C_API PEAK_IPL_Gain_GetIsPixelFormatSupported	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given gamma corrector whether it supports the given pixel format.

Parameters

[in]	gainHandle	The handle to the gamma corrector to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_GetMasterGainMax()

PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainMax	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	masterGainMax
	)

Returns the maximum master gain value which can be set.

Parameters

[in]	gainHandle	The handle to the gain
[out]	masterGainMax	The maximum master gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT masterGainMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetMasterGainMin()

PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainMin	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	masterGainMin
	)

Returns the minimum master gain value which can be set.

Parameters

[in]	gainHandle	The handle to the master gain
[out]	masterGainMin	The minimum master gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT masterGainMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetMasterGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	masterGainValue
	)

Returns the master gain value.

Parameters

[in]	gainHandle	The handle to the gain
[out]	masterGainValue	The current master gain value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT masterGainValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetRedGainMax()

PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainMax	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	redGainMax
	)

Returns the maximum red gain value which can be set.

Parameters

[in]	gainHandle	The handle to the gain
[out]	redGainMax	The maximum red gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT redGainMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetRedGainMin()

PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainMin	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	redGainMin
	)

Returns the minimum red gain value which can be set.

Parameters

[in]	gainHandle	The handle to the master gain
[out]	redGainMin	The minimum red gain value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT redGainMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_GetRedGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	redGainValue
	)

Returns the red gain value.

Parameters

[in]	gainHandle	The handle to the gain
[out]	redGainValue	The current red gain value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT redGainValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_Process()

PEAK_IPL_C_API PEAK_IPL_Gain_Process	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Apply the gain on the given image.

Parameters

[in]	gainHandle	The handle to the gamma corrector to use.
[in]	imageHandle	The handle to the image on which the gamma correction matrix is applied.
[out]	outputImageHandle	The handle to the image on which the gamma correction matrix was applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_ProcessInPlace()

PEAK_IPL_C_API PEAK_IPL_Gain_ProcessInPlace	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Apply the gain on the given image.

Parameters

[in]	gainHandle	The handle to the gamma corrector to use.
[in]	imageHandle	The handle to the image on which the gamma correction matrix is applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_Gain_SetBlueGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_SetBlueGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	blueGainValue
	)

Sets the value of the blue gain.

Parameters

[in]	gainHandle	The handle to the gain.
[in]	blueGainValue	The blue gain value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_SetGreenGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_SetGreenGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	greenGainValue
	)

Sets the value of the green gain.

Parameters

[in]	gainHandle	The handle to the gain.
[in]	greenGainValue	The green gain value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_SetMasterGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_SetMasterGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	masterGainValue
	)

Sets the value of the master gain.

Parameters

[in]	gainHandle	The handle to the gain.
[in]	masterGainValue	The master gain value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Gain_SetRedGainValue()

PEAK_IPL_C_API PEAK_IPL_Gain_SetRedGainValue	(	PEAK_IPL_GAIN_HANDLE	gainHandle,
		float *	redGainValue
	)

Sets the value of the red gain.

Parameters

[in]	gainHandle	The handle to the gain.
[in]	redGainValue	The red gain value that is set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gainHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_GammaCorrector_Construct()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Construct

(

PEAK_IPL_GAMMA_CORRECTOR_HANDLE *

gammaCorrectorHandle

)

Creates a gamma corrector.

Parameters

[out]

gammaCorrectorHandle

The handle to the created gamma corrector.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_Destruct()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Destruct

(

PEAK_IPL_GAMMA_CORRECTOR_HANDLE

gammaCorrectorHandle

)

Destroys the gamma corrector associated with the given handle.

Parameters

[in]

gammaCorrectorHandle

The handle to the gamma corrector to destroy.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle is invalid
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_GetGammaCorrectionMax()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMax	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		float *	gammaMax
	)

Returns the maximum gamma corrector value which can be set.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector
[out]	gammaMax	The maximum gamma corrector value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT gammaMax is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_GetGammaCorrectionMin()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMin	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		float *	gammaMin
	)

Returns the minimum gamma corrector value which can be set.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector
[out]	gammaMin	The minimum gamma corrector value which can be set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT gammaMin is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_GetGammaCorrectionValue()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionValue	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		float *	gammaValue
	)

Returns the gamma corrector value.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector
[out]	gammaValue	The current gamma corrector value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT gammaValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given gamma corrector whether it supports the given pixel format.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_GammaCorrector_Process()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Process	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Corrects the gammas of the given image.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector to use.
[in]	imageHandle	The handle to the image on which the gamma correction matrix is applied.
[out]	outputImageHandle	The handle to the image on which the gamma correction matrix was applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_GammaCorrector_ProcessInPlace()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_ProcessInPlace	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Corrects the gammas of the given image.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector to use.
[in]	imageHandle	The handle to the image on which the gamma correction matrix is applied.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format.
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.2.2

PEAK_IPL_GammaCorrector_SetGammaCorrectionValue()

PEAK_IPL_C_API PEAK_IPL_GammaCorrector_SetGammaCorrectionValue	(	PEAK_IPL_GAMMA_CORRECTOR_HANDLE	gammaCorrectorHandle,
		float *	gammaValue
	)

Sets the value of the gamma correction.

Parameters

[in]	gammaCorrectorHandle	The handle to the gamma corrector.
[in]	gammaValue	The gamma corrector value that are set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE gammaCorrectorHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2.2

PEAK_IPL_Histogram_Construct()

PEAK_IPL_C_API PEAK_IPL_Histogram_Construct	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_HISTOGRAM_HANDLE *	histogramHandle
	)

Creates a histogram from image data.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	histogramHandle	The handle to the created histogram.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT histogramHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_Histogram_Destruct()

PEAK_IPL_C_API PEAK_IPL_Histogram_Destruct

(

PEAK_IPL_HISTOGRAM_HANDLE

histogramHandle

)

Destroys the histogram associated with the given handle.

Parameters

[in]

histogramHandle

The handle to the histogram to destroy.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Histogram_GetBinsForChannel()

PEAK_IPL_C_API PEAK_IPL_Histogram_GetBinsForChannel	(	PEAK_IPL_HISTOGRAM_HANDLE	histogramHandle,
		size_t	channelIndex,
		uint64_t *	bins,
		size_t *	binsSize
	)

Queries the bin list of the channel with the given index.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	histogramHandle	The handle to the histogram of interest.
[in]	channelIndex	The index of the channel of interest.
[out]	bins	The bin list of the given channel.
[in,out]	binsSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of binList and binsSize is a null pointer
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE channelIndex is out of range
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL binList is valid but binsSize is too small
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Histogram_GetNumChannels()

PEAK_IPL_C_API PEAK_IPL_Histogram_GetNumChannels	(	PEAK_IPL_HISTOGRAM_HANDLE	histogramHandle,
		size_t *	numChannels
	)

Queries the number of the given histogram's channels.

Parameters

[in]	histogramHandle	The handle to the histogram of interest.
[out]	numChannels	The number of channels.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numChannels is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Histogram_GetPixelCountForChannel()

PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelCountForChannel	(	PEAK_IPL_HISTOGRAM_HANDLE	histogramHandle,
		size_t	channelIndex,
		uint64_t *	pixelCount
	)

Queries the pixel count for the channel with the given index.

Parameters

[in]	histogramHandle	The handle to the histogram of interest.
[in]	channelIndex	The index of the channel of interest.
[out]	pixelCount	The pixel count of the given channel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelCount is a null pointer
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE channelIndex is out of range
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Histogram_GetPixelFormat()

PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelFormat	(	PEAK_IPL_HISTOGRAM_HANDLE	histogramHandle,
		PEAK_IPL_PIXEL_FORMAT *	pixelFormat
	)

Queries the pixel format of the given histogram.

Parameters

[in]	histogramHandle	The handle to the histogram of interest.
[out]	pixelFormat	The pixel format.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelFormat is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Histogram_GetPixelSumForChannel()

PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelSumForChannel	(	PEAK_IPL_HISTOGRAM_HANDLE	histogramHandle,
		size_t	channelIndex,
		uint64_t *	pixelSum
	)

Queries the pixel sum for the channel with the given index.

Parameters

[in]	histogramHandle	The handle to the histogram of interest.
[in]	channelIndex	The index of the channel of interest.
[out]	pixelSum	The pixel sum of the given channel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE histogramHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelSum is a null pointer
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE channelIndex is out of range
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_Clone()

PEAK_IPL_C_API PEAK_IPL_Image_Clone	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Returns a new created image containing the data of the current image as deep copy.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_Construct()

PEAK_IPL_C_API PEAK_IPL_Image_Construct	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t	width,
		size_t	height,
		PEAK_IPL_IMAGE_HANDLE *	imageHandle
	)

Creates an image.

Parameters

[in]	pixelFormat	The desired pixel format of the image.
[in]	width	The desired width of the image.
[in]	height	The desired height of the image.
[out]	imageHandle	The handle to the created image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_ConstructFromBuffer()

PEAK_IPL_C_API PEAK_IPL_Image_ConstructFromBuffer	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		uint8_t *	buffer,
		uint64_t	bufferSize,
		size_t	width,
		size_t	height,
		PEAK_IPL_IMAGE_HANDLE *	imageHandle
	)

Creates an image from a given buffer.

Parameters

[in]	pixelFormat	The desired pixel format of the image.
[in]	buffer	The buffer to use for the image.
[in]	bufferSize	The size of *buffer.
[in]	width	The desired width of the image in pixels.
[in]	height	The desired height of the image in lines.
[out]	imageHandle	The handle to the created image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of buffer and imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_Image_ConvertTo()

PEAK_IPL_C_API PEAK_IPL_Image_ConvertTo	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_PIXEL_FORMAT	outputPixelFormat,
		PEAK_IPL_CONVERSION_MODE	conversionMode,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the current image converted to the given pixel format.

Parameters

[in]	imageHandle	The handle to the image of interest.
[in]	outputPixelFormat	The output pixel format.
[in]	conversionMode	The conversion mode.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer or the mirror direction is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_ConvertToBuffer()

PEAK_IPL_C_API PEAK_IPL_Image_ConvertToBuffer	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_PIXEL_FORMAT	outputPixelFormat,
		uint8_t *	outputImageBuffer,
		size_t	outputImageBufferSize,
		PEAK_IPL_CONVERSION_MODE	conversionMode,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Stores the data of the current image converted to the given pixel format into a destination buffer and creates a new image.

Parameters

[in]	imageHandle	The handle to the image of interest.
[in]	outputPixelFormat	The output pixel format.
[out]	outputImageBuffer	Pointer to the destination buffer.
[in]	outputImageBufferSize	Size of the destination buffer.
[in]	conversionMode	The conversion mode.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of outputImageBuffer and outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL The output buffer size is too small regarding width, height and pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_IPL_Image_Destruct()

PEAK_IPL_C_API PEAK_IPL_Image_Destruct

(

PEAK_IPL_IMAGE_HANDLE

imageHandle

)

Destroys the image associated with the given handle.

Parameters

[in]

imageHandle

The handle to the image to destroy.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_GetByteCount()

PEAK_IPL_C_API PEAK_IPL_Image_GetByteCount	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		size_t *	byteCount
	)

Queries the size of the given image in number of bytes.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	byteCount	The size of the given image in number of bytes.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT byteCount is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_GetData()

PEAK_IPL_C_API PEAK_IPL_Image_GetData	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		uint8_t **	data
	)

Queries the data pointer of the given image.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	data	The data pointer of the given image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT data is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_GetHeight()

PEAK_IPL_C_API PEAK_IPL_Image_GetHeight	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		size_t *	height
	)

Queries the height of the given image.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	height	The height of the image in lines.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT height is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_Image_GetPixelFormat()

PEAK_IPL_C_API PEAK_IPL_Image_GetPixelFormat	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_PIXEL_FORMAT *	pixelFormat
	)

Queries the pixel format of the given image.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	pixelFormat	The pixel format of the given image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelFormat is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_GetPixelPointer()

PEAK_IPL_C_API PEAK_IPL_Image_GetPixelPointer	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		size_t	xPos,
		size_t	yPos,
		uint8_t **	pixelPointer
	)

Queries the pointer to the given pixel position.

Parameters

[in]	imageHandle	The handle to the image of interest.
[in]	xPos	The x position of the pixel of interest.
[in]	yPos	The y position of the pixel of interest.
[out]	pixelPointer	The pointer to the given pixel position.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelPosition is a null pointer
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE At least one of xPos and yPos is out of range
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_Image_GetTimestamp()

PEAK_IPL_C_API PEAK_IPL_Image_GetTimestamp	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		uint64_t *	timestamp_ns
	)

Get the timestamp for an image in nanoseconds.

Parameters

[in]	imageHandle	The handle to the created image.
[out]	timestamp_ns	Timestamp in nanoseconds.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_Image_GetWidth()

PEAK_IPL_C_API PEAK_IPL_Image_GetWidth	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		size_t *	width
	)

Queries the width of the given image.

Parameters

[in]	imageHandle	The handle to the image of interest.
[out]	width	The width of the image in pixels.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT width is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_Image_SetTimestamp()

PEAK_IPL_C_API PEAK_IPL_Image_SetTimestamp	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		uint64_t	timestamp_ns
	)

Set the timestamp for an image in nanoseconds.

Parameters

[in]	imageHandle	The handle to the created image.
[in]	timestamp_ns	Timestamp in nanoseconds.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageConverter_Construct()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_Construct

(

PEAK_IPL_IMAGE_CONVERTER_HANDLE *

imageConverterHandle

)

Creates an image converter.

Note

To speed up processing image converters maintain internal memory pools to reuse memory instead of allocating new memory for each conversion. The memory is freed when the image converter is destroyed using PEAK_IPL_ImageConverter_Destruct().

Parameters

[out]

imageConverterHandle

The handle to the created image converter.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageConverter_Convert()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_Convert	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		PEAK_IPL_PIXEL_FORMAT	outputPixelFormat,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the input image converted to the given pixel format.

Parameters

[in]	imageConverterHandle	The handle to the image converter of interest.
[in]	inputImageHandle	The handle to the created image.
[in]	outputPixelFormat	The output pixel format.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE At least one of imageConverterHandle and inputImageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageConverter_ConvertToBuffer()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_ConvertToBuffer	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		PEAK_IPL_PIXEL_FORMAT	outputPixelFormat,
		uint8_t *	outputImageBuffer,
		size_t	outputImageBufferSize,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the input image converted to the given pixel format.

Parameters

[in]	imageConverterHandle	The handle to the image converter of interest.
[in]	inputImageHandle	The handle to the input image.
[in]	outputPixelFormat	The output pixel format.
[out]	outputImageBuffer	Pointer to the destination buffer.
[in]	outputImageBufferSize	Size of the destination buffer.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE At least one of imageConverterHandle and inputImageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of outputImageBuffer and outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL The output buffer size is too small regarding width, height and pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_IPL_ImageConverter_Destruct()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_Destruct

(

PEAK_IPL_IMAGE_CONVERTER_HANDLE

imageConverterHandle

)

Destroys the image converter associated with the given handle.

Parameters

[in]

imageConverterHandle

The handle to the image converter of interest.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageConverterHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageConverter_GetConversionMode()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_GetConversionMode	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_CONVERSION_MODE *	conversionMode
	)

Queries the given image converter's current conversion mode.

Parameters

[in]	imageConverterHandle	The handle to the image converter of interest.
[out]	conversionMode	The current conversion mode.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageConverterHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT conversionMode is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageConverter_GetSupportedOutputPixelFormats()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_GetSupportedOutputPixelFormats	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_PIXEL_FORMAT	inputPixelFormat,
		PEAK_IPL_PIXEL_FORMAT *	outputPixelFormats,
		size_t *	outputPixelFormatsSize
	)

Queries the supported output pixel formats for a given input pixel format.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	imageConverterHandle	The handle to the image converter of interest.
[in]	inputPixelFormat	The input pixel format.
[out]	outputPixelFormats	The list of supported output pixel formats.
[in,out]	outputPixelFormatsSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageConverterHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT size is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL outputPixelFormats is valid but size is too small
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageConverter_PreAllocateConversion()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_PreAllocateConversion	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_PIXEL_FORMAT	inputPixelFormat,
		PEAK_IPL_PIXEL_FORMAT	outputPixelFormat,
		size_t	width,
		size_t	height,
		size_t	imageCount
	)

Pre-allocates internal buffer pools for the specified conversion.

Note

You can use the image converter without pre-allocating the internal buffers, but keep in mind that the first conversion of a new image size or format will need to allocate the buffers if not pre-allocated. This results in the first conversion taking more time than normal.

Parameters

[in]	imageConverterHandle	The handle of the image converter to be used.
[in]	inputPixelFormat	The pixelformat of the source image
[in]	outputPixelFormat	The pixelformat of the converted image
[in]	width	Width of the source image
[in]	height	Height of the source image
[in]	imageCount	Count of converted images held at one time

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

PEAK_IPL_ImageConverter_SetConversionMode()

PEAK_IPL_C_API PEAK_IPL_ImageConverter_SetConversionMode	(	PEAK_IPL_IMAGE_CONVERTER_HANDLE	imageConverterHandle,
		PEAK_IPL_CONVERSION_MODE	conversionMode
	)

Sets the given image converter's conversion mode.

Parameters

[in]	imageConverterHandle	The handle to the image converter of interest.
[in]	conversionMode	The conversion mode to set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageConverterHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageReader_Read()

PEAK_IPL_C_API PEAK_IPL_ImageReader_Read	(	const char *	filePath,
		size_t	filePathSize,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Reads an image from a file. Image type is determined by the file ending.

Parameters

[in]	filePath	The file to read from.
[in]	filePathSize	The size of the given string.
[out]	outputImageHandle	The handle to the read image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath and/or outputImageHandle are/is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED An image format of this file is not supported
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

PEAK_IPL_ImageReaderRead_ReadAsPixelFormat()

PEAK_IPL_C_API PEAK_IPL_ImageReaderRead_ReadAsPixelFormat	(	const char *	filePath,
		size_t	filePathSize,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Reads an image from a file. Image type is determined by the file ending.

Parameters

[in]	filePath	The file to read from.
[in]	filePathSize	The size of the given string.
[in]	pixelFormat	The pixel format of the data to read.
[out]	outputImageHandle	The handle to read image.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath and/or outputImageHandle are/is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED An image format of this file is not supported
PEAK_IPL_RETURN_CODE_FORMAT_INTERPRETATION_ERROR Can not interpret this file with the given pixel format
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if pixelFormat is packed pixel format

PEAK_IPL_ImageSharpness_Construct()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_Construct

(

PEAK_IPL_SHARPNESS_HANDLE *

handle

)

Creates a sharpness measurement.

Parameters

[out]

handle

The handle to the created sharpness.

Returns

IMG_RETURN_CODE_SUCCESS Success
IMG_RETURN_CODE_ERROR Something went wrong

Since

1.6

PEAK_IPL_ImageSharpness_Destruct()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_Destruct

(

PEAK_IPL_SHARPNESS_HANDLE

handle

)

Destroys the sharpness measurement associated with the given handle.

Parameters

[in]

handle

The handle to the sharpness measurement.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_GetAlgorithm()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_GetAlgorithm	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_SHARPNESS_ALGORITHM *	algorithm
	)

Returns the algorithm to use for measurement calculation.

Parameters

[in]	handle	The handle to the sharpness measurement.
[out]	algorithm	Current used algorithm.

See also

PEAK_IPL_SHARPNESS_ALGORITHM_t

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT algorithm is an invalid pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_GetIsPixelFormatSupported()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_GetIsPixelFormatSupported	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_BOOL8 *	isPixelFormatSupported
	)

Asks the given sharpness measurement whether it supports the given pixel format.

Parameters

[in]	handle	The handle to the sharpness measurement to use.
[in]	pixelFormat	The pixel format of interest.
[out]	isPixelFormatSupported	The flag telling whether the given pixel format is supported.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_GetROIMinimumSize()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_GetROIMinimumSize	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_SIZE_2D *	min_size
	)

Returns the minimum size of a ROI to use for measurement calculation.

Parameters

[in]	handle	The handle to the sharpness measurement.
[out]	min_size	Minimum size of ROI.

See also

PEAK_IPL_SIZE_2D

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT min_size is an invalid pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_GetROIs()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_GetROIs	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_SHARPNESS_ROI *	roiList,
		size_t *	roiListSize
	)

Returns the ROIs in which the sharpness is measured.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	handle	The handle to the sharpness measurement.
[in]	roiList	The list of ROIs to get.
[in,out]	roiListSize	IN: Size of the given buffer - OUT: Size of the queried data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT roi is an invalid pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_GetSupportedPixelFormatList()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_GetSupportedPixelFormatList	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_PIXEL_FORMAT *	pixelFormatList,
		size_t *	pixelFormatListSize
	)

Queries the supported pixel formats.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	handle	The handle to the image converter of interest.
[out]	pixelFormatList	The list of supported output pixel formats.
[in,out]	pixelFormatListSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT size is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL pixelFormatList is valid but size is too small
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_Measure()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_Measure	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		double *	calculated_value
	)

Measures the relative sharpness of the given image.

Parameters

[in]	handle	The handle to the sharpness to use.
[in]	imageHandle	The handle to the image on which the sharpness is measured.
[out]	calculated_value	The relative measured sharpness value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle and/or imageHandle are/is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT imageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has unsupported pixel format (e.g. packed pixel format)
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_SetAlgorithm()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_SetAlgorithm	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_SHARPNESS_ALGORITHM	algorithm
	)

Sets the algorithm to use for measurement calculation.

Parameters

[in]	handle	The handle to the sharpness measurement.
[in]	algorithm	Algorithm to use.

See also

PEAK_IPL_SHARPNESS_ALGORITHM_t

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageSharpness_SetROIs()

PEAK_IPL_C_API PEAK_IPL_ImageSharpness_SetROIs	(	PEAK_IPL_SHARPNESS_HANDLE	handle,
		PEAK_IPL_SHARPNESS_ROI *	roiList,
		size_t	roiListSize
	)

Sets ROIs in which the sharpness is measured.

Parameters

[in]	handle	The handle to the sharpness measurement.
[in]	roiList	The list of ROIs to set.
[in]	roiListSize	Number of ROIs to set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE handle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_ImageTransformer_Construct()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Construct

(

PEAK_IPL_IMAGE_TRANSFORMER_HANDLE *

imageTransformerHandle

)

Creates an image transformer.

Note

To speed up processing image transformers maintain internal memory pools to reuse memory instead of allocating new memory for each transformation. The memory is freed when the image transformer is destroyed using PEAK_IPL_ImageTransformer_Destruct().

Parameters

[out]

imageTransformerHandle

The handle to the created image transformer.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageTransformer_Destruct()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Destruct

(

PEAK_IPL_IMAGE_TRANSFORMER_HANDLE

imageTransformerHandle

)

Destroys the image transformer associated with the given handle.

Parameters

[in]

imageTransformerHandle

The handle to the image converter of interest.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageTransformerHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_ImageTransformer_MirrorLeftRight()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorLeftRight	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the current image mirrored in left-right direction.

If the transformed image is a bayer-format image and the number of columns is even, the format will change. (e.g. BayerBG8 -> BayerGB8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in]	imageHandle	The handle to the created image.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_MirrorLeftRightInPlace()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorLeftRightInPlace	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Mirrors the image left-right direction in place i.e. it will change the input image itself.

If the transformed image is a bayer-format image and the number of columns is even, the format will change. (e.g. BayerBG8 -> BayerGB8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in,out]	imageHandle	The handle to the image to be mirrored.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageTransformerHandle is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_MirrorUpDown()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDown	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the current image mirrored in up-down direction.

If the transformed image is a bayer-format image and the number of rows is even, the format will change. (e.g. BayerBG8 -> BayerGR8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in]	imageHandle	The handle to the created image.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_MirrorUpDownInPlace()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownInPlace	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Mirrors the image in up-down direction in place i.e. it will change the input image itself.

If the transformed image is a bayer-format image and the number of rows is even, the format will change. (e.g. BayerBG8 -> BayerGR8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in,out]	imageHandle	The handle to the image to be mirrored.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageTransformerHandle is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_MirrorUpDownLeftRight()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownLeftRight	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle
	)

Creates a new image containing the data of the current image mirrored in up-down and left-right direction.

If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. BayerBG8 -> BayerRG8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in]	imageHandle	The handle to the created image.
[out]	outputImageHandle	The handle associated with the image containing the converted data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_MirrorUpDownLeftRightInPlace()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownLeftRightInPlace	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Mirrors the image in up-down and left-right direction in place i.e. it will change the input image itself.

If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. BayerBG8 -> BayerRG8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in,out]	imageHandle	The handle to the image to be mirrored.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageTransformerHandle is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_Rotate()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Rotate	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_HANDLE *	outputImageHandle,
		PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t	rotationAngle
	)

Creates a new image containing the data of the current image rotated in direction and value of the rotation angle.

If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. 90_COUNTERCLOCKWISE & an image with even width: BayerGB8 -> BayerBG8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in]	imageHandle	The handle to the created image.
[in]	rotationAngle	The rotation angle for the image transformer rotation algorithm
[out]	outputImageHandle	The handle associated with the image containing the rotated data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT outputImageHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageTransformer_RotateInPlace()

PEAK_IPL_C_API PEAK_IPL_ImageTransformer_RotateInPlace	(	PEAK_IPL_IMAGE_TRANSFORMER_HANDLE	imageTransformerHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t	rotationAngle
	)

Rotates the image in in direction and value of the rotation angle in place i.e. it will change the input image itself.

If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. 90_COUNTERCLOCKWISE & an image with even width: BayerGB8 -> BayerBG8)

Parameters

[in]	imageTransformerHandle	The handle to the image transformer to use.
[in]	rotationAngle	The rotation angle for the image transformer rotation algorithm
[in,out]	imageHandle	The handle to the image to be mirrored.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageTransformerHandle is invalid
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with imageHandle has packed pixel format

PEAK_IPL_ImageWriter_Write()

PEAK_IPL_C_API PEAK_IPL_ImageWriter_Write	(	PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		const char *	filePath,
		size_t	filePathSize
	)

Writes an image to file and selects the format by file ending. In case the format has parameters, the default parameters are chosen.

Parameters

[in]	inputImageHandle	The handle to the image to save.
[in]	filePath	The file to write the given image to.
[in]	filePathSize	The size of the given string.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED A file type is not supported for this image pixel format
PEAK_IPL_RETURN_CODE_ERROR Something else went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_ImageWriter_WriteAsBMP()

PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsBMP	(	PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		const char *	filePath,
		size_t	filePathSize
	)

Writes an image as BMP image file.

Supported for the following formats: MONO_8, MONO_10, MONO_12, RGB_8, RGB_10, BGR_8, BGR_10, RGBA_8, BGRA_8, RGB_10_PACKED_32, BGR_10_PACKED_32 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8, BAYER_GR_10, BAYER_RG_10, BAYER_GB_10, BAYER_BG_10

Parameters

[in]	inputImageHandle	The handle to the image to save.
[in]	filePath	The file to write the given image to.
[in]	filePathSize	The size of the given string.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED A file type is not supported for this image pixel format
PEAK_IPL_RETURN_CODE_ERROR Something else went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_ImageWriter_WriteAsJPG()

PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsJPG	(	PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		uint32_t	quality,
		const char *	filePath,
		size_t	filePathSize
	)

Writes an image as JPEG image file.

Supported for the following formats: MONO_8, RGB_8, BGR_8, RGBA_8, BGRA_8 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8

Parameters

[in]	inputImageHandle	The handle to the image to save.
[in]	quality	Specifies the output image quality from 0 to 100.
[in]	filePath	The file to write the given image to.
[in]	filePathSize	The size of the given string.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED A file type is not supported for this image pixel format
PEAK_IPL_RETURN_CODE_ERROR Something else went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_ImageWriter_WriteAsPNG()

PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsPNG	(	PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		uint32_t	quality,
		const char *	filePath,
		size_t	filePathSize
	)

Writes an image as PNG image file.

Supported for following formats: MONO_8, MONO_10, MONO_12, RGB_8, RGB_10, RGB_12, RGBA_8, RGBA_10, RGBA_12 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8, BAYER_GR_10, BAYER_RG_10, BAYER_GB_10, BAYER_BG_10, BAYER_GR_12, BAYER_RG_12, BAYER_GB_12, BAYER_BG_12 Written as RGB: BGR_8, BGR_10, BGR_12, BGRA_8, BGRA_10, BGRA_12

Parameters

[in]	inputImageHandle	The handle to the image to save.
[in]	quality	Specifies the output image quality from 0 to 100.
[in]	filePath	The file to write the given image to.
[in]	filePathSize	The size of the given string.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED A file type is not supported for this image pixel format
PEAK_IPL_RETURN_CODE_ERROR Something else went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_ImageWriter_WriteAsRAW()

PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsRAW	(	PEAK_IPL_IMAGE_HANDLE	inputImageHandle,
		const char *	filePath,
		size_t	filePathSize
	)

Writes an image as raw data binary file.

This is supported by all formats.

Parameters

[in]	inputImageHandle	The handle to the image to save.
[in]	filePath	The file to write the given image to.
[in]	filePathSize	The size of the given string.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_IO_ERROR Errors during file access e.g. no permissions on this file
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED A file type is not supported for this image pixel format
PEAK_IPL_RETURN_CODE_ERROR Something else went wrong

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_Library_GetLastError()

PEAK_IPL_C_API PEAK_IPL_Library_GetLastError	(	PEAK_IPL_RETURN_CODE *	lastErrorCode,
		char *	lastErrorDescription,
		size_t *	lastErrorDescriptionSize
	)

Queries the last error.

This function is normally used by applying a two-step procedure. First of all, you call the function with all arguments except of lastErrorDescription.

// Error handling is omitted
PEAK_IPL_RETURN_CODE lastErrorCode = PEAK_IPL_RETURN_CODE_SUCCESS;
size_t size = 0;
PEAK_IPL_GetLastError(&lastErrorCode, NULL, &size);

The function then gives you the last error code and the size of the error description. You could stop now if you only want to query the last error code. If you want to query the error description as well, you have to go on.

// Error handling is omitted
char errorDescription[size];
PEAK_IPL_GetLastError(&returnCode, errorDescription, &size);

This two-step procedure may not be necessary if you just pass a buffer big enough for holding the description at the first function call.

Parameters

[out]	lastErrorCode	The last function error code.
[out]	lastErrorDescription	The description for the last error.
[in,out]	lastErrorDescriptionSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of the arguments is a null pointer
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL lastErrorDescription is valid but lastErrorDescriptionSize is too small

Since

1.0

PEAK_IPL_Library_GetMaxConcurrentThreads()

PEAK_IPL_C_API PEAK_IPL_Library_GetMaxConcurrentThreads

(

size_t *

concurrentThreads

)

Queries the maximum number of concurrent threads used by the library.

Parameters

[out]

concurrentThreads

The mumber of concurrent threads used by the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT concurrentThreads is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_Library_GetMultiThreadingEnabled()

PEAK_IPL_C_API PEAK_IPL_Library_GetMultiThreadingEnabled

(

PEAK_IPL_BOOL8 *

enabled

)

Disables / Enables multithreading in the library.

Parameters

[in]

enabled

The number of concurrent threads of the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT concurrentThreads is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_Library_GetVersionMajor()

PEAK_IPL_C_API PEAK_IPL_Library_GetVersionMajor

(

uint32_t *

libraryVersionMajor

)

Queries the library major version.

Parameters

[out]

libraryVersionMajor

The major version of the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT libraryVersionMajor is a null pointer

Since

1.0

PEAK_IPL_Library_GetVersionMinor()

PEAK_IPL_C_API PEAK_IPL_Library_GetVersionMinor

(

uint32_t *

libraryVersionMinor

)

Queries the library minor version.

Parameters

[out]

libraryVersionMinor

The minor version of the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT libraryVersionMinor is a null pointer

Since

1.0

PEAK_IPL_Library_GetVersionSubminor()

PEAK_IPL_C_API PEAK_IPL_Library_GetVersionSubminor

(

uint32_t *

libraryVersionSubminor

)

Queries the library subminor version.

Parameters

[out]

libraryVersionSubminor

The subminor version of the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT libraryVersionSubminor is a null pointer

Since

1.1

PEAK_IPL_Library_SetMaxConcurrentThreads()

PEAK_IPL_C_API PEAK_IPL_Library_SetMaxConcurrentThreads

(

size_t

concurrentThreads

)

Sets the maximum number of concurrent threads used by the library.

Set number of threads to 0, to let the library decide the amount. Choose any other number to set the amount manually.

Parameters

[in]

concurrentThreads

The number of concurrent threads of the library.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_Library_SetMultiThreadingEnabled()

PEAK_IPL_C_API PEAK_IPL_Library_SetMultiThreadingEnabled

(

PEAK_IPL_BOOL8

enabled

)

Disables / Enables multithreading in the library.

Parameters

[in]

enabled

set to true to enable multithreading, false to disable it

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.6

PEAK_IPL_PixelFormat_CalculateStorageSizeOfPixels()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_CalculateStorageSizeOfPixels	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		uint64_t	numPixels,
		uint64_t *	size
	)

Calculates the storage size of the given number of pixels of the given pixel format in bytes.

Parameters

[in]	pixelFormat	The pixel format of interest.
[in]	numPixels	The number of pixels.
[out]	size	The size of the pixels in bytes.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT size is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetEndianness()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetEndianness	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		PEAK_IPL_ENDIANNESS *	endianness
	)

Queries the endianness of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	endianness	The endianness.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT endianness is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetMaximumValuePerChannel()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetMaximumValuePerChannel	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		uint32_t *	channelMaximumValue
	)

Queries the maximum value of one pixel channel of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	channelMaximumValue	The maximum value of one pixel channel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT channelMaximumValue is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetNumChannels()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumChannels	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t *	numChannels
	)

Queries the number of channels of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	numChannels	The number of channels.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numChannels is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetNumSignificantBitsPerChannel()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumSignificantBitsPerChannel	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t *	numSignificantBits
	)

Queries the number of significant bits per pixel per channel of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	numSignificantBits	The number of significant bits per pixel per channel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numSignificantBits is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetNumSignificantBitsPerPixel()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumSignificantBitsPerPixel	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t *	numSignificantBits
	)

Queries the number of significant bits per pixel of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	numSignificantBits	The number of significant bits per pixel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numSignificantBits is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetNumStorageBitsPerChannel()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumStorageBitsPerChannel	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t *	numStorageBits
	)

Queries the number of storage bits per pixel per channel of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	numStorageBits	The number of storage bits per pixel per channel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numStorageBits is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelFormat_GetNumStorageBitsPerPixel()

PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumStorageBitsPerPixel	(	PEAK_IPL_PIXEL_FORMAT	pixelFormat,
		size_t *	numStorageBits
	)

Queries the number of storage bits per pixel of the given pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	numStorageBits	The number of significant bits per pixel.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numStorageBits is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_Construct()

PEAK_IPL_C_API PEAK_IPL_PixelLine_Construct	(	PEAK_IPL_IMAGE_HANDLE	imageHandle,
		PEAK_IPL_ORIENTATION	orientation,
		size_t	offset,
		PEAK_IPL_PIXEL_LINE_HANDLE *	pixelLineHandle
	)

Creates a pixel line depending on the given orientation.

A pixel line is a whole line or a whole column of the image's pixels.

Parameters

[in]	imageHandle	The image to create the pixel line from.
[in]	orientation	The orientation of the line.
[in]	offset	The offset from the reference border. The reference border depends on the given orientation (vertical: left - horizontal: top).
[out]	pixelLineHandle	The handle to the created pixel line.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE imageHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelLineHandle is a null pointer
PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED Image associated with imageHandle has packed pixel format
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE offset is out of range
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

1.2 Will return PEAK_IPL_RETURN_CODE_IMAGE_FORMAT_NOT_SUPPORTED if image associated with inputImageHandle has packed pixel format

PEAK_IPL_PixelLine_Destruct()

PEAK_IPL_C_API PEAK_IPL_PixelLine_Destruct

(

PEAK_IPL_PIXEL_LINE_HANDLE

pixelLineHandle

)

Destroys the pixel line associated with the given handle.

Parameters

[in]

pixelLineHandle

The handle to the pixel line to destroy.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_GetNumChannels()

PEAK_IPL_C_API PEAK_IPL_PixelLine_GetNumChannels	(	PEAK_IPL_PIXEL_LINE_HANDLE	pixelLineHandle,
		size_t *	numChannels
	)

Queries the number of the given pixel line's channels.

Parameters

[in]	pixelLineHandle	The handle to the pixel line of interest.
[out]	numChannels	The number of channels.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT numChannels is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_GetOffset()

PEAK_IPL_C_API PEAK_IPL_PixelLine_GetOffset	(	PEAK_IPL_PIXEL_LINE_HANDLE	pixelLineHandle,
		size_t *	offset
	)

Queries the offset of the given pixel line.

Parameters

[in]	pixelLineHandle	The handle to the pixel line of interest.
[out]	offset	The offset. The reference border depends on the orientation of the collection line (vertical: left - horizontal: top).

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT offset is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_GetOrientation()

PEAK_IPL_C_API PEAK_IPL_PixelLine_GetOrientation	(	PEAK_IPL_PIXEL_LINE_HANDLE	pixelLineHandle,
		PEAK_IPL_ORIENTATION *	orientation
	)

Queries the orientation of the given pixel line.

Parameters

[in]	pixelLineHandle	The handle to the pixel line of interest.
[out]	orientation	The orientation.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT orientation is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_GetPixelFormat()

PEAK_IPL_C_API PEAK_IPL_PixelLine_GetPixelFormat	(	PEAK_IPL_PIXEL_LINE_HANDLE	pixelLineHandle,
		PEAK_IPL_PIXEL_FORMAT *	pixelFormat
	)

Queries the pixel format of the given pixel line.

Parameters

[in]	pixelLineHandle	The handle to the pixel line of interest.
[out]	pixelFormat	The pixel format.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT pixelFormat is a null pointer
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_PixelLine_GetValuesForChannel()

PEAK_IPL_C_API PEAK_IPL_PixelLine_GetValuesForChannel	(	PEAK_IPL_PIXEL_LINE_HANDLE	pixelLineHandle,
		size_t	channelIndex,
		uint32_t *	values,
		size_t *	valuesSize
	)

Queries the value list for the channel with the given index.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	pixelLineHandle	The handle to the pixel line of interest.
[in]	channelIndex	The index of the channel of interest.
[out]	values	The value list of the given channel.
[in,out]	valuesSize	IN: Size of the given buffer - OUT: Size of the queried data

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_HANDLE pixelLineHandle is invalid
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of values and valuesSize is a null pointer
PEAK_IPL_RETURN_CODE_OUT_OF_RANGE channelIndex is out of range
PEAK_IPL_RETURN_CODE_BUFFER_TOO_SMALL values is valid but valuesSize is too small
PEAK_IPL_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IPL_VideoWriter_Container_GetOption()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Container_GetOption	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_ENCODER_OPTION	option,
		void *	value,
		size_t	count,
		size_t *	outCount
	)

Gets an option of the container.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The container option to set.
[out]	value	The value for the container option.
[in]	count	The size of the value.
[out]	outCount	The resulting size of the value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT value is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Container_OptionRange()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Container_OptionRange	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_ENCODER_OPTION	option,
		void *	min,
		void *	max,
		void *	inc
	)

Receive the range for an option of the container.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The container option to receive the range from.
[out]	min	The minimum value for the encoder option.
[out]	max	The maximum value for the encoder option.
[out]	inc	The increment value for the encoder option.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of min, max and inc is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Container_SetOption()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Container_SetOption	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_CONTAINER_OPTION	option,
		const void *	value,
		size_t	count
	)

Sets an option on the container.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The container option to set.
[in]	value	The value for the container option.
[in]	count	The size of the value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT value is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Encoder_GetOption()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Encoder_GetOption	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_ENCODER_OPTION	option,
		void *	value,
		size_t	count,
		size_t *	outCount
	)

Sets an option of the encoder.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The encoder option to set.
[out]	value	The value for the encoder option.
[in]	count	The size of the value.
[out]	outCount	The resulting size of the value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT value is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Encoder_GetSupportedPixelFormats()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Encoder_GetSupportedPixelFormats	(	PEAK_IPL_VIDEO_ENCODER	encoder,
		PEAK_IPL_PIXEL_FORMAT *	pixelFormatList,
		size_t *	pixelFormatListSize
	)

Get the supported pixelformats for an encoder.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[out]	pixelFormatList	The list of supported pixel formats.
[in,out]	pixelFormatListSize	IN: Size of the given buffer - OUT: Size of the queried data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of pixelFormatList and pixelFormatListSize
is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Encoder_OptionRange()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Encoder_OptionRange	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_ENCODER_OPTION	option,
		void *	min,
		void *	max,
		void *	inc
	)

Receive the range for an option of the encoder.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The encoder option to receive the range from.
[out]	min	The minimum value for the encoder option.
[out]	max	The maximum value for the encoder option.
[out]	inc	The increment value for the encoder option.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of min, max and inc is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Encoder_SetOption()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Encoder_SetOption	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_VIDEO_ENCODER_OPTION	option,
		const void *	value,
		size_t	count
	)

Sets an option on the encoder.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	option	The encoder option to set.
[in]	value	The value for the encoder option.
[in]	count	The size of the value.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT value is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_GetSupportedContainersForAnEncoder()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_GetSupportedContainersForAnEncoder	(	PEAK_IPL_VIDEO_ENCODER	encoder,
		PEAK_IPL_VIDEO_CONTAINER *	containers,
		size_t *	size
	)

Get the supported containers for an encoder.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[in]	encoder	The encoder, which shall be used to retrieve the supported containers.
[out]	containers	The list of supported containers.
[in,out]	size	IN: Size of the given buffer - OUT: Size of the queried data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of containers and size is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_GetSupportedEncodersForAContainer()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_GetSupportedEncodersForAContainer	(	PEAK_IPL_VIDEO_CONTAINER	container,
		PEAK_IPL_VIDEO_ENCODER *	encoders,
		size_t *	size
	)

Get the supported encoders for a container.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Parameters

[out]	encoders	The list of supported encoders.
[in,out]	size	IN: Size of the given buffer - OUT: Size of the queried data.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT At least one of encoders and size is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Queue_GetQueued()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Queue_GetQueued	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t *	queued
	)

Get the count of the currently queued buffers.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	queued	The currently queued buffer count.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Queue_GetRange()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Queue_GetRange	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t *	minSize,
		int32_t *	maxSize
	)

Get the possible range of the internal queue size.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	minSize	The minimum possible queue size.
[out]	maxSize	The maximum possible queue size.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Queue_GetSize()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Queue_GetSize	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t *	size
	)

Get the internal queue size of the video writer.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	size	The current queue size.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Queue_SetSize()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Queue_SetSize	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t	size
	)

Set the internal queue size of the video writer.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	size	The queue size to set.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_Append()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_Append	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_IMAGE_HANDLE	imageHandle
	)

Append an image to the video stream.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	imageHandle	The handle of the image to append.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_Close()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_Close

(

PEAK_IPL_VIDEO_HANDLE

videoHandle

)

Close the video stream.

Parameters

[in]

videoHandle

The handle of the video stream to close.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_GetDroppedFrames()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_GetDroppedFrames	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		uint64_t *	numFrames
	)

Gets the number of dropped frames in the video stream.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	numFrames	The number of dropped frames in the video stream.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT nrOfFrames is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_GetEncodedFrames()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_GetEncodedFrames	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		uint64_t *	numFrames
	)

Gets the number of encoded frames in the video stream.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	numFrames	The number of encoded frames in the video stream.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT nrOfFrames is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_GetFileSize()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_GetFileSize	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		uint64_t *	fileSize
	)

Gets the file size of the video.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	fileSize	The file size of the video.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT fileSize is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_IsOpen()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_IsOpen	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		PEAK_IPL_BOOL8 *	isOpen
	)

Check if the video stream is open.

Parameters

[in]	videoHandle	The handle of the video stream.
[out]	isOpen	Boolean if the video stream is open.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT isOpen is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_Open()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_Open	(	PEAK_IPL_VIDEO_HANDLE *	videoHandle,
		const char *	filePath,
		PEAK_IPL_VIDEO_CONTAINER	container,
		PEAK_IPL_VIDEO_ENCODER	encoder
	)

Open a video stream.

Parameters

[out]	videoHandle	The handle to operate on the video stream. todo wording
[in]	filePath	The filename of the video stream as an utf-8 encoded string (u8string)
[in]	container	The container type of the video stream.
[in]	encoder	The encoder type of the video stream.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_ResetFrameCounters()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_ResetFrameCounters

(

PEAK_IPL_VIDEO_HANDLE

videoHandle

)

Reset compressed and dropped frame counters.

Parameters

[in]

videoHandle

The handle of the video stream.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong

Since

1.5

PEAK_IPL_VideoWriter_Video_WaitUntilFrameDone()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_WaitUntilFrameDone	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t	timeout_ms
	)

Wait until frame processing is done.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	timeout_ms	The timeout in ms.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong
PEAK_IPL_RETURN_CODE_TIMEOUT Wait timed out
limgTypeRETURN_CODE_NOT_SUPPORTED This function is not supported

Since

1.5

PEAK_IPL_VideoWriter_Video_WaitUntilQueueEmpty()

PEAK_IPL_C_API PEAK_IPL_VideoWriter_Video_WaitUntilQueueEmpty	(	PEAK_IPL_VIDEO_HANDLE	videoHandle,
		int32_t	timeout_ms
	)

Wait until queue is empty.

Parameters

[in]	videoHandle	The handle of the video stream.
[in]	timeout_ms	The timeout in ms.

Returns

PEAK_IPL_RETURN_CODE_SUCCESS Success
PEAK_IPL_RETURN_CODE_ERROR Something went wrong
PEAK_IPL_RETURN_CODE_TIMEOUT Wait timed out
limgTypeRETURN_CODE_NOT_SUPPORTED This function is not supported

Since

1.5