Interface definition file for IDS peak comfortC. More...

#include <stddef.h>
#include <stdint.h>

Data Structures
struct	peak_buffer
	peak Buffer descriptor More...

struct	peak_size
	peak Size (2D) More...

struct	peak_position
	peak Position (2D) More...

struct	peak_roi
	The peak ROI (2D) More...

union	peak_matrix
	The peak 3x3 Matrix. More...

struct	peak_camera_descriptor
	peak Camera descriptor More...

union	peak_mac_address
	peak MAC-48 address More...

union	peak_ip_address
	peak IPv4 address More...

struct	peak_ip_config
	peak IP configuration More...

struct	peak_ethernet_info
	peak Ethernet info More...

struct	peak_acquisition_info
	peak Acquisition info More...

struct	peak_pixel_format_info
	peak Pixel format info More...

struct	peak_frame_info
	peak Frame info More...

struct	peak_trigger_mode
	peak Trigger mode More...

struct	peak_flash_mode
	peak Flash mode More...

struct	peak_gfa_enumeration_entry
	peak GFA enumeration entry More...

struct	peak_video_info
	video info structure More...

Macros
#define	PEAK_INVALID_HANDLE
	peak Invalid handle value More...

#define	PEAK_INFINITE
	peak Infinite value More...

#define	PEAK_TRUE
	peak Boolean value for 'true' or 'yes' More...

#define	PEAK_FALSE
	peak Boolean value for 'false' or 'no' More...

#define	PEAK_IDENTITY_MATRIX
	The peak Identity matrix preset. More...

#define	PEAK_SUCCESS(status)
	Check for the status code to indicate success. More...

#define	PEAK_WARNING(status)
	Check for the status code to indicate a warning. More...

#define	PEAK_ERROR(status)
	Check for the status code to indicate an error. More...

#define	PEAK_IS_WRITEABLE(accessStatus)
	Check for the access status code to indicate write access to be possible. More...

#define	PEAK_IS_READABLE(accessStatus)
	Check for the access status code to indicate read access to be possible. More...

#define	PEAK_INVALID_CAMERA_ID
	peak Invalid camera ID value More...

#define	PEAK_TRIGGER_MODE_HARDWARE_TRIGGER
	peak Trigger mode preset: Frame start by trigger input More...

#define	PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER
	peak Trigger mode preset: Frame start by software trigger More...

#define	PEAK_FLASH_MODE_EXPOSURE_ACTIVE
	peak Flash mode preset: Exposure active on flash output More...

#define	PEAK_FLASH_MODE_ACQUISITION_ACTIVE
	peak Flash mode preset: Acquisition active on flash output More...

#define	PEAK_FLASH_MODE_GLOBAL_START_WINDOW
	peak Flash mode preset: Global start window on flash output More...

Typedefs
typedef uint8_t	peak_bool
	peak Boolean type More...

typedef struct peak_camera *	peak_camera_handle
	peak Camera handle More...

typedef uint64_t	peak_camera_id
	peak Camera ID More...

typedef struct peak_frame *	peak_frame_handle
	peak Frame handle More...

typedef struct peak_video *	peak_video_handle
	peak Video handle More...

Enumerations
enum	peak_status { PEAK_STATUS_SUCCESS, PEAK_STATUS_WARNING, PEAK_STATUS_VALUE_ADJUSTED, PEAK_STATUS_ERROR, PEAK_STATUS_NOT_INITIALIZED, PEAK_STATUS_NOT_IMPLEMENTED, PEAK_STATUS_ACCESS_DENIED, PEAK_STATUS_CAMERA_NOT_FOUND, PEAK_STATUS_CAMERA_NOT_AVAILABLE, PEAK_STATUS_INVALID_HANDLE, PEAK_STATUS_INVALID_PARAMETER, PEAK_STATUS_OUT_OF_RANGE, PEAK_STATUS_BUFFER_TOO_SMALL, PEAK_STATUS_INVALID_CONFIGURATION, PEAK_STATUS_TIMEOUT, PEAK_STATUS_ABORTED, PEAK_STATUS_NO_DATA, PEAK_STATUS_INVALID_PEAK_INSTALLATION, PEAK_STATUS_BUSY }
	peak Status codes More...

enum	peak_access_status { PEAK_ACCESS_INVALID, PEAK_ACCESS_NOT_SUPPORTED, PEAK_ACCESS_NONE, PEAK_ACCESS_GFA_LOCK, PEAK_ACCESS_READONLY, PEAK_ACCESS_WRITEONLY, PEAK_ACCESS_READWRITE }
	peak Access status codes More...

enum	peak_camera_type { PEAK_CAMERA_TYPE_INVALID, PEAK_CAMERA_TYPE_UEYE_USB, PEAK_CAMERA_TYPE_UEYE_ETH, PEAK_CAMERA_TYPE_UEYE_PLUS_U3V, PEAK_CAMERA_TYPE_UEYE_PLUS_GEV }
	peak Camera types More...

enum	peak_ethernet_status { PEAK_ETHERNET_STATUS_INVALID, PEAK_ETHERNET_STATUS_OK, PEAK_ETHERNET_STATUS_NOK, PEAK_ETHERNET_STATUS_SUBNET_MISMATCH, PEAK_ETHERNET_STATUS_INAPPLICABLE_IP }
	peak Ethernet status More...

enum	peak_pixel_format { PEAK_PIXEL_FORMAT_INVALID, PEAK_PIXEL_FORMAT_BAYER_GR8, PEAK_PIXEL_FORMAT_BAYER_GR10, PEAK_PIXEL_FORMAT_BAYER_GR12, PEAK_PIXEL_FORMAT_BAYER_RG8, PEAK_PIXEL_FORMAT_BAYER_RG10, PEAK_PIXEL_FORMAT_BAYER_RG12, PEAK_PIXEL_FORMAT_BAYER_GB8, PEAK_PIXEL_FORMAT_BAYER_GB10, PEAK_PIXEL_FORMAT_BAYER_GB12, PEAK_PIXEL_FORMAT_BAYER_BG8, PEAK_PIXEL_FORMAT_BAYER_BG10, PEAK_PIXEL_FORMAT_BAYER_BG12, PEAK_PIXEL_FORMAT_MONO8, PEAK_PIXEL_FORMAT_MONO10, PEAK_PIXEL_FORMAT_MONO12, PEAK_PIXEL_FORMAT_RGB8, PEAK_PIXEL_FORMAT_RGB10, PEAK_PIXEL_FORMAT_RGB12, PEAK_PIXEL_FORMAT_BGR8, PEAK_PIXEL_FORMAT_BGR10, PEAK_PIXEL_FORMAT_BGR12, PEAK_PIXEL_FORMAT_RGBA8, PEAK_PIXEL_FORMAT_RGBA10, PEAK_PIXEL_FORMAT_RGBA12, PEAK_PIXEL_FORMAT_BGRA8, PEAK_PIXEL_FORMAT_BGRA10, PEAK_PIXEL_FORMAT_BGRA12, PEAK_PIXEL_FORMAT_BAYER_GR10P, PEAK_PIXEL_FORMAT_BAYER_GR12P, PEAK_PIXEL_FORMAT_BAYER_RG10P, PEAK_PIXEL_FORMAT_BAYER_RG12P, PEAK_PIXEL_FORMAT_BAYER_GB10P, PEAK_PIXEL_FORMAT_BAYER_GB12P, PEAK_PIXEL_FORMAT_BAYER_BG10P, PEAK_PIXEL_FORMAT_BAYER_BG12P, PEAK_PIXEL_FORMAT_MONO10P, PEAK_PIXEL_FORMAT_MONO12P, PEAK_PIXEL_FORMAT_RGB10P32, PEAK_PIXEL_FORMAT_BGR10P32, PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS, PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS, PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS, PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS, PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS, PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS, PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS, PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS, PEAK_PIXEL_FORMAT_MONO10G40_IDS, PEAK_PIXEL_FORMAT_MONO12G24_IDS }
	peak Pixel format More...

enum	peak_frame_type { PEAK_FRAME_TYPE_INVALID, PEAK_FRAME_TYPE_IMAGE }
	peak Frame type More...

enum	peak_parameter_set { PEAK_PARAMETER_SET_INVALID, PEAK_PARAMETER_SET_DEFAULT, PEAK_PARAMETER_SET_LINESCAN, PEAK_PARAMETER_SET_LONG_EXPOSURE, PEAK_PARAMETER_SET_USER_1, PEAK_PARAMETER_SET_USER_2 }
	peak Parameter set More...

enum	peak_io_channel { PEAK_IO_CHANNEL_INVALID, PEAK_IO_CHANNEL_NONE, PEAK_IO_CHANNEL_SOFTWARE, PEAK_IO_CHANNEL_TRIGGER_INPUT, PEAK_IO_CHANNEL_FLASH_OUTPUT, PEAK_IO_CHANNEL_GPIO_1, PEAK_IO_CHANNEL_GPIO_2 }
	peak IO channel More...

enum	peak_trigger_target { PEAK_TRIGGER_TARGET_INVALID, PEAK_TRIGGER_TARGET_FRAME_START, PEAK_TRIGGER_TARGET_LEVEL_CONTROLLED_EXPOSURE }
	peak Trigger target More...

enum	peak_trigger_edge { PEAK_TRIGGER_EDGE_INVALID, PEAK_TRIGGER_EDGE_RISING, PEAK_TRIGGER_EDGE_FALLING, PEAK_TRIGGER_EDGE_ANY }
	peak Trigger edge More...

enum	peak_flash_reference { PEAK_FLASH_REFERENCE_INVALID, PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE }
	peak Flash reference More...

enum	peak_gain_type { PEAK_GAIN_TYPE_INVALID, PEAK_GAIN_TYPE_ANALOG, PEAK_GAIN_TYPE_DIGITAL, PEAK_GAIN_TYPE_COMBINED }
	peak Gain type More...

enum	peak_gain_channel { PEAK_GAIN_CHANNEL_INVALID, PEAK_GAIN_CHANNEL_RED, PEAK_GAIN_CHANNEL_GREEN, PEAK_GAIN_CHANNEL_BLUE, PEAK_GAIN_CHANNEL_MASTER }
	peak Gain channel More...

enum	peak_color_correction_mode { PEAK_COLOR_CORRECTION_MODE_INVALID, PEAK_COLOR_CORRECTION_MODE_HQ, PEAK_COLOR_CORRECTION_MODE_USER_1 }
	peak Color correction mode More...

enum	peak_auto_feature_mode { PEAK_AUTO_FEATURE_MODE_INVALID, PEAK_AUTO_FEATURE_MODE_OFF, PEAK_AUTO_FEATURE_MODE_ONCE, PEAK_AUTO_FEATURE_MODE_CONTINUOUS }
	peak Auto feature mode More...

enum	peak_auto_feature_roi_mode { PEAK_AUTO_FEATURE_ROI_MODE_INVALID, PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE, PEAK_AUTO_FEATURE_ROI_MODE_MANUAL }
	peak Auto feature ROI mode More...

enum	peak_camera_memory_area { PEAK_CAMERA_MEMORY_AREA_INVALID, PEAK_CAMERA_MEMORY_AREA_USER_DATA_1, PEAK_CAMERA_MEMORY_AREA_USER_DATA_2 }
	peak Camera Memory Area More...

enum	peak_gfa_module { PEAK_GFA_MODULE_INVALID, PEAK_GFA_MODULE_SYSTEM, PEAK_GFA_MODULE_INTERFACE, PEAK_GFA_MODULE_LOCAL_DEVICE, PEAK_GFA_MODULE_REMOTE_DEVICE, PEAK_GFA_MODULE_DATA_STREAM }
	peak GFA modules More...

enum	peak_hotpixel_correction_sensitivity { PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_1, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5 }
	peak hotpixel correction sensitivity level More...

enum	peak_video_encoder { PEAK_VIDEO_ENCODER_INVALID, PEAK_VIDEO_ENCODER_MJPEG }
	peak Encoder types More...

enum	peak_video_container { PEAK_VIDEO_CONTAINER_INVALID, PEAK_VIDEO_CONTAINER_AVI }
	peak Container types More...

enum	peak_video_container_option { PEAK_VIDEO_CONTAINER_OPTION_INVALID, PEAK_VIDEO_CONTAINER_OPTION_FRAMERATE }
	peak container options More...

enum	peak_video_encoder_option { PEAK_VIDEO_ENCODER_OPTION_INVALID, PEAK_VIDEO_ENCODER_OPTION_QUALITY }
	peak container options More...

Functions
peak_status	peak_Library_Init ()
	Init the peak comfortC library. More...

peak_status	peak_Library_Exit ()
	Exit the peak comfortC library. More...

peak_status	peak_Library_GetVersion (uint32_t majorVersion, uint32_t minorVersion, uint32_t subminorVersion, uint32_t patchVersion)
	Query the library version. More...

peak_status	peak_Library_GetLastError (peak_status lastErrorCode, char lastErrorMessage, size_t *lastErrorMessageSize)
	Query the last error. More...

peak_status	peak_CameraList_Update (size_t *cameraCount)
	Update the camera list. More...

peak_status	peak_CameraList_Get (peak_camera_descriptor cameraList, size_t cameraCount)
	Query the current camera list. More...

peak_camera_id	peak_Camera_ID_FromHandle (peak_camera_handle hCam)
	Query the camera id by the camera handle. More...

peak_camera_id	peak_Camera_ID_FromSerialNumber (const char *serialNumber)
	Query the camera id by the serial number. More...

peak_camera_id	peak_Camera_ID_FromMAC (peak_mac_address macAddress)
	Query the camera id by the mac address. More...

peak_access_status	peak_Camera_GetAccessStatus (peak_camera_id cameraID)
	Query the camera access status. More...

peak_status	peak_Camera_GetDescriptor (peak_camera_id cameraID, peak_camera_descriptor *cameraDescriptor)
	Query the camera descriptor. More...

peak_status	peak_Camera_Open (peak_camera_id cameraID, peak_camera_handle *hCam)
	Open the camera by the Camera id. More...

peak_status	peak_Camera_OpenFirstAvailable (peak_camera_handle *hCam)
	Open the first available camera. More...

peak_status	peak_Camera_Close (peak_camera_handle hCam)
	Close the camera. More...

peak_status	peak_Camera_ResetToDefaultSettings (peak_camera_handle hCam)
	Reset the camera configuration. More...

peak_access_status	peak_EthernetConfig_GetAccessStatus (peak_camera_id cameraID)
	Query the ethernet configuration access status. More...

peak_status	peak_EthernetConfig_GetInfo (peak_camera_id cameraID, peak_ethernet_info *ethernetInfo)
	Query the ethernet information. More...

peak_access_status	peak_EthernetConfig_DHCP_GetAccessStatus (peak_camera_id cameraID)
	Query the dhcp access status. More...

peak_status	peak_EthernetConfig_DHCP_Enable (peak_camera_id cameraID, peak_bool enabled)
	Enable/Disable dhcp. More...

peak_bool	peak_EthernetConfig_DHCP_IsEnabled (peak_camera_id cameraID)
	Get the enabled status of dhcp. More...

peak_access_status	peak_EthernetConfig_PersistentIP_GetAccessStatus (peak_camera_id cameraID)
	Query the persistent ip access status. More...

peak_status	peak_EthernetConfig_PersistentIP_Set (peak_camera_id cameraID, peak_ip_config persistentIP)
	Set the persistent ip. More...

peak_status	peak_EthernetConfig_PersistentIP_Get (peak_camera_id cameraID, peak_ip_config *persistentIP)
	Get the persistent ip. More...

peak_status	peak_Acquisition_Start (peak_camera_handle hCam, uint32_t numberOfFrames)
	Start an acquisition. More...

peak_status	peak_Acquisition_Stop (peak_camera_handle hCam)
	Stops an acquisition. More...

peak_bool	peak_Acquisition_IsStarted (peak_camera_handle hCam)
	Check whether the acquisition is currently started or not. More...

peak_status	peak_Acquisition_WaitForFrame (peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle *hFrame)
	Wait for an acquired frame. More...

peak_status	peak_Acquisition_GetInfo (peak_camera_handle hCam, peak_acquisition_info *acquisitionInfo)
	Query the acquisition info. More...

peak_status	peak_Acquisition_Buffer_GetRequiredSize (peak_camera_handle hCam, size_t *requiredBufferSize)
	Query the required image buffer size. More...

peak_status	peak_Acquisition_Buffer_GetRequiredCount (peak_camera_handle hCam, size_t *requiredBufferCount)
	Query the required image buffer count. More...

peak_status	peak_Acquisition_Buffer_Announce (peak_camera_handle hCam, uint8_t memoryAddress, size_t memorySize, void userContext)
	Announce an image buffer. More...

peak_status	peak_Acquisition_Buffer_Revoke (peak_camera_handle hCam, uint8_t *memoryAddress)
	Revoke an image buffer. More...

peak_status	peak_Acquisition_Buffer_RevokeAll (peak_camera_handle hCam)
	Revoke all image buffers. More...

peak_status	peak_PixelFormat_GetInfo (peak_pixel_format pixelFormat, peak_pixel_format_info *pixelFormatInfo)
	Query the pixel format info. More...

peak_status	peak_Frame_Release (peak_camera_handle hCam, peak_frame_handle hFrame)
	Release a frame. More...

peak_status	peak_Frame_GetInfo (peak_frame_handle hFrame, peak_frame_info *frameInfo)
	Query the frame info. More...

peak_status	peak_Frame_Type_Get (peak_frame_handle hFrame, peak_frame_type *frameType)
	Query the type of a frame. More...

peak_status	peak_Frame_Buffer_Get (peak_frame_handle hFrame, peak_buffer *buffer)
	Query the buffer of a frame. More...

peak_status	peak_Frame_ID_Get (peak_frame_handle hFrame, uint64_t *frameID)
	Query the frame id of a frame. More...

peak_status	peak_Frame_Timestamp_Get (peak_frame_handle hFrame, uint64_t *timestamp_ns)
	Query the timestamp of a frame. More...

peak_status	peak_Frame_ROI_Get (peak_frame_handle hFrame, peak_roi *roi)
	Query the size parameters of a frame. More...

peak_status	peak_Frame_PixelFormat_Get (peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
	Query the pixel format of a frame. More...

peak_bool	peak_Frame_IsComplete (peak_frame_handle hFrame)
	Check whether the frame is complete. More...

peak_status	peak_Frame_BytesExpected_Get (peak_frame_handle hFrame, size_t *bytesExpected)
	Query the bytes expected for a complete image. More...

peak_status	peak_Frame_BytesWritten_Get (peak_frame_handle hFrame, size_t *bytesWritten)
	Query the bytes written to the buffer of a frame. More...

peak_status	peak_Frame_ProcessingTime_Get (peak_frame_handle hFrame, uint32_t *processingTime_ms)
	Query the processing time of a frame. More...

peak_access_status	peak_CameraSettings_ParameterSet_GetAccessStatus (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Query the parameter set access status. More...

peak_status	peak_CameraSettings_ParameterSet_GetList (peak_camera_handle hCam, peak_parameter_set parameterSetList, size_t parameterSetCount)
	Get the list of currently usable parameter sets. More...

peak_status	peak_CameraSettings_ParameterSet_Store (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Store the current camera configuration in a user-definable parameter set. More...

peak_status	peak_CameraSettings_ParameterSet_Apply (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Apply the specified parameter set. More...

peak_access_status	peak_CameraSettings_ParameterSet_Startup_GetAccessStatus (peak_camera_handle hCam)
	Query the startup parameter set access status. More...

peak_status	peak_CameraSettings_ParameterSet_Startup_Set (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Set the startup parameter set. More...

peak_status	peak_CameraSettings_ParameterSet_Startup_Get (peak_camera_handle hCam, peak_parameter_set *parameterSet)
	Get the startup parameter set. More...

peak_access_status	peak_CameraSettings_DiskFile_GetAccessStatus (peak_camera_handle hCam)
	Query the disk file settings access status. More...

peak_status	peak_CameraSettings_DiskFile_Store (peak_camera_handle hCam, const char *file)
	Store the current camera configuration to a disk file. More...

peak_status	peak_CameraSettings_DiskFile_Apply (peak_camera_handle hCam, const char *file)
	Apply the camera configuration from the specified disk file. More...

peak_access_status	peak_FrameRate_GetAccessStatus (peak_camera_handle hCam)
	Query the frame rate access status. More...

peak_status	peak_FrameRate_GetRange (peak_camera_handle hCam, double minFrameRate_fps, double maxFrameRate_fps, double *incFrameRate_fps)
	Get the current range of valid frame rate values. More...

peak_status	peak_FrameRate_Set (peak_camera_handle hCam, double frameRate_fps)
	Set the frame rate. More...

peak_status	peak_FrameRate_Get (peak_camera_handle hCam, double *frameRate_fps)
	Get the frame rate. More...

peak_access_status	peak_ExposureTime_GetAccessStatus (peak_camera_handle hCam)
	Query the exposure time access status. More...

peak_status	peak_ExposureTime_GetRange (peak_camera_handle hCam, double minExposureTime_us, double maxExposureTime_us, double *incExposureTime_us)
	Get the current range of valid exposure time values. More...

peak_status	peak_ExposureTime_Set (peak_camera_handle hCam, double exposureTime_us)
	Set the exposure time. More...

peak_status	peak_ExposureTime_Get (peak_camera_handle hCam, double *exposureTime_us)
	Get the exposure time. More...

peak_access_status	peak_PixelClock_GetAccessStatus (peak_camera_handle hCam)
	Query the pixel clock access status. More...

peak_bool	peak_PixelClock_HasRange (peak_camera_handle hCam)
	Check whether the valid values for the pixel clock feature are organized as a range. More...

peak_status	peak_PixelClock_GetRange (peak_camera_handle hCam, double minPixelClock_MHz, double maxPixelClock_MHz, double *incPixelClock_MHz)
	Get the current range of valid pixel clock values. More...

peak_status	peak_PixelClock_GetList (peak_camera_handle hCam, double pixelClockList, size_t pixelClockCount)
	Get the list of currently selectable pixel clock values. More...

peak_status	peak_PixelClock_Set (peak_camera_handle hCam, double pixelClock_MHz)
	Set the pixel clock. More...

peak_status	peak_PixelClock_Get (peak_camera_handle hCam, double *pixelClock_MHz)
	Get the pixel clock. More...

peak_access_status	peak_IOChannel_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel access status. More...

peak_status	peak_IOChannel_GetList (peak_camera_handle hCam, peak_io_channel ioChannelList, size_t ioChannelCount)
	Get the list of supported io channels. More...

peak_access_status	peak_IOChannel_Level_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel level property access status. More...

peak_bool	peak_IOChannel_Level_IsHigh (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the level of the io channel. More...

peak_access_status	peak_IOChannel_Inverter_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel inverter property access status. More...

peak_status	peak_IOChannel_Inverter_Enable (peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
	Enable/Disable the io channel inverter property. More...

peak_bool	peak_IOChannel_Inverter_IsEnabled (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the enabled status of the io channel inverter property. More...

peak_access_status	peak_IOChannel_NoiseFilter_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel noise filter property access status. More...

peak_status	peak_IOChannel_NoiseFilter_Enable (peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
	Enable/Disable the io channel noise filter property. More...

peak_bool	peak_IOChannel_NoiseFilter_IsEnabled (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the enabled status of the io channel noise filter property. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_GetRange (peak_camera_handle hCam, peak_io_channel ioChannel, double minNoiseFilterDuration_us, double maxNoiseFilterDuration_us, double *incNoiseFilterDuration_us)
	Get the current range of valid io channel noise filter duration values. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_Set (peak_camera_handle hCam, peak_io_channel ioChannel, double noiseFilterDuration_us)
	Set the io channel noise filter duration. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_Get (peak_camera_handle hCam, peak_io_channel ioChannel, double *noiseFilterDuration_us)
	Get the io channel noise filter duration. More...

peak_access_status	peak_Trigger_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger feature access status. More...

peak_status	peak_Trigger_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the trigger. More...

peak_bool	peak_Trigger_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the trigger. More...

peak_bool	peak_Trigger_IsExecutable (peak_camera_handle hCam)
	Check whether the trigger is executable or not. More...

peak_status	peak_Trigger_Execute (peak_camera_handle hCam)
	Execute the trigger. More...

peak_access_status	peak_Trigger_Mode_GetAccessStatus (peak_camera_handle hCam, peak_trigger_mode triggerMode)
	Query the trigger mode access status. More...

peak_status	peak_Trigger_Mode_Set (peak_camera_handle hCam, peak_trigger_mode triggerMode)
	Set the trigger mode. More...

peak_status	peak_Trigger_Mode_Get (peak_camera_handle hCam, peak_trigger_mode *triggerMode)
	Get the trigger mode. More...

peak_access_status	peak_Trigger_Edge_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger edge property access status. More...

peak_status	peak_Trigger_Edge_GetList (peak_camera_handle hCam, peak_trigger_edge triggerEdgeList, size_t triggerEdgeCount)
	Get the list of currently selectable trigger edges. More...

peak_status	peak_Trigger_Edge_Set (peak_camera_handle hCam, peak_trigger_edge triggerEdge)
	Set the trigger edge. More...

peak_status	peak_Trigger_Edge_Get (peak_camera_handle hCam, peak_trigger_edge *triggerEdge)
	Get the trigger edge. More...

peak_access_status	peak_Trigger_Delay_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger delay property access status. More...

peak_status	peak_Trigger_Delay_GetRange (peak_camera_handle hCam, double minTriggerDelay_us, double maxTriggerDelay_us, double *incTriggerDelay_us)
	Get the current range of valid trigger delay values. More...

peak_status	peak_Trigger_Delay_Set (peak_camera_handle hCam, double triggerDelay_us)
	Set the trigger delay. More...

peak_status	peak_Trigger_Delay_Get (peak_camera_handle hCam, double *triggerDelay_us)
	Get the trigger delay. More...

peak_access_status	peak_Trigger_Divider_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger divider property access status. More...

peak_status	peak_Trigger_Divider_GetRange (peak_camera_handle hCam, uint32_t minTriggerDivider, uint32_t maxTriggerDivider, uint32_t *incTriggerDivider)
	Get the current range of valid trigger divider values. More...

peak_status	peak_Trigger_Divider_Set (peak_camera_handle hCam, uint32_t triggerDivider)
	Set the trigger divider. More...

peak_status	peak_Trigger_Divider_Get (peak_camera_handle hCam, uint32_t *triggerDivider)
	Get the trigger divider. More...

peak_access_status	peak_Trigger_Burst_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger burst property access status. More...

peak_status	peak_Trigger_Burst_GetRange (peak_camera_handle hCam, uint32_t minTriggerBurst, uint32_t maxTriggerBurst, uint32_t *incTriggerBurst)
	Get the current range of valid trigger burst values. More...

peak_status	peak_Trigger_Burst_Set (peak_camera_handle hCam, uint32_t triggerBurst)
	Set the trigger burst. More...

peak_status	peak_Trigger_Burst_Get (peak_camera_handle hCam, uint32_t *triggerBurst)
	Get the trigger burst. More...

peak_access_status	peak_Flash_GetAccessStatus (peak_camera_handle hCam)
	Query the flash feature access status. More...

peak_status	peak_Flash_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the flash. More...

peak_bool	peak_Flash_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the flash. More...

peak_access_status	peak_Flash_Mode_GetAccessStatus (peak_camera_handle hCam, peak_flash_mode flashMode)
	Query the flash mode access status. More...

peak_status	peak_Flash_Mode_Set (peak_camera_handle hCam, peak_flash_mode flashMode)
	Set the flash mode. More...

peak_status	peak_Flash_Mode_Get (peak_camera_handle hCam, peak_flash_mode *flashMode)
	Get the flash mode. More...

peak_access_status	peak_Flash_StartDelay_GetAccessStatus (peak_camera_handle hCam)
	Query the flash start delay property access status. More...

peak_status	peak_Flash_StartDelay_GetRange (peak_camera_handle hCam, double minFlashStartDelay_us, double maxFlashStartDelay_us, double *incFlashStartDelay_us)
	Get the current range of valid flash start delay values. More...

peak_status	peak_Flash_StartDelay_Set (peak_camera_handle hCam, double flashStartDelay_us)
	Set the flash start delay. More...

peak_status	peak_Flash_StartDelay_Get (peak_camera_handle hCam, double *flashStartDelay_us)
	Get the flash start delay. More...

peak_access_status	peak_Flash_EndDelay_GetAccessStatus (peak_camera_handle hCam)
	Query the flash end delay property access status. More...

peak_status	peak_Flash_EndDelay_GetRange (peak_camera_handle hCam, double minFlashEndDelay_us, double maxFlashEndDelay_us, double *incFlashEndDelay_us)
	Get the current range of valid flash end delay values. More...

peak_status	peak_Flash_EndDelay_Set (peak_camera_handle hCam, double flashEndDelay_us)
	Set the flash end delay. More...

peak_status	peak_Flash_EndDelay_Get (peak_camera_handle hCam, double *flashEndDelay_us)
	Get the flash end delay. More...

peak_access_status	peak_Flash_Duration_GetAccessStatus (peak_camera_handle hCam)
	Query the flash duration property access status. More...

peak_status	peak_Flash_Duration_GetRange (peak_camera_handle hCam, double minFlashDuration_us, double maxFlashDuration_us, double *incFlashDuration_us)
	Get the current range of valid flash duration values. More...

peak_status	peak_Flash_Duration_Set (peak_camera_handle hCam, double flashDuration_us)
	Set the flash duration. More...

peak_status	peak_Flash_Duration_Get (peak_camera_handle hCam, double *flashDuration_us)
	Get the flash duration. More...

peak_access_status	peak_PixelFormat_GetAccessStatus (peak_camera_handle hCam)
	Query the pixel format access status. More...

peak_status	peak_PixelFormat_GetList (peak_camera_handle hCam, peak_pixel_format pixelFormatList, size_t pixelFormatCount)
	Get the list of currently selectable pixel formats. More...

peak_status	peak_PixelFormat_Set (peak_camera_handle hCam, peak_pixel_format pixelFormat)
	Set the pixel format. More...

peak_status	peak_PixelFormat_Get (peak_camera_handle hCam, peak_pixel_format *pixelFormat)
	Get the pixel format. More...

peak_access_status	peak_Gain_GetAccessStatus (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel)
	Query the gain access status for the specified gain type and gain channel. More...

peak_status	peak_Gain_GetChannelList (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannelList, size_t gainChannelCount)
	Get the list of available gain channels for the given gain type. More...

peak_status	peak_Gain_GetRange (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double minGain, double maxGain, double *incGain)
	Get the current range of valid gain values for the specified gain type and gain channel. More...

peak_status	peak_Gain_Set (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double gain)
	Set the gain for the specified gain type and gain channel. More...

peak_status	peak_Gain_Get (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *gain)
	Get the gain value for the specified gain type and gain channel. More...

peak_access_status	peak_Gamma_GetAccessStatus (peak_camera_handle hCam)
	Query the gamma access status. More...

peak_status	peak_Gamma_GetRange (peak_camera_handle hCam, double minGamma, double maxGamma, double *incGamma)
	Get the current range of valid gamma values. More...

peak_status	peak_Gamma_Set (peak_camera_handle hCam, double gamma)
	Set the gamma value. More...

peak_status	peak_Gamma_Get (peak_camera_handle hCam, double *gamma)
	Get the gamma value. More...

peak_access_status	peak_ColorCorrection_GetAccessStatus (peak_camera_handle hCam)
	Query the color correction access status. More...

peak_status	peak_ColorCorrection_Mode_GetList (peak_camera_handle hCam, peak_color_correction_mode colorCorrectionModeList, size_t colorCorrectionModeCount)
	Get the list of currently selectable color correction modes. More...

peak_status	peak_ColorCorrection_Mode_Set (peak_camera_handle hCam, peak_color_correction_mode colorCorrectionMode)
	Set the color correction mode. More...

peak_status	peak_ColorCorrection_Mode_Get (peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionMode)
	Get the color correction mode. More...

peak_access_status	peak_ColorCorrection_Matrix_GetAccessStatus (peak_camera_handle hCam)
	Query the color correction matrix access status. More...

peak_status	peak_ColorCorrection_Matrix_GetRange (peak_camera_handle hCam, double minMatrixElementValue, double maxMatrixElementValue, double *incMatrixElementValue)
	Get the current range of valid color correction matrix element values. More...

peak_status	peak_ColorCorrection_Matrix_Set (peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
	Sets the color correction matrix for the current selected color correction. More...

peak_status	peak_ColorCorrection_Matrix_Get (peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
	Get the color correction matrix. More...

peak_status	peak_ColorCorrection_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the color correction. More...

peak_bool	peak_ColorCorrection_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the color correction. More...

peak_access_status	peak_AutoBrightness_GetAccessStatus (peak_camera_handle hCam)
	Query the auto brightness access status. More...

peak_status	peak_AutoBrightness_Target_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTarget, uint32_t maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
	Get the current range of valid auto brightness target values. More...

peak_status	peak_AutoBrightness_Target_Set (peak_camera_handle hCam, uint32_t autoBrightnessTarget)
	Set the auto brightness target value. More...

peak_status	peak_AutoBrightness_Target_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
	Get the auto brightness target value. More...

peak_status	peak_AutoBrightness_TargetTolerance_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTargetTolerance, uint32_t maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
	Get the current range of valid auto brightness target tolerance values. More...

peak_status	peak_AutoBrightness_TargetTolerance_Set (peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
	Set the auto brightness target tolerance value. More...

peak_status	peak_AutoBrightness_TargetTolerance_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
	Get the auto brightness target tolerance value. More...

peak_status	peak_AutoBrightness_TargetPercentile_GetRange (peak_camera_handle hCam, double minAutoBrightnessTargetPercentile, double maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
	Get the current range of valid auto brightness target percentile values. More...

peak_status	peak_AutoBrightness_TargetPercentile_Set (peak_camera_handle hCam, double autoBrightnessTargetPercentile)
	Set the auto brightness target percentile value. More...

peak_status	peak_AutoBrightness_TargetPercentile_Get (peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
	Get the auto brightness target percentile value. More...

peak_status	peak_AutoBrightness_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
	Set the auto brightness ROI mode. More...

peak_status	peak_AutoBrightness_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
	Get the auto brightness ROI mode. More...

peak_status	peak_AutoBrightness_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoBrightnessROIOffset, peak_position maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
	Get the current range of valid auto brightness ROI offsets. More...

peak_status	peak_AutoBrightness_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoBrightnessROISize, peak_size maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
	Get the current range of valid auto brightness ROI sizes. More...

peak_status	peak_AutoBrightness_ROI_Set (peak_camera_handle hCam, peak_roi autoBrightnessROI)
	Set the auto brightness ROI. More...

peak_status	peak_AutoBrightness_ROI_Get (peak_camera_handle hCam, peak_roi *autoBrightnessROI)
	Get the auto brightness ROI. More...

peak_access_status	peak_AutoBrightness_Exposure_GetAccessStatus (peak_camera_handle hCam)
	Query the auto exposure control access status. More...

peak_status	peak_AutoBrightness_Exposure_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
	Set the auto exposure control mode. More...

peak_status	peak_AutoBrightness_Exposure_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
	Get the auto exposure control mode. More...

peak_access_status	peak_AutoBrightness_Gain_GetAccessStatus (peak_camera_handle hCam)
	Query the auto gain control access status. More...

peak_status	peak_AutoBrightness_Gain_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
	Set the auto gain control mode. More...

peak_status	peak_AutoBrightness_Gain_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
	Get the auto gain control mode. More...

peak_access_status	peak_AutoWhiteBalance_GetAccessStatus (peak_camera_handle hCam)
	Query the auto white balance access status. More...

peak_status	peak_AutoWhiteBalance_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
	Set the auto white balance ROI mode. More...

peak_status	peak_AutoWhiteBalance_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
	Get the auto white balance ROI mode. More...

peak_status	peak_AutoWhiteBalance_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoWhiteBalanceROIOffset, peak_position maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
	Get the current range of valid auto white balance ROI offsets. More...

peak_status	peak_AutoWhiteBalance_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoWhiteBalanceROISize, peak_size maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
	Get the current range of valid auto white balance ROI sizes. More...

peak_status	peak_AutoWhiteBalance_ROI_Set (peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
	Set the auto white balance ROI. More...

peak_status	peak_AutoWhiteBalance_ROI_Get (peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
	Get the auto white balance ROI. More...

peak_status	peak_AutoWhiteBalance_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
	Set the auto white balance control mode. More...

peak_status	peak_AutoWhiteBalance_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
	Get the auto white balance control mode. More...

peak_access_status	peak_ROI_GetAccessStatus (peak_camera_handle hCam)
	Query the ROI access status. More...

peak_status	peak_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minROIOffset, peak_position maxROIOffset, peak_position *incROIOffset)
	Get the current range of valid ROI offsets. More...

peak_status	peak_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minROISize, peak_size maxROISize, peak_size *incROISize)
	Get the current range of valid ROI sizes. More...

peak_status	peak_ROI_Set (peak_camera_handle hCam, peak_roi roi)
	Set the ROI. More...

peak_status	peak_ROI_Get (peak_camera_handle hCam, peak_roi *roi)
	Get the ROI. More...

peak_access_status	peak_Binning_GetAccessStatus (peak_camera_handle hCam)
	Query the binning access status. More...

peak_status	peak_Binning_FactorX_GetList (peak_camera_handle hCam, uint32_t binningFactorXList, size_t binningFactorXCount)
	Get the list of currently selectable factors for the binning in x direction. More...

peak_status	peak_Binning_FactorY_GetList (peak_camera_handle hCam, uint32_t binningFactorYList, size_t binningFactorYCount)
	Get the list of currently selectable factors for the binning in y direction. More...

peak_status	peak_Binning_Set (peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
	Set the binning factors. More...

peak_status	peak_Binning_Get (peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
	Get the binning factors. More...

peak_access_status	peak_Decimation_GetAccessStatus (peak_camera_handle hCam)
	Query the decimation access status. More...

peak_status	peak_Decimation_FactorX_GetList (peak_camera_handle hCam, uint32_t decimationFactorXList, size_t decimationFactorXCount)
	Get the list of currently selectable factors for the decimation in x direction. More...

peak_status	peak_Decimation_FactorY_GetList (peak_camera_handle hCam, uint32_t decimationFactorYList, size_t decimationFactorYCount)
	Get the list of currently selectable factors for the decimation in y direction. More...

peak_status	peak_Decimation_Set (peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
	Set the decimation factors. More...

peak_status	peak_Decimation_Get (peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
	Get the decimation factors. More...

peak_access_status	peak_Mirror_LeftRight_GetAccessStatus (peak_camera_handle hCam)
	Query the left-right mirroring access status. More...

peak_status	peak_Mirror_LeftRight_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the left-right mirroring. More...

peak_bool	peak_Mirror_LeftRight_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the left-right mirroring. More...

peak_access_status	peak_Mirror_UpDown_GetAccessStatus (peak_camera_handle hCam)
	Query the up-down mirroring access status. More...

peak_status	peak_Mirror_UpDown_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the up-down mirroring. More...

peak_bool	peak_Mirror_UpDown_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the up-down mirroring. More...

peak_access_status	peak_CameraMemory_Area_GetAccessStatus (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
	Query the camera memory area access status. More...

peak_status	peak_CameraMemory_Area_GetList (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryAreaList, size_t cameraMemoryAreaCount)
	Get the list of currently usable camera memory areas. More...

peak_status	peak_CameraMemory_Area_Size_Get (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, size_t *cameraMemoryAreaSize)
	Get the size of a camera memory area. More...

peak_status	peak_CameraMemory_Area_Data_Clear (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
	Clear a camera memory area. More...

peak_status	peak_CameraMemory_Area_Data_Write (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, const uint8_t *data, size_t dataSize)
	Write to a camera memory area. More...

peak_status	peak_CameraMemory_Area_Data_Read (peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, uint8_t *data, size_t dataSize)
	Read from the specified camera memory area. More...

peak_status	peak_GFA_EnableWriteAccess (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the GFA write access. More...

peak_bool	peak_GFA_IsWriteAccessEnabled (peak_camera_handle hCam)
	Get the enabled status of the GFA write access. More...

peak_access_status	peak_GFA_Feature_GetAccessStatus (peak_camera_handle hCam, peak_gfa_module module, const char *featureName)
	Query the access status of the feature with the given name. More...

peak_bool	peak_GFA_Float_HasRange (peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName)
	Check whether the valid values for the float feature with the given name are organized as a range. More...

peak_status	peak_GFA_Float_GetRange (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double minFloatValue, double maxFloatValue, double incFloatValue)
	Get the current range of valid values for the float feature with the given name. More...

peak_status	peak_GFA_Float_GetList (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double floatList, size_t *floatCount)
	Get the list of currently selectable values for the float feature with the given name. More...

peak_status	peak_GFA_Float_Set (peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double floatValue)
	Set the float feature with the given name. More...

peak_status	peak_GFA_Float_Get (peak_camera_handle hCam, peak_gfa_module module, const char floatFeatureName, double floatValue)
	Get the float feature with the given name. More...

peak_bool	peak_GFA_Integer_HasRange (peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName)
	Check whether the valid values for the integer feature with the given name are organized as a range. More...

peak_status	peak_GFA_Integer_GetRange (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t minIntegerValue, int64_t maxIntegerValue, int64_t incIntegerValue)
	Get the current range of valid values for the integer feature with the given name. More...

peak_status	peak_GFA_Integer_GetList (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t integerList, size_t *integerCount)
	Get the list of currently selectable values for the integer feature with the given name. More...

peak_status	peak_GFA_Integer_Set (peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t integerValue)
	Set the integer feature with the given name. More...

peak_status	peak_GFA_Integer_Get (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t integerValue)
	Get the integer feature with the given name. More...

peak_status	peak_GFA_Boolean_Set (peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool booleanValue)
	Set the boolean feature with the given name. More...

peak_status	peak_GFA_Boolean_Get (peak_camera_handle hCam, peak_gfa_module module, const char booleanFeatureName, peak_bool booleanValue)
	Get the boolean feature with the given name. More...

peak_status	peak_GFA_String_Set (peak_camera_handle hCam, peak_gfa_module module, const char stringFeatureName, const char stringValue)
	Set the string feature with the given name. More...

peak_status	peak_GFA_String_Get (peak_camera_handle hCam, peak_gfa_module module, const char stringFeatureName, char stringValue, size_t *stringValueSize)
	Get the string feature with the given name. More...

peak_status	peak_GFA_Command_Execute (peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName)
	Execute the command feature with the given name. More...

peak_status	peak_GFA_Command_WaitForDone (peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName, uint32_t timeout_ms)
	Wait for the execution of the command feature with the given name to be done. More...

peak_status	peak_GFA_Enumeration_GetList (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, peak_gfa_enumeration_entry enumerationEntryList, size_t *enumerationEntryCount)
	Get the list of currently selectable enumeration entries. More...

peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatus (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, const peak_gfa_enumeration_entry enumerationEntry)
	Query the access status of the enumeration entry. More...

peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, const char enumerationEntrySymbolicValue)
	Query the access status of the enumeration entry by its symbolic value. More...

peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
	Query the access status of the enumeration entry by its integer value. More...

peak_status	peak_GFA_Enumeration_Set (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, const peak_gfa_enumeration_entry enumerationEntry)
	Set the enumeration feature with the given name. More...

peak_status	peak_GFA_Enumeration_SetBySymbolicValue (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, const char enumerationEntrySymbolicValue)
	Set the enumeration feature with the given name by the entries symbolic value. More...

peak_status	peak_GFA_Enumeration_SetByIntegerValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
	Set the enumeration feature with the given name by the entries integer value. More...

peak_status	peak_GFA_Enumeration_Get (peak_camera_handle hCam, peak_gfa_module module, const char enumerationFeatureName, peak_gfa_enumeration_entry enumerationEntry)
	Get the enumeration feature with the given name. More...

peak_status	peak_GFA_Register_Set (peak_camera_handle hCam, peak_gfa_module module, const char registerFeatureName, const uint8_t registerValue, size_t registerValueSize)
	Set the register feature with the given name. More...

peak_status	peak_GFA_Register_Get (peak_camera_handle hCam, peak_gfa_module module, const char registerFeatureName, uint8_t registerValue, size_t *registerValueSize)
	Get the register feature with the given name. More...

peak_status	peak_GFA_Data_Write (peak_camera_handle hCam, peak_gfa_module module, uint64_t address, const uint8_t *data, size_t dataSize)
	Write data to the specified register address. More...

peak_status	peak_GFA_Data_Read (peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t *data, size_t dataSize)
	Read data from the specified register address. More...

peak_status	peak_IPL_PixelFormat_GetList (peak_camera_handle hCam, peak_pixel_format inputPixelFormat, peak_pixel_format outputPixelFormatList, size_t outputPixelFormatCount)
	Get a list of supported output pixel formats for a specific input pixelformat. More...

peak_status	peak_IPL_PixelFormat_Set (peak_camera_handle hCam, peak_pixel_format pixelFormat)
	Set the output pixel format for host processing. More...

peak_status	peak_IPL_PixelFormat_Get (peak_camera_handle hCam, peak_pixel_format *pixelFormat)
	Get the output pixel format of the host processing. More...

peak_status	peak_IPL_Gain_GetRange (peak_camera_handle hCam, peak_gain_channel gainChannel, double minGain, double maxGain, double *incGain)
	Get the current range of valid host gain values for the specified gain channel. More...

peak_status	peak_IPL_Gain_Set (peak_camera_handle hCam, peak_gain_channel gainChannel, double gain)
	Set the host gain for the specified gain channel. More...

peak_status	peak_IPL_Gain_Get (peak_camera_handle hCam, peak_gain_channel gainChannel, double *gain)
	Get the host gain value for the specified gain channel. More...

peak_status	peak_IPL_Gamma_GetRange (peak_camera_handle hCam, double minGamma, double maxGamma, double *incGamma)
	Get the current range of valid host gamma values. More...

peak_status	peak_IPL_Gamma_Set (peak_camera_handle hCam, double gamma)
	Set the host gamma value. More...

peak_status	peak_IPL_Gamma_Get (peak_camera_handle hCam, double *gamma)
	Get the host gamma value. More...

peak_status	peak_IPL_ColorCorrection_Matrix_Set (peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
	Sets the cost color correction matrix. More...

peak_status	peak_IPL_ColorCorrection_Matrix_Get (peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
	Get the host color correction matrix. More...

peak_status	peak_IPL_ColorCorrection_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the host color correction. More...

peak_bool	peak_IPL_ColorCorrection_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the host color correction. More...

peak_status	peak_IPL_AutoBrightness_Target_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTarget, uint32_t maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
	Get the current range of valid host auto brightness target values. More...

peak_status	peak_IPL_AutoBrightness_Target_Set (peak_camera_handle hCam, uint32_t autoBrightnessTarget)
	Set the host auto brightness target value. More...

peak_status	peak_IPL_AutoBrightness_Target_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
	Get the host auto brightness target value. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_GetRange (peak_camera_handle hCam, uint32_t minAutoBrightnessTargetTolerance, uint32_t maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
	Get the current range of valid host auto brightness target tolerance values. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_Set (peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
	Set the host auto brightness target tolerance value. More...

peak_status	peak_IPL_AutoBrightness_TargetTolerance_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
	Get the host auto brightness target tolerance value. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_GetRange (peak_camera_handle hCam, double minAutoBrightnessTargetPercentile, double maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
	Get the current range of valid host auto brightness target percentile values. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_Set (peak_camera_handle hCam, double autoBrightnessTargetPercentile)
	Set the host auto brightness target percentile value. More...

peak_status	peak_IPL_AutoBrightness_TargetPercentile_Get (peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
	Get the host auto brightness target percentile value. More...

peak_status	peak_IPL_AutoBrightness_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
	Set the host auto brightness ROI mode. More...

peak_status	peak_IPL_AutoBrightness_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
	Get the host auto brightness ROI mode. More...

peak_status	peak_IPL_AutoBrightness_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoBrightnessROIOffset, peak_position maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
	Get the current range of valid host auto brightness ROI offsets. More...

peak_status	peak_IPL_AutoBrightness_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoBrightnessROISize, peak_size maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
	Get the current range of valid host auto brightness ROI sizes. More...

peak_status	peak_IPL_AutoBrightness_ROI_Set (peak_camera_handle hCam, peak_roi autoBrightnessROI)
	Set the host auto brightness ROI. More...

peak_status	peak_IPL_AutoBrightness_ROI_Get (peak_camera_handle hCam, peak_roi *autoBrightnessROI)
	Get the host auto brightness ROI. More...

peak_status	peak_IPL_AutoBrightness_Exposure_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
	Set the host auto exposure control mode. More...

peak_status	peak_IPL_AutoBrightness_Exposure_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
	Get the host auto exposure control mode. More...

peak_status	peak_IPL_AutoBrightness_Gain_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
	Set the host auto gain control mode. More...

peak_status	peak_IPL_AutoBrightness_Gain_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
	Get the host auto gain control mode. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
	Set the host auto white balance ROI mode. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
	Get the host auto white balance ROI mode. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoWhiteBalanceROIOffset, peak_position maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
	Get the current range of valid host auto white balance ROI offsets. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoWhiteBalanceROISize, peak_size maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
	Get the current range of valid host auto white balance ROI sizes. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Set (peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
	Set the host auto white balance ROI. More...

peak_status	peak_IPL_AutoWhiteBalance_ROI_Get (peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
	Get the host auto white balance ROI. More...

peak_status	peak_IPL_AutoWhiteBalance_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
	Set the host auto white balance control mode. More...

peak_status	peak_IPL_AutoWhiteBalance_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
	Get the host auto white balance control mode. More...

peak_status	peak_IPL_HotpixelCorrection_Sensitivity_Set (peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
	Set the host hotpixel correction sensitivity level. More...

peak_status	peak_IPL_HotpixelCorrection_Sensitivity_Get (peak_camera_handle hCam, peak_hotpixel_correction_sensitivity *hotpixelCorrectionSensitivity)
	Get the host hotpixel correction sensitivity level. More...

peak_status	peak_IPL_HotpixelCorrection_GetList (peak_camera_handle hCam, peak_position hotpixelList, size_t hotpixelCount)
	Get the list of detected host hotpixel correction positions/pixels. More...

peak_status	peak_IPL_HotpixelCorrection_SetList (peak_camera_handle hCam, peak_position *hotpixelList, size_t hotpixelCount)
	Set the list of host hotpixel positions. More...

peak_status	peak_IPL_HotpixelCorrection_ResetList (peak_camera_handle hCam)
	Reset the list of host hotpixel positions. More...

peak_status	peak_IPL_HotpixelCorrection_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the host hotpixel correction. More...

peak_bool	peak_IPL_HotpixelCorrection_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the host hotpixel correction. More...

peak_status	peak_IPL_Mirror_UpDown_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the up-down host mirroring. More...

peak_bool	peak_IPL_Mirror_UpDown_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the up-down host mirroring. More...

peak_status	peak_IPL_Mirror_LeftRight_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the left-right host mirroring. More...

peak_bool	peak_IPL_Mirror_LeftRight_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the left-right host mirroring. More...

peak_status	peak_IPL_ProcessFrame (peak_camera_handle hCam, peak_frame_handle hFrame, peak_frame_handle *hResultFrame)
	Process a frame with the host image processing pipeline and store the result in a new frame. More...

peak_status	peak_IPL_ProcessFrameInplace (peak_camera_handle hCam, peak_frame_handle hFrame)
	Process a frame with the host image processing pipeline and replace the original frame. More...

peak_status	peak_VideoWriter_Open (peak_video_handle hVideo, const char fileName, peak_video_container container, peak_video_encoder encoder)
	Opens a video file with the given file name. More...

peak_status	peak_VideoWriter_Close (peak_video_handle hVideo)
	Closes a video file. More...

peak_status	peak_VideoWriter_AddFrame (peak_video_handle hVideo, peak_frame_handle hFrame)
	Writes a image frame into the video file. More...

peak_status	peak_VideoWriter_Container_GetEncoderList (peak_video_container container, peak_video_encoder encoderList, size_t encoderCount)
	Get the list of currently usable encoders. More...

peak_status	peak_VideoWriter_Encoder_GetPixelFormatList (peak_video_encoder encoder, peak_pixel_format pixelFormatList, size_t pixelFormatCount)
	Get the list of currently selectable pixel formats. More...

peak_status	peak_VideoWriter_Encoder_GetContainerList (peak_video_encoder encoder, peak_video_container containerList, size_t containerCount)
	Get the list of currently usable containers. More...

peak_status	peak_VideoWriter_GetInfo (peak_video_handle hVideo, peak_video_info *videoInfo)
	Get information from the video stream. More...

peak_status	peak_VideoWriter_Container_Option_Set (peak_video_handle hVideo, peak_video_container_option containerOption, const void *value, size_t count)
	Set additional container options. More...

peak_status	peak_VideoWriter_Container_Option_Get (peak_video_handle hVideo, peak_video_container_option containerOption, void value, size_t count, size_t outCount)
	Get container options. More...

peak_status	peak_VideoWriter_Encoder_Option_Set (peak_video_handle hVideo, peak_video_encoder_option encoderOption, const void *value, size_t count)
	Set additional encoder options. More...

peak_status	peak_VideoWriter_Encoder_Option_Get (peak_video_handle hVideo, peak_video_encoder_option encoderOption, void value, size_t count, size_t outCount)
	Get encoder options. More...

peak_status	peak_VideoWriter_WaitUntilQueueEmpty (peak_video_handle hVideo, int32_t timeout_ms)
	Wait until queue is empty. More...

Detailed Description

Interface definition file for IDS peak comfortC.

Function Documentation

◆ peak_Decimation_GetAccessStatus()

peak_access_status peak_Decimation_GetAccessStatus ( peak_camera_handle hCam )

Query the decimation access status.

Provides the current access status for the decimation feature.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The decimation feature is readable and writeable.; PEAK_ACCESS_READONLY The decimation feature is readable only.; PEAK_ACCESS_GFA_LOCK The decimation feature is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The decimation feature is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The decimation feature is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
PEAK_STATUS_ERROR An unexpected internal error occurred.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ peak_Decimation_GetAccessStatus()