IDSpeakcomfortC  v1.5.0

Functions

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

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_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]hCamThe camera handle.
[in]enabledThe 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_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]hCamThe 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_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]hCamThe camera handle.
[in]enabledThe 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_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]hCamThe 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.