Zivid::Frame2D Class Reference

A 2D frame captured by a Zivid camera More...

#include <Zivid/Frame2D.h>

Public Member Functions
ZIVID_CORE_EXPORT	Frame2D ()
	Construct a new empty 2d frame More...
ZIVID_CORE_EXPORT Image< ColorRGBA >	imageRGBA () const
	Get color (RGBA) image from the frame More...
ZIVID_CORE_EXPORT Image< ColorBGRA >	imageBGRA () const
	Get color (BGRA) image from the frame More...
ZIVID_CORE_EXPORT Settings2D	settings () const
	Get the settings used to capture this frame More...
ZIVID_CORE_EXPORT CameraState	state () const
	Get the camera state data at the time of the capture More...
ZIVID_CORE_EXPORT FrameInfo	info () const
	Get information collected at the time of the capture More...
ZIVID_CORE_EXPORT CameraInfo	cameraInfo () const
	Get information about the camera used to capture the frame More...
ZIVID_CORE_EXPORT std::string	toString () const
	Get string representation of the frame More...

Detailed Description

A 2D frame captured by a Zivid camera

Contains a 2D image as well as metadata, settings and state of the API at the time of capture.

Note that if this Frame2D object was returned from a call to Camera::capture, then there may still be remaining data transfer and processing going on in the background. When you call a method on the Frame2D object that requires the capture to be finished, for example Frame2D::imageRGBA(), the method will block until the image is available.

Constructor & Destructor Documentation

Frame2D()

ZIVID_CORE_EXPORT Zivid::Frame2D::Frame2D

(

)

Construct a new empty 2d frame

Member Function Documentation

cameraInfo()

ZIVID_CORE_EXPORT CameraInfo Zivid::Frame2D::cameraInfo

(

)

const

Get information about the camera used to capture the frame

This method returns instantly, even if the capture is still in-progress.

imageBGRA()

ZIVID_CORE_EXPORT Image< ColorBGRA > Zivid::Frame2D::imageBGRA

(

)

const

Get color (BGRA) image from the frame

The format of each pixel is given by ColorBGRA. If the image is not yet available because the capture is still in-progress, then this method will block until the image is available.

imageRGBA()

ZIVID_CORE_EXPORT Image< ColorRGBA > Zivid::Frame2D::imageRGBA

(

)

const

Get color (RGBA) image from the frame

The format of each pixel is given by ColorRGBA. If the image is not yet available because the capture is still in-progress, then this method will block until the image is available.

info()

ZIVID_CORE_EXPORT FrameInfo Zivid::Frame2D::info

(

)

const

Get information collected at the time of the capture

If the capture is still in-progress, then this method will block until the capture completes.

settings()

ZIVID_CORE_EXPORT Settings2D Zivid::Frame2D::settings

(

)

const

Get the settings used to capture this frame

This method returns instantly, even if the capture is still in-progress.

state()

ZIVID_CORE_EXPORT CameraState Zivid::Frame2D::state

(

)

const

Get the camera state data at the time of the capture

If the capture is still in-progress, then this method will block until the capture completes.

toString()

ZIVID_CORE_EXPORT std::string Zivid::Frame2D::toString

(

)

const

Get string representation of the frame

Returns

Frame info as string

If the capture is still in-progress, then this method will block until the capture completes.

---

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

• Zivid/Frame2D.h