Mirror

Functions
PEAK_API_STATUS	peak_IPL_Mirror_UpDown_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the up-down host mirroring.
PEAK_API_BOOL	peak_IPL_Mirror_UpDown_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the up-down host mirroring.
PEAK_API_STATUS	peak_IPL_Mirror_LeftRight_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the left-right host mirroring.
PEAK_API_BOOL	peak_IPL_Mirror_LeftRight_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the left-right host mirroring.

Detailed Description

Image mirroring related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Mirror.

Function Documentation

peak_IPL_Mirror_LeftRight_Enable()

PEAK_API_STATUS peak_IPL_Mirror_LeftRight_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the left-right host mirroring.

Sets the left-right host mirroring to enabled or disabled. Mirroring a bayer pixel format changes the format, therefore we recommend processing to a RGB format

Parameters

[in]	hCam	The camera handle.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_Mirror_LeftRight_IsEnabled()

PEAK_API_BOOL peak_IPL_Mirror_LeftRight_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the left-right host mirroring.

Queries whether the left-right host mirroring is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The left-right mirroring feature is currently enabled.

PEAK_FALSE The left-right mirroring feature is currently disabled or the query failed.

peak_IPL_Mirror_UpDown_Enable()

PEAK_API_STATUS peak_IPL_Mirror_UpDown_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the up-down host mirroring.

Sets the up-down host mirroring to enabled or disabled. Mirroring a bayer pixel format changes the format, therefore we recommend processing to a RGB format

Parameters

[in]	hCam	The camera handle.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_Mirror_UpDown_IsEnabled()

PEAK_API_BOOL peak_IPL_Mirror_UpDown_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the up-down host mirroring.

Queries whether the up-down host mirroring is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The up-down mirroring feature is currently enabled.

PEAK_FALSE The up-down mirroring feature is currently disabled or the query failed.