CVD::VideoFrame< T > Class Template Reference
[Video frames]

#include <videoframe.h>

Inheritance diagram for CVD::VideoFrame< T >:

[legend]

List of all members.

Public Member Functions
VideoFrameFlags::FieldType	field () const
double	timestamp () const
	What is the time (since boot) of this frame?
	VideoFrame (double t, const BasicImage< T > &im, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
	VideoFrame (double t, T *data, const ImageRef &size, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
Protected Member Functions
virtual	~VideoFrame ()
	We don't usually delete video frames. Some special destruction is usually needed.
Protected Attributes
VideoFrameFlags::FieldType	my_field
double	my_timestamp
	Type of field in this frame.

---

Detailed Description

template<class T>
class CVD::VideoFrame< T >

A frame from a VideoBuffer.

Parameters:

T

The pixel type of the video frames

Definition at line 53 of file videoframe.h.

---

Constructor & Destructor Documentation

template<class T>

CVD::VideoFrame< T >::VideoFrame	(	double	t,
		T *	data,
		const ImageRef &	size,
		VideoFrameFlags::FieldType	f = VideoFrameFlags::Unknown
	)			[inline]

(Used internally) Construct a VideoFrame around a block of memory. The memory is not managed by the VideoFrame so must me managed seperately

Parameters:

	t	The time (in seconds) of this frame
	data	The image data for this frame
	size	The size of this video frame

Definition at line 61 of file videoframe.h.

template<class T>

CVD::VideoFrame< T >::VideoFrame	(	double	t,
		const BasicImage< T > &	im,
		VideoFrameFlags::FieldType	f = VideoFrameFlags::Unknown
	)			[inline]

(Used internally) Construct a VideoFrame from a BasicImage

Parameters:

	t	The time (in seconds) of this frame
	im	The image data for this frame. BasicImages do not manage their own memory, so this must be managed externally

Definition at line 70 of file videoframe.h.

template<class T>

virtual CVD::VideoFrame< T >::~VideoFrame

(

)

[inline, protected, virtual]

We don't usually delete video frames. Some special destruction is usually needed.

Definition at line 88 of file videoframe.h.

---

Member Function Documentation

template<class T>

VideoFrameFlags::FieldType CVD::VideoFrame< T >::field

(

)

const [inline]

Definition at line 81 of file videoframe.h.

template<class T>

double CVD::VideoFrame< T >::timestamp

(

)

const [inline]

What is the time (since boot) of this frame?

Definition at line 76 of file videoframe.h.

---

Member Data Documentation

template<class T>

VideoFrameFlags::FieldType CVD::VideoFrame< T >::my_field [protected]

Definition at line 92 of file videoframe.h.

template<class T>

double CVD::VideoFrame< T >::my_timestamp [protected]

Type of field in this frame.

No of seconds since boot of this frame

Definition at line 93 of file videoframe.h.

---

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

• videoframe.h