Zivid::Frame2D Class Reference

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

#include <Zivid/Frame2D.h>

Public Member Functions
ZIVID_CORE_EXPORT Image< ColorRGBA >	imageRGBA () const
	Get color (RGBA) 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 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.

Member Function Documentation

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.

info()

ZIVID_CORE_EXPORT FrameInfo Zivid::Frame2D::info

(

)

const

Get information collected at the time of the capture

settings()

ZIVID_CORE_EXPORT Settings2D Zivid::Frame2D::settings

(

)

const

Get the settings used to capture this frame

state()

ZIVID_CORE_EXPORT CameraState Zivid::Frame2D::state

(

)

const

Get the camera state data at the time of the capture

toString()

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

(

)

const

Get string representation of the frame

Returns

Frame info as string

---

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

• Zivid/Frame2D.h