Numeric types and values

Data Structures
struct	peak_buffer
	peak Buffer descriptor More...
struct	peak_size
	peak Size (2D) More...
struct	peak_position
	peak Position (2D) More...
struct	peak_roi
	The peak ROI (2D) More...
union	peak_matrix
	The peak 3x3 Matrix. More...
struct	peak_version
	The peak version info. More...

Macros
#define	PEAK_INVALID_HANDLE
	peak Invalid handle value
#define	PEAK_INFINITE
	peak Infinite value
#define	PEAK_TRUE
	peak Boolean value for 'true' or 'yes'
#define	PEAK_FALSE
	peak Boolean value for 'false' or 'no'
#define	PEAK_IDENTITY_MATRIX
	The peak Identity matrix preset.

Typedefs
typedef uint8_t	peak_bool
	peak Boolean type

Detailed Description

Definitions on numeric types and values.

Macro Definition Documentation

PEAK_FALSE

#define PEAK_FALSE

peak Boolean value for 'false' or 'no'

This value reflects a negative decision, i.e. 'false' or 'no'. It is used for variables of type peak_bool.

PEAK_IDENTITY_MATRIX

#define PEAK_IDENTITY_MATRIX

The peak Identity matrix preset.

Use this preset to set a peak_matrix for the identity.

PEAK_INFINITE

#define PEAK_INFINITE

peak Infinite value

This value can be used to specify infinity in several function calls. The value can be used for timeout parameters as well as for count parameters, where documented.

For example this value can be used for the timeout_ms parameter in peak_Acquisition_WaitForFrame to specify an infinite wait timeout. It also can be used for the numberOfFrames parameter in peak_Acquisition_Start to specify an infinite acquisition_and_buffer_preparation.

PEAK_INVALID_HANDLE

#define PEAK_INVALID_HANDLE

peak Invalid handle value

Use this value for the initialization of variables of handle type, i.e. peak_camera_handle, peak_frame_handle.

PEAK_TRUE

#define PEAK_TRUE

peak Boolean value for 'true' or 'yes'

This value reflects a positive decision, i.e. 'true' or 'yes'. It is used for variables of type peak_bool.

Typedef Documentation

peak_bool

typedef uint8_t peak_bool

peak Boolean type

This type is for boolean decisions, i.e. 'true' and 'false' or 'yes' and 'no'. Possible values for this type are PEAK_TRUE and PEAK_FALSE.