Data Structures
struct	_TAG_PVCAM_FRAME_INFO_GUID

struct	_TAG_FRAME_INFO

struct	smart_stream_type

struct	rgn_type

struct	io_struct

struct	io_list

struct	active_camera_type

struct	md_frame_header

struct	md_frame_header_v3

struct	md_frame_roi_header

struct	md_ext_item_info

struct	md_ext_item

struct	md_ext_item_collection

struct	md_frame_roi

struct	md_frame

Macros
#define	MAX_CAM 16

#define	CAM_NAME_LEN 32

#define	PARAM_NAME_LEN 32

#define	ERROR_MSG_LEN 255

#define	CCD_NAME_LEN 17

#define	MAX_ALPHA_SER_NUM_LEN 32

#define	MAX_PP_NAME_LEN 32

#define	MAX_SYSTEM_NAME_LEN 32

#define	MAX_VENDOR_NAME_LEN 32

#define	MAX_PRODUCT_NAME_LEN 32

#define	MAX_CAM_PART_NUM_LEN 32

#define	MAX_GAIN_NAME_LEN 32

#define	MAX_SPDTAB_NAME_LEN 32

#define	MAX_CAM_SYSTEMS_INFO_LEN 1024

#define	PP_MAX_PARAMETERS_PER_FEATURE 10

#define	PL_MD_FRAME_SIGNATURE 5328208

#define	PL_MD_EXT_TAGS_MAX_SUPPORTED 255

#define	CLASS0 0 /* Camera Communications */

#define	CLASS2 2 /* Configuration/Setup */

#define	CLASS3 3 /* Data Acquisition */

#define	PARAM_DD_INFO_LENGTH ((CLASS0<<16) + (TYPE_INT16<<24) + 1)
	Returns the length of an information message for each device driver. More...

#define	PARAM_DD_VERSION ((CLASS0<<16) + (TYPE_UNS16<<24) + 2)
	Returns a version number for the device driver used to access the camera. More...

#define	PARAM_DD_RETRIES ((CLASS0<<16) + (TYPE_UNS16<<24) + 3)
	Reads/sets the maximum number of command retransmission attempts that are allowed. More...

#define	PARAM_DD_TIMEOUT ((CLASS0<<16) + (TYPE_UNS16<<24) + 4)
	Reads/sets the maximum time the driver waits for acknowledgment. More...

#define	PARAM_DD_INFO ((CLASS0<<16) + (TYPE_CHAR_PTR<<24) + 5)
	Returns an information message for each device. More...

#define	PARAM_CAM_INTERFACE_TYPE ((CLASS0<<16) + (TYPE_ENUM<<24) + 10)
	Returns a list of camera communication interfaces. More...

#define	PARAM_CAM_INTERFACE_MODE ((CLASS0<<16) + (TYPE_ENUM<<24) + 11)
	Returns a list of camera communication interface modes. More...

#define	PARAM_ADC_OFFSET ((CLASS2<<16) + (TYPE_INT16<<24) + 195)
	Bias offset voltage. More...

#define	PARAM_CHIP_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 129)
	The name of the sensor. More...

#define	PARAM_SYSTEM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 130)
	The name of the system. More...

#define	PARAM_VENDOR_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 131)
	The name of the vendor. More...

#define	PARAM_PRODUCT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 132)
	The name of the product. More...

#define	PARAM_CAMERA_PART_NUMBER ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 133)
	The part number of the camera. More...

#define	PARAM_COOLING_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 214)
	This is the type of cooling used by the current camera. More...

#define	PARAM_PREAMP_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 502)
	The number of milliseconds required for the sensor output preamp to stabilize, after it is turned on. More...

#define	PARAM_COLOR_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 504)
	The color mode of the sensor. More...

#define	PARAM_MPP_CAPABLE ((CLASS2<<16) + (TYPE_ENUM<<24) + 224)
	Indicates whether this sensor runs in MPP mode. More...

#define	PARAM_PREAMP_OFF_CONTROL ((CLASS2<<16) + (TYPE_UNS32<<24) + 507)
	The exposure time limit in milliseconds above which the preamp is turned off during exposure. More...

#define	PARAM_PREMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 53)
	The number of masked lines at the near end of the parallel register. More...

#define	PARAM_PRESCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 55)
	The number of pixels discarded from the serial register before the first real data pixel. More...

#define	PARAM_POSTMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 54)
	The number of masked lines at the far end of the parallel register. More...

#define	PARAM_POSTSCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 56)
	The number of pixels to discard from the serial register after the last real data pixel. More...

#define	PARAM_PIX_PAR_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 500)
	This is the center-to-center distance between pixels in the parallel direction. More...

#define	PARAM_PIX_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 63)
	This is the size of the active area of a pixel, in the parallel direction. More...

#define	PARAM_PIX_SER_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 501)
	This is the center-to-center distance between pixels in the serial direction. More...

#define	PARAM_PIX_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 62)
	This is the size of the active area of a pixel in the serial direction. More...

#define	PARAM_SUMMING_WELL ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 505)
	Checks to see if the summing well exists. More...

#define	PARAM_FWELL_CAPACITY ((CLASS2<<16) + (TYPE_UNS32<<24) + 506)
	Gets the full-well capacity of this sensor, measured in electrons. More...

#define	PARAM_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 57)
	The parallel size of the sensor chip, in active rows. More...

#define	PARAM_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 58)
	The serial size of the sensor chip, in active columns. More...

#define	PARAM_ACCUM_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 538)
	Returns `TRUE` for ATTR_AVAIL if the camera has accumulation capability. More...

#define	PARAM_FLASH_DWNLD_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 539)
	Reports if the camera supports firmware download. More...

#define	PARAM_READOUT_TIME ((CLASS2<<16) + (TYPE_FLT64<<24) + 179)
	Time it will take to read out the image from the sensor with the current camera settings, in microseconds. More...

#define	PARAM_CLEARING_TIME ((CLASS2<<16) + (TYPE_INT64<<24) + 180)
	This parameter reports the time needed to clear the sensor. More...

#define	PARAM_POST_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 181)
	Post-trigger delay, in nanoseconds. More...

#define	PARAM_PRE_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 182)
	Pre-trigger delay, in nanoseconds. More...

#define	PARAM_CLEAR_CYCLES ((CLASS2<<16) + (TYPE_UNS16<<24) + 97)
	Number of clear cycles. More...

#define	PARAM_CLEAR_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 523)
	Defines when clearing takes place. More...

#define	PARAM_FRAME_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 509)
	Reports frame transfer capability. More...

#define	PARAM_PMODE ((CLASS2<<16) + (TYPE_ENUM <<24) + 524)
	Parallel clocking method. More...

#define	PARAM_TEMP ((CLASS2<<16) + (TYPE_INT16<<24) + 525)
	Returns the current measured temperature of the sensor in hundredths of degrees Celsius. More...

#define	PARAM_TEMP_SETPOINT ((CLASS2<<16) + (TYPE_INT16<<24) + 526)
	Sets the desired sensor temperature in hundredths of degrees Celsius. More...

#define	PARAM_CAM_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 532)
	Returns the firmware version of the camera, as a hexadecimal number. More...

#define	PARAM_HEAD_SER_NUM_ALPHA ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 533)
	Returns the alphanumeric serial number for the camera head. More...

#define	PARAM_PCI_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 534)
	Returns the version number of the PCI firmware. More...

#define	PARAM_FAN_SPEED_SETPOINT ((CLASS2<<16) + (TYPE_ENUM<<24) + 710)
	Sets and gets the desired fan speed. More...

#define	PARAM_CAM_SYSTEMS_INFO ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 536)
	Returns description of all camera nodes. More...

#define	PARAM_EXPOSURE_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 535)
	The exposure/triggering mode. More...

#define	PARAM_EXPOSE_OUT_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 560)
	The expose-out mode. More...

#define	PARAM_BIT_DEPTH ((CLASS2<<16) + (TYPE_INT16<<24) + 511)
	Pixel sample range in number of bits for the currently configured acquisition. More...

#define	PARAM_IMAGE_FORMAT ((CLASS2<<16) + (TYPE_ENUM<<24) + 248)
	Native image format of the camera pixel stream. More...

#define	PARAM_IMAGE_COMPRESSION ((CLASS2<<16) + (TYPE_ENUM<<24) + 249)
	Native image compression of the camera pixel stream. More...

#define	PARAM_SCAN_MODE ((CLASS3<<16) + (TYPE_ENUM<<24) + 250)
	Scan mode of the camera. More...

#define	PARAM_SCAN_DIRECTION ((CLASS3<<16) + (TYPE_ENUM<<24) + 251)
	Scan direction of the camera. More...

#define	PARAM_SCAN_DIRECTION_RESET ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 252)
	Scan direction reset state. More...

#define	PARAM_SCAN_LINE_DELAY ((CLASS3<<16) + (TYPE_UNS16<<24) + 253)
	Scan line delay value of the camera. More...

#define	PARAM_SCAN_LINE_TIME ((CLASS3<<16) + (TYPE_INT64<<24) + 254)
	Scan line time of the camera. More...

#define	PARAM_SCAN_WIDTH ((CLASS3<<16) + (TYPE_UNS16<<24) + 255)
	Scan width in number of lines. More...

#define	PARAM_FRAME_ROTATE ((CLASS2<<16) + (TYPE_ENUM<<24) + 256)
	Virtual frame rotation mode. More...

#define	PARAM_FRAME_FLIP ((CLASS2<<16) + (TYPE_ENUM<<24) + 257)
	Virtual frame flipping mode. More...

#define	PARAM_GAIN_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 512)
	Gain setting for the current speed choice. More...

#define	PARAM_SPDTAB_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 513)
	Selects the sensor readout speed from a table of available choices. More...

#define	PARAM_GAIN_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 514)
	Name of the currently selected Gain (via PARAM_GAIN_INDEX). More...

#define	PARAM_SPDTAB_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 515)
	Name of the currently selected Speed (via PARAM_SPDTAB_INDEX). More...

#define	PARAM_READOUT_PORT ((CLASS2<<16) + (TYPE_ENUM<<24) + 247)
	Sensor readout port being used by the currently selected speed. More...

#define	PARAM_PIX_TIME ((CLASS2<<16) + (TYPE_UNS16<<24) + 516)
	This is the actual speed for the currently selected speed choice. More...

#define	PARAM_SHTR_CLOSE_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 519)
	The shutter close delay. More...

#define	PARAM_SHTR_OPEN_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 520)
	The shutter open delay. More...

#define	PARAM_SHTR_OPEN_MODE ((CLASS2<<16) + (TYPE_ENUM <<24) + 521)
	The shutter opening condition. More...

#define	PARAM_SHTR_STATUS ((CLASS2<<16) + (TYPE_ENUM <<24) + 522)
	The state of the camera shutter. More...

#define	PARAM_IO_ADDR ((CLASS2<<16) + (TYPE_UNS16<<24) + 527)
	Sets and gets the currently active I/O address. More...

#define	PARAM_IO_TYPE ((CLASS2<<16) + (TYPE_ENUM<<24) + 528)
	Gets the type of I/O available at the current address. More...

#define	PARAM_IO_DIRECTION ((CLASS2<<16) + (TYPE_ENUM<<24) + 529)
	Gets the direction of the signal at the current address. More...

#define	PARAM_IO_STATE ((CLASS2<<16) + (TYPE_FLT64<<24) + 530)
	Sets and gets the state of the currently active I/O signal. More...

#define	PARAM_IO_BITDEPTH ((CLASS2<<16) + (TYPE_UNS16<<24) + 531)
	Gets the bit depth for the signal at the current address. More...

#define	PARAM_GAIN_MULT_FACTOR ((CLASS2<<16) + (TYPE_UNS16<<24) + 537)
	Gain multiplication factor for cameras with multiplication gain functionality. More...

#define	PARAM_GAIN_MULT_ENABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 541)
	Gain multiplier on/off indicator for cameras with the multiplication gain functionality. More...

#define	PARAM_PP_FEAT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 542)
	This returns the name of the currently-selected post-processing feature. More...

#define	PARAM_PP_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 543)
	This selects the current post-processing feature from a table of available choices. More...

#define	PARAM_ACTUAL_GAIN ((CLASS2<<16) + (TYPE_UNS16<<24) + 544)
	Gets the actual e/ADU for the current gain setting. More...

#define	PARAM_PP_PARAM_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 545)
	This selects the current post-processing parameter from a table of available choices. More...

#define	PARAM_PP_PARAM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 546)
	Gets the name of the currently-selected post-processing parameter for the currently-selected post-processing feature. More...

#define	PARAM_PP_PARAM ((CLASS2<<16) + (TYPE_UNS32<<24) + 547)
	This gets or sets the post-processing parameter for the currently-selected post-processing parameter in the index. More...

#define	PARAM_READ_NOISE ((CLASS2<<16) + (TYPE_UNS16<<24) + 548)
	Gets the read noise for the current speed. More...

#define	PARAM_PP_FEAT_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 549)
	This returns the ID of the currently-selected post-processing feature. More...

#define	PARAM_PP_PARAM_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 550)
	This returns the ID of the currently-selected post-processing parameter. More...

#define	PARAM_SMART_STREAM_MODE_ENABLED ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 700)
	This parameter allows the user to retrieve or set the state of the S.M.A.R.T. streaming mode. More...

#define	PARAM_SMART_STREAM_MODE ((CLASS2<<16) + (TYPE_UNS16<<24) + 701)
	This parameter allows the user to select between available S.M.A.R.T. streaming modes. More...

#define	PARAM_SMART_STREAM_EXP_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 702)
	This parameter allows to set or read the current exposure parameters for S.M.A.R.T. streaming. More...

#define	PARAM_SMART_STREAM_DLY_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 703)
	This parameter allows to set or read the current delays between exposures in S.M.A.R.T. streaming. More...

#define	PARAM_EXP_TIME ((CLASS3<<16) + (TYPE_UNS16<<24) + 1)
	Used to examine and change the exposure time in VTM only. More...

#define	PARAM_EXP_RES ((CLASS3<<16) + (TYPE_ENUM<<24) + 2)
	Gets the exposure resolution for the current resolution index. More...

#define	PARAM_EXP_RES_INDEX ((CLASS3<<16) + (TYPE_UNS16<<24) + 4)
	Gets and sets the index into the exposure resolution table. More...

#define	PARAM_EXPOSURE_TIME ((CLASS3<<16) + (TYPE_UNS64<<24) + 8)
	Used to examine current exposure time and range of valid values. More...

#define	PARAM_BOF_EOF_ENABLE ((CLASS3<<16) + (TYPE_ENUM<<24) + 5)
	Enables and configures the BOF/EOF interrupts. More...

#define	PARAM_BOF_EOF_COUNT ((CLASS3<<16) + (TYPE_UNS32<<24) + 6)
	Returns the Begin-Of-Frame and/or End-Of-Frame count. More...

#define	PARAM_BOF_EOF_CLR ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 7)
	Clears the BOF/EOF count when a pl_set_param is performed. More...

#define	PARAM_CIRC_BUFFER ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 299)
	Tests to see if the hardware/software can perform circular buffer. More...

#define	PARAM_FRAME_BUFFER_SIZE ((CLASS3<<16) + (TYPE_UNS64<<24) + 300)
	Retrieves the min, max, current and recommended (default) buffer size in bytes. More...

#define	PARAM_BINNING_SER ((CLASS3<<16) + (TYPE_ENUM<<24) + 165)
	Used to obtain serial part of serial x parallel binning factors permutations. More...

#define	PARAM_BINNING_PAR ((CLASS3<<16) + (TYPE_ENUM<<24) + 166)
	Used to obtain parallel part of serial x parallel binning factors permutations. More...

#define	PARAM_METADATA_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 168)
	Parameter used to enable or disable the embedded frame metadata feature. More...

#define	PARAM_METADATA_RESET_TIMESTAMP ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 176)
	Resets the camera-generated metadata timestamp. More...

#define	PARAM_ROI_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 169)
	The number of currently configured ROIs. More...

#define	PARAM_CENTROIDS_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 170)
	This parameter is used to enable or disable the Centroids/Object detection feature. More...

#define	PARAM_CENTROIDS_RADIUS ((CLASS3<<16) + (TYPE_UNS16 <<24) + 171)
	This parameter is used to set the Centroid radius. More...

#define	PARAM_CENTROIDS_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 172)
	Deals with number of Centroids. More...

#define	PARAM_CENTROIDS_MODE ((CLASS3<<16) + (TYPE_ENUM <<24) + 173)
	This parameter is used to retrieve and control the camera Centroid/Object detection modes. More...

#define	PARAM_CENTROIDS_BG_COUNT ((CLASS3<<16) + (TYPE_ENUM <<24) + 174)
	Supported Centroids background frame processing count. More...

#define	PARAM_CENTROIDS_THRESHOLD ((CLASS3<<16) + (TYPE_UNS32 <<24) + 175)
	Used to configure threshold multiplier for specific object detection modes. More...

#define	PARAM_TRIGTAB_SIGNAL ((CLASS3<<16) + (TYPE_ENUM<<24) + 180)
	Used to select the output signal to be configured. More...

#define	PARAM_LAST_MUXED_SIGNAL ((CLASS3<<16) + (TYPE_UNS8<<24) + 181)
	Used to set the number of active output signals. More...

#define	PARAM_FRAME_DELIVERY_MODE ((CLASS3<<16) + (TYPE_ENUM <<24) + 400)
	Deals with frame delivery modes. More...


#define	MS16_BYTE(two_byte_value) ((uns8)(((uns16)(two_byte_value) >> 8) & 0xFF))

#define	LS16_BYTE(two_byte_value) ((uns8)(((uns16)(two_byte_value) >> 0) & 0xFF))

#define	MS32_BYTE(four_byte_value) ((uns8)(((uns32)(four_byte_value) >> 24) & 0xFF))

#define	MH32_BYTE(four_byte_value) ((uns8)(((uns32)(four_byte_value) >> 16) & 0xFF))

#define	ML32_BYTE(four_byte_value) ((uns8)(((uns32)(four_byte_value) >> 8) & 0xFF))

#define	LS32_BYTE(four_byte_value) ((uns8)(((uns32)(four_byte_value) >> 0) & 0xFF))

#define	VAL_UNS16(ms_byte, ls_byte)

#define	VAL_UNS32(ms_byte, mh_byte, ml_byte, ls_byte)

#define	VAL_INT64(b0, b1, b2, b3, b4, b5, b6, b7)


#define	TYPE_INT16 1

#define	TYPE_INT32 2

#define	TYPE_FLT64 4

#define	TYPE_UNS8 5

#define	TYPE_UNS16 6

#define	TYPE_UNS32 7

#define	TYPE_UNS64 8

#define	TYPE_ENUM 9

#define	TYPE_BOOLEAN 11

#define	TYPE_INT8 12

#define	TYPE_CHAR_PTR 13

#define	TYPE_VOID_PTR 14

#define	TYPE_VOID_PTR_PTR 15

#define	TYPE_INT64 16

#define	TYPE_SMART_STREAM_TYPE 17

#define	TYPE_SMART_STREAM_TYPE_PTR 18

#define	TYPE_FLT32 19

Typedefs
typedef struct _TAG_PVCAM_FRAME_INFO_GUID	PVCAM_FRAME_INFO_GUID

typedef struct _TAG_FRAME_INFO	FRAME_INFO

typedef enum PL_OPEN_MODES	PL_OPEN_MODES

typedef enum PL_COOL_MODES	PL_COOL_MODES

typedef enum PL_MPP_MODES	PL_MPP_MODES

typedef enum PL_SHTR_MODES	PL_SHTR_MODES

typedef enum PL_PMODES	PL_PMODES

typedef enum PL_COLOR_MODES	PL_COLOR_MODES

typedef enum PL_IMAGE_FORMATS	PL_IMAGE_FORMATS

typedef enum PL_IMAGE_COMPRESSIONS	PL_IMAGE_COMPRESSIONS

typedef enum PL_FRAME_ROTATE_MODES	PL_FRAME_ROTATE_MODES

typedef enum PL_FRAME_FLIP_MODES	PL_FRAME_FLIP_MODES

typedef enum PL_PARAM_ATTRIBUTES	PL_PARAM_ATTRIBUTES

typedef enum PL_PARAM_ACCESS	PL_PARAM_ACCESS

typedef enum PL_IO_TYPE	PL_IO_TYPE

typedef enum PL_IO_DIRECTION	PL_IO_DIRECTION

typedef enum PL_READOUT_PORTS	PL_READOUT_PORTS

typedef enum PL_CLEAR_MODES	PL_CLEAR_MODES

typedef enum PL_SHTR_OPEN_MODES	PL_SHTR_OPEN_MODES

typedef enum PL_EXPOSURE_MODES	PL_EXPOSURE_MODES

typedef enum PL_SW_TRIG_STATUSES	PL_SW_TRIG_STATUSES

typedef enum PL_EXPOSE_OUT_MODES	PL_EXPOSE_OUT_MODES

typedef enum PL_FAN_SPEEDS	PL_FAN_SPEEDS

typedef enum PL_TRIGTAB_SIGNALS	PL_TRIGTAB_SIGNALS

typedef enum PL_FRAME_DELIVERY_MODES	PL_FRAME_DELIVERY_MODES

typedef enum PL_CAM_INTERFACE_TYPES	PL_CAM_INTERFACE_TYPES

typedef enum PL_CAM_INTERFACE_MODES	PL_CAM_INTERFACE_MODES

typedef enum PL_CENTROIDS_MODES	PL_CENTROIDS_MODES

typedef enum PL_SCAN_MODES	PL_SCAN_MODES

typedef enum PL_SCAN_DIRECTIONS	PL_SCAN_DIRECTIONS

typedef enum PP_FEATURE_IDS	PP_FEATURE_IDS

typedef enum PP_PARAMETER_IDS	PP_PARAMETER_IDS

typedef struct smart_stream_type	smart_stream_type

typedef enum PL_SMT_MODES	PL_SMT_MODES

typedef enum PL_IMAGE_STATUSES	PL_IMAGE_STATUSES

typedef enum PL_CCS_ABORT_MODES	PL_CCS_ABORT_MODES

typedef enum PL_IRQ_MODES	PL_IRQ_MODES

typedef enum PL_CIRC_MODES	PL_CIRC_MODES

typedef enum PL_EXP_RES_MODES	PL_EXP_RES_MODES

typedef enum PL_SRC_MODES	PL_SRC_MODES

typedef enum PL_CALLBACK_EVENT	PL_CALLBACK_EVENT

typedef struct rgn_type	rgn_type

typedef struct io_struct	io_entry

typedef struct io_list	io_list

typedef struct active_camera_type	active_camera_type

typedef enum PL_MD_FRAME_FLAGS	PL_MD_FRAME_FLAGS

typedef enum PL_MD_ROI_FLAGS	PL_MD_ROI_FLAGS

typedef struct md_frame_header	md_frame_header

typedef struct md_frame_header_v3	md_frame_header_v3

typedef struct md_frame_roi_header	md_frame_roi_header

typedef enum PL_MD_EXT_TAGS	PL_MD_EXT_TAGS

typedef struct md_ext_item_info	md_ext_item_info

typedef struct md_ext_item	md_ext_item

typedef struct md_ext_item_collection	md_ext_item_collection

typedef struct md_frame_roi	md_frame_roi

typedef struct md_frame	md_frame

typedef PVCAM_FRAME_INFO_GUID *	PPVCAM_FRAME_INFO_GUID

typedef FRAME_INFO *	PFRAME_INFO

typedef smart_stream_type *	smart_stream_type_ptr

typedef rgn_type *	rgn_ptr

typedef const rgn_type *	rgn_const_ptr

typedef io_entry *	io_entry_ptr

typedef io_list *	io_list_ptr

typedef io_list **	io_list_ptr_ptr

typedef active_camera_type *	active_camera_ptr

typedef int16	pm_script_hook(int16 hcam, uns16 exp_total, uns16 rgn_total, const rgn_type rgn_array, int16 mode, uns32 exposure_time, uns32 pixels, active_camera_type *active_camera)

typedef void(PV_DECL *	PL_CALLBACK_SIG_LEGACY) (void)

typedef void(PV_DECL *	PL_CALLBACK_SIG_EX) (void *pContext)

typedef void(PV_DECL *	PL_CALLBACK_SIG_EX2) (const FRAME_INFO *pFrameInfo)

typedef void(PV_DECL *	PL_CALLBACK_SIG_EX3) (const FRAME_INFO pFrameInfo, void pContext)

Enumerations
enum	PL_OPEN_MODES { OPEN_EXCLUSIVE }

enum	PL_COOL_MODES { NORMAL_COOL, CRYO_COOL, NO_COOL }

enum	PL_MPP_MODES { MPP_UNKNOWN, MPP_ALWAYS_OFF, MPP_ALWAYS_ON, MPP_SELECTABLE }

enum	PL_SHTR_MODES { SHTR_FAULT, SHTR_OPENING, SHTR_OPEN, SHTR_CLOSING, SHTR_CLOSED, SHTR_UNKNOWN }

enum	PL_PMODES { PMODE_NORMAL, PMODE_FT, PMODE_MPP, PMODE_FT_MPP, PMODE_ALT_NORMAL, PMODE_ALT_FT, PMODE_ALT_MPP, PMODE_ALT_FT_MPP }

enum	PL_COLOR_MODES { COLOR_NONE = 0, COLOR_RESERVED = 1, COLOR_RGGB = 2, COLOR_GRBG, COLOR_GBRG, COLOR_BGGR }

enum	PL_IMAGE_FORMATS { PL_IMAGE_FORMAT_MONO16 = 0, PL_IMAGE_FORMAT_BAYER16, PL_IMAGE_FORMAT_MONO8, PL_IMAGE_FORMAT_BAYER8, PL_IMAGE_FORMAT_MONO24, PL_IMAGE_FORMAT_BAYER24, PL_IMAGE_FORMAT_RGB24, PL_IMAGE_FORMAT_RGB48, PL_IMAGE_FORMAT_RGB72, PL_IMAGE_FORMAT_MONO32, PL_IMAGE_FORMAT_BAYER32 }

enum	PL_IMAGE_COMPRESSIONS { PL_IMAGE_COMPRESSION_NONE = 0, PL_IMAGE_COMPRESSION_RESERVED8 = 8, PL_IMAGE_COMPRESSION_BITPACK9, PL_IMAGE_COMPRESSION_BITPACK10, PL_IMAGE_COMPRESSION_BITPACK11, PL_IMAGE_COMPRESSION_BITPACK12, PL_IMAGE_COMPRESSION_BITPACK13, PL_IMAGE_COMPRESSION_BITPACK14, PL_IMAGE_COMPRESSION_BITPACK15, PL_IMAGE_COMPRESSION_RESERVED16 = 16, PL_IMAGE_COMPRESSION_BITPACK17, PL_IMAGE_COMPRESSION_BITPACK18, PL_IMAGE_COMPRESSION_RESERVED24 = 24, PL_IMAGE_COMPRESSION_RESERVED32 = 32 }

enum	PL_FRAME_ROTATE_MODES { PL_FRAME_ROTATE_MODE_NONE = 0, PL_FRAME_ROTATE_MODE_90CW, PL_FRAME_ROTATE_MODE_180CW, PL_FRAME_ROTATE_MODE_270CW }

enum	PL_FRAME_FLIP_MODES { PL_FRAME_FLIP_MODE_NONE = 0, PL_FRAME_FLIP_MODE_X, PL_FRAME_FLIP_MODE_Y, PL_FRAME_FLIP_MODE_XY }

enum	PL_PARAM_ATTRIBUTES { ATTR_CURRENT, ATTR_COUNT, ATTR_TYPE, ATTR_MIN, ATTR_MAX, ATTR_DEFAULT, ATTR_INCREMENT, ATTR_ACCESS, ATTR_AVAIL }

enum	PL_PARAM_ACCESS { ACC_READ_ONLY = 1, ACC_READ_WRITE, ACC_EXIST_CHECK_ONLY, ACC_WRITE_ONLY }

enum	PL_IO_TYPE { IO_TYPE_TTL, IO_TYPE_DAC }

enum	PL_IO_DIRECTION { IO_DIR_INPUT, IO_DIR_OUTPUT, IO_DIR_INPUT_OUTPUT }

enum	PL_READOUT_PORTS { READOUT_PORT_0 = 0, READOUT_PORT_1, READOUT_PORT_2, READOUT_PORT_3 }

enum	PL_CLEAR_MODES { CLEAR_NEVER, CLEAR_AUTO = CLEAR_NEVER, CLEAR_PRE_EXPOSURE, CLEAR_PRE_SEQUENCE, CLEAR_POST_SEQUENCE, CLEAR_PRE_POST_SEQUENCE, CLEAR_PRE_EXPOSURE_POST_SEQ, MAX_CLEAR_MODE }

enum	PL_SHTR_OPEN_MODES { OPEN_NEVER, OPEN_PRE_EXPOSURE, OPEN_PRE_SEQUENCE, OPEN_PRE_TRIGGER, OPEN_NO_CHANGE }

enum	PL_EXPOSURE_MODES { TIMED_MODE, STROBED_MODE, BULB_MODE, TRIGGER_FIRST_MODE, FLASH_MODE, VARIABLE_TIMED_MODE, INT_STROBE_MODE, MAX_EXPOSE_MODE = 7, EXT_TRIG_INTERNAL = (7 + 0) << 8, EXT_TRIG_TRIG_FIRST = (7 + 1) << 8, EXT_TRIG_EDGE_RISING = (7 + 2) << 8, EXT_TRIG_LEVEL = (7 + 3) << 8, EXT_TRIG_SOFTWARE_FIRST = (7 + 4) << 8, EXT_TRIG_SOFTWARE_EDGE = (7 + 5) << 8, EXT_TRIG_LEVEL_OVERLAP = (7 + 6) << 8, EXT_TRIG_LEVEL_PULSED = (7 + 7) << 8 }

enum	PL_SW_TRIG_STATUSES { PL_SW_TRIG_STATUS_TRIGGERED = 0, PL_SW_TRIG_STATUS_IGNORED }

enum	PL_EXPOSE_OUT_MODES { EXPOSE_OUT_FIRST_ROW = 0, EXPOSE_OUT_ALL_ROWS, EXPOSE_OUT_ANY_ROW, EXPOSE_OUT_ROLLING_SHUTTER, EXPOSE_OUT_LINE_TRIGGER, EXPOSE_OUT_GLOBAL_SHUTTER, MAX_EXPOSE_OUT_MODE }

enum	PL_FAN_SPEEDS { FAN_SPEED_HIGH, FAN_SPEED_MEDIUM, FAN_SPEED_LOW, FAN_SPEED_OFF }

enum	PL_TRIGTAB_SIGNALS { PL_TRIGTAB_SIGNAL_EXPOSE_OUT }

enum	PL_FRAME_DELIVERY_MODES { PL_FRAME_DELIVERY_MODE_MAX_FPS = 0, PL_FRAME_DELIVERY_MODE_CONSTANT_INTERVALS }

enum	PL_CAM_INTERFACE_TYPES { PL_CAM_IFC_TYPE_UNKNOWN = 0, PL_CAM_IFC_TYPE_1394 = 0x100, PL_CAM_IFC_TYPE_1394_A, PL_CAM_IFC_TYPE_1394_B, PL_CAM_IFC_TYPE_USB = 0x200, PL_CAM_IFC_TYPE_USB_1_1, PL_CAM_IFC_TYPE_USB_2_0, PL_CAM_IFC_TYPE_USB_3_0, PL_CAM_IFC_TYPE_USB_3_1, PL_CAM_IFC_TYPE_PCI = 0x400, PL_CAM_IFC_TYPE_PCI_LVDS, PL_CAM_IFC_TYPE_PCIE = 0x800, PL_CAM_IFC_TYPE_PCIE_LVDS, PL_CAM_IFC_TYPE_PCIE_X1, PL_CAM_IFC_TYPE_PCIE_X4, PL_CAM_IFC_TYPE_PCIE_X8, PL_CAM_IFC_TYPE_VIRTUAL = 0x1000, PL_CAM_IFC_TYPE_ETHERNET = 0x2000 }

enum	PL_CAM_INTERFACE_MODES { PL_CAM_IFC_MODE_UNSUPPORTED = 0, PL_CAM_IFC_MODE_CONTROL_ONLY, PL_CAM_IFC_MODE_IMAGING }

enum	PL_CENTROIDS_MODES { PL_CENTROIDS_MODE_LOCATE = 0, PL_CENTROIDS_MODE_TRACK, PL_CENTROIDS_MODE_BLOB }

enum	PL_SCAN_MODES { PL_SCAN_MODE_AUTO = 0, PL_SCAN_MODE_PROGRAMMABLE_LINE_DELAY, PL_SCAN_MODE_PROGRAMMABLE_SCAN_WIDTH }

enum	PL_SCAN_DIRECTIONS { PL_SCAN_DIRECTION_DOWN = 0, PL_SCAN_DIRECTION_UP, PL_SCAN_DIRECTION_DOWN_UP }

enum	PP_FEATURE_IDS { PP_FEATURE_RING_FUNCTION, PP_FEATURE_BIAS, PP_FEATURE_BERT, PP_FEATURE_QUANT_VIEW, PP_FEATURE_BLACK_LOCK, PP_FEATURE_TOP_LOCK, PP_FEATURE_VARI_BIT, PP_FEATURE_RESERVED, PP_FEATURE_DESPECKLE_BRIGHT_HIGH, PP_FEATURE_DESPECKLE_DARK_LOW, PP_FEATURE_DEFECTIVE_PIXEL_CORRECTION, PP_FEATURE_DYNAMIC_DARK_FRAME_CORRECTION, PP_FEATURE_HIGH_DYNAMIC_RANGE, PP_FEATURE_DESPECKLE_BRIGHT_LOW, PP_FEATURE_DENOISING, PP_FEATURE_DESPECKLE_DARK_HIGH, PP_FEATURE_ENHANCED_DYNAMIC_RANGE, PP_FEATURE_FRAME_SUMMING, PP_FEATURE_LARGE_CLUSTER_CORRECTION, PP_FEATURE_MAX }

enum	PP_PARAMETER_IDS { PP_PARAMETER_RF_FUNCTION = (PP_FEATURE_RING_FUNCTION * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_BIAS_ENABLED = (PP_FEATURE_BIAS * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_BIAS_LEVEL, PP_FEATURE_BERT_ENABLED = (PP_FEATURE_BERT * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_BERT_THRESHOLD, PP_FEATURE_QUANT_VIEW_ENABLED = (PP_FEATURE_QUANT_VIEW * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_QUANT_VIEW_E, PP_FEATURE_BLACK_LOCK_ENABLED = (PP_FEATURE_BLACK_LOCK * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_BLACK_LOCK_BLACK_CLIP, PP_FEATURE_TOP_LOCK_ENABLED = (PP_FEATURE_TOP_LOCK * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_TOP_LOCK_WHITE_CLIP, PP_FEATURE_VARI_BIT_ENABLED = (PP_FEATURE_VARI_BIT * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_VARI_BIT_BIT_DEPTH, PP_FEATURE_DESPECKLE_BRIGHT_HIGH_ENABLED = (PP_FEATURE_DESPECKLE_BRIGHT_HIGH * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DESPECKLE_BRIGHT_HIGH_THRESHOLD, PP_FEATURE_DESPECKLE_BRIGHT_HIGH_MIN_ADU_AFFECTED, PP_FEATURE_DESPECKLE_DARK_LOW_ENABLED = (PP_FEATURE_DESPECKLE_DARK_LOW * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DESPECKLE_DARK_LOW_THRESHOLD, PP_FEATURE_DESPECKLE_DARK_LOW_MAX_ADU_AFFECTED, PP_FEATURE_DEFECTIVE_PIXEL_CORRECTION_ENABLED = (PP_FEATURE_DEFECTIVE_PIXEL_CORRECTION * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DYNAMIC_DARK_FRAME_CORRECTION_ENABLED = (PP_FEATURE_DYNAMIC_DARK_FRAME_CORRECTION * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_HIGH_DYNAMIC_RANGE_ENABLED = (PP_FEATURE_HIGH_DYNAMIC_RANGE * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DESPECKLE_BRIGHT_LOW_ENABLED = (PP_FEATURE_DESPECKLE_BRIGHT_LOW * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DESPECKLE_BRIGHT_LOW_THRESHOLD, PP_FEATURE_DESPECKLE_BRIGHT_LOW_MAX_ADU_AFFECTED, PP_FEATURE_DENOISING_ENABLED = (PP_FEATURE_DENOISING * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DENOISING_NO_OF_ITERATIONS, PP_FEATURE_DENOISING_GAIN, PP_FEATURE_DENOISING_OFFSET, PP_FEATURE_DENOISING_LAMBDA, PP_FEATURE_DESPECKLE_DARK_HIGH_ENABLED = (PP_FEATURE_DESPECKLE_DARK_HIGH * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_DESPECKLE_DARK_HIGH_THRESHOLD, PP_FEATURE_DESPECKLE_DARK_HIGH_MIN_ADU_AFFECTED, PP_FEATURE_ENHANCED_DYNAMIC_RANGE_ENABLED = (PP_FEATURE_ENHANCED_DYNAMIC_RANGE * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_FRAME_SUMMING_ENABLED = (PP_FEATURE_FRAME_SUMMING * PP_MAX_PARAMETERS_PER_FEATURE), PP_FEATURE_FRAME_SUMMING_COUNT, PP_FEATURE_FRAME_SUMMING_32_BIT_MODE, PP_FEATURE_LARGE_CLUSTER_CORRECTION_ENABLED = (PP_FEATURE_LARGE_CLUSTER_CORRECTION * PP_MAX_PARAMETERS_PER_FEATURE), PP_PARAMETER_ID_MAX }

enum	PL_SMT_MODES { SMTMODE_ARBITRARY_ALL = 0, SMTMODE_MAX }

enum	PL_IMAGE_STATUSES { READOUT_NOT_ACTIVE, EXPOSURE_IN_PROGRESS, READOUT_IN_PROGRESS, READOUT_COMPLETE, FRAME_AVAILABLE = READOUT_COMPLETE, READOUT_FAILED, ACQUISITION_IN_PROGRESS, MAX_CAMERA_STATUS }

enum	PL_CCS_ABORT_MODES { CCS_NO_CHANGE = 0, CCS_HALT, CCS_HALT_CLOSE_SHTR, CCS_CLEAR, CCS_CLEAR_CLOSE_SHTR, CCS_OPEN_SHTR, CCS_CLEAR_OPEN_SHTR }

enum	PL_IRQ_MODES { NO_FRAME_IRQS = 0, BEGIN_FRAME_IRQS, END_FRAME_IRQS, BEGIN_END_FRAME_IRQS }

enum	PL_CIRC_MODES { CIRC_NONE = 0, CIRC_OVERWRITE, CIRC_NO_OVERWRITE }

enum	PL_EXP_RES_MODES { EXP_RES_ONE_MILLISEC = 0, EXP_RES_ONE_MICROSEC, EXP_RES_ONE_SEC }

enum	PL_SRC_MODES { SCR_PRE_OPEN_SHTR = 0, SCR_POST_OPEN_SHTR, SCR_PRE_FLASH, SCR_POST_FLASH, SCR_PRE_INTEGRATE, SCR_POST_INTEGRATE, SCR_PRE_READOUT, SCR_POST_READOUT, SCR_PRE_CLOSE_SHTR, SCR_POST_CLOSE_SHTR }

enum	PL_CALLBACK_EVENT { PL_CALLBACK_BOF = 0, PL_CALLBACK_EOF, PL_CALLBACK_CHECK_CAMS, PL_CALLBACK_CAM_REMOVED, PL_CALLBACK_CAM_RESUMED, PL_CALLBACK_MAX }

enum	PL_MD_FRAME_FLAGS { PL_MD_FRAME_FLAG_ROI_TS_SUPPORTED = 0x01, PL_MD_FRAME_FLAG_UNUSED_2 = 0x02, PL_MD_FRAME_FLAG_UNUSED_3 = 0x04, PL_MD_FRAME_FLAG_UNUSED_4 = 0x10, PL_MD_FRAME_FLAG_UNUSED_5 = 0x20, PL_MD_FRAME_FLAG_UNUSED_6 = 0x40, PL_MD_FRAME_FLAG_UNUSED_7 = 0x80 }

enum	PL_MD_ROI_FLAGS { PL_MD_ROI_FLAG_INVALID = 0x01, PL_MD_ROI_FLAG_HEADER_ONLY = 0x02, PL_MD_ROI_FLAG_UNUSED_3 = 0x04, PL_MD_ROI_FLAG_UNUSED_4 = 0x10, PL_MD_ROI_FLAG_UNUSED_5 = 0x20, PL_MD_ROI_FLAG_UNUSED_6 = 0x40, PL_MD_ROI_FLAG_UNUSED_7 = 0x80 }

enum	PL_MD_EXT_TAGS { PL_MD_EXT_TAG_PARTICLE_ID = 0, PL_MD_EXT_TAG_PARTICLE_M0, PL_MD_EXT_TAG_PARTICLE_M2, PL_MD_EXT_TAG_MAX }

Functions
rs_bool PV_DECL	pl_pvcam_get_ver (uns16 *pvcam_version)
	Returns the PVCAM version number. More...

rs_bool PV_DECL	pl_pvcam_init (void)
	Opens and initializes the library. More...

rs_bool PV_DECL	pl_pvcam_uninit (void)
	Closes the library, closes all devices, frees memory. More...

DEPRECATED rs_bool PV_DECL	pl_cam_check (int16 hcam)

rs_bool PV_DECL	pl_cam_close (int16 hcam)
	Frees the current camera, prepares it for power-down. More...

rs_bool PV_DECL	pl_cam_get_name (int16 cam_num, char *camera_name)
	Returns the name of a camera. More...

rs_bool PV_DECL	pl_cam_get_total (int16 *totl_cams)
	Returns the number of cameras attached to the system. More...

rs_bool PV_DECL	pl_cam_open (char camera_name, int16 hcam, int16 o_mode)
	Reserves and initializes the camera hardware. More...

DEPRECATED rs_bool PV_DECL	pl_cam_register_callback (int16 hcam, int32 callback_event, void *callback)

DEPRECATED rs_bool PV_DECL	pl_cam_register_callback_ex (int16 hcam, int32 callback_event, void callback, void context)

DEPRECATED rs_bool PV_DECL	pl_cam_register_callback_ex2 (int16 hcam, int32 callback_event, void *callback)

rs_bool PV_DECL	pl_cam_register_callback_ex3 (int16 hcam, int32 callback_event, void callback, void context)
	Installs a function that will be called when an event occurs in a camera providing information about frame via FRAME_INFO type and with user context information. More...

rs_bool PV_DECL	pl_cam_deregister_callback (int16 hcam, int32 callback_event)
	Uninstalls a function for camera system event. More...

int16 PV_DECL	pl_error_code (void)
	Returns the most recent error condition. More...

rs_bool PV_DECL	pl_error_message (int16 err_code, char *msg)
	Returns a string explaining input error code. More...

rs_bool PV_DECL	pl_get_param (int16 hcam, uns32 param_id, int16 param_attribute, void *param_value)
	Returns the requested attribute for a PVCAM parameter. More...

rs_bool PV_DECL	pl_set_param (int16 hcam, uns32 param_id, void *param_value)
	Sets the current value for a PVCAM parameter. More...

rs_bool PV_DECL	pl_get_enum_param (int16 hcam, uns32 param_id, uns32 index, int32 value, char desc, uns32 length)
	Returns the enumerated value of the parameter param_id at index. More...

rs_bool PV_DECL	pl_enum_str_length (int16 hcam, uns32 param_id, uns32 index, uns32 *length)
	Returns the length of the descriptive string for the parameter param_id at index. More...

rs_bool PV_DECL	pl_pp_reset (int16 hcam)
	This function will reset all post-processing modules to their default values. More...

rs_bool PV_DECL	pl_create_smart_stream_struct (smart_stream_type **array, uns16 entries)
	Creates and allocates variable of smart_stream_type type with the number of entries passed in via the entries parameter and returns pointer to it. More...

rs_bool PV_DECL	pl_release_smart_stream_struct (smart_stream_type **array)
	Frees the space previously allocated by the pl_create_smart_stream_struct function. More...

rs_bool PV_DECL	pl_create_frame_info_struct (FRAME_INFO **new_frame)
	Creates and allocates variable of FRAME_INFO type and returns pointer to it. More...

rs_bool PV_DECL	pl_release_frame_info_struct (FRAME_INFO *frame_to_delete)
	Deletes variable of FRAME_INFO type. More...

rs_bool PV_DECL	pl_exp_setup_seq (int16 hcam, uns16 exp_total, uns16 rgn_total, const rgn_type rgn_array, int16 exp_mode, uns32 exposure_time, uns32 exp_bytes)
	Prepares the camera to perform a readout. More...

rs_bool PV_DECL	pl_exp_start_seq (int16 hcam, void *pixel_stream)
	Begins exposing, returns immediately. More...

rs_bool PV_DECL	pl_exp_setup_cont (int16 hcam, uns16 rgn_total, const rgn_type rgn_array, int16 exp_mode, uns32 exposure_time, uns32 exp_bytes, int16 buffer_mode)
	Sets circular buffer mode. More...

rs_bool PV_DECL	pl_exp_start_cont (int16 hcam, void *pixel_stream, uns32 size)
	Begins continuous readout into circular buffer. More...

rs_bool PV_DECL	pl_exp_trigger (int16 hcam, uns32 *flags, uns32 value)
	Sends a software trigger to the device. More...

rs_bool PV_DECL	pl_exp_check_status (int16 hcam, int16 status, uns32 bytes_arrived)
	Checks the status of sequence acquisition. More...

rs_bool PV_DECL	pl_exp_check_cont_status (int16 hcam, int16 status, uns32 bytes_arrived, uns32 *buffer_cnt)
	Checks the continuous readout status from the camera into a circular buffer. More...

rs_bool PV_DECL	pl_exp_check_cont_status_ex (int16 hcam, int16 status, uns32 byte_cnt, uns32 buffer_cnt, FRAME_INFO frame_info)
	Checks the continuous readout status from the camera into a circular buffer. More...

rs_bool PV_DECL	pl_exp_get_latest_frame (int16 hcam, void **frame)
	This function returns a pointer to the most recently acquired frame in the circular buffer. More...

rs_bool PV_DECL	pl_exp_get_latest_frame_ex (int16 hcam, void *frame, FRAME_INFO frame_info)
	Returns pointer to the most recent frame in circular buffer. More...

rs_bool PV_DECL	pl_exp_get_oldest_frame (int16 hcam, void **frame)
	This function returns pointer to the oldest unretrieved frame in the circular buffer. More...

rs_bool PV_DECL	pl_exp_get_oldest_frame_ex (int16 hcam, void *frame, FRAME_INFO frame_info)
	This function returns pointer to the oldest unretrieved frame in the circular buffer. More...

rs_bool PV_DECL	pl_exp_unlock_oldest_frame (int16 hcam)
	Makes oldest frame in circular buffer overwritable. More...

rs_bool PV_DECL	pl_exp_stop_cont (int16 hcam, int16 cam_state)
	Stops continuous readout acquisition. Identical to pl_exp_abort. More...

rs_bool PV_DECL	pl_exp_abort (int16 hcam, int16 cam_state)
	Stops collecting data, cleans up device driver, halts camera. More...

rs_bool PV_DECL	pl_exp_finish_seq (int16 hcam, void *pixel_stream, int16 hbuf)
	Finishes and cleans up after pl_exp_start_seq. More...

rs_bool PV_DECL	pl_io_script_control (int16 hcam, uns16 addr, flt64 state, uns32 location)
	Defines control of an I/O line from within a camera script. More...

rs_bool PV_DECL	pl_io_clear_script_control (int16 hcam)
	Clears the current setup for control of the available I/O lines within a camera script. More...

DEPRECATED rs_bool PV_DECL	pl_exp_init_seq (void)

DEPRECATED rs_bool PV_DECL	pl_exp_uninit_seq (void)

DEPRECATED rs_bool PV_DECL	pl_dd_get_info (int16 hcam, int16 bytes, char *text)

DEPRECATED rs_bool PV_DECL	pl_dd_get_info_length (int16 hcam, int16 *bytes)

DEPRECATED rs_bool PV_DECL	pl_dd_get_ver (int16 hcam, uns16 *dd_version)

DEPRECATED rs_bool PV_DECL	pl_dd_get_retries (int16 hcam, uns16 *max_retries)

DEPRECATED rs_bool PV_DECL	pl_dd_set_retries (int16 hcam, uns16 max_retries)

DEPRECATED rs_bool PV_DECL	pl_dd_get_timeout (int16 hcam, uns16 *m_sec)

DEPRECATED rs_bool PV_DECL	pl_dd_set_timeout (int16 hcam, uns16 m_sec)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_adc_offset (int16 hcam, int16 *offset)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_adc_offset (int16 hcam, int16 offset)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_chip_name (int16 hcam, char *chip_name)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_clear_cycles (int16 hcam, uns16 *clear_cycles)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_clear_cycles (int16 hcam, uns16 clr_cycles)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_clear_mode (int16 hcam, int16 *clear_mode)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_clear_mode (int16 hcam, int16 ccd_clear)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_color_mode (int16 hcam, uns16 *color_mode)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_cooling_mode (int16 hcam, int16 *cooling)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_frame_capable (int16 hcam, rs_bool *frame_capable)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_fwell_capacity (int16 hcam, uns32 *fwell_capacity)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_mpp_capable (int16 hcam, int16 *mpp_capable)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_preamp_dly (int16 hcam, uns16 *preamp_dly)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_preamp_off_control (int16 hcam, uns32 *preamp_off_control)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_preamp_off_control (int16 hcam, uns32 preamp_off_control)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_preflash (int16 hcam, uns16 *pre_flash)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_pmode (int16 hcam, int16 *pmode)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_pmode (int16 hcam, int16 pmode)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_premask (int16 hcam, uns16 *pre_mask)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_prescan (int16 hcam, uns16 *prescan)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_postmask (int16 hcam, uns16 *post_mask)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_postscan (int16 hcam, uns16 *postscan)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_par_size (int16 hcam, uns16 *par_size)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_ser_size (int16 hcam, uns16 *ser_size)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_serial_num (int16 hcam, uns16 *serial_num)

DEPRECATED rs_bool PV_DECL	pl_ccs_get_status (int16 hcam, int16 *ccs_status)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_summing_well (int16 hcam, rs_bool *s_well_exists)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_tmp (int16 hcam, int16 *cur_tmp)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_tmp_range (int16 hcam, int16 tmp_hi_val, int16 tmp_lo_val)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_tmp_setpoint (int16 hcam, int16 *tmp_setpoint)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_tmp_setpoint (int16 hcam, int16 tmp_setpoint)

DEPRECATED rs_bool PV_DECL	pl_ccd_set_readout_port (int16, int16)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_pix_par_dist (int16 hcam, uns16 *pix_par_dist)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_pix_par_size (int16 hcam, uns16 *pix_par_size)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_pix_ser_dist (int16 hcam, uns16 *pix_ser_dist)

DEPRECATED rs_bool PV_DECL	pl_ccd_get_pix_ser_size (int16 hcam, uns16 *pix_ser_size)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_bits (int16 hcam, int16 *spdtab_bits)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_gain (int16 hcam, int16 *spdtab_gain)

DEPRECATED rs_bool PV_DECL	pl_spdtab_set_gain (int16 hcam, int16 spdtab_gain)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_max_gain (int16 hcam, int16 *spdtab_max_gain)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_num (int16 hcam, int16 *spdtab_num)

DEPRECATED rs_bool PV_DECL	pl_spdtab_set_num (int16 hcam, int16 spdtab_num)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_entries (int16 hcam, int16 *spdtab_entries)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_port (int16 hcam, int16 *spdtab_port)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_port_total (int16 hcam, int16 *total_ports)

DEPRECATED rs_bool PV_DECL	pl_spdtab_get_time (int16 hcam, uns16 *spdtab_time)

DEPRECATED rs_bool PV_DECL	pl_shtr_get_close_dly (int16 hcam, uns16 *shtr_close_dly)

DEPRECATED rs_bool PV_DECL	pl_shtr_set_close_dly (int16 hcam, uns16 shtr_close_dly)

DEPRECATED rs_bool PV_DECL	pl_shtr_get_open_dly (int16 hcam, uns16 *shtr_open_dly)

DEPRECATED rs_bool PV_DECL	pl_shtr_set_open_dly (int16 hcam, uns16 shtr_open_dly)

DEPRECATED rs_bool PV_DECL	pl_shtr_get_open_mode (int16 hcam, int16 *shtr_open_mode)

DEPRECATED rs_bool PV_DECL	pl_shtr_set_open_mode (int16 hcam, int16 shtr_open_mode)

DEPRECATED rs_bool PV_DECL	pl_shtr_get_status (int16 hcam, int16 *shtr_status)

DEPRECATED rs_bool PV_DECL	pl_exp_get_time_seq (int16 hcam, uns16 *exp_time)

DEPRECATED rs_bool PV_DECL	pl_exp_set_time_seq (int16 hcam, uns16 exp_time)

DEPRECATED rs_bool PV_DECL	pl_exp_check_progress (int16 hcam, int16 status, uns32 bytes_arrived)

DEPRECATED rs_bool PV_DECL	pl_exp_set_cont_mode (int16 hcam, int16 mode)

DEPRECATED rs_bool PV_DECL	pl_subsys_do_diag (int16 hcam, uns8 subsys_id, uns16 *err_code)

DEPRECATED rs_bool PV_DECL	pl_subsys_get_id (int16 hcam, uns8 subsys_id, uns16 part_num, uns8 revision)

DEPRECATED rs_bool PV_DECL	pl_subsys_get_name (int16 hcam, uns8 subsys_id, char *subsys_name)

DEPRECATED rs_bool PV_DECL	pl_exp_get_driver_buffer (int16 hcam, void *pixel_stream, uns32 byte_cnt)

DEPRECATED rs_bool PV_DECL	pl_buf_init (void)

DEPRECATED rs_bool PV_DECL	pl_buf_uninit (void)

DEPRECATED rs_bool PV_DECL	pl_buf_alloc (int16 hbuf, int16 exp_total, int16 bit_depth, int16 rgn_total, const rgn_type rgn_array)

DEPRECATED rs_bool PV_DECL	pl_buf_get_exp_date (int16 hbuf, int16 exp_num, int16 year, uns8 month, uns8 day, uns8 hour, uns8 min, uns8 sec, uns16 *msec)

DEPRECATED rs_bool PV_DECL	pl_buf_set_exp_date (int16 hbuf, int16 exp_num, int16 year, uns8 month, uns8 day, uns8 hour, uns8 min, uns8 sec, uns16 msec)

DEPRECATED rs_bool PV_DECL	pl_buf_get_exp_time (int16 hbuf, int16 exp_num, uns32 *exp_msec)

DEPRECATED rs_bool PV_DECL	pl_buf_get_exp_total (int16 hbuf, int16 *total_exps)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_bin (int16 himg, int16 ibin, int16 jbin)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_handle (int16 hbuf, int16 exp_num, int16 img_num, int16 *himg)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_ofs (int16 himg, int16 s_ofs, int16 p_ofs)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_ptr (int16 himg, void **img_addr)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_size (int16 himg, int16 x_size, int16 y_size)

DEPRECATED rs_bool PV_DECL	pl_buf_get_img_total (int16 hbuf, int16 *totl_imgs)

DEPRECATED rs_bool PV_DECL	pl_buf_get_size (int16 hbuf, int32 *buf_size)

DEPRECATED rs_bool PV_DECL	pl_buf_free (int16 hbuf)

DEPRECATED rs_bool PV_DECL	pl_buf_get_bits (int16 hbuf, int16 *bit_depth)

DEPRECATED rs_bool PV_DECL	pl_exp_unravel (int16 hcam, uns16 exposure, void pixel_stream, uns16 rgn_total, const rgn_type rgn_array, uns16 **array_list)

DEPRECATED rs_bool PV_DECL	pl_exp_wait_start_xfer (int16 hcam, uns32 tlimit)

DEPRECATED rs_bool PV_DECL	pl_exp_wait_end_xfer (int16 hcam, uns32 tlimit)

DEPRECATED rs_bool PV_DECL	pv_cam_get_ccs_mem (int16 hcam, uns16 *size)

DEPRECATED rs_bool PV_DECL	pv_cam_send_debug (int16 hcam, char debug_str, uns16 reply_len, char reply_str)

DEPRECATED rs_bool PV_DECL	pv_cam_write_read (int16 hcam, uns8 c_class, uns16 write_bytes, uns8 write_array, uns8 read_array)

DEPRECATED rs_bool PV_DECL	pv_dd_active (int16 hcam, void *pixel_stream)

DEPRECATED rs_bool PV_DECL	pv_exp_get_bytes (int16 hcam, uns32 *exp_bytes)

DEPRECATED rs_bool PV_DECL	pv_exp_get_script (int16 hcam, rs_bool *script_valid)

DEPRECATED rs_bool PV_DECL	pv_exp_get_status (int16 hcam, int16 status, uns32 byte_cnt, uns32 *frame_cnt)

DEPRECATED rs_bool PV_DECL	pv_exp_set_bytes (int16 hcam, uns32 frame_count, uns32 seq_bytes, void *pixel_stream)

DEPRECATED rs_bool PV_DECL	pv_exp_set_script (int16 hcam, rs_bool script_valid)

DEPRECATED rs_bool PV_DECL	pv_set_error_code (int16 omode, int16 err_code)

DEPRECATED rs_bool PV_DECL	pv_cam_do_reads (int16 hcam)

DEPRECATED rs_bool PV_DECL	pv_free (void *block, int16 heap)

DEPRECATED void *PV_DECL	pv_malloc (uns32 size, int16 heap)

DEPRECATED void *PV_DECL	pv_realloc (void *block, uns32 size, int16 heap)

DEPRECATED rs_bool PV_DECL	pv_script_set_hook (pm_script_hook *pfn)

DEPRECATED rs_bool PV_DECL	pv_ccd_get_accum_capable (int16 hcam, rs_bool *accum_capable)

DEPRECATED rs_bool PV_DECL	pv_exp_get_frames (int16 hcam, uns32 *exp_frames)

DEPRECATED rs_bool PV_DECL	pv_exp_set_frames (int16 hcam, uns32 exp_frames)

DEPRECATED rs_bool PV_DECL	pv_exp_set_no_readout_timeout (int16 hcam)

DEPRECATED rs_bool PV_DECL	pv_exp_reset_no_readout_timeout (int16 hcam)

DEPRECATED rs_bool PV_DECL	pm_cam_write_read (int16 hcam, uns8 c_class, uns16 write_bytes, uns8 write_array, uns8 read_array)

DEPRECATED rs_bool PV_DECL	pl_ddi_get_ver (uns16 *ddi_version)

DEPRECATED rs_bool PV_DECL	pl_cam_get_diags (int16 hcam)

rs_bool PV_DECL	pl_md_frame_decode (md_frame pDstFrame, void pSrcBuf, uns32 srcBufSize)
	Decodes a metadata-enabled frame data into provided frame descriptor structure. More...

rs_bool PV_DECL	pl_md_frame_recompose (void pDstBuf, uns16 offX, uns16 offY, uns16 dstWidth, uns16 dstHeight, md_frame pSrcFrame)
	Optional function that recomposes a multi-ROI frame into a displayable image buffer. More...

rs_bool PV_DECL	pl_md_create_frame_struct_cont (md_frame **pFrame, uns16 roiCount)
	This method creates an empty md_frame structure for known number of ROIs. More...

rs_bool PV_DECL	pl_md_create_frame_struct (md_frame *pFrame, void pSrcBuf, uns32 srcBufSize)
	This method creates an empty md_frame structure from an existing buffer. More...

rs_bool PV_DECL	pl_md_release_frame_struct (md_frame *pFrame)
	Releases the md_frame struct. More...

rs_bool PV_DECL	pl_md_read_extended (md_ext_item_collection pOutput, void pExtMdPtr, uns32 extMdSize)
	Reads all the extended metadata from the given ext. metadata buffer. More...

Macro Definition Documentation

◆ CAM_NAME_LEN

#define CAM_NAME_LEN 32

Maximum length of a camera name including space for null terminator.

See also: pl_cam_get_name for details.

◆ CCD_NAME_LEN

#define CCD_NAME_LEN 17

Maximum length of a sensor chip name including space for null terminator.

See also: PARAM_CHIP_NAME for details.

◆ CLASS0

#define CLASS0 0 /* Camera Communications */

◆ CLASS2

#define CLASS2 2 /* Configuration/Setup */

◆ CLASS3

#define CLASS3 3 /* Data Acquisition */

◆ ERROR_MSG_LEN

#define ERROR_MSG_LEN 255

Maximum length of an error message including space for null terminator.

See also: pl_error_message for details.

◆ LS16_BYTE

#define LS16_BYTE ( two_byte_value ) ((uns8)(((uns16)(two_byte_value) >> 0) & 0xFF))

Extracts the least significant byte from a two-uns8 integer input.

◆ LS32_BYTE

#define LS32_BYTE ( four_byte_value ) ((uns8)(((uns32)(four_byte_value) >> 0) & 0xFF))

Extracts the least significant byte from a four-uns8 integer input.

◆ MAX_ALPHA_SER_NUM_LEN

#define MAX_ALPHA_SER_NUM_LEN 32

Maximum length of a camera serial number string including space for null terminator.

See also: PARAM_HEAD_SER_NUM_ALPHA for details.

◆ MAX_CAM

#define MAX_CAM 16

Maximum number of cameras on this system.

◆ MAX_CAM_PART_NUM_LEN

#define MAX_CAM_PART_NUM_LEN 32

Maximum length of a camera part number including space for null terminator.

See also: PARAM_CAMERA_PART_NUMBER for details.

◆ MAX_CAM_SYSTEMS_INFO_LEN

#define MAX_CAM_SYSTEMS_INFO_LEN 1024

Maximum length of a gain name including space for null terminator.

See also: PARAM_CAM_SYSTEMS_INFO for details.

◆ MAX_GAIN_NAME_LEN

#define MAX_GAIN_NAME_LEN 32

Maximum length of a gain name including space for null terminator.

See also: PARAM_GAIN_NAME for details.

◆ MAX_PP_NAME_LEN

#define MAX_PP_NAME_LEN 32

Maximum length of a post-processing parameter/feature name including space for null terminator.

See also: PARAM_PP_FEAT_NAME and PARAM_PP_PARAM_NAME for details.

◆ MAX_PRODUCT_NAME_LEN

#define MAX_PRODUCT_NAME_LEN 32

Maximum length of a product name including space for null terminator.

See also: PARAM_PRODUCT_NAME for details.

◆ MAX_SPDTAB_NAME_LEN

#define MAX_SPDTAB_NAME_LEN 32

Maximum length of a speed name including space for null terminator.

See also: PARAM_SPDTAB_NAME for details.

◆ MAX_SYSTEM_NAME_LEN

#define MAX_SYSTEM_NAME_LEN 32

Maximum length of a system name including space for null terminator.

See also: PARAM_SYSTEM_NAME for details.

◆ MAX_VENDOR_NAME_LEN

#define MAX_VENDOR_NAME_LEN 32

Maximum length of a vendor name. including space for null terminator

See also: PARAM_VENDOR_NAME for details.

◆ MH32_BYTE

#define MH32_BYTE ( four_byte_value ) ((uns8)(((uns32)(four_byte_value) >> 16) & 0xFF))

Extracts the middle-high significant byte from a four-uns8 integer input.

◆ ML32_BYTE

#define ML32_BYTE ( four_byte_value ) ((uns8)(((uns32)(four_byte_value) >> 8) & 0xFF))

Extracts the middle-low significant byte from a four-uns8 integer input.

◆ MS16_BYTE

#define MS16_BYTE ( two_byte_value ) ((uns8)(((uns16)(two_byte_value) >> 8) & 0xFF))

Following macros can be used to extract a single byte from multi-byte integers, or to combine multiple bytes into a larger integer value.Extracts the most significant byte from a two-uns8 integer input.

◆ MS32_BYTE

#define MS32_BYTE ( four_byte_value ) ((uns8)(((uns32)(four_byte_value) >> 24) & 0xFF))

Extracts the most significant byte from a four-uns8 integer input.

◆ PARAM_NAME_LEN

#define PARAM_NAME_LEN 32

◆ PL_MD_EXT_TAGS_MAX_SUPPORTED

#define PL_MD_EXT_TAGS_MAX_SUPPORTED 255

Maximum number of extended metadata tags supported.

◆ PL_MD_FRAME_SIGNATURE

#define PL_MD_FRAME_SIGNATURE 5328208

The signature is located in the first 4 bytes of the frame header. The signature is checked before any metadata-related operations are executed on the buffer.

◆ PP_MAX_PARAMETERS_PER_FEATURE

#define PP_MAX_PARAMETERS_PER_FEATURE 10

Used with the PARAM_PP_PARAM_ID parameter ID.

◆ TYPE_BOOLEAN

#define TYPE_BOOLEAN 11

◆ TYPE_CHAR_PTR

#define TYPE_CHAR_PTR 13

◆ TYPE_ENUM

#define TYPE_ENUM 9

◆ TYPE_FLT32

#define TYPE_FLT32 19

◆ TYPE_FLT64

#define TYPE_FLT64 4

◆ TYPE_INT16

#define TYPE_INT16 1

Data type used by pl_get_param with ATTR_TYPE.

◆ TYPE_INT32

#define TYPE_INT32 2

◆ TYPE_INT64

#define TYPE_INT64 16

◆ TYPE_INT8

#define TYPE_INT8 12

◆ TYPE_SMART_STREAM_TYPE

#define TYPE_SMART_STREAM_TYPE 17

◆ TYPE_SMART_STREAM_TYPE_PTR

#define TYPE_SMART_STREAM_TYPE_PTR 18

◆ TYPE_UNS16

#define TYPE_UNS16 6

◆ TYPE_UNS32

#define TYPE_UNS32 7

◆ TYPE_UNS64

#define TYPE_UNS64 8

◆ TYPE_UNS8

#define TYPE_UNS8 5

◆ TYPE_VOID_PTR

#define TYPE_VOID_PTR 14

◆ TYPE_VOID_PTR_PTR

#define TYPE_VOID_PTR_PTR 15

◆ VAL_INT64

#define VAL_INT64	(	b0,
		b1,
		b2,
		b3,
		b4,
		b5,
		b6,
		b7
	)

Value:

(\
    ((long64)((uns8)(b0)) << 56) |\
    ((long64)((uns8)(b1)) << 48) |\
    ((long64)((uns8)(b2)) << 40) |\
    ((long64)((uns8)(b3)) << 32) |\
    ((long64)((uns8)(b4)) << 24) |\
    ((long64)((uns8)(b5)) << 16) |\
    ((long64)((uns8)(b6)) <<  8) |\
    ((long64)((uns8)(b7)) <<  0))

Produces a 64-bit signed integer value from 8 input bytes.

◆ VAL_UNS16

#define VAL_UNS16	(	ms_byte,
		ls_byte
	)

Value:

(\
    ((uns16)((uns8)(ms_byte)) << 8) |\
    ((uns16)((uns8)(ls_byte)) << 0))

Produces a 16-bit unsigned integer value from 2 input bytes.

◆ VAL_UNS32

#define VAL_UNS32	(	ms_byte,
		mh_byte,
		ml_byte,
		ls_byte
	)

Value:

(\
    ((uns32)((uns8)(ms_byte)) << 24) |\
    ((uns32)((uns8)(mh_byte)) << 16) |\
    ((uns32)((uns8)(ml_byte)) <<  8) |\
    ((uns32)((uns8)(ls_byte)) <<  0))

Produces a 32-bit unsigned integer value from 4 input bytes.

Typedef Documentation

◆ active_camera_type

typedef struct active_camera_type active_camera_type

Used in pv_script_set_hook.

Remarks: This structure is deprecated.

◆ FRAME_INFO

typedef struct _TAG_FRAME_INFO FRAME_INFO

Structure used to uniquely identify frames in the camera.

Please note that this information is generated by the low level device driver. While the information is accurate for slower acquisitions and most legacy CCD cameras, the timestamps are still obtained from the operating systems. For that reason the timestamps may not always represent the time of actual, in-camera acquisition. This is especially true for fast CMOS cameras that implement an internal frame buffer. Such cameras often report both the BOF and EOF timestamps as identical numbers with the readout time reported as 0. For accurate hardware timestamps please see Embedded Frame Metadata feature.

◆ io_entry

typedef struct io_struct io_entry

◆ io_list

typedef struct io_list io_list

◆ md_ext_item

typedef struct md_ext_item md_ext_item

An extended metadata item together with its value. The user will retrieve a collection of these items.

◆ md_ext_item_collection

typedef struct md_ext_item_collection md_ext_item_collection

A collection of decoded extended metadata.

◆ md_ext_item_info

typedef struct md_ext_item_info md_ext_item_info

This structure describes the extended metadata TAG. This information is retrieved from an internal table. User needs this to correctly read and display the extended metadata value.

◆ md_frame

typedef struct md_frame md_frame

This is a helper structure that is used to decode the md_frame_header. Since the header cannot contain any pointers, we need to calculate all information using only offsets.

Please note the structure keeps only pointers to data residing in the image buffer. Once the buffer is deleted, the contents of the structure become invalid.

◆ md_frame_header

typedef struct md_frame_header md_frame_header

This is a frame header that is located before each frame. The size of this structure must remain constant. The structure is generated by the camera and should be 16-byte aligned.

◆ md_frame_header_v3

typedef struct md_frame_header_v3 md_frame_header_v3

Version 3 of the frame header with improved timestamp and exposure time accuracy. When the md_frame_header.version is reported as 3, users are expected to use reinterpret_cast to cast the md_frame.header pointer to md_frame_header_v3 type.

◆ md_frame_roi

typedef struct md_frame_roi md_frame_roi

This is a helper structure that is used to decode the md_frame_roi_header. Since the header cannot contain any pointers, PVCAM will calculate all information using offsets from frame & ROI headers.

The structure must be created using the pl_md_create_frame_struct function. Please note the structure keeps only pointers to data residing in the image buffer. Once the buffer is deleted the contents of the structure become invalid.

◆ md_frame_roi_header

typedef struct md_frame_roi_header md_frame_roi_header

This is a ROI header that is located before every ROI data. The size of this structure must remain constant. The structure is generated by the camera and should be 16-byte aligned.

◆ PL_CALLBACK_EVENT

typedef enum PL_CALLBACK_EVENT PL_CALLBACK_EVENT

Used with the functions pl_cam_register_callback* and pl_cam_deregister_callback.

Please note that callbacks are generated based on actual frame data transfer. This means that the BOF and EOF callbacks may not always correspond to actual readout of given frame from the camera sensor. This is especially true for fast cameras where frames are buffered on the camera side and BOF/EOF callbacks are generated when the frame is actually received on the device driver side. It is recommended to use camera hardware signals for accurate frame synchronization.

Treated as int32 type.

◆ PL_CAM_INTERFACE_MODES

typedef enum PL_CAM_INTERFACE_MODES PL_CAM_INTERFACE_MODES

Used with the PARAM_CAM_INTERFACE_MODE parameter ID. Treated as int32 type.

◆ PL_CAM_INTERFACE_TYPES

typedef enum PL_CAM_INTERFACE_TYPES PL_CAM_INTERFACE_TYPES

Used with the PARAM_CAM_INTERFACE_TYPE parameter ID.

32-bit enum where:

Upper 24 bits are interface classes, flags, 1bit = one class, 24 possible classes.
Lower 8 bits are interface revisions, there are 254 possible revisions for each interface class.

Usage:

if (attrCurrent & PL_CAM_IFC_TYPE_USB)
   // The camera is running on USB, any USB
if (attrCurrent & PL_CAM_IFC_TYPE_USB && type >= PL_CAM_IFC_TYPE_USB_3_0)
   // The camera is running on USB, the camera is running on at least USB 3.0
if (attrCurrent == PL_CAM_IFC_TYPE_USB_3_1)
   // The camera is running exactly on USB 3.1

Treated as int32 type.

◆ PL_CCS_ABORT_MODES

typedef enum PL_CCS_ABORT_MODES PL_CCS_ABORT_MODES

Used with the pl_exp_abort function. These modes are applicable for CCD cameras only. For latest sCMOS cameras, please use the CCS_HALT mode.

Treated as int16 type.

◆ PL_CENTROIDS_MODES

typedef enum PL_CENTROIDS_MODES PL_CENTROIDS_MODES

Used with the PARAM_CENTROIDS_MODE parameter ID. Treated as int32 type.

◆ PL_CIRC_MODES

typedef enum PL_CIRC_MODES PL_CIRC_MODES

Used with the function pl_exp_setup_cont. Treated as int16 type.

◆ PL_CLEAR_MODES

typedef enum PL_CLEAR_MODES PL_CLEAR_MODES

Used with the PARAM_CLEAR_MODE parameter ID. Treated as int32 type.

◆ PL_COLOR_MODES

typedef enum PL_COLOR_MODES PL_COLOR_MODES

Used with the PARAM_COLOR_MODE parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.colorMask)

◆ PL_COOL_MODES

typedef enum PL_COOL_MODES PL_COOL_MODES

Used with the PARAM_COOLING_MODE parameter ID. Treated as int32 type.

◆ PL_EXP_RES_MODES

typedef enum PL_EXP_RES_MODES PL_EXP_RES_MODES

Used with the PARAM_EXP_RES parameter ID. The resolution defines in which units is the exposure passed to pl_exp_setup_seq and pl_exp_setup_cont calls and for the Variable Timed Mode (PARAM_EXP_TIME). Treated as int32 type.

◆ PL_EXPOSE_OUT_MODES

typedef enum PL_EXPOSE_OUT_MODES PL_EXPOSE_OUT_MODES

Used with the PARAM_EXPOSE_OUT_MODE parameter ID. Build the values for the Expose Out modes that are "ORed" with the trigger modes when setting up the script. Treated as int32 type.

◆ PL_EXPOSURE_MODES

typedef enum PL_EXPOSURE_MODES PL_EXPOSURE_MODES

Used with the PARAM_EXPOSURE_MODE parameter ID. Treated as int32 type.

Used with the functions pl_exp_setup_cont and pl_exp_setup_seq. Treated as int16 type.

◆ PL_FAN_SPEEDS

typedef enum PL_FAN_SPEEDS PL_FAN_SPEEDS

Used with the PARAM_FAN_SPEED_SETPOINT parameter ID. Treated as int32 type.

◆ PL_FRAME_DELIVERY_MODES

typedef enum PL_FRAME_DELIVERY_MODES PL_FRAME_DELIVERY_MODES

Used with the PARAM_FRAME_DELIVERY_MODE parameter ID. Treated as int32 type.

◆ PL_FRAME_FLIP_MODES

typedef enum PL_FRAME_FLIP_MODES PL_FRAME_FLIP_MODES

Frame flip modes. Used with the PARAM_FRAME_FLIP parameter ID. Treated as int32 type.

◆ PL_FRAME_ROTATE_MODES

typedef enum PL_FRAME_ROTATE_MODES PL_FRAME_ROTATE_MODES

Frame rotation modes. Used with the PARAM_FRAME_ROTATE parameter ID. Treated as int32 type.

◆ PL_IMAGE_COMPRESSIONS

typedef enum PL_IMAGE_COMPRESSIONS PL_IMAGE_COMPRESSIONS

Image compression used to reduce the size of the pixel data. Once the image is decompressed, the pixels can be accessed according to PL_IMAGE_FORMATS type. Used with the PARAM_IMAGE_COMPRESSION parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.imageCompression field).

◆ PL_IMAGE_FORMATS

typedef enum PL_IMAGE_FORMATS PL_IMAGE_FORMATS

Image format specifies the buffer format in which the pixels are transferred. The format should be used together with PARAM_BIT_DEPTH because it specifies only the format of the pixel container, not the actual bit depth of the pixel it contains. Used with the PARAM_IMAGE_FORMAT parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.imageFormat field).

◆ PL_IMAGE_STATUSES

typedef enum PL_IMAGE_STATUSES PL_IMAGE_STATUSES

Used with the functions pl_exp_check_status, and pl_exp_check_cont_status and pl_exp_check_cont_status_ex. Treated as int16 type.

◆ PL_IO_DIRECTION

typedef enum PL_IO_DIRECTION PL_IO_DIRECTION

Used with the PARAM_IO_DIRECTION parameter ID. Treated as int32 type.

◆ PL_IO_TYPE

typedef enum PL_IO_TYPE PL_IO_TYPE

Used with the PARAM_IO_TYPE parameter ID. Treated as int32 type.

◆ PL_IRQ_MODES

typedef enum PL_IRQ_MODES PL_IRQ_MODES

Used with the PARAM_BOF_EOF_ENABLE parameter ID. Treated as int32 type.

◆ PL_MD_EXT_TAGS

typedef enum PL_MD_EXT_TAGS PL_MD_EXT_TAGS

Available extended metadata tags. Used in md_ext_item_info structure. Used directly as an enum type without casting to any integral type.

◆ PL_MD_FRAME_FLAGS

typedef enum PL_MD_FRAME_FLAGS PL_MD_FRAME_FLAGS

Used in md_frame_header structure. Treated as uns8 type.

◆ PL_MD_ROI_FLAGS

typedef enum PL_MD_ROI_FLAGS PL_MD_ROI_FLAGS

Used in md_frame_roi_header structure. Treated as uns8 type.

◆ PL_MPP_MODES

typedef enum PL_MPP_MODES PL_MPP_MODES

Used with the PARAM_MPP_CAPABLE parameter ID. Treated as int32 type.

◆ PL_OPEN_MODES

typedef enum PL_OPEN_MODES PL_OPEN_MODES

The modes under which the camera can be open. Used with the function pl_cam_open. Treated as int16 type.

◆ PL_PARAM_ACCESS

typedef enum PL_PARAM_ACCESS PL_PARAM_ACCESS

Used with the function pl_get_param and ATTR_ACCESS. Treated as uns16 type.

◆ PL_PARAM_ATTRIBUTES

typedef enum PL_PARAM_ATTRIBUTES PL_PARAM_ATTRIBUTES

Used with the function pl_get_param. Treated as int16 type.

◆ PL_PMODES

typedef enum PL_PMODES PL_PMODES

Used with the PARAM_PMODE parameter ID. Treated as int32 type.

◆ PL_READOUT_PORTS

typedef enum PL_READOUT_PORTS PL_READOUT_PORTS

Used with the PARAM_READOUT_PORT parameter ID. Treated as int32 type.

◆ PL_SCAN_DIRECTIONS

typedef enum PL_SCAN_DIRECTIONS PL_SCAN_DIRECTIONS

Used with the PARAM_SCAN_DIRECTION parameter ID. Treated as int32 type.

◆ PL_SCAN_MODES

typedef enum PL_SCAN_MODES PL_SCAN_MODES

Used with the PARAM_SCAN_MODE parameter ID. Treated as int32 type.

◆ PL_SHTR_MODES

typedef enum PL_SHTR_MODES PL_SHTR_MODES

Used with the PARAM_SHTR_STATUS parameter ID. Treated as int32 type.

◆ PL_SHTR_OPEN_MODES

typedef enum PL_SHTR_OPEN_MODES PL_SHTR_OPEN_MODES

Used with the PARAM_SHTR_OPEN_MODE parameter ID. Treated as int32 type.

◆ PL_SMT_MODES

typedef enum PL_SMT_MODES PL_SMT_MODES

Used with the PARAM_SMART_STREAM_MODE parameter ID. Treated as uns16 type.

◆ PL_SRC_MODES

typedef enum PL_SRC_MODES PL_SRC_MODES

Used with the function pl_io_script_control. Treated as uns32 type.

◆ PL_SW_TRIG_STATUSES

typedef enum PL_SW_TRIG_STATUSES PL_SW_TRIG_STATUSES

Used with pl_exp_trigger function. Treated as uns32 type.

◆ PL_TRIGTAB_SIGNALS

typedef enum PL_TRIGTAB_SIGNALS PL_TRIGTAB_SIGNALS

Used with the PARAM_TRIGTAB_SIGNAL parameter ID. Treated as int32 type.

◆ pm_script_hook

typedef int16 pm_script_hook(int16 hcam, uns16 exp_total, uns16 rgn_total, const rgn_type *rgn_array, int16 mode, uns32 exposure_time, uns32 *pixels, active_camera_type *active_camera)

◆ PP_FEATURE_IDS

typedef enum PP_FEATURE_IDS PP_FEATURE_IDS

Used with the PARAM_PP_FEAT_ID parameter ID. Treated as uns16 type.

◆ PP_PARAMETER_IDS

typedef enum PP_PARAMETER_IDS PP_PARAMETER_IDS

Used with the PARAM_PP_PARAM_ID parameter ID. Treated as uns16 type.

◆ PVCAM_FRAME_INFO_GUID

typedef struct _TAG_PVCAM_FRAME_INFO_GUID PVCAM_FRAME_INFO_GUID

GUID for FRAME_INFO structure.

◆ rgn_type

typedef struct rgn_type rgn_type

Defines the acquisition region. Used in pl_exp_setup_seq and pl_exp_setup_cont. In most cases the s1, s2 coordinates correspond to x1, x2 coordinates. The sensor region width is then calculated as s2 - s1 + 1. The resulting image width would be (s2 - s1 + 1) / sbin. Similarly the p1, p2 coordinates correspond to y1, y2 coordinates. The sensor region height is then calculated as (p2 - p1 + 1). The resulting image height would be (p2 - p1 + 1) / pbin.

◆ smart_stream_type

typedef struct smart_stream_type smart_stream_type

Used with the PARAM_SMART_STREAM_EXP_PARAMS and PARAM_SMART_STREAM_DLY_PARAMS parameter IDs and pl_create_smart_stream_struct and pl_release_smart_stream_struct functions.

Enumeration Type Documentation

◆ PL_CALLBACK_EVENT

enum PL_CALLBACK_EVENT

Used with the functions pl_cam_register_callback* and pl_cam_deregister_callback.

Please note that callbacks are generated based on actual frame data transfer. This means that the BOF and EOF callbacks may not always correspond to actual readout of given frame from the camera sensor. This is especially true for fast cameras where frames are buffered on the camera side and BOF/EOF callbacks are generated when the frame is actually received on the device driver side. It is recommended to use camera hardware signals for accurate frame synchronization.

Treated as int32 type.

Enumerator
PL_CALLBACK_BOF	Beginning of frame callback. Occurs when the frame transfer begins.
PL_CALLBACK_EOF	End of frame callback. Occurs when the frame is fully transferred and ready in the frame buffer.
PL_CALLBACK_CHECK_CAMS	List of connected cameras has changed. This feature is currently not supported. The list of cameras is refreshed only during pl_pvcam_init.
PL_CALLBACK_CAM_REMOVED	A camera has been removed from the system.
PL_CALLBACK_CAM_RESUMED	A camera previously removed is available again. This feature is not currently supported.
PL_CALLBACK_MAX

◆ PL_CAM_INTERFACE_MODES

enum PL_CAM_INTERFACE_MODES

Used with the PARAM_CAM_INTERFACE_MODE parameter ID. Treated as int32 type.

Enumerator
PL_CAM_IFC_MODE_UNSUPPORTED	Interface is not supported.
PL_CAM_IFC_MODE_CONTROL_ONLY	Control commands only.
PL_CAM_IFC_MODE_IMAGING	Full imaging.

◆ PL_CAM_INTERFACE_TYPES

enum PL_CAM_INTERFACE_TYPES

Used with the PARAM_CAM_INTERFACE_TYPE parameter ID.

32-bit enum where:

Upper 24 bits are interface classes, flags, 1bit = one class, 24 possible classes.
Lower 8 bits are interface revisions, there are 254 possible revisions for each interface class.

Usage:

if (attrCurrent & PL_CAM_IFC_TYPE_USB)
   // The camera is running on USB, any USB
if (attrCurrent & PL_CAM_IFC_TYPE_USB && type >= PL_CAM_IFC_TYPE_USB_3_0)
   // The camera is running on USB, the camera is running on at least USB 3.0
if (attrCurrent == PL_CAM_IFC_TYPE_USB_3_1)
   // The camera is running exactly on USB 3.1

Treated as int32 type.

Enumerator
PL_CAM_IFC_TYPE_UNKNOWN	Unrecognized type.
PL_CAM_IFC_TYPE_1394	A generic 1394 in case we cannot identify the sub type.
PL_CAM_IFC_TYPE_1394_A	FireWire 400.
PL_CAM_IFC_TYPE_1394_B	FireWire 800.
PL_CAM_IFC_TYPE_USB	A generic USB in case we cannot identify the sub type.
PL_CAM_IFC_TYPE_USB_1_1	FullSpeed (12 Mbit/s).
PL_CAM_IFC_TYPE_USB_2_0	HighSpeed (480 Mbit/s).
PL_CAM_IFC_TYPE_USB_3_0	SuperSpeed (5 Gbit/s).
PL_CAM_IFC_TYPE_USB_3_1	SuperSpeed+ (10 Gbit/s).
PL_CAM_IFC_TYPE_PCI	A generic PCI interface.
PL_CAM_IFC_TYPE_PCI_LVDS	LVDS PCI interface.
PL_CAM_IFC_TYPE_PCIE	A generic PCIe interface.
PL_CAM_IFC_TYPE_PCIE_LVDS	LVDS PCIe interface.
PL_CAM_IFC_TYPE_PCIE_X1	Single channel PCIe interface.
PL_CAM_IFC_TYPE_PCIE_X4	4 channel PCIe interface.
PL_CAM_IFC_TYPE_PCIE_X8	8 channel PCIe interface.
PL_CAM_IFC_TYPE_VIRTUAL	Base for all Virtual camera interfaces.
PL_CAM_IFC_TYPE_ETHERNET	Base for all Ethernet based cameras.

◆ PL_CCS_ABORT_MODES

enum PL_CCS_ABORT_MODES

Used with the pl_exp_abort function. These modes are applicable for CCD cameras only. For latest sCMOS cameras, please use the CCS_HALT mode.

Treated as int16 type.

Enumerator
CCS_NO_CHANGE	Do not alter the current state of the CCS. Use only if instructed by the camera vendor.
CCS_HALT	Halt all CCS activity, and put the CCS into the idle state. Recommended for sCMOS cameras and for most acquisitions with CCD sensors when using pre-sequence clearing.
CCS_HALT_CLOSE_SHTR	Close the shutter, then halt all CCS activity, and put the CCS into the idle state.
CCS_CLEAR	Put the CCS into the continuous clearing state. Recommended for CCD sensors where continuous clearing is required.
CCS_CLEAR_CLOSE_SHTR	Close the shutter, then put the CCS into the continuous clearing state.
CCS_OPEN_SHTR	Open the shutter, then halt all CCS activity, and put the CCS into the idle state.
CCS_CLEAR_OPEN_SHTR	Open the shutter, then put the CCS into the continuous clearing state.

◆ PL_CENTROIDS_MODES

enum PL_CENTROIDS_MODES

Used with the PARAM_CENTROIDS_MODE parameter ID. Treated as int32 type.

Enumerator
PL_CENTROIDS_MODE_LOCATE	Locate mode (PrimeLocate)
PL_CENTROIDS_MODE_TRACK	Particle Tracking mode
PL_CENTROIDS_MODE_BLOB	Blob Detection mode

◆ PL_CIRC_MODES

enum PL_CIRC_MODES

Used with the function pl_exp_setup_cont. Treated as int16 type.

Enumerator
CIRC_NONE	Used internally by PVCAM for sequence acquisitions only.
CIRC_OVERWRITE	In this circular buffer mode the oldest frame in buffer is automatically replaced by new frame. No error is indicated by any function.
CIRC_NO_OVERWRITE	In non-overwrite mode the oldest frame in circular buffer is also replaced by new frame as in CIRC_OVERWRITE mode (e.g. via to DMA from camera HW), but PVCAM recognizes that and returns an error about buffer overrun in next call of pl_exp_get_oldest_frame or pl_exp_get_latest_frame_ex.

◆ PL_CLEAR_MODES

enum PL_CLEAR_MODES

Used with the PARAM_CLEAR_MODE parameter ID. Treated as int32 type.

Enumerator
CLEAR_NEVER	Don't ever clear the sensor. Useful for performing a readout after an exposure has been aborted.
CLEAR_AUTO	Clear the sensor automatically. Modern cameras control the sensor clearing as needed. Some cameras will report only this clearing mode. For backward compatibility with existing applications the 'auto' clearing mode is reported under the same value as the 'clear never' mode.
CLEAR_PRE_EXPOSURE	Before each exposure, clears the sensor the number of times specified by the `clear_cycles` variable. This mode can be used in a sequence. It is most useful when there is a considerable amount of time between exposures.
CLEAR_PRE_SEQUENCE	Before each sequence, clears the sensor the number of times specified by the `clear_cycles` variable. If no sequence is set up, this mode behaves as if the sequence had one exposure. The result is the same as using CLEAR_PRE_EXPOSURE.
CLEAR_POST_SEQUENCE	Clears continuously after the sequence ends. The camera continues clearing until a new exposure is set up or started, the abort command is sent, the speed entry number is changed, or the camera is reset.
CLEAR_PRE_POST_SEQUENCE	Clears `clear_cycles` times before each sequence and clears continuously after the sequence ends. The camera continues clearing until a new exposure is set up or started, the abort command is sent, the speed entry number is changed, or the camera is reset.
CLEAR_PRE_EXPOSURE_POST_SEQ	Clears `clear_cycles` times before each exposure and clears continuously after the sequence ends. The camera continues clearing until a new exposure is set up or started, the abort command is sent, the speed entry number is changed, or the camera is reset.
MAX_CLEAR_MODE

◆ PL_COLOR_MODES

enum PL_COLOR_MODES

Used with the PARAM_COLOR_MODE parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.colorMask)

Enumerator
COLOR_NONE	Monochrome camera, no color mask.
COLOR_RESERVED	Reserved, do not use.
COLOR_RGGB	Color camera with RGGB color mask.
COLOR_GRBG	Color camera with GRBG color mask.
COLOR_GBRG	Color camera with GBRG color mask.
COLOR_BGGR	Color camera with BGGR color mask.

◆ PL_COOL_MODES

enum PL_COOL_MODES

Used with the PARAM_COOLING_MODE parameter ID. Treated as int32 type.

Enumerator
NORMAL_COOL	This is a thermo-electrically (TE)-cooled camera with air or liquid assisted cooling.
CRYO_COOL	The camera is cryogenically cooled.
NO_COOL	The camera has no cooling or the cooling is optional and should be provided by the end user.

◆ PL_EXP_RES_MODES

enum PL_EXP_RES_MODES

Used with the PARAM_EXP_RES parameter ID. The resolution defines in which units is the exposure passed to pl_exp_setup_seq and pl_exp_setup_cont calls and for the Variable Timed Mode (PARAM_EXP_TIME). Treated as int32 type.

Enumerator
EXP_RES_ONE_MILLISEC	Exposure value is defined in milli-seconds.
EXP_RES_ONE_MICROSEC	Exposure value is defined in micro-seconds.
EXP_RES_ONE_SEC	Exposure value is defined in seconds.

◆ PL_EXPOSE_OUT_MODES

enum PL_EXPOSE_OUT_MODES

Used with the PARAM_EXPOSE_OUT_MODE parameter ID. Build the values for the Expose Out modes that are "ORed" with the trigger modes when setting up the script. Treated as int32 type.

Enumerator
EXPOSE_OUT_FIRST_ROW	Expose out high when first row is exposed (from first row begin to first row end)
EXPOSE_OUT_ALL_ROWS	Expose out high when all rows are exposed at once (from last row begin to first row end). The duration of the signal equals to exposure value entered which means the actual exposure time is longer - use this mode with triggered light source only.
EXPOSE_OUT_ANY_ROW	Expose out high when any row is exposed (from first row begin to last row end)
EXPOSE_OUT_ROLLING_SHUTTER	Like FIRST_ROW but the expose out signal is high when all rows are being exposed at once. If the exposure time entered is shorter than readout time the expose out signal will not become high at all.
EXPOSE_OUT_LINE_TRIGGER	Expose out signal pulses for every line readout as configured via the PARAM_SCAN_MODE and related parameters. If PARAM_SCAN_MODE is not available or enabled, the Expose Out behaves as EXPOSE_OUT_ANY_ROW.
EXPOSE_OUT_GLOBAL_SHUTTER	Similar to EXPOSE_OUT_ROLLING_SHUTTER but using sensor's global shutter mode.
MAX_EXPOSE_OUT_MODE

◆ PL_EXPOSURE_MODES

enum PL_EXPOSURE_MODES

Used with the PARAM_EXPOSURE_MODE parameter ID. Treated as int32 type.

Used with the functions pl_exp_setup_cont and pl_exp_setup_seq. Treated as int16 type.

Enumerator
TIMED_MODE	Causes the exposure to use the internal timer to control the exposure duration.
STROBED_MODE	Causes the external trigger to signal the start of exposure. The exposure duration is still controlled by the internal timer.
BULB_MODE	Causes the trigger to control the duration of the exposure, as well as when it occurs.
TRIGGER_FIRST_MODE	Causes the trigger to control the beginning of a sequence. Each exposure in the sequence then uses the internal timer to control the exposure duration. The software will look for one trigger only and then proceed with the sequence.
FLASH_MODE
VARIABLE_TIMED_MODE	The duration of the exposure can be controlled by software dynamically without requiring the acquisition to be reconfigured with pl_exp_setup_seq. Use pl_set_param with PARAM_EXP_TIME to set new exposure time before calling pl_exp_start_seq.
INT_STROBE_MODE
MAX_EXPOSE_MODE
EXT_TRIG_INTERNAL	Internal camera trigger, camera controls the start and the duration of the exposure. This mode is similar to the legacy TIMED_MODE. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_TRIG_FIRST	Trigger controls the start of first exposure. Subsequent exposures are controlled by the camera internal timer. This mode is similar to the legacy TRIGGER_FIRST_MODE. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_EDGE_RISING	Trigger controls the start of each exposure. This mode is similar to the legacy STROBED_MODE. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_LEVEL	Trigger controls the start and duration of each exposure. This mode is similar to the legacy BULB_MODE. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_SOFTWARE_FIRST	Exposure is triggered with software trigger, using the pl_exp_trigger call. Similarly to EXT_TRIG_TRIG_FIRST, the trigger starts the first exposure only. Subsequent exposures are controlled by the camera internal timer. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_SOFTWARE_EDGE	Exposure is triggered with software trigger, using the pl_exp_trigger call. Similarly to EXT_TRIG_EDGE_RISING, each call to pl_exp_trigger triggers one exposure. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_LEVEL_OVERLAP	Trigger controls the start and duration of each exposure. This mode allows overlapping exposure and readout. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.
EXT_TRIG_LEVEL_PULSED	A special case of a level trigger where the first trigger pulse starts the exposure and the next trigger pulse starts the readout of that exposure. For N frames specified in the software, there must be N+1 trigger pulses in the series with individual exposure times being equal to the time interval between the trigger pulses. This value allows the exposure mode to be "ORed" with PL_EXPOSE_OUT_MODES for pl_exp_setup_seq and pl_exp_setup_cont functions.

◆ PL_FAN_SPEEDS

enum PL_FAN_SPEEDS

Used with the PARAM_FAN_SPEED_SETPOINT parameter ID. Treated as int32 type.

Enumerator
FAN_SPEED_HIGH	The full fan speed set in factory, the default value.
FAN_SPEED_MEDIUM	Medium fan speed.
FAN_SPEED_LOW	Low fan speed.
FAN_SPEED_OFF	Fan is turned off.

◆ PL_FRAME_DELIVERY_MODES

enum PL_FRAME_DELIVERY_MODES

Used with the PARAM_FRAME_DELIVERY_MODE parameter ID. Treated as int32 type.

Enumerator

PL_FRAME_DELIVERY_MODE_MAX_FPS

Camera will sample and deliver the frames as fast as possible while considering the interface bandwidth. This mode may result in uneven frame intervals, but possibly higher frame rates.

PL_FRAME_DELIVERY_MODE_CONSTANT_INTERVALS

Camera will sample and deliver the frames in constant intervals. In this mode the camera samples the sensor in constant time intervals but if the interface is busy and all frame buffers are full, the frame will be skipped and the sensor will be sampled in the next interval (unlike the FPS mode where the sensor would be sampled immediately once the buffer/interface is unclogged). This results in even frame intervals but there might be gaps in between the frame deliveries and thus reduced frame rate.

◆ PL_FRAME_FLIP_MODES

enum PL_FRAME_FLIP_MODES

Frame flip modes. Used with the PARAM_FRAME_FLIP parameter ID. Treated as int32 type.

Enumerator
PL_FRAME_FLIP_MODE_NONE	No flip
PL_FRAME_FLIP_MODE_X	Horizontal flip, mirroring along x-axis
PL_FRAME_FLIP_MODE_Y	Vertical flip, mirroring along y-axis
PL_FRAME_FLIP_MODE_XY	Horizontal and vertical flip

◆ PL_FRAME_ROTATE_MODES

enum PL_FRAME_ROTATE_MODES

Frame rotation modes. Used with the PARAM_FRAME_ROTATE parameter ID. Treated as int32 type.

Enumerator
PL_FRAME_ROTATE_MODE_NONE	No rotation
PL_FRAME_ROTATE_MODE_90CW	90 degrees clockwise
PL_FRAME_ROTATE_MODE_180CW	180 degrees clockwise
PL_FRAME_ROTATE_MODE_270CW	270 degrees clockwise

◆ PL_IMAGE_COMPRESSIONS

enum PL_IMAGE_COMPRESSIONS

Image compression used to reduce the size of the pixel data. Once the image is decompressed, the pixels can be accessed according to PL_IMAGE_FORMATS type. Used with the PARAM_IMAGE_COMPRESSION parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.imageCompression field).

Enumerator
PL_IMAGE_COMPRESSION_NONE	No compression, the pixels can be accessed according to PL_IMAGE_FORMATS
PL_IMAGE_COMPRESSION_RESERVED8
PL_IMAGE_COMPRESSION_BITPACK9	9-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK10	10-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK11	11-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK12	12-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK13	13-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK14	14-bit packing in 16bit format
PL_IMAGE_COMPRESSION_BITPACK15	15-bit packing in 16bit format
PL_IMAGE_COMPRESSION_RESERVED16
PL_IMAGE_COMPRESSION_BITPACK17	17-bit packing in 24bit format
PL_IMAGE_COMPRESSION_BITPACK18	18-bit packing in 24bit format
PL_IMAGE_COMPRESSION_RESERVED24
PL_IMAGE_COMPRESSION_RESERVED32

◆ PL_IMAGE_FORMATS

enum PL_IMAGE_FORMATS

Image format specifies the buffer format in which the pixels are transferred. The format should be used together with PARAM_BIT_DEPTH because it specifies only the format of the pixel container, not the actual bit depth of the pixel it contains. Used with the PARAM_IMAGE_FORMAT parameter ID. Treated as int32 type (but should not exceed a value of 255 due to md_frame_header.imageFormat field).

Enumerator
PL_IMAGE_FORMAT_MONO16	16bit mono, 2 bytes per pixel.
PL_IMAGE_FORMAT_BAYER16	16bit bayer masked image, 2 bytes per pixel. See also PL_COLOR_MODES.
PL_IMAGE_FORMAT_MONO8	8bit mono, 1 byte per pixel.
PL_IMAGE_FORMAT_BAYER8	8bit bayer masked image, 1 byte per pixel. See also PL_COLOR_MODES.
PL_IMAGE_FORMAT_MONO24	24bit mono, 3 bytes per pixel.
PL_IMAGE_FORMAT_BAYER24	24bit bayer masked image, 3 bytes per pixel. See also PL_COLOR_MODES.
PL_IMAGE_FORMAT_RGB24	8bit RGB, 1 byte per sample, 3 bytes per pixel.
PL_IMAGE_FORMAT_RGB48	16bit RGB, 2 bytes per sample, 6 bytes per pixel.
PL_IMAGE_FORMAT_RGB72	24bit RGB, 3 bytes per sample, 9 bytes per pixel.
PL_IMAGE_FORMAT_MONO32	32bit mono, 4 bytes per pixel.
PL_IMAGE_FORMAT_BAYER32	32bit bayer masked image, 4 bytes per pixel. See also PL_COLOR_MODES.

◆ PL_IMAGE_STATUSES

enum PL_IMAGE_STATUSES

Used with the functions pl_exp_check_status, and pl_exp_check_cont_status and pl_exp_check_cont_status_ex. Treated as int16 type.

Enumerator
READOUT_NOT_ACTIVE	The system is idle, no data is expected. If any arrives, it will be discarded.
EXPOSURE_IN_PROGRESS	The data collection routines are active. They are waiting for data to arrive, but none has arrived yet.
READOUT_IN_PROGRESS	The data collection routines are active. The data has started to arrive.
READOUT_COMPLETE	Means frame is available for a circular buffer acquisition.
FRAME_AVAILABLE	New camera status indicating at least one frame is available.
READOUT_FAILED	Something went wrong. The function returns a PV_FAIL and pl_error_code is set.
ACQUISITION_IN_PROGRESS
MAX_CAMERA_STATUS

◆ PL_IO_DIRECTION

enum PL_IO_DIRECTION

Used with the PARAM_IO_DIRECTION parameter ID. Treated as int32 type.

Enumerator
IO_DIR_INPUT	The port configured as input.
IO_DIR_OUTPUT	The port configured as output.
IO_DIR_INPUT_OUTPUT	The port configured as bi-directional.

◆ PL_IO_TYPE

enum PL_IO_TYPE

Used with the PARAM_IO_TYPE parameter ID. Treated as int32 type.

Enumerator
IO_TYPE_TTL	The bit pattern written to this address.
IO_TYPE_DAC	The value of the desired analog output written to the DAC at this address.

◆ PL_IRQ_MODES

enum PL_IRQ_MODES

Used with the PARAM_BOF_EOF_ENABLE parameter ID. Treated as int32 type.

Enumerator
NO_FRAME_IRQS	Both counters are disabled.
BEGIN_FRAME_IRQS	Counts BOF events.
END_FRAME_IRQS	Counts EOF events.
BEGIN_END_FRAME_IRQS	Provides a sum of BOF and EOF event.

◆ PL_MD_EXT_TAGS

enum PL_MD_EXT_TAGS

Available extended metadata tags. Used in md_ext_item_info structure. Used directly as an enum type without casting to any integral type.

Enumerator
PL_MD_EXT_TAG_PARTICLE_ID	Particle ID
PL_MD_EXT_TAG_PARTICLE_M0	Particle M0 vector
PL_MD_EXT_TAG_PARTICLE_M2	Particle M2 vector
PL_MD_EXT_TAG_MAX

◆ PL_MD_FRAME_FLAGS

enum PL_MD_FRAME_FLAGS

Used in md_frame_header structure. Treated as uns8 type.

Enumerator
PL_MD_FRAME_FLAG_ROI_TS_SUPPORTED	Check this bit before using the timestampBOR and timestampEOR.
PL_MD_FRAME_FLAG_UNUSED_2
PL_MD_FRAME_FLAG_UNUSED_3
PL_MD_FRAME_FLAG_UNUSED_4
PL_MD_FRAME_FLAG_UNUSED_5
PL_MD_FRAME_FLAG_UNUSED_6
PL_MD_FRAME_FLAG_UNUSED_7

◆ PL_MD_ROI_FLAGS

enum PL_MD_ROI_FLAGS

Used in md_frame_roi_header structure. Treated as uns8 type.

Enumerator
PL_MD_ROI_FLAG_INVALID	This flag is used by pl_md_frame_decode to discard invalid ROIs. Any ROI with this flag will not be included in the md_frame ROI array.
PL_MD_ROI_FLAG_HEADER_ONLY	This flag is used to report an ROI that contains no pixel data. Such ROI is used to only mark a location within the frame.
PL_MD_ROI_FLAG_UNUSED_3
PL_MD_ROI_FLAG_UNUSED_4
PL_MD_ROI_FLAG_UNUSED_5
PL_MD_ROI_FLAG_UNUSED_6
PL_MD_ROI_FLAG_UNUSED_7

◆ PL_MPP_MODES

enum PL_MPP_MODES

Used with the PARAM_MPP_CAPABLE parameter ID. Treated as int32 type.

Enumerator
MPP_UNKNOWN
MPP_ALWAYS_OFF
MPP_ALWAYS_ON
MPP_SELECTABLE

◆ PL_OPEN_MODES

enum PL_OPEN_MODES

The modes under which the camera can be open. Used with the function pl_cam_open. Treated as int16 type.

Enumerator
OPEN_EXCLUSIVE	Default camera open mode. The camera is opened exclusively for the calling process.

◆ PL_PARAM_ACCESS

enum PL_PARAM_ACCESS

Used with the function pl_get_param and ATTR_ACCESS. Treated as uns16 type.

Enumerator
ACC_READ_ONLY	Parameter is read only, pl_set_param for such parameter will fail.
ACC_READ_WRITE	Parameter can be read and written.
ACC_EXIST_CHECK_ONLY	Only parameter availability can be checked.
ACC_WRITE_ONLY	Parameter can only be written.

◆ PL_PARAM_ATTRIBUTES

enum PL_PARAM_ATTRIBUTES

Used with the function pl_get_param. Treated as int16 type.

Enumerator

ATTR_CURRENT

Current value. For the enumerated type the value returned here is the value assigned to current enum item, not the item index. The data type for this attribute is defined by ATTR_TYPE.

ATTR_COUNT

Number of possible values for enumerated and array data types. If the data type returned by ATTR_TYPE is TYPE_CHAR_PTR (and not an enumerated type), then the ATTR_COUNT is the number of characters in the string including a space for NULL terminator. If 0 or 1 is returned, ATTR_COUNT is a scalar (single element) of the following data types: TYPE_INT8, TYPE_UNS8, TYPE_INT16, TYPE_UNS16, TYPE_INT32, TYPE_UNS32, TYPE_INT64, TYPE_UNS64, TYPE_FLT64 and TYPE_BOOLEAN. The data type for this attribute is TYPE_UNS32.

ATTR_TYPE

Data type of parameter. Data types used by pl_get_param with attribute type (ATTR_TYPE) are:

Value	Type
TYPE_BOOLEAN	rs_bool
TYPE_INT8	int8
TYPE_UNS8	uns8
TYPE_INT16	int16
TYPE_UNS16	uns16
TYPE_INT32	int32
TYPE_UNS32	uns32
TYPE_INT64	long64
TYPE_UNS64	ulong64
TYPE_FLT32	flt32
TYPE_FLT64	flt64
TYPE_ENUM	int32
TYPE_CHAR_PTR	char*
TYPE_VOID_PTR	void*
TYPE_VOID_PTR_PTR	void**
TYPE_SMART_STREAM_TYPE	smart_stream_type
TYPE_SMART_STREAM_TYPE_PTR	smart_stream_type*

The data type for this attribute is TYPE_UNS16.

ATTR_MIN

Minimum value. The value is only valid for the following data types: TYPE_INT8, TYPE_UNS8, TYPE_INT16, TYPE_UNS16, TYPE_INT32, TYPE_UNS32, TYPE_INT64, TYPE_UNS64, TYPE_FLT64 and TYPE_BOOLEAN. The data type for this attribute is defined by ATTR_TYPE.

ATTR_MAX

Maximum value. The value is only valid for the following data types: TYPE_INT8, TYPE_UNS8, TYPE_INT16, TYPE_UNS16, TYPE_INT32, TYPE_UNS32, TYPE_INT64, TYPE_UNS64, TYPE_FLT64 and TYPE_BOOLEAN. The data type for this attribute is defined by ATTR_TYPE.

ATTR_DEFAULT

Default value. This value should be equal to the current value set in camera after power cycle. For the enumerated type the value returned here is the value assigned to current enum item not the item index. The data type for this attribute is defined by ATTR_TYPE.

ATTR_INCREMENT

Step size for values (zero if non-linear or has no increment). The value is only valid for the following data types: TYPE_INT8, TYPE_UNS8, TYPE_INT16, TYPE_UNS16, TYPE_INT32, TYPE_UNS32, TYPE_INT64, TYPE_UNS64 and TYPE_FLT64. The value for this attribute is never negative. If the value is not zero, valid values can be easily calculated. The first valid value is the value reported for the attribute ATTR_MIN, the second value is the minimum value plus increment (ATTR_INCREMENT), and so on up to the maximum value (ATTR_MAX). The data type for this attribute is defined by ATTR_TYPE.

ATTR_ACCESS

Reports if the parameter with ID param_id can be written to and/or read from or (if it cannot be written to and/or read) tells whether a feature exists. If the param_id can be either written to or read from the next step is to determine its data type. The access types are enumerated: ACC_EXIST_CHECK_ONLY ACC_READ_ONLY ACC_WRITE_ONLY ACC_READ_WRITE The data type for this attribute is TYPE_UNS16.

ATTR_AVAIL

Feature available with attached hardware and software. The data type for this attribute is TYPE_BOOLEAN.

◆ PL_PMODES

enum PL_PMODES

Used with the PARAM_PMODE parameter ID. Treated as int32 type.

Enumerator
PMODE_NORMAL
PMODE_FT
PMODE_MPP
PMODE_FT_MPP
PMODE_ALT_NORMAL
PMODE_ALT_FT
PMODE_ALT_MPP
PMODE_ALT_FT_MPP

◆ PL_READOUT_PORTS

enum PL_READOUT_PORTS

Used with the PARAM_READOUT_PORT parameter ID. Treated as int32 type.

Enumerator
READOUT_PORT_0
READOUT_PORT_1
READOUT_PORT_2
READOUT_PORT_3

◆ PL_SCAN_DIRECTIONS

enum PL_SCAN_DIRECTIONS

Used with the PARAM_SCAN_DIRECTION parameter ID. Treated as int32 type.

Enumerator
PL_SCAN_DIRECTION_DOWN	Default mode. The camera starts reading from top to bottom
PL_SCAN_DIRECTION_UP	Camera starts reading from bottom to up
PL_SCAN_DIRECTION_DOWN_UP	Camera initially starts reading from top to bottom and then switches automatically to read out from bottom to top. The direction alternates between frames down-up-down-up and so on.

◆ PL_SCAN_MODES

enum PL_SCAN_MODES

Used with the PARAM_SCAN_MODE parameter ID. Treated as int32 type.

Enumerator
PL_SCAN_MODE_AUTO	Normal camera imaging and the default mode of operation, the FPGA reads each row in succession without inserting additional delays between rows
PL_SCAN_MODE_PROGRAMMABLE_LINE_DELAY	This mode allows the user to configure the PARAM_SCAN_LINE_DELAY. The PARAM_SCAN_WIDTH will become read-only and its value will be auto-calculated and reported by the camera
PL_SCAN_MODE_PROGRAMMABLE_SCAN_WIDTH	This mode allows the user to configure the PARAM_SCAN_WIDTH. The PARAM_SCAN_LINE_DELAY will become read-only and its value will be auto-calculated and reported by the camera

◆ PL_SHTR_MODES

enum PL_SHTR_MODES

Used with the PARAM_SHTR_STATUS parameter ID. Treated as int32 type.

Enumerator
SHTR_FAULT
SHTR_OPENING
SHTR_OPEN
SHTR_CLOSING
SHTR_CLOSED
SHTR_UNKNOWN

◆ PL_SHTR_OPEN_MODES

enum PL_SHTR_OPEN_MODES

Used with the PARAM_SHTR_OPEN_MODE parameter ID. Treated as int32 type.

Enumerator
OPEN_NEVER	The shutter closes before the exposure and stays closed during the exposure.
OPEN_PRE_EXPOSURE	Opens each exposure. Normal mode.
OPEN_PRE_SEQUENCE	Opens the shutter at the start of each sequence. Useful for frame transfer and external strobe devices.
OPEN_PRE_TRIGGER	If using a triggered mode, this function causes the shutter to open before the external trigger is armed. If using a non-triggered mode, this function operates identical to OPEN_PRE_EXPOSURE.
OPEN_NO_CHANGE	Sends no signals to open or close the shutter. Useful for frame transfer when you want to open the shutter and leave it open (see pl_exp_abort).

◆ PL_SMT_MODES

enum PL_SMT_MODES

Used with the PARAM_SMART_STREAM_MODE parameter ID. Treated as uns16 type.

Enumerator
SMTMODE_ARBITRARY_ALL	Smart streaming values can be arbitrary.
SMTMODE_MAX

◆ PL_SRC_MODES

enum PL_SRC_MODES

Used with the function pl_io_script_control. Treated as uns32 type.

Enumerator
SCR_PRE_OPEN_SHTR
SCR_POST_OPEN_SHTR
SCR_PRE_FLASH
SCR_POST_FLASH
SCR_PRE_INTEGRATE
SCR_POST_INTEGRATE
SCR_PRE_READOUT
SCR_POST_READOUT
SCR_PRE_CLOSE_SHTR
SCR_POST_CLOSE_SHTR

◆ PL_SW_TRIG_STATUSES

enum PL_SW_TRIG_STATUSES

Used with pl_exp_trigger function. Treated as uns32 type.

Enumerator
PL_SW_TRIG_STATUS_TRIGGERED	The camera has accepted the trigger signal and started exposing.
PL_SW_TRIG_STATUS_IGNORED	The camera was unable to accept the trigger due to an ongoing exposure.

◆ PL_TRIGTAB_SIGNALS

enum PL_TRIGTAB_SIGNALS

Used with the PARAM_TRIGTAB_SIGNAL parameter ID. Treated as int32 type.

Enumerator
PL_TRIGTAB_SIGNAL_EXPOSE_OUT	Control the expose out hardware signal multiplexing

◆ PP_FEATURE_IDS

enum PP_FEATURE_IDS

Used with the PARAM_PP_FEAT_ID parameter ID. Treated as uns16 type.

Enumerator
PP_FEATURE_RING_FUNCTION
PP_FEATURE_BIAS
PP_FEATURE_BERT	Background Event Reduction Technology
PP_FEATURE_QUANT_VIEW
PP_FEATURE_BLACK_LOCK
PP_FEATURE_TOP_LOCK
PP_FEATURE_VARI_BIT
PP_FEATURE_RESERVED	Should not be used at any time moving forward.
PP_FEATURE_DESPECKLE_BRIGHT_HIGH
PP_FEATURE_DESPECKLE_DARK_LOW
PP_FEATURE_DEFECTIVE_PIXEL_CORRECTION
PP_FEATURE_DYNAMIC_DARK_FRAME_CORRECTION
PP_FEATURE_HIGH_DYNAMIC_RANGE
PP_FEATURE_DESPECKLE_BRIGHT_LOW
PP_FEATURE_DENOISING	PrimeEnhance feature
PP_FEATURE_DESPECKLE_DARK_HIGH
PP_FEATURE_ENHANCED_DYNAMIC_RANGE
PP_FEATURE_FRAME_SUMMING
PP_FEATURE_LARGE_CLUSTER_CORRECTION
PP_FEATURE_MAX

◆ PP_PARAMETER_IDS

enum PP_PARAMETER_IDS

Used with the PARAM_PP_PARAM_ID parameter ID. Treated as uns16 type.

Enumerator
PP_PARAMETER_RF_FUNCTION
PP_FEATURE_BIAS_ENABLED
PP_FEATURE_BIAS_LEVEL
PP_FEATURE_BERT_ENABLED
PP_FEATURE_BERT_THRESHOLD
PP_FEATURE_QUANT_VIEW_ENABLED
PP_FEATURE_QUANT_VIEW_E
PP_FEATURE_BLACK_LOCK_ENABLED
PP_FEATURE_BLACK_LOCK_BLACK_CLIP
PP_FEATURE_TOP_LOCK_ENABLED
PP_FEATURE_TOP_LOCK_WHITE_CLIP
PP_FEATURE_VARI_BIT_ENABLED
PP_FEATURE_VARI_BIT_BIT_DEPTH
PP_FEATURE_DESPECKLE_BRIGHT_HIGH_ENABLED
PP_FEATURE_DESPECKLE_BRIGHT_HIGH_THRESHOLD
PP_FEATURE_DESPECKLE_BRIGHT_HIGH_MIN_ADU_AFFECTED
PP_FEATURE_DESPECKLE_DARK_LOW_ENABLED
PP_FEATURE_DESPECKLE_DARK_LOW_THRESHOLD
PP_FEATURE_DESPECKLE_DARK_LOW_MAX_ADU_AFFECTED
PP_FEATURE_DEFECTIVE_PIXEL_CORRECTION_ENABLED
PP_FEATURE_DYNAMIC_DARK_FRAME_CORRECTION_ENABLED
PP_FEATURE_HIGH_DYNAMIC_RANGE_ENABLED
PP_FEATURE_DESPECKLE_BRIGHT_LOW_ENABLED
PP_FEATURE_DESPECKLE_BRIGHT_LOW_THRESHOLD
PP_FEATURE_DESPECKLE_BRIGHT_LOW_MAX_ADU_AFFECTED
PP_FEATURE_DENOISING_ENABLED
PP_FEATURE_DENOISING_NO_OF_ITERATIONS
PP_FEATURE_DENOISING_GAIN
PP_FEATURE_DENOISING_OFFSET
PP_FEATURE_DENOISING_LAMBDA
PP_FEATURE_DESPECKLE_DARK_HIGH_ENABLED
PP_FEATURE_DESPECKLE_DARK_HIGH_THRESHOLD
PP_FEATURE_DESPECKLE_DARK_HIGH_MIN_ADU_AFFECTED
PP_FEATURE_ENHANCED_DYNAMIC_RANGE_ENABLED
PP_FEATURE_FRAME_SUMMING_ENABLED
PP_FEATURE_FRAME_SUMMING_COUNT
PP_FEATURE_FRAME_SUMMING_32_BIT_MODE
PP_FEATURE_LARGE_CLUSTER_CORRECTION_ENABLED
PP_PARAMETER_ID_MAX

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ CAM_NAME_LEN

◆ CCD_NAME_LEN

◆ CLASS0

◆ CLASS2

◆ CLASS3

◆ ERROR_MSG_LEN

◆ LS16_BYTE

◆ LS32_BYTE

◆ MAX_ALPHA_SER_NUM_LEN

◆ MAX_CAM

◆ MAX_CAM_PART_NUM_LEN

◆ MAX_CAM_SYSTEMS_INFO_LEN

◆ MAX_GAIN_NAME_LEN

◆ MAX_PP_NAME_LEN

◆ MAX_PRODUCT_NAME_LEN

◆ MAX_SPDTAB_NAME_LEN

◆ MAX_SYSTEM_NAME_LEN

◆ MAX_VENDOR_NAME_LEN

◆ MH32_BYTE

◆ ML32_BYTE

◆ MS16_BYTE

◆ MS32_BYTE

◆ PARAM_NAME_LEN

◆ PL_MD_EXT_TAGS_MAX_SUPPORTED

◆ PL_MD_FRAME_SIGNATURE

◆ PP_MAX_PARAMETERS_PER_FEATURE

◆ TYPE_BOOLEAN

◆ TYPE_CHAR_PTR

◆ TYPE_ENUM

◆ TYPE_FLT32

◆ TYPE_FLT64

◆ TYPE_INT16

◆ TYPE_INT32

◆ TYPE_INT64

◆ TYPE_INT8

◆ TYPE_SMART_STREAM_TYPE

◆ TYPE_SMART_STREAM_TYPE_PTR

◆ TYPE_UNS16

◆ TYPE_UNS32

◆ TYPE_UNS64

◆ TYPE_UNS8

◆ TYPE_VOID_PTR

◆ TYPE_VOID_PTR_PTR

◆ VAL_INT64

◆ VAL_UNS16

◆ VAL_UNS32

Typedef Documentation

◆ active_camera_type

◆ FRAME_INFO

◆ io_entry

◆ io_list

◆ md_ext_item

◆ md_ext_item_collection

◆ md_ext_item_info

◆ md_frame

◆ md_frame_header

◆ md_frame_header_v3

◆ md_frame_roi

◆ md_frame_roi_header

◆ PL_CALLBACK_EVENT

◆ PL_CAM_INTERFACE_MODES

◆ PL_CAM_INTERFACE_TYPES

◆ PL_CCS_ABORT_MODES

◆ PL_CENTROIDS_MODES

◆ PL_CIRC_MODES

◆ PL_CLEAR_MODES

◆ PL_COLOR_MODES

◆ PL_COOL_MODES

◆ PL_EXP_RES_MODES

◆ PL_EXPOSE_OUT_MODES

◆ PL_EXPOSURE_MODES

◆ PL_FAN_SPEEDS

◆ PL_FRAME_DELIVERY_MODES

◆ PL_FRAME_FLIP_MODES