A handle to a 2D image being displayed on Zivid camera's projector. More...

#include <Zivid/Projection/ProjectedImage.h>

Public Member Functions
ZIVID_CORE_EXPORT Frame2D	capture2D (const Settings2D &settings)
	Capture a single 2D frame without stopping the ongoing image projection.

ZIVID_CORE_EXPORT Frame2D	capture (const Settings2D &settings)
	Capture a single 2D frame without stopping the ongoing image projection.

ZIVID_CORE_EXPORT void	stop ()
	Stops the ongoing image projection.

ZIVID_CORE_EXPORT bool	active () const
	Check if a handle is associated with an ongoing image projection.

ZIVID_CORE_EXPORT std::string	toString () const
	Get string representation of the projected image.

Detailed Description

A handle to a 2D image being displayed on Zivid camera's projector.

The image projection will stop when this handle goes out of scope, if another operation is started on the camera or if the stop() method on this handle is called.

Member Function Documentation

◆ active()

ZIVID_CORE_EXPORT bool Zivid::Projection::ProjectedImage::active ( ) const

Check if a handle is associated with an ongoing image projection.

Returns: A bool indicating the active status.

◆ capture()

ZIVID_CORE_EXPORT Frame2D Zivid::Projection::ProjectedImage::capture ( const Settings2D & settings )

Capture a single 2D frame without stopping the ongoing image projection.

Parameters

settings Settings2D to use for the capture

Returns: A frame containing a 2D image and metadata

This method is deprecated and will be removed in the next SDK major release (3.0). It is replaced by capture2D.

This method returns right after the acquisition of the image is complete. This function can only be used with a zero-brightness 2D capture, otherwise it will interfere with the projected image. An exception will be thrown if settings contains brightness > 0.

◆ capture2D()

ZIVID_CORE_EXPORT Frame2D Zivid::Projection::ProjectedImage::capture2D ( const Settings2D & settings )

Capture a single 2D frame without stopping the ongoing image projection.

Parameters

settings Settings2D to use for the capture

Returns: A frame containing a 2D image and metadata

This method returns right after the acquisition of the image is complete. This function can only be used with a zero-brightness 2D capture, otherwise it will interfere with the projected image. An exception will be thrown if settings contains brightness > 0.

◆ stop()

ZIVID_CORE_EXPORT void Zivid::Projection::ProjectedImage::stop ( )

Stops the ongoing image projection.

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::Projection::ProjectedImage::toString ( ) const

Get string representation of the projected image.

The documentation for this class was generated from the following file:

Zivid/Projection/ProjectedImage.h