AVT::VmbAPI::Frame Class Reference

#include <Frame.h>

Classes
struct	Impl

Public Member Functions
IMEXPORT	Frame (VmbInt64_t bufferSize)
IMEXPORT	Frame (VmbUchar_t *pBuffer, VmbInt64_t bufferSize)
IMEXPORT VmbErrorType	GetAncillaryData (AncillaryDataPtr &pAncillaryData)
IMEXPORT VmbErrorType	GetAncillaryData (ConstAncillaryDataPtr &pAncillaryData) const
IMEXPORT VmbErrorType	GetAncillarySize (VmbUint32_t &ancillarySize) const
IMEXPORT VmbErrorType	GetBuffer (const VmbUchar_t *&pBuffer) const
IMEXPORT VmbErrorType	GetBuffer (VmbUchar_t *&pBuffer)
IMEXPORT VmbErrorType	GetBufferSize (VmbUint32_t &bufferSize) const
IMEXPORT VmbErrorType	GetFrameID (VmbUint64_t &frameID) const
IMEXPORT VmbErrorType	GetHeight (VmbUint32_t &height) const
IMEXPORT VmbErrorType	GetImage (const VmbUchar_t *&pBuffer) const
IMEXPORT VmbErrorType	GetImage (VmbUchar_t *&pBuffer)
IMEXPORT VmbErrorType	GetImageSize (VmbUint32_t &imageSize) const
bool	GetObserver (IFrameObserverPtr &observer) const
IMEXPORT VmbErrorType	GetOffsetX (VmbUint32_t &offsetX) const
IMEXPORT VmbErrorType	GetOffsetY (VmbUint32_t &offsetY) const
IMEXPORT VmbErrorType	GetPixelFormat (VmbPixelFormatType &pixelFormat) const
IMEXPORT VmbErrorType	GetReceiveStatus (VmbFrameStatusType &status) const
IMEXPORT VmbErrorType	GetTimestamp (VmbUint64_t &timestamp) const
IMEXPORT VmbErrorType	GetWidth (VmbUint32_t &width) const
IMEXPORT VmbErrorType	RegisterObserver (const IFrameObserverPtr &pObserver)
IMEXPORT VmbErrorType	UnregisterObserver ()
IMEXPORT	~Frame ()

Private Member Functions
	Frame ()
	Frame (Frame &)
Frame &	operator= (const Frame &)

Private Attributes
Impl *	m_pImpl

Friends
class	Camera

Detailed Description

Definition at line 43 of file Frame.h.

Constructor & Destructor Documentation

Frame() [1/4]

AVT::VmbAPI::Frame::Frame ( VmbInt64_t  bufferSize )

explicit

Definition at line 55 of file Frame.cpp.

Frame() [2/4]

AVT::VmbAPI::Frame::Frame	(	VmbUchar_t *	pBuffer,
		VmbInt64_t	bufferSize
	)

Definition at line 68 of file Frame.cpp.

~Frame()

AVT::VmbAPI::Frame::~Frame

(

)

Definition at line 111 of file Frame.cpp.

Frame() [3/4]

AVT::VmbAPI::Frame::Frame ( )

private

Definition at line 39 of file Frame.cpp.

Frame() [4/4]

AVT::VmbAPI::Frame::Frame ( Frame &  )

private

Definition at line 44 of file Frame.cpp.

Member Function Documentation

GetAncillaryData() [1/2]

VmbErrorType AVT::VmbAPI::Frame::GetAncillaryData

(

AncillaryDataPtr &

pAncillaryData

)

Definition at line 164 of file Frame.cpp.

GetAncillaryData() [2/2]

VmbErrorType AVT::VmbAPI::Frame::GetAncillaryData

(

ConstAncillaryDataPtr &

pAncillaryData

)

const

Definition at line 176 of file Frame.cpp.

GetAncillarySize()

VmbErrorType AVT::VmbAPI::Frame::GetAncillarySize

(

VmbUint32_t &

ancillarySize

)

const

Definition at line 232 of file Frame.cpp.

GetBuffer() [1/2]

VmbErrorType AVT::VmbAPI::Frame::GetBuffer

(

const VmbUchar_t *&

pBuffer

)

const

Definition at line 195 of file Frame.cpp.

GetBuffer() [2/2]

VmbErrorType AVT::VmbAPI::Frame::GetBuffer

(

VmbUchar_t *&

pBuffer

)

Definition at line 188 of file Frame.cpp.

GetBufferSize()

VmbErrorType AVT::VmbAPI::Frame::GetBufferSize

(

VmbUint32_t &

bufferSize

)

const

Definition at line 239 of file Frame.cpp.

GetFrameID()

VmbErrorType AVT::VmbAPI::Frame::GetFrameID

(

VmbUint64_t &

frameID

)

const

Definition at line 281 of file Frame.cpp.

GetHeight()

VmbErrorType AVT::VmbAPI::Frame::GetHeight

(

VmbUint32_t &

height

)

const

Definition at line 260 of file Frame.cpp.

GetImage() [1/2]

VmbErrorType AVT::VmbAPI::Frame::GetImage

(

const VmbUchar_t *&

pBuffer

)

const

Definition at line 210 of file Frame.cpp.

GetImage() [2/2]

VmbErrorType AVT::VmbAPI::Frame::GetImage

(

VmbUchar_t *&

pBuffer

)

Definition at line 202 of file Frame.cpp.

GetImageSize()

VmbErrorType AVT::VmbAPI::Frame::GetImageSize

(

VmbUint32_t &

imageSize

)

const

Definition at line 225 of file Frame.cpp.

GetObserver()

bool AVT::VmbAPI::Frame::GetObserver

(

IFrameObserverPtr &

observer

)

const

Definition at line 153 of file Frame.cpp.

GetOffsetX()

VmbErrorType AVT::VmbAPI::Frame::GetOffsetX

(

VmbUint32_t &

offsetX

)

const

Definition at line 267 of file Frame.cpp.

GetOffsetY()

VmbErrorType AVT::VmbAPI::Frame::GetOffsetY

(

VmbUint32_t &

offsetY

)

const

Definition at line 274 of file Frame.cpp.

GetPixelFormat()

VmbErrorType AVT::VmbAPI::Frame::GetPixelFormat

(

VmbPixelFormatType &

pixelFormat

)

const

Definition at line 246 of file Frame.cpp.

GetReceiveStatus()

VmbErrorType AVT::VmbAPI::Frame::GetReceiveStatus

(

VmbFrameStatusType &

status

)

const

Definition at line 218 of file Frame.cpp.

GetTimestamp()

VmbErrorType AVT::VmbAPI::Frame::GetTimestamp

(

VmbUint64_t &

timestamp

)

const

Definition at line 288 of file Frame.cpp.

GetWidth()

VmbErrorType AVT::VmbAPI::Frame::GetWidth

(

VmbUint32_t &

width

)

const

Definition at line 253 of file Frame.cpp.

operator=()

Frame & AVT::VmbAPI::Frame::operator= ( const Frame &  )

private

Definition at line 49 of file Frame.cpp.

RegisterObserver()

VmbErrorType AVT::VmbAPI::Frame::RegisterObserver

(

const IFrameObserverPtr &

pObserver

)

Definition at line 123 of file Frame.cpp.

UnregisterObserver()

VmbErrorType AVT::VmbAPI::Frame::UnregisterObserver

(

)

Definition at line 136 of file Frame.cpp.

Friends And Related Function Documentation

Camera

friend class Camera

friend

Definition at line 45 of file Frame.h.

Member Data Documentation

m_pImpl

Impl* AVT::VmbAPI::Frame::m_pImpl

private

Definition at line 326 of file Frame.h.

---

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

• Frame.h
• Frame.cpp