Mirror

Functions
PEAK_API_ACCESS_STATUS	peak_Mirror_LeftRight_GetAccessStatus (peak_camera_handle hCam)
	Query the left-right mirroring access status.
PEAK_API_STATUS	peak_Mirror_LeftRight_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the left-right mirroring.
PEAK_API_BOOL	peak_Mirror_LeftRight_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the left-right mirroring.
PEAK_API_ACCESS_STATUS	peak_Mirror_UpDown_GetAccessStatus (peak_camera_handle hCam)
	Query the up-down mirroring access status.
PEAK_API_STATUS	peak_Mirror_UpDown_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the up-down mirroring.
PEAK_API_BOOL	peak_Mirror_UpDown_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the up-down mirroring.

Detailed Description

Image mirroring related functions and types.

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

Function Documentation

peak_Mirror_LeftRight_Enable()

PEAK_API_STATUS peak_Mirror_LeftRight_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the left-right mirroring.

Sets the left-right mirroring to enabled or disabled.

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_ACCESS_DENIED The left-right mirroring feature is not accessible for write. Check the access status via peak_Mirror_LeftRight_GetAccessStatus.

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_Mirror_LeftRight_GetAccessStatus()

PEAK_API_ACCESS_STATUS peak_Mirror_LeftRight_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the left-right mirroring access status.

Provides the current access status for the left-right mirroring feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The left-right mirroring feature is readable and writeable.

PEAK_ACCESS_READONLY The left-right mirroring feature is readable only.

PEAK_ACCESS_GFA_LOCK The left-right mirroring feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The left-right mirroring is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The left-right mirroring feature is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

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

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

peak_Mirror_LeftRight_IsEnabled()

PEAK_API_BOOL peak_Mirror_LeftRight_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the left-right mirroring.

Queries whether the left-right 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_Mirror_UpDown_Enable()

PEAK_API_STATUS peak_Mirror_UpDown_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the up-down mirroring.

Sets the up-down mirroring to enabled or disabled.

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_ACCESS_DENIED The up-down mirroring feature is not accessible for write. Check the access status via peak_Mirror_UpDown_GetAccessStatus.

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_Mirror_UpDown_GetAccessStatus()

PEAK_API_ACCESS_STATUS peak_Mirror_UpDown_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the up-down mirroring access status.

Provides the current access status for the up-down mirroring feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The up-down mirroring feature is readable and writeable.

PEAK_ACCESS_READONLY The up-down mirroring feature is readable only.

PEAK_ACCESS_GFA_LOCK The up-down mirroring feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The up-down mirroring is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The up-down mirroring feature is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

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

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

peak_Mirror_UpDown_IsEnabled()

PEAK_API_BOOL peak_Mirror_UpDown_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the up-down mirroring.

Queries whether the up-down 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.